For AI agents: markdown of this page — /docs-content-en/entities/shipment-items/get.md documentation index — /llms.txt

Get a shipment item

GET /v1/shipment-items/:id

Returns a single shipment item of an online store order by its ID, taken from the shipment item list or search.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionShipment item ID. List: GET /v1/shipment-items
Parameterselect (query) Typestring Requiredno DescriptionComma-separated field selection: ?select=id,orderDeliveryId,quantity. Only the listed fields are returned in data. An unknown field does not cause an error: it is absent from data, and meta.warnings carries an UNKNOWN_SELECT_FIELD warning with the field name in field. Field list: GET /v1/shipment-items/fields

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/shipment-items/1353" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/shipment-items/1353" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/shipment-items/1353', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`Shipment ${data.orderDeliveryId}: basket item ${data.basketId}, quantity ${data.quantity}`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/shipment-items/1353', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe shipment item
Fielddata.id Typenumber DescriptionShipment item ID
Fielddata.orderDeliveryId Typenumber DescriptionShipment ID. Get the shipment: GET /v1/shipments/:id
Fielddata.basketId Typenumber DescriptionBasket item ID. Get the basket item: GET /v1/basket-items/:id
Fielddata.quantity Typenumber DescriptionProduct quantity in the shipment, can be fractional
Fielddata.reservedQuantity Typenumber DescriptionReserved quantity
Fielddata.xmlId Typestring DescriptionExternal item code
Fielddata.dateInsert Typedatetime DescriptionCreation date, ISO 8601
Fieldmeta.warnings Typearray DescriptionWarnings about request parameters: code, message, field. Present only when there are warnings

Response example

JSON 
{
  "success": true,
  "data": {
    "basketId": 1387,
    "dateInsert": "2026-10-07T09:55:27.000Z",
    "id": 1353,
    "orderDeliveryId": 1207,
    "quantity": 0.75,
    "reservedQuantity": 0,
    "xmlId": "vibe-doc-si-1"
  }
}

Error response example

404 — shipment item not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "shipment item is not exists"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo shipment item with this id exists. Error text: shipment item is not exists
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe request completed, but the response contains no item. This is the response for an item of a system shipment and for an item of a shipment that no longer exists. Error text: shipmentItem <id> not found
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the sale scope
HTTP403 CodeMANAGEMENT_KEY_NO_ENTITY_ACCESS DescriptionThe request was made with a management key. Entities require an application key or a personal key with the sale scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe provided API key was not found
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

An item from the list may not be retrievable by id. Items for which this method returns 404 with the text shipmentItem <id> not found are still returned by the GET /v1/shipment-items list. Get the contents of a shipment from the list with filter[orderDeliveryId]: it returns such items too.

See also