Skip to main content
Orders

List Goodsouts

List order goodsouts. Please note that all expands will be applied automatically. The warehouse ID filter accepts warehouse shortcodes as well as IDs.

GET
/v1/orders/goodsouts

Fuzzy search available

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

Query Parameters

expandstringquery

Usage: expand=*

Expand attributes, courier, courier.service, courier.tracking, lines, order, order.brand, order.channel, order.currency, shipping_address, shipping_address.contact, shipping_address.country, tags, warehouse, warehouse.country

id[EQUALS]numberquery

Filter for goodsout id. (EQUALS)

status[IN]anyquery

Filter for goodsout status. (IN)

status[NOT_IN]anyquery

Filter for goodsout status. (NOT_IN)

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)

shipping_address.country.iso_2[IN]stringquery

Filter for country. (IN)

shipping_address.country.iso_2[NOT_IN]stringquery

Filter for country. (NOT_IN)

date_placed[LESS_THAN]anyquery

Filter for placed date. (LESS_THAN)

date_placed[ON_DATE]anyquery

Filter for placed date. (ON_DATE)

date_placed[MORE_THAN]anyquery

Filter for placed date. (MORE_THAN)

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)

warehouse.id[IN]stringquery

Filter for fulfilment warehouse. (IN)

warehouse.id[NOT_IN]stringquery

Filter for fulfilment warehouse. (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

Full BladePRO ID.

courierobject

Courier.

creatorstring

Who created the goodsout.

date_placedany

Placed date.

despatch_dateany

Despatch date.

despatch_on_dateany

Despatch on date.

idnumber

Goodsout ID.

linesany

Summaries of the active goodsout lines that describe products. No extras or packaging are listed.

orderobject

The parent order.

retailer_idnumber

ID of the retailer the goodsout is destined for. Null when the goodsout has no retailer.

shipping_addressobject

The shipping address.

statusenum<string>

Goodsout status.

Available options: draft, awaiting_allocation, hung, returned, awaiting_payment, awaiting_picking, awaiting_despatch, backorder_release, backorder, cancelled, return_open, item_refunded, item_replaced, awaiting_collection, despatched
tagsany

List of applied tags.

typeenum<string>

Goodsout type, as set when the goodsout was created.

Available options: consumer, trade, retail
warehouseobject

Fulfilment warehouse.

Still need help? Share an idea