Для AI-агентов: markdown этой страницы — /docs-content/entities/delivery-services.md индекс документации — /llms.txt

Службы доставки

Выбирайте службу доставки для отгрузки. Создавайте свои записи на уже зарегистрированном REST-обработчике.

Битрикс24 API: sale.delivery.* Скоуп: delivery

Встроенные службы доступны для чтения. Битрикс24 разрешает изменять и удалять только записи на REST-обработчиках. Для OAuth-приложения дополнительно проверяется владение обработчиком. Одного скоупа sale недостаточно.

Список служб доставки

GET /v1/delivery-services

Позволяет найти службы доставки в интернет-магазине по заданным условиям и выбрать записи для дальнейшей работы.

Параметры

Параметр Тип Обяз. Описание
filter (query) object | string нет Фильтрация по полям службы доставки. JSON-объект или запись с квадратными скобками. Синтаксис фильтрации. Пример: ?filter[id]=85. Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $like, $nlike
sort (query) string нет Имена полей через запятую. Минус перед именем задаёт сортировку по убыванию. Пример: sort=-id
select (query) string нет Поля ответа через запятую или * для всех полей. Пример: select=id,name,active,currency

Выборка содержит все записи, соответствующие фильтру, без постраничного перехода. Поддерживаются только параметры из таблицы.

Примеры

curl — личный ключ

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

curl — OAuth-приложение

Terminal 
curl -g "https://vibecode.bitrix24.tech/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 — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/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-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/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)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив служб доставки
data[].id integer Идентификатор службы доставки
data[].parentId integer | null Идентификатор родительской службы из списка служб доставки. Может быть null
data[].name string | null Название службы доставки
data[].active string | null Признак активности: Y или N
data[].description string | null Описание службы доставки
data[].currency string | null Код валюты из списка валют
data[].sort integer | null Порядок сортировки
data[].logotype integer | null Идентификатор файла логотипа, не URL. Может быть null
meta.total integer Количество записей в data

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 85,
      "name": "Курьерская доставка по адресу",
      "active": "N",
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 1
  }
}

Пример ответа при ошибке

400 — неподдерживаемый параметр запроса:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Неподдерживаемый параметр запроса, повтор sort или select, некорректный тип параметра или повтор поля сортировки
400 INVALID_FILTER Совмещены JSON и запись фильтра с квадратными скобками или повторено условие фильтра
400 INVALID_FILTER_SHAPE Некорректная структура фильтра, пустое условие, вложенные значения или смешение массива и операторов
400 INVALID_FILTER_OPERATOR Неподдерживаемый оператор фильтра
400 INVALID_DUPLICATE_FILTER_FIELD Несколько условий задают одно поле с одним оператором
400 UNKNOWN_FILTER_FIELD Неизвестное поле фильтра
400 UNKNOWN_SELECT_FIELD Неизвестное поле в select
400 UNKNOWN_SORT_FIELD Неизвестное поле в sort
502 BITRIX_RESPONSE_INVALID Ответ не соответствует формату службы доставки
422 BITRIX_ERROR Битрикс24 отклонил операцию. Исходный текст ошибки сохраняется
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
403 SCOPE_DENIED У API-ключа нет скоупа delivery
401 TOKEN_MISSING Для ключа не настроены данные авторизации Битрикс24

Полный список общих ошибок API — Ошибки.

Смотрите также