Update a shipment line

Logistics module

PATCH/shipment-lines/{id}shipmentLines.update

A line on a shipping manifest. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability logistics.shipment.write.
OAuth scopes: logistics.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

shipmentLines.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the shipment line.

Request body: ShipmentLineUpdate

shipmentLines.update: ShipmentLineUpdate
Field	Type	Required	Description
description	string	No	Line description.Constraints: length 1 to 300
quantity	number	No	Quantity.
element_id	string \| null	No	Canon element carried.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "description": "Truss sections, 10 ft",
  "quantity": 24,
  "element_id": "4000.01.01-XPMS-001"
}

Response 200: ShipmentLine

shipmentLines.update: ShipmentLine
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the shipment line.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
shipment_id	string (uuid)	Yes	Identifier of the shipment.
description	string	Yes	Line description.Constraints: length 1 to 300
quantity	number	Yes	Quantity.
element_id	string \| null	Yes	Canon element carried.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Truss sections, 10 ft",
  "quantity": 24,
  "element_id": "4000.01.01-XPMS-001"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/shipment-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"description":"Truss sections, 10 ft","quantity":24,"element_id":"4000.01.01-XPMS-001"}'

const { data, etag } = await xos.shipmentLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "description": "Truss sections, 10 ft",
    "quantity": 24,
    "element_id": "4000.01.01-XPMS-001"
  }, { ifMatch: etag });

response = xos.shipment_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"description": "Truss sections, 10 ft", "quantity": 24, "element_id": "4000.01.01-XPMS-001"}, if_match=etag)

xos shipment-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"Truss sections, 10 ft","quantity":24,"element_id":"4000.01.01-XPMS-001"}' --if-match auto