Get shipment

GET /api/v1/inventory/shipments/{id}

Retrieve a specific shipment with line items.

Operation ID: get_shipment_api_v1_inventory_shipments__id__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

Path

id string required

Responses

200 Successful Response

Schema: ShipmentResponse

id string required

Shipment UUID.

business_id string required

Business UUID.

status string required

Shipment status.

fees array · Fee requiredFee

Shipment fees.

3 fields

name string: Fee name (e.g., 'Shipping', 'Handling').
description string: Fee description (alternative to name).
amount integer required: Fee amount in cents.

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.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

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/{id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/shipments/{id}' \
  -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/{id}', {
  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/{id}", headers=headers)
data = response.json()