Sign in

v6

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-09153208467.0 KB
orders

Search for orders

This request retrieves a paginated list of orders that supports query, sorting, and pagination parameters to filter and structure the results.

get/orders

Query parameters

querystring

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

sortstring

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

pageinteger

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfterstring

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSizeinteger

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of summarized order details, including key identifiers, status, and shipping information, filtered and sorted according to the request parameters.

orderIdinteger

The unique internal identifier for the order.

sellerIdinteger

The unique identifier for the seller account associated with the order.

createdstring date-time

Timestamp when the order record was initially created.

lastModifiedstring date-time

Timestamp when the order record was last modified.

orderIdentifierstring

A unique identifier from the source system (e.g., shop system) to prevent duplicate order creation.

orderReferencestring

An easy-to-read reference number for the order, typically set by the customer or shop.

orderStatusstring

The current fulfillment status of the order (e.g., 'PENDING', 'PROCESSING', 'COMPLETED').

tagsstring[]

Optional list of descriptive tags applied to the order.

orderDatestring date-time

The date and time when the order was placed by the customer.

cancelRequestedAtstring date-time

Timestamp if a cancellation request was logged for the order.

shipToCountrystring

The ISO 2 country code (e.g., 'DE', 'US') for the delivery address.

shipToZipstring

The ZIP code for the delivery address.

shipToCompanystring

The company name for the delivery address.

shipToName1string

The first name/line 1 name for the delivery address.

shipToName2string

The second name/line 2 name for the delivery address.

shipToAddressIdentifierstring

An optional identifier for the delivery address (e.g., a store ID).

earliestPredatedShipmentstring date

The earliest allowed date for the order to be shipped.

latestPredatedShipmentstring date

The latest allowed date for the order to be shipped.

completedAtstring date-time

Timestamp when the order was marked as fulfilled/completed.

exportedAtstring date-time

Timestamp when the order was exported to the warehouse management system.

shipToEmailstring

The email address for the delivery recipient.

billToEmailstring

The email address for the invoice recipient.

piiDataRemovedboolean

Indicates if Personally Identifiable Information (PII) has been removed from the order record.

totalShipmentWeightnumber

The total weight of all shipments associated with the order (in kg).

shopIdinteger

The unique identifier of the source shop system.

shopSystemstring

The technical name of the shop system (e.g., 'Shopware', 'Shopify').

shopSystemNamestring

The display name of the shop system.

customerPurchaseOrderNumberstring

A reference code assigned to the purchase order by the customer.

channelIdstring

The ID of the sales channel associated with the order.

channelNamestring

The name of the sales channel associated with the order.

customAttributesobject

Arbitrary key-value pairs for storing custom data related to the order.