API Documentation
Authentication APIs
- Login & Register
- Create & Manage Users
Catalog APIs
- GETList all products
- GETList all skus
- GETRetrieve a product
- GETRetrieve product variants
- GETRetrieve variant detail
- GETList all categories
- GETRetrieve product reviews
- POSTCreate product review
- GETRetrieve similar products
- GETRetrieve up sell products
- GETRetrieve cross sell products
- GETRetrieve recommended products
- POSTDatocms webhook
Cart & Checkout APIs
- Cart
- Checkout
Coupons & promotions API
Customers API
Orders APIs
Shipping APIs
Analytics
Campaigns API
Retrieve order detail
Authorizations
Access token
Path Parameters
order number
Response
India
10 digit phone number without country code.
Use in shipping details only.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
Use in shipping details only.
to show refundable details in order cancellation ui.
amount deducted from paid amount.
reason for cancellation charges.
loyalty point redeemed will be rollbacked and credited to user account.
payment mode for refund.
original-payment-mode
, bank-transfer
amount that will be refunded to customer.
order cancellation option should be visible only if this flag is true.
GST
pending
, success
, failed
, partially_paid
masked card number e.g. ************1111
Visa
, Master Card
, Rupay
Credit Card
, Debit Card
, Netbanking
, UPI
, Wallet
, Loyalty Point
, IMPS
, NEFT
, RTGS
pending
, success
, failed
, partially_paid
, refund_initiated
payment
, refund
India
10 digit phone number without country code.
Use in shipping details only.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
Use in shipping details only.
draft
, awaiting_approval
, cancelled
, shipped
, delivered
, awaiting_shipment