Skip to content

Customer orders

Read the customer's order history, details, and status.

Fields

idstringUnique identifier of the resource.
orderNumberstring
statusenumnew · confirmed · inProgress · invoiced · readyToPickUp · inTransit · delivered · partialDelivered · closed · cancelled · invalid · pendingToConfirm · pendingToDeliveredToClient · returned · partialReturned · partialCancelled · none
totalnumber
currencyCodestringISO 4217 currency code, for example PEN.
emailstring
orderGroupstring
stepenumpending · confirmed · shipped · outForDelivery · delivered · cancelled
See all 37 fields
totalPaidnumber
orderDatestring
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
paymentAtstring
subTotalnumber
discountnumber
shippingnumber
taxnumber
phonestring
firstNamestring
lastNamestring
shippingAddressobject
shippingAddressSummarystring
billingAddressobject
itemsarray<object>
paymentsarray<object>
statusTimelinearray<object>
shipmentsarray<object>
paymentPathstring
returnStatusenumnone · requested · inProgress · inspected · returned · rejected
returnDeadlinestring
canRequestReturnboolean
cancellationRequestedAtstring
canRequestCancellationboolean
refundsarray<object>
totalRefundednumber
issuesDocumentsboolean
documentsarray<object>

Operations

MethodEndpointOperation
GET/v1/customer/ordersList customer orders
GET/v1/customer/orders/{orderId}Get customer order
POST/v1/customer/orders/{orderId}/cancellation-requestRequest a cancellation
POST/v1/customer/orders/{orderId}/return-requestRequest a return
GET/v1/customer/orders/{orderId}/statusGet order status
GET/v1/customer/orders/group/{orderGroup}Get orders by group

Last updated: