Para agentes de IA: markdown desta página — /docs-content-en/entities/delivery-services.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Delivery services

Select a delivery service for a shipment. Create your own records using a registered REST handler.

Bitrix24 API: sale.delivery.* Scope: delivery

Built-in services are readable. Bitrix24 permits updates and deletion only for REST-handler records; OAuth applications are also checked against handler ownership. The sale scope alone is insufficient.

List delivery services

GET /v1/delivery-services

Find delivery services in the online store by specified conditions and choose records for further operations.

Parameters

Parameter Type Required Description
Parameterfilter (query) Typeobject | string Requiredno DescriptionFilter by delivery service fields. Accepts a JSON object or bracket notation. Filtering syntax. Example: ?filter[id]=85. Operators: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $like, $nlike
Parametersort (query) Typestring Requiredno DescriptionComma-separated field names. A leading minus sorts in descending order. Example: sort=-id
Parameterselect (query) Typestring Requiredno DescriptionComma-separated fields to return, or * for all fields. Example: select=id,name,active,currency

The result contains all matching records, with no pagination. Only the parameters in the table are supported.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id" \
  -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?filter[id]=85&select=id,name,active,currency&sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/delivery-services?filter[id]=85&select=id,name,active,currency&sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionDelivery service records
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
Fieldmeta.total Typeinteger DescriptionNumber of records in data

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 85,
      "name": "Courier delivery to an address",
      "active": "N",
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 1
  }
}

Error response example

400 — unsupported query parameter:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Only filter, sort and select are supported; the full list has no pagination"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionUnsupported query parameter, repeated sort or select, invalid parameter type, or duplicate sort field
HTTP400 CodeINVALID_FILTER DescriptionThe request combines JSON and bracket filter notation, or repeats a filter condition
HTTP400 CodeINVALID_FILTER_SHAPE DescriptionThe filter has an invalid structure, empty conditions, nested values, or mixed array and operator forms
HTTP400 CodeINVALID_FILTER_OPERATOR DescriptionUnsupported filter operator
HTTP400 CodeINVALID_DUPLICATE_FILTER_FIELD DescriptionMultiple conditions produce the same filter field and operator
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown filter field
HTTP400 CodeUNKNOWN_SELECT_FIELD DescriptionUnknown field in select
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionUnknown field in sort
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