Orders

Get Orders

Rate limit: 100 requests per minute

get/api/v1/orders/

Request

The document declares no server URL.
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/aboutyou/apis/sellers-center-api/docs/api/v1/orders/get.ts
A function with typed inputs. Its response is checked against the schema.

order_numberstring nullable

Order number to search for.

customer_keystring nullable

Customer key to search for.

carrier_keystring nullable

Carrier key of the order to filter by. Available carrier keys can be retrieved from the Carrier model (active carriers only).

shop_countrystring nullable

Shop country to search for.

order_status'open' | 'shipped' | 'cancelled' | 'returned' | 'mixed'

Status of the order to filter by. Choose from: "open", "shipped", "cancelled", "returned", "mixed".

order_item_status'open' | 'shipped' | 'cancelled' | 'returned'

Status of the order item to filter by. Choose from: "open", "shipped", "cancelled", "returned".

orders_fromstring date-time nullable

Orders from date to filter by.

orders_tostring date-time nullable

Orders to date to filter by.

fulfillment_type'dropshipping' | 'fulfillment_by_marketplace'

Fulfillment type to filter by.

pageinteger

Page number to retrieve items from.

per_pageinteger

Number of items per page.

cursorstring nullable

Opaque cursor from previous response for cursor-based pagination. When provided, omit page or use page=1.

No recorded changes to this operation across all 1 revision of this API.