🔒
Requires order access scope. For more info , refer to:access scope

Order API

Order APIs provide developer the ability to manage orders in authenticated stores.

We provide following APIs:

Order - manage orders in the store.Order contains all the information a single purchase would needed, for example, Customer and Line Item, and related Shipping Address and Billing Address information.
Order Risk - manage order risk to help merchants mitigate potential risks

📘
Noted:
All date time related parameters require ISO-8601 format in UTC time zone.

Object Model

Order:

LineItem:

PaymentLine:

Fulfillment:

Customer:

ShippingAddress:

BillingAddress:

LocationLine:

OrderConfig:

MarketSetting:

MarketCurrencySymbol:

MarketPriceSetting:

Status	desc
opened	Order successfully created
canceled	Cancellation of unpaid order
placed	Completed paid orders
finished	The scenarios where the order is in the `finished` state: 1. All items in the order have been received 2. Order cancelled after payment 3. Full refund of order amount with all items deleted 4. Full refund of order amount with all items returned

Status	Desc
waiting	Pending payment
paying	Payment Processing
authorized	Authorized
partially_paid	Partial Payment (Gift Card Used)
paid	Payment Received
cancelled	Payment Cancelled
failed	Payment Failed
refunding	Refund Processing
refund_fail	Refund Failed
refunded	Fully Refunded
partially_refunded	Partial Refund

RefundLineItem:

LineItem:

PaymentDetail: