Creates several shipments in one call, each as a draft.

POST /inventory/shipments/bulk

Group: Inventory › Shipments · Operation ID: bulkCreateShipments

All or nothing: if any shipment is rejected, nothing is written, not even the entries before it. index on the error says which, counting from zero. Each entry is exactly what POST inventory/shipments takes, and the results come back in input order.

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.

Request body

Required, application/json: bulkCreateShipmentsInput.

Field Type Required Description
shipments array of object yes The shipments to create. At least one, and each is exactly what POST inventory/shipments takes.
shipments[].businessPartnerId string yes The unique identifier for the customer the goods go to. Required. Despite the name, this is a customer id. See id on GET accounting/customers/:id.
shipments[].entityId string no The unique identifier for the legal entity. Omit it and the first line's warehouse decides it. See id on GET base/entities.
shipments[].documentDate string (date) no The date the shipment is dated. Defaults to today. Use format YYYY-MM-DD.
shipments[].deliveryDate string (date) no The planned delivery date. Use format YYYY-MM-DD.
shipments[].currency string no The currency for every amount on the shipment. Format ISO 4217, for example 'EUR'. Omit it to use the currency of the legal entity's default accounting book, and creation fails when the entity has no default book.
shipments[].shipmentCarrierId string no The unique identifier for the carrier taking the goods. See id on GET inventory/shipment-carriers/:id.
shipments[].trackingNumber string no The carrier's tracking number.
shipments[].referenceNumber string no The customer's own reference for the shipment.
shipments[].notes string no Free text on the shipment.
shipments[].lines array of object yes The lines of the shipment. At least one is required.
shipments[].lines[].itemId string yes The unique identifier for the item going out. See id on GET inventory/items/:id.
shipments[].lines[].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.
shipments[].lines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
shipments[].lines[].quantity string (decimal) yes The quantity to ship, in that unit. Greater than zero.
shipments[].lines[].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.
shipments[].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. Naming it links the shipment to the order it fulfills.
shipments[].lines[].notes string no Free text on the line.
shipments[].lines[].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.
shipments[].lines[].batches[].batchNumberId string no The unique identifier for the batch going out.
shipments[].lines[].batches[].batchNumber string no The batch number as printed. Required unless batchNumberId is given.
shipments[].lines[].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.
shipments[].lines[].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.
shipments[].lines[].serials[].serialNumberId string no The unique identifier for the unit going out.
shipments[].lines[].serials[].serialNumber string no The serial number stamped on the unit. Required unless serialNumberId is given.
shipments[].lines[].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.
shipments[].lines[].binLocations[].binLocationId string yes The unique identifier for the bin to take the goods from. See id on GET inventory/bins/:id.
shipments[].lines[].binLocations[].quantity string (decimal) yes The quantity taken from this bin, in the line's unit.
shipments[].lines[].binLocations[].batchNumber string no Names one of this line's batches, when the bin entry belongs to it.
shipments[].lines[].binLocations[].serialNumber string no Names one of this line's serialized units, when the bin entry belongs to it.

Example:

{
  "shipments": [
    {
      "businessPartnerId": "c73f2b81-5d94-4e60-a812-0f9b6d3e45c7",
      "documentDate": "2026-08-14",
      "deliveryDate": "2026-08-19",
      "shipmentCarrierId": "9d0a5e26-b183-4c47-92f5-6a4e17b0c853",
      "trackingNumber": "3SABCD1234567",
      "referenceNumber": "PO-BAKKER-4417",
      "currency": "EUR",
      "notes": "Palletised",
      "lines": [
        {
          "itemId": "5f21c8b0-9d34-4a76-8e12-04b93c7de5a8",
          "locationId": "e1d84c07-5b39-4a26-9f70-2c8b613ad495",
          "unitId": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
          "quantity": "40.00",
          "unitPrice": "24.00",
          "sourceDocumentLineId": "f9a4cdef-6095-425e-84f1-7f8192801ea2",
          "notes": "Ship complete"
        }
      ]
    }
  ]
}

Response

200 Success

Under data (bulkCreateShipmentsOutput):

