API Reference
  1. Fulfilment API
  2. Fulfilment / Shipments

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Fulfilment account ID

string

Store reference ID

string

Order reference ID

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

string

Date with format 'yyyyMMdd' - Date created

string

Date with format 'yyyyMMdd' - Date created

string

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

string

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

string

Date with format 'yyyyMMdd' - Date dispatched

string

Date with format 'yyyyMMdd' - Date dispatched

string

Postage method ID

string

Warehouse location ID

string

List of sku codes separated by , (comma)

string

Extender reference identifier

string
Defaults to false

Sets if the response should include the shipment items property

string
Defaults to 1

Page number

string
Defaults to 100

Maximum number of results per page.

Body Params
number
string
string
status
array
status
string
string
string
string
string
string
string
string
skuCodes
array
skuCodes
boolean
number
number
Responses
200

OK

Updated about 7 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8

Updated about 7 hours ago

Did this page help you?