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

Get a CRM delivery

GET /v1/crm-deliveries/:id

Returns a single delivery of a CRM object by ID, for example a deal delivery from its list of deliveries.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionDelivery ID. List of an object's deliveries: GET /v1/crm-deliveries. The matching shipment in GET /v1/shipments has the same ID

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-deliveries/1223" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-deliveries/1223" \
  -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/crm-deliveries/1223', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.deliveryName, data.priceDelivery)

JavaScript — OAuth application

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

const { data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.id Typenumber DescriptionDelivery ID
Fielddata.accountNumber Typestring DescriptionDelivery number: the order number and the sequence number separated by /
Fielddata.priceDelivery Typenumber DescriptionDelivery cost
Fielddata.currency Typestring DescriptionCurrency code of the delivery cost
Fielddata.deducted Typestring DescriptionShipped flag: Y — shipped, N — not shipped
Fielddata.dateDeducted Typestring | null DescriptionShipping time, or null until shipped
Fielddata.deliveryId Typenumber DescriptionDelivery service ID. List: GET /v1/delivery-services
Fielddata.deliveryName Typestring DescriptionDelivery service name

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1223,
    "accountNumber": "1041/2",
    "priceDelivery": 500,
    "currency": "USD",
    "deducted": "N",
    "dateDeducted": null,
    "deliveryId": 1,
    "deliveryName": "Courier delivery"
  }
}

Error response example

404 — no delivery with this ID:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Delivery has not been found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_ID Descriptionid is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo delivery with this id
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 connection

Full list of common API errors — Errors.

See also