Customer orders
Read the customer's order history, details, and status.
Fields
idstringUnique identifier of the resource.orderNumberstringstatusenumnew · confirmed · inProgress · invoiced · readyToPickUp · inTransit · delivered · partialDelivered · closed · cancelled · invalid · pendingToConfirm · pendingToDeliveredToClient · returned · partialReturned · partialCancelled · nonetotalnumbercurrencyCodestringISO 4217 currency code, for example PEN.emailstringorderGroupstringstepenumpending · confirmed · shipped · outForDelivery · delivered · cancelledSee all 37 fields
totalPaidnumberorderDatestringcreatedOnstringTimestamp when the resource was created, in ISO 8601.updatedOnstringTimestamp when the resource was last modified, in ISO 8601.paymentAtstringsubTotalnumberdiscountnumbershippingnumbertaxnumberphonestringfirstNamestringlastNamestringshippingAddressobjectshippingAddressSummarystringbillingAddressobjectitemsarray<object>paymentsarray<object>statusTimelinearray<object>shipmentsarray<object>paymentPathstringreturnStatusenumnone · requested · inProgress · inspected · returned · rejectedreturnDeadlinestringcanRequestReturnbooleancancellationRequestedAtstringcanRequestCancellationbooleanrefundsarray<object>totalRefundednumberissuesDocumentsbooleandocumentsarray<object>Operations
| Method | Endpoint | Operation |
|---|---|---|
GET | / | List customer orders |
GET | / | Get customer order |
POST | / | Request a cancellation |
POST | / | Request a return |
GET | / | Get order status |
GET | / | Get orders by group |
Last updated: