Skip to content

Order Drafts

Create, update, share, and convert order drafts.

Fields

idstringUnique identifier of the resource.
currencyCodestringISO 4217 currency code, for example PEN.
emailstring
statusenumdraft · sent · viewed · accepted · rejected · expired · converted · cancelled
totalnumber
draftNumberstring
sourcestring
notesstring
See all 47 fields
phonestring
firstNamestring
lastNamestring
identificationTypestring
identificationNumberstring
entityNamestring
draftDatestring
sentAtstring
viewedAtstring
acceptedAtstring
rejectedAtstring
expiredAtstring
cancelledAtstring
convertedAtstring
shareTokenstring
shareExpiresAtstring
allowAnonymousShareAccessboolean
sharedAtstring
billingAddressobject
shippingAddressobject
metadataobject
subTotalnumber
discountnumber
shippingnumber
taxnumber
warrantynumber
paymentMethodstring
paymentCodestring
itemsarray<object>
shippingMethodsarray<object>
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
orderPathsarray<string>
cancelReasonstring
identificationCountryCodestring
storeIdstring
customerIdstring
cartIdstring
entityTaxIdstring

Operations

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}/invoiceSend draft invoice
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

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

Last updated: