List: Shipment items

GET /v1/shipment-items

Scope: sale.

Example

curl -X GET 'https://vibecode.bitrix24.com/v1/shipment-items' -H 'X-Api-Key: YOUR_KEY'

Behavior

Lists include system shipment positions and old orphan rows. Use filter[orderDeliveryId] to select one shipment; a listed old row does not guarantee a readable get by ID.

Create requires orderDeliveryId, basketId, quantity. Shipment and basket IDs belong to the same order; Bitrix24 decides access and whether system shipment operations are allowed. PATCH cannot reassign basketId or orderDeliveryId. Fractional quantities are forwarded without rounding; excessive unallocated quantities return a business refusal. PATCH changes only supplied fields. reservedQuantity is readonly.

Response

{
  "success": true,
  "data": [
    {
      "id": 12,
      "basketId": 21,
      "orderDeliveryId": 42,
      "quantity": 0.5
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Errors

Shipment items