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

Get a delivery service

GET /v1/delivery-services/:id

Look up a delivery service by its ID to check its settings before updating the service or using it in an integration.

Parameters

Parameter Type Required Description
Parameterid (path) Typeinteger Requiredyes DescriptionPositive integer no greater than 9007199254740991. Obtain it from the delivery service list

Query parameters are not supported.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/delivery-services/85" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

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

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

JavaScript — OAuth app

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionDelivery service record
Fielddata.id Typeinteger DescriptionDelivery service ID
Fielddata.parentId Typeinteger | null DescriptionParent service ID from the delivery service list. May be null
Fielddata.name Typestring | null DescriptionDelivery service name
Fielddata.active Typestring | null DescriptionActivity flag: Y or N
Fielddata.description Typestring | null DescriptionDelivery service description
Fielddata.currency Typestring | null DescriptionCurrency code from the currency list
Fielddata.sort Typeinteger | null DescriptionSort order
Fielddata.logotype Typeinteger | null DescriptionLogo file ID, not a URL. May be null

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 85,
    "parentId": null,
    "name": "Courier delivery",
    "active": "N",
    "description": "",
    "currency": "USD",
    "sort": 100,
    "logotype": null
  }
}

Error response example

404 — delivery service not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionThe path ID is not a positive safe integer, or the request contains query parameters
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo delivery service with this ID was found
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe response does not match the delivery service format
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the operation. The original error message is preserved
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the delivery scope
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 credentials are configured for the key

For common API errors, see Errors.

See also