List orders
GET/apps-api/v1/orders
Responses are private and never cached.
Required permission
orders.read
Query parameters
limitintegerOptional
1 to 100; default 25
cursorstringOptional
max 1024 characters
status"pending" | "completed" | "canceled" | "requires_action"Optional
updatedAfterstring (date-time)Optional
Headers
Poltura-InstallationstringRequired
Response
ordersobject[]Required
max 100 items
idstringRequired
orderNumberstringRequired
status"pending" | "completed" | "canceled" | "requires_action"Required
paymentStatusstringRequired
one of "not_paid", "awaiting", "authorized", "captured", "partially_captured", "partially_refunded", "refunded", "canceled", "requires_action"
fulfillmentStatusstringRequired
one of "not_fulfilled", "partially_fulfilled", "fulfilled", "partially_shipped", "shipped", "partially_returned", "returned", "canceled", "requires_action"
currencystringRequired
totalobjectRequired
amountstringRequired
currencystringRequired
subtotalobjectRequired
amountstringRequired
currencystringRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
emailstring (email) | nullRequired
customerIdstring | nullRequired
itemsobject[]Required
max 200 items
idstringRequired
variantIdstring | nullRequired
productIdstring | nullRequired
titlestringRequired
quantityintegerRequired
-9007199254740991 to 9007199254740991
unitPriceobjectRequired
amountstringRequired
currencystringRequired
shippingAddressobject | nullRequired
firstNamestringRequired
lastNamestringRequired
address1stringRequired
address2string | nullRequired
citystringRequired
postalCodestringRequired
countryCodestringRequired
provincestring | nullRequired
phonestring | nullRequired
metadataobjectRequired
nextCursorstring | nullRequired
max 1024 characters
Errors
| Status | Code |
|---|---|
| 400 | invalid_input, unsupported_api_version |
| 401 | unauthorized |
| 403 | forbidden, insufficient_scope |
| 404 | not_found |
| 409 | conflict, quota_exceeded |
| 412 | stale_version |
| 413 | payload_too_large |
| 429 | rate_limited |
| 503 | unavailable |