Fejlesztőknek
Kezdj bele
API-k/App API/Orders/List orders

List orders

Ez az oldal még csak angolul érhető el.
GET/apps-api/v1/orders

Responses are private and never cached.

Szükséges jogosultság

orders.read

Lekérdezési paraméterek

limitintegerOpcionális

1 to 100; default 25

cursorstringOpcionális

max 1024 characters

status"pending" | "completed" | "canceled" | "requires_action"Opcionális
updatedAfterstring (date-time)Opcionális

Fejlécek

Poltura-InstallationstringKötelező

Válasz

ordersobject[]Kötelező

max 100 items

idstringKötelező
orderNumberstringKötelező
status"pending" | "completed" | "canceled" | "requires_action"Kötelező
paymentStatusstringKötelező

one of "not_paid", "awaiting", "authorized", "captured", "partially_captured", "partially_refunded", "refunded", "canceled", "requires_action"

fulfillmentStatusstringKötelező

one of "not_fulfilled", "partially_fulfilled", "fulfilled", "partially_shipped", "shipped", "partially_returned", "returned", "canceled", "requires_action"

currencystringKötelező
totalobjectKötelező
amountstringKötelező
currencystringKötelező
subtotalobjectKötelező
amountstringKötelező
currencystringKötelező
createdAtstring (date-time)Kötelező
updatedAtstring (date-time)Kötelező
emailstring (email) | nullKötelező
customerIdstring | nullKötelező
itemsobject[]Kötelező

max 200 items

idstringKötelező
variantIdstring | nullKötelező
productIdstring | nullKötelező
titlestringKötelező
quantityintegerKötelező

-9007199254740991 to 9007199254740991

unitPriceobjectKötelező
amountstringKötelező
currencystringKötelező
shippingAddressobject | nullKötelező
firstNamestringKötelező
lastNamestringKötelező
address1stringKötelező
address2string | nullKötelező
citystringKötelező
postalCodestringKötelező
countryCodestringKötelező
provincestring | nullKötelező
phonestring | nullKötelező
metadataobjectKötelező
nextCursorstring | nullKötelező

max 1024 characters

Hibák

ÁllapotKód
400invalid_input, unsupported_api_version
401unauthorized
403forbidden, insufficient_scope
404not_found
409conflict, quota_exceeded
412stale_version
413payload_too_large
429rate_limited
503unavailable