Skip to content
Guides

Order Drafts

Create, update, share, and convert order drafts.

MethodEndpointOperation
POST/v1/order-draftsCreate order draft
GET/v1/order-draftsList order drafts
GET/v1/order-drafts/{draftId}Get order draft
PATCH/v1/order-drafts/{draftId}Update order draft
POST/v1/order-drafts/{draftId}/convertConvert order draft to order
POST/v1/order-drafts/{draftId}/shareCreate order draft share link
POST/v1/order-drafts/{draftId}/cancelCancel order draft
GET/v1/order-drafts/{draftId}/shipping-optionsList order draft shipping options
PATCH/v1/order-drafts/{draftId}/statusUpdate order draft status

Items

MethodEndpointOperation
POST/v1/order-drafts/{draftId}/itemsAdd item to order draft
PATCH/v1/order-drafts/{draftId}/items/{itemId}Update order draft item
DELETE/v1/order-drafts/{draftId}/items/{itemId}Remove item from order draft

Shipping Method

MethodEndpointOperation
PUT/v1/order-drafts/{draftId}/shipping-methodSet order draft shipping method
DELETE/v1/order-drafts/{draftId}/shipping-methodClear order draft shipping method

On this page