Update a sales order shipment

Operation ID: updateSalesOrderShipment

Group: Accounting › Sales Order Shipments

Open in the interactive reference

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

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a sales order shipment with the fields you send. A field you leave out keeps its current value.

Use the sales order shipment's id, not its shipmentNumber. The lines change through createItems, updateItems, and deleteItems, and leaving out all three leaves the lines as they are.

updateItems and deleteItems name lines by the line's own id, and each line must belong to this shipment. If any part of the update can't be made, the shipment is left as it was. After the update, the shipped quantities on the related sales order products are recalculated.

Inventory can also write carrier, trackingId, shipDate, and the shipped quantities when the shipment is committed there, so a value set here can be replaced. Setting status to 'cancelled' cancels only this sales order shipment, not the shipment in inventory.

The response is empty. Read the result with GET accounting/sales-order-shipments/:id.

Parameters

Name In Type Required Description
Api-Version header string · 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 of the sales order shipment you want to update. Example: "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45".

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. Example: "DHL".
incoterm string no The incoterm. For example 'DAP' or 'EXW'. Omit to leave unchanged.
status any no The lifecycle status. Omit to leave unchanged. Setting 'cancelled' soft-cancels the accounting mirror only and leaves the inventory shipment untouched. One of: "pendingShipment", "shipped", "cancelled". Example: "shipped".
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 date no The date the customer requested delivery. Use format YYYY-MM-DD. Omit to leave unchanged.
shipDate date no The date the shipment was dispatched. Use format YYYY-MM-DD. Omit to leave unchanged.
deliveryDate date no The date the shipment is delivered. Use format YYYY-MM-DD. Omit to leave unchanged.
createItems array<object> no Lines to add to the shipment. Each has no id because the line doesn't exist yet, and its orderedQty is copied from the sales order product item. Omit for no additions.
createItems[].salesOrderProductItemId string yes The sales order product item the new shipment line is for. If no product item has this id, the request fails with SALES_ORDER_PRODUCT_ITEMS_NOT_FOUND. See items[].id on GET accounting/sales-orders/:id.
createItems[].shippedQty decimal yes The quantity shipped on the new line, as a count of units.
updateItems array<object> no Lines to change, matched by the line's own id. Omit for no changes. Example: [{"id":"5a0f3e6d-81b7-4c8e-9b21-9c2a6a107d34","shippedQty":"5"}].
updateItems[].id string yes The unique identifier for the shipment line to change. It must belong to this shipment, or the request fails with SHIPMENT_ITEMS_NOT_FOUND.
updateItems[].shippedQty decimal no The new shipped quantity for the line, as a count of units. Omit to leave unchanged.
deleteItems array<string> no The identifiers of the shipment lines to remove. Each must belong to this shipment, or the request fails with SHIPMENT_ITEMS_NOT_FOUND. Omit for no removals. 
{
  "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

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

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