Skip to main content
Orders

View Goodsout

Retrieves a single goodsout.

GET
/v1/orders/goodsouts/{id}

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

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

Query Parameters

expandstringquery

Usage: expand=*

Expand attributes, lines, lines.items, lines.items.batch, lines.items.component, lines.items.despatched_stocks, lines.items.despatched_stocks.batch, lines.principal_tax, lines.variation, lines.variation.descriptions, lines.variation.descriptions.locale, lines.variation.type, order, order.channel, order.channel.organisation, shipments, shipments.shipping_service, shipments.shipping_service.courier_account, shipments.shipping_service.courier_account.courier, shipping_address, shipping_address.country, shipping_address.country.region, tags, warehouse

Response

200application/json

successful operation

attributesany

List of attributes.

cancellation_dateany

The date a goodsout was cancelled.

date_placedany

Placed date.

delivery_instructionsstring

Delivery instructions.

despatch_dateany

Despatch date.

despatch_on_dateany

Despatch on date.

gift_messagestring

Gift message.

idnumber

ID.

linesany

List of lines.

orderobject

Order.

retailer_idnumber

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

shipmentsany

List of shipments.

shipping_addressobject

Shipping Address.

sourcestring

Source.

statusenum<string>

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

Applied tags.

typeenum<string>

Goodsout type, as set when the goodsout was created.

Available options: consumer, trade, retail
warehouseobject

Warehouse.

Still need help? Share an idea