List shipments

GET /api/v1/inventory/shipments

Retrieve all shipments for inventory orders.

Operation ID: get_shipments_api_v1_inventory_shipments_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

cursor string: Cursor for pagination
limit integer: Pagination limit
direction string default: next: Pagination direction: 'next' or 'prev'
include_total_count boolean default: False: Whether to include total count (expensive - avoid if possible)
sort_by string: Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descending boolean default: True: Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: ShipmentListResponse

items array · ShipmentResponse requiredShipmentResponse

List of items

14 fields

id string required: Shipment UUID.
business_id string required: Business UUID.
status string required: Shipment status.
fees array · Fee required: Shipment fees.
line_items array · object required: Items in shipment.
description string: Notes.
tracking_number string: Tracking number.
expected_arrival_date string · date-time: Expected delivery.
shipped_date string · date-time: Ship date.
location_id string: Destination location ID.
location_name string: Destination location name.
created_at string · date-time required: Created timestamp.
updated_at string · date-time required: Updated timestamp.
version integer: Version for optimistic locking.

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/inventory/shipments

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/shipments' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/shipments', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/inventory/shipments", headers=headers)
data = response.json()