Update Sales Order Shipment

PATCH /accounting/sales-order-shipments/{id}

Group: Accounting › Sales Order Shipments · Operation ID: updateSalesOrderShipment

Updates the sales order shipment with the given identifier and its lines. Only the fields in the request body change. carrier, tracking id, ship date and shipped quantities can also be written from inventory when the shipment is committed, so a value set here can be overwritten by that sync.

Every field is optional and omitting it leaves the value unchanged. The response is empty. Read the result with GET accounting/sales-order-shipments/:id.

The lines are a child collection, edited through the three arrays createItems, updateItems and deleteItems rather than by resending the whole array. Omit an array for no operations of that kind, and omit all three to leave the lines untouched. createItems entries carry no id because the row does not exist yet. updateItems and deleteItems match on the line's own id, and a line belonging to another shipment is rejected.

The change is all-or-nothing, so a failure at any point leaves the shipment exactly as it was. Changing any line re-derives the shipped-product rollup on the sales order products those lines belong to.

carrier, trackingId, shipDate and the shipped quantities can also be written from the inventory side when the mirrored shipment is committed, so a value set here can later be replaced by that sync. Setting status to 'cancelled' soft-cancels the accounting mirror only, and the inventory shipment is untouched.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the sales order shipment to update.

Request body

Required, application/json: updateSalesOrderShipmentInput.

Field Type Required Description
trackingId string no The carrier tracking number or tracking URL. Omit to leave unchanged.
shipmentNumber string no The shipment document number. Omit to leave unchanged.
carrier string no The name of the carrier handling the shipment. Omit to leave unchanged.
incoterm string no The incoterm. For example 'DAP' or 'EXW'. Omit to leave unchanged.
status string, one of "pendingShipment", "shipped", "cancelled" no The lifecycle status. Omit to leave unchanged. Setting 'cancelled' soft-cancels the accounting mirror only and leaves the inventory shipment untouched.
warehouseId string no The warehouse location the shipment is dispatched from. Omit to leave unchanged. See id on GET inventory/warehouses/:id.
shipToContactEmail string no The shipping contact email. Omit to leave unchanged.
customerRequestDate string (date) no The date the customer requested delivery. Use format YYYY-MM-DD. Omit to leave unchanged.
shipDate string (date) no The date the shipment was dispatched. Use format YYYY-MM-DD. Omit to leave unchanged.
deliveryDate string (date) no The date the shipment is delivered. Use format YYYY-MM-DD. Omit to leave unchanged.
createItems array of object no Lines to add to the shipment. Each has no id because the row does not exist yet, and its orderedQty is copied from the referenced sales order product item. Omit for no additions.
createItems[].salesOrderProductItemId string yes The sales order product item the new line ships. Fails with SALES_ORDER_PRODUCT_ITEMS_NOT_FOUND when it matches nothing. There is no endpoint for it.
createItems[].shippedQty string (decimal) yes The quantity shipped on the new line, as a count of units.
updateItems array of object no Lines to change, matched by the line's own id. Omit for no changes.
updateItems[].id string yes The unique identifier for the shipment line to change. It must belong to this shipment, or the call fails with SHIPMENT_ITEMS_NOT_FOUND.
updateItems[].shippedQty string (decimal) no The new shipped quantity for the line, as a count of units. Omit to leave unchanged.
deleteItems array of string no The identifiers of the shipment lines to remove. Each must belong to this shipment, or the call fails with SHIPMENT_ITEMS_NOT_FOUND. Omit for no removals.

Example:

{
  "trackingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shipmentNumber": "<shipmentNumber>",
  "carrier": "DHL",
  "incoterm": "<incoterm>",
  "status": "shipped",
  "warehouseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shipToContactEmail": "<shipToContactEmail>",
  "customerRequestDate": "2026-01-15",
  "shipDate": "2026-01-15",
  "deliveryDate": "2026-01-15",
  "createItems": [
    {
      "salesOrderProductItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "shippedQty": "19.99"
    }
  ],
  "updateItems": [
    {
      "id": "5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34",
      "shippedQty": "5"
    }
  ],
  "deleteItems": [
    "<deleteItems>"
  ]
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
WAREHOUSE_NOT_FOUND 400
SHIPMENT_ITEMS_NOT_FOUND 400
SALES_ORDER_PRODUCT_ITEMS_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses