Get Shipments

get

https://apisandbox.jooraccess.com/v4/shipments

List shipments, with optional filters by external ID, line item, status, carrier, and shipping or delivery date ranges. Includes pagination.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Limited to 1,000 shipment objects per page.

Query Params

account

string

required

Defaults to ######

JOOR Account ID

page

integer

Defaults to 1

Page number (starts at 1)

page_size

integer

Defaults to 1000

Shipments per page (max 1,000).

shipment_status

string

enum

Defaults to (Empty)

Filter by status (comma-separated).

external_id

array of strings

Filter by external IDs (comma-separated)

external_id

line_item_id

array of strings

Filter by order line item IDs (comma-separated)

line_item_id

shipping_date_from

string

ISO 8601 date lower bound for shipping_date.

shipping_date_to

string

ISO 8601 date upper bound for shipping_date.

expected_delivery_date_from

string

ISO 8601 lower bound for expected_delivery_date.

expected_delivery_date_to

string

ISO 8601 upper bound for expected_delivery_date.

carrier

string

Filter by carrier name (exact match).

Headers

Authorization

string

Authorization token

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Limited to 1,000 shipment objects per page.

200

400Bad Request