getDraftOrder( )

Retrieves a draft order.

The retrieved draft order contains the latest calculations:

  • Line items, shipping details, and buyer information.
  • Tax details and price totals.
  • Automatic discounts and automatic additional fees, along with updated eligibility.

Note: When retrieving a committed draft order, it is not recalculated.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
draftOrderIdstringRequired

Draft order ID.

Returns
Return Type:Promise<GetDraftOrderResponse>
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?