Skip to main content
Orders

List Despatched Goodsouts

List order goodsouts. Please note that all expands will be applied automatically.

GET
/v1/orders/despatched

Fuzzy search available

Scope(s): APP::ORDERS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand attributes, courier, courier.service, courier.tracking, order, order.currency

id[EQUALS]numberquery

Filter for goodsout id. (EQUALS)

order.reference[IN]stringquery

Filter for the parent order. (IN)

order.channel.short_code[IN]stringquery

Filter for order channel. (IN)

order.channel.short_code[NOT_IN]stringquery

Filter for order channel. (NOT_IN)

order.channel.id[IN]stringquery

Filter for order channel. (IN)

order.channel.id[NOT_IN]stringquery

Filter for order channel. (NOT_IN)

despatch_date[LESS_THAN]anyquery

Filter for despatch date. (LESS_THAN)

despatch_date[ON_DATE]anyquery

Filter for despatch date. (ON_DATE)

despatch_date[MORE_THAN]anyquery

Filter for despatch date. (MORE_THAN)

order.currency.code[IN]stringquery

Filter for currency. (IN)

order.currency.code[NOT_IN]stringquery

Filter for currency. (NOT_IN)

sortingenum<string>query

Sort by bid, warehouse.name, order.channel.name, status, order.status, placed_date, despatch_date (prefix with '-' for descending order).

Available options: bid, -bid, warehouse.name, -warehouse.name, order.channel.name, -order.channel.name, status, -status, order.status, -order.status, placed_date, -placed_date, despatch_date, -despatch_date

Response

200application/json

successful operation

attributesany

List of applied attributes.

bidstring

BID.

courierobject

Courier.

despatch_dateany

Despatch date.

idnumber

Goodsout ID.

orderobject

The parent order.

statusstring

Status.

Still need help? Share an idea