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.

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?