Update shipment

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

Update a shipment's details.

Path Parameters:

id: UUID of the shipment to update

Request Body: (all fields optional)

status: Updated shipment status
line_items: Replace line items array
fees: Replace fees array
description: Updated notes
tracking_number: Updated tracking number
expected_arrival_date: Updated arrival date in ISO 8601 format
shipped_date: Updated ship date in ISO 8601 format
version: Version for optimistic locking to prevent concurrent updates (optional)

Returns: The updated shipment.

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

idstringrequired

Request body

Schema: ShipmentUpdateRequest

feesarray · Fee: Updated fees.
statusstring: Updated status.
line_itemsarray · LineItem: Updated items.
descriptionstring: Updated notes.
tracking_numberstring: Updated tracking.
expected_arrival_datestring · date-time: Updated arrival date.
shipped_datestring · date-time: Updated ship date.
location_idstring: Updated destination location.
versioninteger: Version for optimistic locking.

Responses

200Successful Response

Schema: SuccessEnvelope_ShipmentResponse_

successboolean
messagestring
codestring
dataShipmentResponse

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

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

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/inventory/shipments/{id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Received in warehouse",
  "status": "delivered"
}'