getOrderDraftabilityStatus( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Checks whether a draft can be created for an order.

If orderDraftable returns as true, the order can be used to create a draft order.

If orderDraftable returns as false, refer to the nonDraftableReasons array in the response to understand why the order is not draftable.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderIdstringRequired

Order ID.

Returns
Return Type:Promise<GetOrderDraftabilityStatusResponse>
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?