Search

get

https://api.ochre.io/v1/fulfilment/shipments

Lists all available shipments.
The search criteria can be set with GET parameters or sent in the request payload as a JSON object. This last method is advised when requesting a long list of sku codes, for instance.

Query Params

fulfilment_account_id

string

Fulfilment account ID

store_id

string

Store reference ID

order_id

string

Order reference ID

status

string

List of statuses separated by , (comma)

incubating
syncing
new
pending_hold_request
hold_request
hold
pending_unhold_request
unhold_request
dispatched
pending_cancel_request
cancel_request
cancelled
fail_on_cancel
fail
unknown

from

string

Date with format 'yyyyMMdd' - Date created

string

Date with format 'yyyyMMdd' - Date created

updated_from

string

Date with format 'yyyyMMdd' or “yyyyMMdd’T’HH:mm:ss’Z'” - Updated date

updated_to

string

Date with format 'yyyyMMdd' or “yyyyMMdd’T’HH:mm:ss’Z'” - Updated date

dispatch_from

string

Date with format 'yyyyMMdd' - Date dispatched

dispatch_to

string

Date with format 'yyyyMMdd' - Date dispatched

postage_method_id

string

Postage method ID

warehouse_location_id

string

Warehouse location ID

sku_codes

string

List of sku codes separated by , (comma)

external_reference_id

string

Extender reference identifier

include_items

string

Defaults to false

Sets if the response should include the shipment items property

page

string

Defaults to 1

Page number

limit

string

Defaults to 100

Maximum number of results per page.

Body Params

fulfilmentAccountId

number

storeId

string

orderId

string

status

array

status

from

string

updated_from

string

updated_to

string

dispatchFrom

string

dispatchTo

string

postageMethodId

string

warehouseLocationId

string

skuCodes

array

skuCodes

includeItems

boolean

page

number

limit

number

Responses

200

400Bad Request

401Unauthorized

500Internal Server Error