Start free trial

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_api_v1_inventory_shipments__id__put·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

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject