Create shipment

POST/api/v1/inventory/shipments

Record a received shipment and update inventory.

Operation ID: create_shipment_api_v1_inventory_shipments_post·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.

Request body

Schema: ShipmentCreateRequest

feesarray · Fee: Shipment-specific fees.
statusstring: Shipment status.
line_itemsarray · LineItem: Items included in this shipment.
descriptionstring: Shipment notes.
tracking_numberstring: Carrier tracking number.
expected_arrival_datestring · date-time: Expected delivery date.
shipped_datestring · date-time: Date shipped.
location_idstring: Destination location ID (where the shipment is being shipped to).

Responses

201Successful Response

Schema: SuccessEnvelope_ShipmentResponse_

successboolean
messagestring
codestring
dataShipmentResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/inventory/shipments

bash

curl -X POST 'https://api.ondayzero.com/api/v1/inventory/shipments' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "fees": [],
  "status": "string",
  "line_items": [],
  "description": "string",
  "tracking_number": "string",
  "expected_arrival_date": "2026-01-01T00:00:00Z"
}'