Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v5.0.20
v5.0.30
Log In
API Reference
Log In
v5.0.30
Home
Guides
API Reference
Changelog
Discussions
Intro to the UC Marketplace API
All
Pages
Start typing to search…
JUMP TO
UC Marketplace Glyde API
Intro to the UC Marketplace API
Authentication
Handling errors
Storefront API
Authentication
Get token for admin or vendor user
post
Authenticate existing customer
post
Set customer's password after reset
post
Check if email is available
post
Send password reset email to customer
put
Get customer token using user credentials
post
Category
Get category
get
Get category using url-key/path
get
Search
Get total number of search results for both vendors and products
get
Product
Search products
get
Retrieve product by URL key
get
Retrieve product by ID
get
Retrieve related products by product ID
get
Get related products by product SKU
get
Retrieve product reviews by product ID
get
Create a product review
post
Create ordered product review.
post
Update the product price
post
Save Product as Draft
post
Update Product without Review Confirmation
put
Submit Product to be Reviewed
post
Retrieve Product Information
get
Get product price for customer
get
Get existing product reviews.
get
Get all products pending review after ordering them.
get
Get pre-defined options for product ratings.
get
Get recently viewed product list
get
Save a product to recently viewed list
post
Product Attribute
Retrieve Product Attributes
get
Payment
Payment options
get
Shopping Cart Quote
Place order
post
Set shipping options
post
Save shipping and billing address and payment information
post
Get payment methods
get
Update quote item quantity
put
Get the quote details for provided address
post
Merge items in guest cart with items in existing cart
post
Remove item from quote
del
Get quote/cart summary of totals
get
Get quote items
get
Add item to quote
post
Create new quote
post
Get quote details
get
Guest checkout
Create a new cart for a guest user
post
Get guest quote
get
Add a product to guest quote
post
Update a product in guest quote
put
Get items (products) in guest quote
get
Get payment options
get
Shipping information
post
Get quote totals for guest
get
Get quote details for provided address as guest
post
Get payment methods
get
Set shipping options as guest
post
Place order as guest
post
Order
List of orders
get
Order Attribute
Update Order Attributes
put
Invoice
Get PDF of invoice
get
List of invoices
get
Shipment
List of shipments
get
Enquiry
Create new enquiry
post
Fetch enquiries linked to a specific vendor
get
Retrieve a chat URL for a product enquiry using the product ID.
get
Offer
Request offer
post
Add to cart with offer
post
Update offer
post
Storefront: Return
Add an attachment to an existing message in an existing RMA
post
Add a message to an existing RMA request
post
Retrieve available return reasons, conditions, and resolutions
get
Get a list of returns for an order
get
Place an RMA for customer
post
Retrieve a return request by ID
get
Subscription
Retrieve Customer's Subscription
get
Update Status/ Change Subscription Plan.
post
Retrieve details for a particular subscription using subscription id.
get
Vendor
Get vendor details by vendor url-key
get
Search vendors and get list
get
Retrieve reviews for a vendor
get
Retrieve vendor album details (v2)
get
Retrieve vendor policies by vendor id (v2)
get
Retrieve vendor ratings by vendor ID (v2)
get
Retrieve vendor albums by vendor ID (v2)
get
Retrieve vendor details by vendor ID (v2)
get
Vendor Sign Up
Get vendor sign up form blocks
get
Get vendor sign up fields
get
Get Vendor Sign Up Form Countries
get
Get vendor payout basis types
get
Check if vendor email exists
post
Create Vendor via sign-up
post
Vendor Review
Get customer's vendor reviews
get
Get all vendors pending review after ordering from them
get
Create ordered product vendor review
post
Vendor Rating
Get pre-defined options for vendor ratings.
get
Customer
Get customer details
get
Create new customer
post
Update customer details
put
Get unread message count for customer C2C communications
get
Organisation
Get organisation orders for organisation id
get
Get organisation users for organisation id
get
Get organisation details
get
Create a new organisation
post
Get organisations for customer
get
Get all groups for the organisation
get
Search organisation by name
get
Assign customer to organisation
post
Chat
Get chat entity by channel URL
get
Get Seller Chats
post
Get Buyer Chats
post
Get Seller Moderator Chats
post
Configuration
Get JSON stored in studio configuration
get
Retrieve marketplace configuration data
get
Get regions for country-code
get
Get list of all countries
get
Content
Get CMS page
get
Admin API
Category
Get category list
get
Product
Create products
post
Update Omnyfy products
put
Delete product by SKU
del
Get product list
get
Retrieve product prices by product ID
get
Product Attribute
Create a product attribute set
post
Create a product attribute
post
Assign product attribute to attribute set
post
Get attribute-set list
get
Get product attribute list
get
Order
Get order list
get
Ship Order
post
Order Attribute
Add an attribute option
post
Delete Order Attribute Value
del
Set Order Attribute Value
post
Order Item Attribute
Update Order Item Attributes
put
Enquiry (Admin Token)
Retrieve all customer enquiries as an administrator.
get
Shipment
Get shipments list
get
Create a shipment
post
Attachment (Admin Token)
Upload/add attachments
post
Customer
Delete customer
del
Get customers list
get
Update customer details
put
Invoice
Get invoice based on order id.
get
Refund
Create refund for invoice.
post
Vendor
Retrieve vendor profile using authentication token
get
Retrieve vendor album details
get
Retrieve vendor policies by vendor id
get
Retrieve vendor ratings by vendor ID
get
Retrieve vendor albums by vendor ID
get
Retrieve vendor details by vendor ID
get
Vendor Payout
Process Stripe Payout
post
Get Payout History List
get
Get Payout Invoice List
get
Get Stripe Payout Total
get
Get Payout Invoice PDF
get
Subscription
Retrieve subscription list
get
Action for a subscription
post
Vendor Sign Up
Retrieve vendor types for sign-up form
get
Download attachment
get
Project Bidding
Project Settings (Admin Token)
Get configuration
get
Admin get Project Type by vendor Id
get
Get vendors who match with projects criteria
get
Project Settings (Customer Token)
Get configuration
get
Customer get Project Type by vendor Id
get
Project Category
Get available subcategories
get
Project (Admin Token)
send vendor invitation
post
Get projects
get
Get project
get
Create project
post
Update project
put
Submit project
post
Project completion
post
Submit vendor's invitation response
post
Project (Customer Token)
send vendor invitation
post
Get vendors who match with projects criteria
get
Get project
get
Update project
put
Get customer's projects
get
Create project
post
Customer cancels a project
post
Submit project
post
Project Questionnaire (Admin Token)
Get questionnaire for project category by questionnaire id
get
Create questionnaire response
post
Project Proposal (Admin Token)
Get proposal by id
get
Admin/Vendor removes a quote item from proposal
del
Admin changes proposal status to cancel request
post
Admin/Vendor accepts proposal cancellation request
post
Submit proposal with optional milestone
put
Complete proposal
post
Get proposal quote rates
get
Admin/Vendor add new proposal quote items
post
Admin Update Proposal Quote Item
put
Get proposal file
get
Project Proposal (Customer Token)
Customer accepts proposal cancellation request
post
Get proposal by id
get
Submit customer's proposal response
post
Customer requests proposal cancellation from vendor
get
Get proposal file of customer
get
Project Proposal Milestone
Admin/Vendor adds a new milestone in proposal
put
Admin/Vendor updates a milestone in proposal
put
Admin/Vendor cancels a milestone in proposal
post
Admin/Vendor deletes a milestone in proposal
del
Admin/Vendor updates a milestone item in proposal
put
Delete a milestone item in proposal
del
Admin/Vendor marks milestone as paid
put
Project Questionnaire (Customer Token)
Create questionnaire response
post
Customer get questionnaire for project category by questionnaire id
get
Project Order (Admin Token)
Complete a pending order
post
Project Order (Customer Token)
Create new pending order for milestone
post
Project Attachment (Admin Token)
Upload attachment
post
download attachment
get
Project Attachment (Customer Token)
upload attachment
post
download attachment
get
Webhooks
Webhooks API
Retrieve webhook types
get
Retrieve webhooks
get
Create a webhook
post
Update an existing webhook
put
Delete a webhook
del
Webhooks
vendor.approved
post
vendor.updated
post
order.updated
post
cart.updated
post
product.updated
post
product.saleable_quantity.updated
post
shipment.updated
post
vendor.signup.completed
post
enquiry.message.send
post
order.created
post
cart.added
post
cart.deleted
post
customer.login
post
store.configuration.updated
post
project.invitation.responded
post
project.updated
post
project.proposal.updated
post
project.type.updated
post
project.type.deleted
post
Admin: Enquiry
Get list of enquiries
get
Admin: Vendor
Retrieve vendor profile using authentication token (v2)
get
Storefront: Product
Retrieve product by URL key (v2)
get
Retrieve product by ID (v2)
get
Retrieve product prices by product ID (v2)
get
Retrieve related products by product ID (v2)
get
Storefront: Product Review
Retrieve product reviews by product ID (v2)
get
Create a product review (v2)
post
Storefront: Shopping Cart Quote
Apply coupon code to quote
put
Delete applied coupon code from quote
del
Storefront: Shopping Cart Quote (Guest)
Delete quote item from guest quote
del
Apply coupon code to quote
put
Delete coupon code from quote
del
Storefront: Vendor Review
Retrieve reviews for a vendor (v2)
get
Storefront: Vendor Sign Up
Retrieve vendor types for sign-up form (v2)
get
Powered by
Intro to the UC Marketplace API
Ask AI
