Create and manage eCommerce orders
Order ID.
Order number displayed in the site owner's dashboard (auto-generated).
Date and time the order was created in ISO-8601 format.
Date and time the order was last updated in ISO-8601 format.
Order line items.
Buyer information.
Order payment status.
NOT_PAID - This can be an order made online, but not yet paid. In such cases order.status will be INITIALIZED.order.status will be APPROVED.PAID - All payments associated with this order are paid. For online payments: payment.regularPaymentDetails.status: APPROVED. For gift cards: payment.giftCardPaymentDetails.voided: false.PARTIALLY_REFUNDED - Order was refunded, but refund amount is less than order total price.FULLY_REFUNDED - Order fully refunded. Refund amount equals total price.PENDING - Payments received but not yet confirmed by the payment provider.PARTIALLY_PAID - At least one payment was received and approved, covering less than total price amount.Order fulfillment status.
Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
Weight measurement unit - defaults to site's weight unit.
Currency used for the pricing of this order in ISO-4217 format.
Whether tax is included in line item prices.
Site language in which original values are shown.
Order price summary.
Billing address and contact details.
Shipping info and selected shipping option details.
Buyer note left by the customer.
Order status.
INITIALIZED: Order created, but not yet approved or canceled.APPROVED: Order approved. This happens when either an online payment is received or when order.priceSummary.total = 0 (a zero-total order). Offline orders (cash payment) are automatically approved.CANCELED: Order canceled by the user.Whether order is archived.
Tax summary.
Deprecated. Use taxInfo instead.
This field will be removed on September 30, 2024.
Tax information.
Applied discounts.
Order activities.
Order attribution source.
ID of the order's initiator.
Information about the sales channel that submitted this order.
Whether a human has seen the order. Set when an order is clicked on in the dashboard.
Checkout ID.
Custom fields.
Balance summary.
Additional fees applied to the order.
Custom field data for the order object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
Order recipient address and contact details.
This field may differ from the address in shippingInfo.logistics when:
Date and time the order was originally purchased in ISO-8601 format. Used for migration from external systems.