Update Shipment

PATCH /inventory/shipments/{id}

Group: Inventory › Shipments · Operation ID: updateShipment

Updates the draft shipment with the given identifier. Only the fields in the request body change.

Only a draft can be changed. Lines change through three arrays, deleteLines then updateLines then createLines, applied in that order, so one call can retire a line and add its replacement. A line's batches, serials or binLocations, when sent, replace what the line had. The whole call is one transaction.

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 shipment to update.

Request body

Required, application/json: updateShipmentInput.

Field	Type	Required	Description
`businessPartnerId`	string	no	The unique identifier for the customer the goods go to. Despite the name, this is a customer id. See id on GET accounting/customers/:id.
`documentDate`	string (date)	no	The date the shipment is dated. Use format YYYY-MM-DD.
`deliveryDate`	string (date)	no	The planned delivery date. Use format YYYY-MM-DD.
`currency`	string	no	The currency for every amount on the shipment. Format ISO 4217, for example 'EUR'.
`shipmentCarrierId`	string	no	The unique identifier for the carrier taking the goods. See id on GET inventory/shipment-carriers/:id.
`trackingNumber`	string	no	The carrier's tracking number.
`referenceNumber`	string	no	The customer's own reference for the shipment.
`notes`	string	no	Free text on the shipment. Pass an empty string to clear it.
`deleteLines`	array of string	no	The unique identifiers of lines to remove. Applied before updateLines and createLines.
`updateLines`	array of object	no	The lines to change, each addressed by id. Applied after deleteLines and before createLines.
`updateLines[].id`	string	yes	The unique identifier for the line to change. A line belonging to another shipment is rejected.
`updateLines[].itemId`	string	no	The unique identifier for the item going out. See id on GET inventory/items/:id.
`updateLines[].locationId`	string	no	The unique identifier for the warehouse the goods leave from. It must agree with every other line. See id on GET inventory/warehouses/:id.
`updateLines[].unitId`	string	no	The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
`updateLines[].quantity`	string (decimal)	no	The quantity to ship, in the line's unit. Greater than zero.
`updateLines[].unitPrice`	string (decimal)	no	The value of one unit, in the shipment's currency.
`updateLines[].notes`	string	no	Free text on the line. Pass an empty string to clear it.
`updateLines[].batches`	array of object	no	The batches going out on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity. This replaces the line's batches.
`updateLines[].batches[].batchNumberId`	string	no	The unique identifier for the batch going out.
`updateLines[].batches[].batchNumber`	string	no	The batch number as printed. Required unless batchNumberId is given.
`updateLines[].batches[].quantity`	string (decimal)	yes	The quantity of this batch to ship, in the line's unit. The batch quantities of a line must add up to the line's quantity.
`updateLines[].serials`	array of object	no	The serialized units going out, one entry per unit. Required for a serialized item, and the count must equal the line's quantity. This replaces the line's serials.
`updateLines[].serials[].serialNumberId`	string	no	The unique identifier for the unit going out.
`updateLines[].serials[].serialNumber`	string	no	The serial number stamped on the unit. Required unless serialNumberId is given.
`updateLines[].binLocations`	array of object	no	The bins the goods come out of, in a bin-tracked warehouse. An entry may name a batchNumber or serialNumber of its own line. This replaces the line's bin entries.
`updateLines[].binLocations[].binLocationId`	string	yes	The unique identifier for the bin to take the goods from. See id on GET inventory/bins/:id.
`updateLines[].binLocations[].quantity`	string (decimal)	yes	The quantity taken from this bin, in the line's unit.
`updateLines[].binLocations[].batchNumber`	string	no	Names one of this line's batches, when the bin entry belongs to it.
`updateLines[].binLocations[].serialNumber`	string	no	Names one of this line's serialized units, when the bin entry belongs to it.
`createLines`	array of object	no	The lines to add.
`createLines[].itemId`	string	yes	The unique identifier for the item going out. See id on GET inventory/items/:id.
`createLines[].locationId`	string	yes	The unique identifier for the warehouse the goods leave from. Every line must use the same warehouse. See id on GET inventory/warehouses/:id.
`createLines[].unitId`	string	yes	The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
`createLines[].quantity`	string (decimal)	yes	The quantity to ship, in that unit. Greater than zero.
`createLines[].unitPrice`	string (decimal)	no	The value of one unit, in the shipment's currency. Omit it to take the price from the sales order line.
`createLines[].sourceDocumentLineId`	string	no	The sales order line this line ships against. Each order publishes its lines as items[].id on GET accounting/sales-orders/:id. Naming it links the shipment to the order it fulfills.
`createLines[].notes`	string	no	Free text on the line.
`createLines[].batches`	array of object	no	The batches going out on this line. Required for a batch-tracked item, and the quantities must add up to the line's quantity.
`createLines[].batches[].batchNumberId`	string	no	The unique identifier for the batch going out.
`createLines[].batches[].batchNumber`	string	no	The batch number as printed. Required unless batchNumberId is given.
`createLines[].batches[].quantity`	string (decimal)	yes	The quantity of this batch to ship, in the line's unit. The batch quantities of a line must add up to the line's quantity.
`createLines[].serials`	array of object	no	The serialized units going out, one entry per unit. Required for a serialized item, and the count must equal the line's quantity.
`createLines[].serials[].serialNumberId`	string	no	The unique identifier for the unit going out.
`createLines[].serials[].serialNumber`	string	no	The serial number stamped on the unit. Required unless serialNumberId is given.
`createLines[].binLocations`	array of object	no	The bins the goods come out of, in a bin-tracked warehouse. An entry may name a batchNumber or serialNumber of its own line.
`createLines[].binLocations[].binLocationId`	string	yes	The unique identifier for the bin to take the goods from. See id on GET inventory/bins/:id.
`createLines[].binLocations[].quantity`	string (decimal)	yes	The quantity taken from this bin, in the line's unit.
`createLines[].binLocations[].batchNumber`	string	no	Names one of this line's batches, when the bin entry belongs to it.
`createLines[].binLocations[].serialNumber`	string	no	Names one of this line's serialized units, when the bin entry belongs to it.