Field Type Required Description
items array of object yes The created shipments, in input order. Match them to inputs by position.
items[].id string yes The unique identifier for the shipment.
items[].documentNumber string no The shipment's document number, for example 'SD-8841'. Absent while none has been assigned.
items[].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'.
items[].documentDate string (date) yes The date the shipment is dated. Format YYYY-MM-DD.
items[].deliveryDate string (date) no The planned or actual delivery date. Format YYYY-MM-DD.
items[].entityId string yes The unique identifier for the legal entity the shipment belongs to. See id on GET base/entities.
items[].entityName string no The display name of that legal entity.
items[].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.
items[].businessPartnerName string no The display name of that customer.
items[].shipmentCarrierId string no The unique identifier for the carrier taking the goods. See id on GET inventory/shipment-carriers/:id.
items[].shipmentCarrierName string no The name of that carrier.
items[].trackingNumber string no The carrier's tracking number for the goods.
items[].referenceNumber string no The customer's own reference for the shipment.
items[].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.
items[].currency string no The currency of every amount on the shipment. Format ISO 4217, for example 'EUR'.
items[].totalAmount string (decimal) no The total value of the shipment, in the shipment's currency.
items[].notes string no Free text on the shipment.
items[].createdDate string (date-time) no The date and time the shipment was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lastModifiedDate string (date-time) no The date and time the shipment record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lines array of object yes The lines of the shipment. A shipment always has at least one.
items[].lines[].id string yes The unique identifier for the shipment line.
items[].lines[].itemId string yes The unique identifier for the item going out. See id on GET inventory/items/:id.
items[].lines[].itemCode string no The short code of that item.
items[].lines[].itemName string no The display name of that item.
items[].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.
items[].lines[].locationCode string no The short code of that warehouse.
items[].lines[].locationName string no The display name of that warehouse.
items[].lines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
items[].lines[].unitCode string no The short code of that unit.
items[].lines[].quantity string (decimal) yes The quantity going out, in the line's unit.
items[].lines[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].lines[].pickedQuantity string (decimal) no How much of the line has been picked. This API does not set it.
items[].lines[].packedQuantity string (decimal) no How much of the line has been packed. This API does not set it.
items[].lines[].returnedQuantity string (decimal) no How much of the line has come back on a sales return.
items[].lines[].openReturnQuantity string (decimal) no How much of the line may still be returned.
items[].lines[].unitPrice string (decimal) no The value of one unit, in the shipment's currency.
items[].lines[].status string no Where the line sits in the warehouse process. This is free text with no fixed set of values.
items[].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.
items[].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.
items[].lines[].notes string no Free text on the line.
items[].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.
items[].lines[].batches[].batchNumberId string no The unique identifier for the batch record.
items[].lines[].batches[].batchNumber string yes The batch number as printed.
items[].lines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
items[].lines[].batches[].quantity string (decimal) yes The quantity of this batch going out, in the line's unit.
items[].lines[].batches[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].lines[].batches[].returnedQuantity string (decimal) no How much of this batch has come back on a sales return.
items[].lines[].batches[].unitCost string (decimal) no The cost of one unit of this batch at shipment, in the shipment's currency.
items[].lines[].serials array of object no The serialized units going out, one entry per unit. Absent when the item is not serialized.
items[].lines[].serials[].serialNumberId string no The unique identifier for the serial record.
items[].lines[].serials[].serialNumber string yes The serial number stamped on the unit.
items[].lines[].serials[].returnedQuantity string (decimal) no How much of this unit has come back on a sales return.
items[].lines[].serials[].unitCost string (decimal) no The cost of this unit at shipment, in the shipment's currency.
items[].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.
items[].lines[].binLocations[].binLocationId string yes The unique identifier for the bin the goods come out of. See id on GET inventory/bins/:id.
items[].lines[].binLocations[].binLocationCode string no The short code of that bin.
items[].lines[].binLocations[].quantity string (decimal) yes The quantity taken from this bin, in the line's unit.
items[].lines[].binLocations[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].lines[].binLocations[].batchNumber string no The batch this bin entry belongs to, when it belongs to one of the line's batches.
items[].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

Errors

Code Status
NOTHING_TO_CREATE 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