Draft Order Object

Draft Order main entity. A temporary version of an order, allowing modifications before finalization.

Properties
idstringRead-onlyformat GUID

Draft order ID.

orderIdstringformat GUID

ID of the order this draft commits to.

lineItemsArray <ItemDetails>minItems 1maxItems 300

Line items. Includes details about changes when relevant.

shippingInfoShippingInfo

Shipping info. Includes details about changes when relevant.

buyerInfoBuyerInfodeprecated - use buyerDetails instead

Buyer information.

billingInfoBillingInfodeprecated - use billingDetails instead

Billing address and contact details.

additionalFeesArray <AdditionalFeeDetails>maxItems 100

Additional fees.

Includes details about the source, and whether the additional fee is applied to the order.

discountsArray <DiscountDetails>maxItems 320

Discounts.

Includes details about the source, and whether the discount is applied to the order.

createdDatestringRead-onlyformat date-time

Date and time the draft order was created.

updatedDatestringRead-onlyformat date-time

Date and time the draft order was updated.

createdByCreatedByRead-only

Identity of the draft order's initiator.

statusstringRead-only

Draft order status.

weightUnitstring

Weight measurement unit. Defaults to the site's weight unit.

currencystringformat CURRENCY

Currency used for pricing.

priceSummaryPriceSummaryRead-only

Price summary.

taxSummaryTaxSummaryRead-onlydeprecated - use taxInfo instead

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

balanceSummaryBalanceSummaryRead-only

Balance summary.

commitSettingsCommitSettings

Side effects to perform on commit.

memberIdstringformat GUID

Member ID (if order created by a member).

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.
taxInfoTaxInfo

Tax information.

extendedFieldsExtendedFields

Custom field data for the draft order object.

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

buyerDetailsBuyerDetails

Buyer information.

Includes details about changes when relevant.

billingDetailsBillingDetails

Billing address and contact details. Includes details about changes when relevant.

businessLocationDetailsBusinessLocationDetails

Order business location.

Includes details about changes when relevant.

Did this help?