Example:

{
  "businessPartnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentDate": "2026-01-15",
  "deliveryDate": "2026-01-15",
  "currency": "<currency>",
  "shipmentCarrierId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trackingNumber": "3SABCD7654321",
  "referenceNumber": "<referenceNumber>",
  "notes": "<notes>",
  "deleteLines": [
    "<deleteLines>"
  ],
  "updateLines": [
    {
      "id": "8c14a6f2-3b70-4d59-9e02-6f5a1d38b47c",
      "quantity": "36.00"
    }
  ],
  "createLines": [
    {
      "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": "19.99",
      "unitPrice": "19.99",
      "sourceDocumentLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notes": "<notes>",
      "batches": [
        {
          "batchNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "batchNumber": "<batchNumber>",
          "quantity": "19.99"
        }
      ],
      "serials": [
        {
          "serialNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "serialNumber": "<serialNumber>"
        }
      ],
      "binLocations": [
        {
          "binLocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "quantity": "19.99",
          "batchNumber": "<batchNumber>",
          "serialNumber": "<serialNumber>"
        }
      ]
    }
  ]
}

Response

200 Success

Under data (updateShipmentOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the shipment.
`documentNumber`	string	no	The shipment's document number, for example 'SD-8841'. Absent while none has been assigned.
`documentStatus`	string	yes	The status of the shipment. Possible values: 'DRAFT', 'PACKED', 'PARTIALLY_SHIPPED', 'SHIPPED', 'COMMITTED', 'DELIVERED', 'COMPLETED', 'CANCELLED', 'INVOICED', 'PARTIALLY_INVOICED', 'RETURNED', 'PARTIALLY_RETURNED'.
`documentDate`	string (date)	yes	The date the shipment is dated. Format YYYY-MM-DD.
`deliveryDate`	string (date)	no	The planned or actual delivery date. Format YYYY-MM-DD.
`entityId`	string	yes	The unique identifier for the legal entity the shipment belongs to. See id on GET base/entities.
`entityName`	string	no	The display name of that legal entity.
`businessPartnerId`	string	yes	The unique identifier for the customer the goods go to. Despite the name, this is a customer id. See id on GET accounting/customers/:id.
`businessPartnerName`	string	no	The display name of that customer.
`shipmentCarrierId`	string	no	The unique identifier for the carrier taking the goods. See id on GET inventory/shipment-carriers/:id.
`shipmentCarrierName`	string	no	The name of that carrier.
`trackingNumber`	string	no	The carrier's tracking number for the goods.
`referenceNumber`	string	no	The customer's own reference for the shipment.
`returnStatus`	string	no	How much of the shipment has come back on sales returns. Possible values: 'OPEN', 'PARTIALLY_RETURNED', 'FULLY_RETURNED'. The return process maintains it.
`currency`	string	no	The currency of every amount on the shipment. Format ISO 4217, for example 'EUR'.
`totalAmount`	string (decimal)	no	The total value of the shipment, in the shipment's currency.
`notes`	string	no	Free text on the shipment.
`createdDate`	string (date-time)	no	The date and time the shipment was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time)	no	The date and time the shipment record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lines`	array of object	yes	The lines of the shipment. A shipment always has at least one.
`lines[].id`	string	yes	The unique identifier for the shipment line.
`lines[].itemId`	string	yes	The unique identifier for the item going out. See id on GET inventory/items/:id.
`lines[].itemCode`	string	no	The short code of that item.
`lines[].itemName`	string	no	The display name of that item.
`lines[].locationId`	string	no	The unique identifier for the warehouse the goods leave from. Every line of a shipment must use the same warehouse. See id on GET inventory/warehouses/:id.
`lines[].locationCode`	string	no	The short code of that warehouse.
`lines[].locationName`	string	no	The display name of that warehouse.
`lines[].unitId`	string	yes	The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
`lines[].unitCode`	string	no	The short code of that unit.
`lines[].quantity`	string (decimal)	yes	The quantity going out, in the line's unit.
`lines[].inventoryQuantity`	string (decimal)	no	The same quantity in the item's stocking unit.
`lines[].pickedQuantity`	string (decimal)	no	How much of the line has been picked. This API does not set it.
`lines[].packedQuantity`	string (decimal)	no	How much of the line has been packed. This API does not set it.
`lines[].returnedQuantity`	string (decimal)	no	How much of the line has come back on a sales return.
`lines[].openReturnQuantity`	string (decimal)	no	How much of the line may still be returned.
`lines[].unitPrice`	string (decimal)	no	The value of one unit, in the shipment's currency.
`lines[].status`	string	no	Where the line sits in the warehouse process. This is free text with no fixed set of values.
`lines[].sourceDocumentLineId`	string	no	The sales order line this line ships against. Each order publishes its lines as items[].id on GET accounting/sales-orders/:id.
`lines[].sourceDocumentLineType`	string, one of `"IMInventorySalesOrderLine"`, `"IMInventorySalesDeliveryLine"`, `"IMSalesOrderLine"`, `"IMInventoryPurchaseReturnLine"`, `"IMInventorySalesReturnLine"`, `"IMWarehouseTransferLine"`, `"IMInventoryDecreaseLine"`, `"IMInventoryIncreaseLine"`, `"IMInventoryRevaluationLine"`, `"IMInventoryTransferLine"`, `"IMInventoryAdjustmentLine"`, `"IMInventoryCountLine"`, `"IMInventoryPutAwayTask"`, `"IMInventoryPurchaseReturnReversal"`, `"PurchaseOrderLine"`, `"IMLandedCostAllocationLine"`, `"SalesOrderProductItem"`, `"IMWarehouseTransferOrderLine"`, `"VendorBillItemBase"`, `"InvPurchaseDeliveryLine"`	no	The kind of document line the source line is.
`lines[].notes`	string	no	Free text on the line.
`lines[].batches`	array of object	no	The batches going out on this line, for a batch-tracked item. Absent when the item is not batch-tracked.
`lines[].batches[].batchNumberId`	string	no	The unique identifier for the batch record.
`lines[].batches[].batchNumber`	string	yes	The batch number as printed.
`lines[].batches[].expirationDate`	string (date)	no	The expiration date of the batch. Format YYYY-MM-DD.
`lines[].batches[].quantity`	string (decimal)	yes	The quantity of this batch going out, in the line's unit.
`lines[].batches[].inventoryQuantity`	string (decimal)	no	The same quantity in the item's stocking unit.
`lines[].batches[].returnedQuantity`	string (decimal)	no	How much of this batch has come back on a sales return.
`lines[].batches[].unitCost`	string (decimal)	no	The cost of one unit of this batch at shipment, in the shipment's currency.
`lines[].serials`	array of object	no	The serialized units going out, one entry per unit. Absent when the item is not serialized.
`lines[].serials[].serialNumberId`	string	no	The unique identifier for the serial record.
`lines[].serials[].serialNumber`	string	yes	The serial number stamped on the unit.
`lines[].serials[].returnedQuantity`	string (decimal)	no	How much of this unit has come back on a sales return.
`lines[].serials[].unitCost`	string (decimal)	no	The cost of this unit at shipment, in the shipment's currency.
`lines[].binLocations`	array of object	no	The bins the goods come out of, in a bin-tracked warehouse. Each entry that names a batchNumber or serialNumber belongs to that batch or unit, and one that names neither belongs to the line.
`lines[].binLocations[].binLocationId`	string	yes	The unique identifier for the bin the goods come out of. See id on GET inventory/bins/:id.
`lines[].binLocations[].binLocationCode`	string	no	The short code of that bin.
`lines[].binLocations[].quantity`	string (decimal)	yes	The quantity taken from this bin, in the line's unit.
`lines[].binLocations[].inventoryQuantity`	string (decimal)	no	The same quantity in the item's stocking unit.
`lines[].binLocations[].batchNumber`	string	no	The batch this bin entry belongs to, when it belongs to one of the line's batches.
`lines[].binLocations[].serialNumber`	string	no	The serialized unit this bin entry belongs to, when it belongs to one of the line's units.

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`WRONG_STATUS`	400
`REFERENCE_NOT_FOUND`	400
`NO_LINES`	400
`SOURCE_LINE_NOT_PROJECTED`	400
`INVALID_QUANTITY`	400
`MIXED_LOCATIONS`	400
`DUPLICATE_TRACKING_NUMBER`	400
`UNKNOWN_TRACKING_REFERENCE`	400
`POSTING_REJECTED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, WRONG_STATUS, REFERENCE_NOT_FOUND, NO_LINES, SOURCE_LINE_NOT_PROJECTED, INVALID_QUANTITY, MIXED_LOCATIONS, DUPLICATE_TRACKING_NUMBER, UNKNOWN_TRACKING_REFERENCE, POSTING_REJECTED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error