Order Object

Create and manage eCommerce orders

Properties
activitiesArray <Activity>Read-onlymaxItems 1000

Order activities.

additionalFeesArray <AdditionalFee>maxItems 100

Additional fees applied to the order.

appliedDiscountsArray <AppliedDiscount>maxItems 320

Applied discounts.

archivedboolean

Whether order is archived.

attributionSourcestring

Order attribution source.

balanceSummaryBalanceSummaryRead-only

Balance summary.

billingInfoBillingInfo

Billing address and contact details.

businessLocationBusinessLocationbeta

Order Location

buyerInfoBuyerInfo

Buyer information.

buyerLanguagestring

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.

buyerNotestringmaxLength 1000

Buyer note left by the customer.

channelInfoChannelInfo

Information about the sales channel that submitted this order.

checkoutIdstringformat GUID

Checkout ID.

createdByCreatedByRead-only

ID of the order's initiator.

createdDatestringRead-onlyimmutableformat date-time

Date and time the order was created in ISO-8601 format.

currencystringformat CURRENCY

Currency used for the pricing of this order in ISO-4217 format.

currencyConversionDetailsCurrencyConversionDetailsbeta

Currency conversion details. For use with multi-currency sites.

customFieldsArray <CustomField>

Custom fields.

extendedFieldsExtendedFields

Custom field data for the order object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.

fulfillmentStatusstringRead-only

Order fulfillment status.

idstringRead-onlyformat GUID

Order ID.

lineItemsArray <OrderLineItem>Read-onlyminItems 1maxItems 300

Order line items.

numbernumberRead-only

Order number displayed in the site owner's dashboard (auto-generated).

payAfterFreeTrialPayAfterFreeTrialRead-onlybeta

Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.

paymentStatusstring

Order payment status.

priceSummaryPriceSummaryRead-only

Order price summary.

purchasedDatestringbetaimmutableformat date-time

Date and time the order was originally purchased in ISO-8601 format. Used for migration from external systems.

purchaseFlowIdstringformat GUID

Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

recipientInfoRecipientInfo

Order recipient address and contact details.

This field may differ from the address in shippingInfo.logistics when:

  • The chosen shipping option is pickup point or store pickup.
  • No shipping option is selected.
seenByAHumanboolean

Whether a human has seen the order. Set when an order is clicked on in the dashboard.

shippingInfoShippingInfo

Shipping info and selected shipping option details.

siteLanguagestringRead-onlyimmutable

Site language in which original values are shown.

statusstring

Order status.

tagsTags

Order tags.

Tags are labels attached to entities, allowing for flexible categorization and data management.

taxIncludedInPricesbooleanimmutable

Whether tax is included in line item prices.

taxInfoTaxInfo

Tax information.

taxSummaryTaxSummarydeprecated - use taxInfo instead

Tax summary. Deprecated. Use taxInfo instead. This field will be removed on September 30, 2024.

updatedDatestringRead-onlyformat date-time

Date and time the order was last updated in ISO-8601 format.

weightUnitstring

Weight measurement unit - defaults to site's weight unit.

Did this help?