An order represents a completed purchase from a buyer. Orders are created through the checkout flow or manually via the Create Order endpoint.
The order contains details about purchased items, buyer and recipient information, pricing, tax, shipping, fulfillment status, and payment status.
To get the total sum of all discounts applied to an order, use priceSummary.discount.amount.
Order activities.
Additional fees applied to the order.
Applied discounts.
Whether order is archived.
Order attribution source.
Balance summary.
Billing address and contact details.
Order Location
Buyer information.
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.
Buyer note left by the customer.
Information about the sales channel that submitted this order.
Checkout ID.
ID of the order's initiator.
Date and time the order was created in ISO-8601 format.
Currency used for the pricing of this order in ISO-4217 format.
Currency conversion details. For use with multi-currency sites.
Custom fields.
Custom field data for the order object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Order fulfillment status.
Order ID.
Order line items.
Order number displayed in the site owner's dashboard (auto-generated).
Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
Order payment status.
Order price summary.
Date and time the order was originally purchased in ISO-8601 format. Used for migration from external systems.
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
Final recipient's address and contact details.
This field represents who will ultimately receive the order. It may differ from shippingInfo.logistics.shippingDestination when:
shippingDestination contains the pickup location.Whether a human has seen the order. Set when an order is clicked on in the dashboard.
Shipping info and selected shipping option details.
Site language in which original values are shown.
Order status.
Order tags.
Tags are labels attached to entities, allowing for flexible categorization and data management.
Whether tax is included in line item prices.
Tax information.
Tax summary.
Deprecated. Use taxInfo instead.
This field will be removed on September 30, 2024.
Date and time the order was last updated in ISO-8601 format.
Weight measurement unit - defaults to site's weight unit.