List orders

Get orders for given filters

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

Parameter	Details
shopKey required	string Example: ms
countryCode required	string Example: de

Query Parameters

Parameter	Details
with	Array of strings Example: ?with=legacyCustomData string Enum: legacyCustomData items.legacyCustomData customer.legacyCustomData
filters[id]	Array of integers integer
filters[minId]	integer
filters[maxId]	integer
filters[minCreatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxCreatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[minUpdatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxUpdatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[billingAddressCountryCode]	string Example: DEU
filters[shippingAddressCountryCode]	string Example: DEU
filters[customerId]	Array of integers integer
filters[minCustomerId]	integer
filters[maxCustomerId]	integer
filters[customerReferenceKey]	Array of strings string
filters[referenceKey]	Array of strings string
filters[status]	string Enum: order_open payment_pending payment_reserved invoice_completed cancellation_pending cancellation_completed invoice_partially_completed
filters[detailedStatus]	string Enum: order.order_created order.order_open order.order_pended order.order_confirmed order.order_delegated order.order_shipped order.order_invoiced order.order_aborted order.order_cancelled shipping.shipping_open shipping.shipping_ordered shipping.shipping_delivered shipping.shipping_cancelled shipping.shipping_undeliverable shipping.shipping_partially_delivered billing.billing_open billing.billing_pending billing.billing_payment_pending billing.billing_completed billing.billing_payment_aborted billing.billing_payment_cancelled billing.billing_refunded billing.billing_denied
filters[firstName]	string Example: Anna
filters[lastName]	string Example: Fohlmeister
filters[email] MaxLength: 60	string Example: anna.fohlmeister@project-collins.com
filters[minInvoicedAt]	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
filters[maxInvoicedAt]	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
filters[voucherCode]	string Example: fashion2020
filters[productId]	integer Example: 123
filters[variantId]	integer Example: 123
sort	string Enum: id appId customerId createdAt confirmedAt updatedAt paymentKey Default: id
sortDir	string Enum: asc desc Default: asc
cursor	string
limit Minimum: 1 Maximum: 100	integer Default: 10

Responses

200

List of orders

application/json

Success

Array of undefined

object

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

404

Not Found

application/json

Error

GET/shops/{shopKey}/countries/{countryCode}/orders

Request samples

Response samples

200

Order:

Content type: application/json