Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v5.0.12
v5.0.16
v5.0.20
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v5.0.20
Home
Guides
API Reference
Changelog
Discussions
Order Attribute
Search
All
Pages
Start typing to search…
JUMP TO
UC Marketplace Glyde API
Intro to the UC Marketplace API
Authentication
Handling errors
Storefront API
Storefront: Authentication
Authenticate existing customer
post
Reset customer password
put
Get token for admin or vendor user
post
Generate Customer Token
post
Set customer's password after reset
post
Check if email is available
post
Storefront: 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
Save a product to recently viewed list
post
Get recently viewed product list
get
Get all products pending review after ordering them.
get
Get pre-defined options for product ratings.
get
Get existing product reviews.
get
Create ordered product review.
post
Get product price for customer
get
Search products
get
Retrieve Product Information
get
Submit Product to be Reviewed
post
Update Product without Review Confirmation
put
Save Product as Draft
post
Update the product price
post
Product Attribute
Retrieve Product Attributes
get
Product Attribute (Admin Token)
Add an attribute option
post
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
Get the quote details for provided address
post
Merge items in guest cart with items in existing cart
post
Update quote item quantity
put
Remove item from quote
del
Get quote/cart summary of totals
get
Get quote items
get
Add item to quote
post
Get quote details
get
Create new quote
post
Shopping Cart Quote (Guest)
Place order as guest
post
Set shipping options as guest
post
Shiiping information
post
Get payment methods
get
Get quote details for provided address as guest
post
Get quote totals for guest
get
Update a product in guest quote
put
Get items (products) in guest quote
get
Add a product to guest quote
post
Create a new cart for this guest user
post
Get guest quote
get
Get payment options
get
Order
List of orders
get
Order (Admin Token)
Ship Order
post
Order Attribute
Update Order Attributes
put
Invoice
Get PDF of invoice
get
List of invoices
get
Invoice (Admin Token)
Get invoice based on order id.
get
Create refund for invoice.
post
Shipment
List of shipments
get
Shipment (Admin Token)
Get shipments list
get
Enquiry
Create new enquiry
post
/V1/storeview/{store-code}/user/enquiry/vendor/{vendor_id}
get
/V1/storeview/{store-code}/user/enquiry/product/{product_id}
get
Get list of enquiries
get
Enquiry (Admin Token)
Get list of enquiries as admin
get
Attachment (Admin Token)
Download attachment
get
Upload/add attachments
post
Offer
Request offer
post
Update offer
post
Add to cart with offer
post
Return
Get a list of returns for an order
get
Place an RMA for customer
post
Get a list of return specifics (reason, condition, resolutions)
get
Add a message to an existing RMA request
post
Add an attachment to an existing message in an existing RMA
post
Get a specific return request by id
get
Subscription
Retrieve subscription list
get
Action for a subscription
post
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
Vendor Sign Up
Check if vendor email exists
post
Get vendor form header and footer
get
Create vendor sign-up
post
Get vendor sign up form fields
get
Get Vendor Sign Up Form Countries
get
Get Vendor Sign Up Form Basis
get
Vendor Review
Get all vendors pending review after ordering from them
get
Get all vendors review
get
Create ordered product vendor review
post
Create ordered product vendor review
post
Storefront: Vendor Rating
Get pre-defined options for vendor ratings.
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
Customer
Get unread message count for customer C2C communications
get
Get customer details
get
Update customer details
put
Organisation
Get organisations for customer
get
Create a new organisation
post
Search organisation by nam
get
Get organisation details
get
Get organisation users for organisation id
get
Get all groups for the organisation
get
Get organisation orders for organisation id
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
Get header - top level 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
Get product list
get
Create products
post
Update Omnyfy products
put
Provide product details
get
Get product by url-key
get
Get product price
get
Get related products
get
Create product reviews
post
Get product reviews
get
Delete product by SKU
del
Product Attribute
Create a product attribute
post
Create a product attribute set
post
Assign product attribute to attribute set
post
Get attribute-set list
get
Get product attribute list
get
Order
Get order list
get
Order Attribute
Order Item Attribute
Update Order Item Attributes
put
Shipment
Create a shipment
post
Customer
Create new customer
post
Update customer details
put
Get customers list
get
Delete customer
del
Vendor
Get vendor's profile by providing token
get
Get vendor album by id
get
Get vendor policies by vendor id
get
Get vendor ratings by vendor id
get
Get vendor albums by vendor id
get
Get reviews for vendor
get
Get Vendor Details by vendor id
get
Vendor Sign Up
Get vendor types for sign up form
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
Powered by
Order Attribute
