Custom Webstore (B2C)

List Orders

List Orders

get/openapi/{version}/customwebstore/orders/

Request

  • Base URL
    https://base_url
  • Auth
    none declared. Required headers: connection-id

Path parameters

versionstring required

Query parameters

created_afterstring

Filter by order creation time. Example: ?created_after=2024-01-01:00:00:00

created_beforestring

Filter by order creation time. Example: ?created_before=2024-01-01:00:00:00

fulfilment_orders_statusstring

Filter by fulfilment orders status (comma-separated). Example: ?fulfilment_orders_status=ON_HOLD,CANCELLED

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Order by field. Example: ?ordering=created_at or ?ordering=-updated_at

searchstring

Search by unique order identifier. Example: ?search=ordertest123

shipment_statusstring

Filter by shipment status (comma-separated). Example: ?shipment_status=IN_TRANSIT,DELIVERED

unique_order_identifierstring

Filter by unique_order_identifier (comma-separated). Example: ?unique_order_identifier=test1,test2

updated_afterstring

Filter by order update time. Example: ?updated_after=2024-01-01:00:00:00

updated_beforestring

Filter by order update time. Example: ?updated_before=2024-01-01:00:00:00

Headers

connection-idstring required

Custom webstore connection id.

Response

List Orders

successboolean
messagestring required

Changes

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