A temporary, editable version of an order. Use draft orders to modify pricing, line items, or discounts on an existing order before committing the changes.
When committed, the draft order's changes are applied to the original order.
Additional fees.
Includes details about the source, and whether the additional fee is applied to the order.
Balance summary.
Billing address and contact details. Includes details about changes when relevant.
Billing address and contact details.
Order business location.
Includes details about changes when relevant.
Buyer information.
Includes details about changes when relevant.
Buyer information.
Side effects to perform on commit.
Identity of the draft order's initiator.
Date and time the draft order was created.
Currency used for pricing.
Discounts.
Includes details about the source, and whether the discount is applied to the order.
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.
Draft order ID.
Line items. Includes details about changes when relevant.
Member ID (if order created by a member).
ID of the order this draft commits to.
Price summary.
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:
Shipping info. Includes details about changes when relevant.
Draft order status.
Tax information.
Deprecated. Use taxInfo instead.
This field will be removed on September 30, 2024.
Tax summary.
Date and time the draft order was updated.
Weight measurement unit. Defaults to the site's weight unit.