List shipments

List shipments with their orders and products, optionally filtered by available attributes.

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

Database ID(s) of the shipment.

string | null

A unique number to identify the shipment. Partial match.

enum

Status of shipment. One value or a list, for example ?status=10 or ?status[]=10&status[]=20. Cancelled shipments are returned only when this filter names them.


  • 10 - New
  • 15 - Ready for shipment
  • 20 - Shipped
  • 30 - Cancelled
string | null

A unique number to identify the customer, vendor or RMA-related company. Partial match.

string | null

Name of the customer, vendor or RMA-related company. Partial match.

integer | null

Database ID of the customer order.

string | null

A unique number to identify the customer order. Partial match.

integer | null

Database ID of the RMA order.

string | null

A unique number to identify the RMA order. Partial match.

integer | null

Database ID of the purchase order.

string | null

A unique number to identify the purchase order. Partial match.

string | null

Reference of the related customer order or RMA order. Partial match.

string | null

Notes for the waybill. Partial match.

string | null

Tracking number. Partial match.

integer | null

ID of the site from which products are shipped.

integer | null

Minimum creation date and time as UNIX timestamp.

integer | null

Maximum creation date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum delivery date as UNIX timestamp.

integer | null

Maximum delivery date as UNIX timestamp. The whole of that day is covered.

custom_values
array of objects | null

Conditions on custom fields of the shipment. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json