Справочник API

iRECA: Курьер — API

REST-интерфейс системы доставки iRECA: Курьер. Заказы, товары, склады, курьеры, фискальные документы и удалённая фискализация. 93 метода в 21 разделах.

Версияv1
Базовый адресhttps://api-courier-ireca.softbalance.ru/api/v1
ФорматJSON
Поддержкаireca@softbalance.ru

Быстрый старт #

Минимальный сквозной сценарий: от получения токена до созданного заказа, который увидит курьер в приложении.

  1. Получите токен. В web-кабинете диспетчера: «Настройки» → «Магазины» → «+Добавить» свой ресурс. Без web-кабинета — напишите в поддержку, потребуется ИНН компании.
  2. Загрузите справочники. Налоговые ставки, типы платежей и причины отмены заказа создаются в web-кабинете, а читаются через API: налоговые ставки, типы платежей, причины отмены.
  3. Создайте товары.POST /goods — на них будут ссылаться позиции заказа.
  4. Настройте callback.POST /orders/callback — сервис будет сам присылать изменения по заказу, опрашивать API не нужно.
  5. Создайте заказ.POST /orders — заказ появится у курьера в приложении.
  6. Отслеживайте выполнение. Через callback либо запросами GET /orders и GET /orders/journalStatuses.
Совет

Начните с одного тестового заказа на одном товаре. Так вы быстрее поймаете ошибки в справочниках и адресах, чем на массовой загрузке.

Сквозной пример
# 1. Проверяем токен и читаем справочник статусов доставки
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/orderDeliveryStatuses' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

# 2. Создаём товар
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/goods' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[{"goodId":"355864","title":"Пицца Маргарита","price":539.78,"taxId":1}]'

# 3. Создаём заказ
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orders' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d @order.json

Авторизация #

Авторизация выполняется по токену. Токен передаётся в заголовке каждого запроса:

HTTP-заголовок
Authorization: Bearer ACCESS_TOKEN

Базовый адрес всех методов:

Base URL
https://api-courier-ireca.softbalance.ru/api/v1
Важно

Токен — это полный доступ к данным вашего ресурса. Не размещайте его в клиентском коде сайта или мобильного приложения: запросы к API должны уходить с вашего сервера.

Варианты интеграции #

Существует два варианта интеграции с системой iRECA Курьер.

С web-кабинетом диспетчера

К web-кабинету диспетчера может быть подключено неограниченное количество сайтов и внешних систем.

Порядок подключения:

  1. Добавьте свой ресурс и получите токен: «Настройки» → «Магазины» → «+Добавить».
  2. Загрузите в свою систему справочники: налоговые ставки, типы платежей, причины отмены заказа.
  3. Создайте callback-функцию, чтобы отслеживать изменения по заказу.
  4. Создайте товары.
  5. Создайте заказы.

Без web-кабинета диспетчера

Токен и учётные данные для работы в приложении выдаёт техническая поддержка. Отправьте обращение на ireca@softbalance.ru.

Для регистрации необходимо предоставить ИНН компании.

Важно

При интеграции через web-кабинет ряд сущностей создаётся только в самом кабинете, через API их можно лишь читать: курьеры, налоговые ставки, типы платежей, причины отмены заказа, роли, поставщики.

Если вы пользуетесь web-кабинетом и решите его отключить, все созданные данные сохранятся и останутся доступны по API.

Общие правила #

Дата и время

Все даты и время передаются и возвращаются в часовом поясе GMT+00:00 в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.

Формат даты
{
  "deliveryTimeFrom": "2021-05-15 13:21:13",
  "deliveryTimeTo": "2021-05-15 15:21:13"
}
Важно

Не передавайте локальное время заведения — пересчитайте его в UTC. Иначе курьер получит заказ со сдвинутым интервалом доставки.

Пагинация

Методы, возвращающие списки, принимают два параметра.

ПараметрТипОписание
pagenumberНомер страницы, начиная с 1
countnumberКоличество элементов на страницу. По умолчанию — 20, максимум — 500

Тело запроса

Методы создания и массового обновления принимают массив объектов, даже если объект один. Заголовок Content-Type: application/json обязателен для POST и PUT.

Один объект — всё равно массив
[
  {
    "goodId": "355864",
    "title": "Пицца Маргарита"
  }
]

Методы /replace

У большинства ресурсов есть метод POST .../replace — «создать или обновить». Если объект с указанным идентификатором существует, он будет обновлён; если нет — создан. Это удобнее, чем каждый раз проверять существование объекта отдельным запросом.

Ошибки и коды ответов #

При возникновении ошибки сервис возвращает объект следующего вида:

Формат ошибки
{
  "error": true,
  "message": "Модель не существует"
}

В исходной документации этот пример был записан синтаксисом PHP — {"error" => true, …}. Здесь он приведён к настоящему JSON, который и приходит по HTTP.

Коды состояния HTTP

КодЗначение
200Запрос выполнен, данные в теле ответа
201Объект создан
204Выполнено успешно, тело ответа пустое
400Некорректный запрос
401Токен не передан или недействителен
403Недостаточно прав
404Объект не найден
422Данные не прошли валидацию
500Внутренняя ошибка сервиса
Совет

Проверяйте именно код состояния HTTP, а не наличие поля error в теле: при 204 тела ответа нет вовсе.

Все методы списком #

Полный перечень методов API. Кликните по строке, чтобы перейти к описанию.

МетодПутьНазначениеРаздел
GET/locations?courierId={courierId}&{createdAt}=&page={page}&count={count}Получение массива Geo - данныхGeo-данные
POST/ordersСоздание заказовЗаказы
POST/orders?isRefund=1Создание заказов для кассового возвратаЗаказы
GET/orders?orderId={orderId}Получение заказаЗаказы
GET/ordersПолучение списка заказовЗаказы
GET/ordersAlfa! Получение списка заказов, которые изменили свой статус на указанный в запросе, в определенный период. Запрос возвращает массив заказов, которые за указанный в запросе период имели указанный статус доставки.Заказы
PUT/orders?orderId={orderId}Редактирование заказаЗаказы
PUT/orders/multipleUpdateРедактирование массива заказовЗаказы
POST/orders/replaceСоздание/Редактирование заказовЗаказы
DELETE/orders?orderId={orderId}Удаление заказаЗаказы
POST/orders/callbackУстанавливает callback на изменение заказаЗаказы
POST/you-order-callbackЗапрос на заданный callback URLЗаказы
GET/orders/journalStatuses?orderId={orderId}Получение списка изменений статусов доставки заказаЗаказы
GET/orderReceipts?orderId={orderId}Получить чек оплатыФискальные документы
GET/orderReturnReceipts?orderId={orderId}Получить чек возвратаФискальные документы
GET/correctionReceipts?courierId={courierId}&page={page}&count={count}Получить чек коррекцииФискальные документы
POST/atolOnlineSettings/replaceСоздание/Редактирование настроекУдаленная фискализация с Atol Online
GET/pechka54SettingsПолучение настроекУдаленная фискализация с Pechka54
GET/journal?entityId={entityId}&startedAt={startedAt}&page={page}&count={count}Получить список изменений заказаЖурнал изменений заказов
POST/goodsСоздание товаровКаталог товаров
GET/goods?goodId={goodId}Получение данных товараКаталог товаров
GET/goods?page={page}&count={count}Получение списка товаровКаталог товаров
PUT/goods?goodId={goodId}Редактирование товараКаталог товаров
POST/goods/replaceСоздание/Редактирование товаровКаталог товаров
DELETE/goods?goodId={goodId}Удаление товараКаталог товаров
POST/specificitiesСоздание характеристикХарактеристики
GET/specificities?specificityId={specificityId}Получение данных характеристикХарактеристики
GET/specificities?page={page}&count={count}Получение списка характеристикХарактеристики
PUT/specificities?specificityId={specificityId}Редактирование характеристикиХарактеристики
POST/specificities/replaceСоздание/Редактирование характеристикиХарактеристики
DELETE/specificities?specificityId={specificityId}Удаление характеристикиХарактеристики
POST/warehousesСоздание складаСклады
GET/warehouses?warehouseId={warehouseId}Получение данных складаСклады
GET/warehouses?page={page}&count={count}Получение списка складовСклады
PUT/warehouses?warehouseId={warehouseId}Редактирование складаСклады
POST/warehouses/replaceСоздание/Редактирование складаСклады
DELETE/warehouses?warehouseId={warehouseId}Удаление складаСклады
POST/couriersСоздание курьеровКурьер
GET/couriers?courierId={courierId}Получение данных курьераКурьер
GET/couriersПолучение списка курьеровКурьер
PUT/couriers?courierId={courierId}Редактирование данных курьераКурьер
POST/couriers/replaceСоздание/Редактирование курьеровКурьер
DELETE/couriers?courierId={courierId}Удаление курьераКурьер
POST/userRolesСоздание ролиРоли приложения
GET/userRoles?roleId={roleId}Получение данных ролиРоли приложения
GET/userRolesПолучение списка ролейРоли приложения
PUT/userRoles?roleId={roleId}Редактирование ролиРоли приложения
POST/userRoles/replaceСоздание/Редактирование ролиРоли приложения
DELETE/userRoles?roleId={roleId}Удаление ролиРоли приложения
GET/permissions?roleId={roleId}&permissionId={permissionId}Получение списка настроек доступаНастройки доступа
POST/permissions/replaceУстановка/сброс настройки доступаНастройки доступа
POST/clientsСоздание клиентовКлиент
GET/clients?clientId={clientId}Получение данных клиентаКлиент
GET/clientsПолучение списка клиентовКлиент
PUT/clients?clientId={clientId}Редактирование данных клиентаКлиент
POST/clients/replaceСоздание/Редактирование клиентаКлиент
DELETE/clients?clientId={clientId}Удаление клиентаКлиент
POST/suppliersСоздание поставщикаПоставщики
GET/suppliers?supplierId={supplierId}Получение данных поставщикаПоставщики
GET/suppliers?page={page}&count={count}Получение списка поставщиковПоставщики
PUT/suppliers?supplierId={supplierId}Редактирование поставщикаПоставщики
POST/suppliers/replaceСоздание/Редактирование поставщикаПоставщики
DELETE/suppliers?supplierId={supplierId}Удаление поставщикаПоставщики
GET/licensesСписок курьеров использующих лицензииУправление лицензиями
POST/licenses/close?deviceId={deviceId}Освободить лицензиюУправление лицензиями
POST/licenses/callbackУстанавливает callback на закрытие сессии курьераУправление лицензиями
POST/exampleЗапрос на заданный callback URLУправление лицензиями
GET/bankTerminalLogs?orderId={orderId}&courierId={courierId}&count={count}&page={page}Получить список ошибокОшибки банковского терминала
GET/fiscalRegistratorLogs?orderId={orderId}&courierId={courierId}&count={count}&page={page}Получить список ошибокОшибки фискального регистратора
POST/orderReturnReasonsСоздание причин отказаПричины отмены заказа
GET/orderReturnReasons?reasonId={reasonId}Получение причины отказаПричины отмены заказа
GET/orderReturnReasonsПолучение списка причин отказаПричины отмены заказа
PUT/orderReturnReasons?reasonId={reasonId}Редактирование причины отказаПричины отмены заказа
POST/orderReturnReasons/replaceСоздание/Редактирование причин отказаПричины отмены заказа
DELETE/orderReturnReasons?reasonId={reasonId}Удаление причины отказаПричины отмены заказа
POST/paymentTypesСоздание типов платежейТипы платежей
GET/paymentTypes?paymentTypeId={paymentTypeId}Получение типа платежаТипы платежей
GET/paymentTypesПолучение списка типов платежейТипы платежей
PUT/paymentTypes?paymentTypeId={paymentTypeId}Редактирование типа платежаТипы платежей
POST/paymentTypes/replaceСоздание/Редактирование типов платежейТипы платежей
DELETE/paymentTypes?paymentTypeId={paymentTypeId}Удаление типа платежаТипы платежей
POST/taxesСоздание налоговых ставокНалоговые ставки
GET/taxes?taxId={taxId}Получение налоговой ставкиНалоговые ставки
GET/taxesПолучение списка налоговых ставокНалоговые ставки
PUT/taxes?taxId={taxId}Редактирование налоговой ставкиНалоговые ставки
POST/taxes/replaceСоздание/Редактирование налоговых ставокНалоговые ставки
DELETE/taxes?taxId={taxId}Удаление налоговой ставкиНалоговые ставки
GET/dictionary/orderStatusesСписок статусов состояния заказаСправочники
GET/dictionary/orderDeliveryStatusesСписок статусов доставки заказаСправочники
GET/dictionary/closeTypesСписок типов платежей в фискальном регистратореСправочники
GET/dictionary/taxTypesСписок предопределенных значений налоговых ставокСправочники
GET/dictionary/goodCalcTypesСписок признаков предмета расчетаСправочники
GET/dictionary/permissionsСписок настроек доступа пользователей приложенияСправочники

Geo-данные #

Наименьший интервал обновления Geo-данных раз в минуту.

GETПолучение массива Geo - данных#

/locations?courierId={courierId}&{createdAt}=&page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
courierIdИдентификатор курьера55752
createdAtДата и время получаемых данных2016-08-17 20:00:00
pageНомер страницы1
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)3

Тело запроса

ПолеТипОписание
locationsмассив Geo - локаций
элемент массива
courierIdИдентификатор курьерапример: 7
orderIdИдентификатор заказапример: 2255
orderStatusIdСтатус заказапример: 1
longitudeШиротапример: 30.33342890000000
latitudeДолготапример: 60.03194500000000
accuracyПогрешностьпример: 24

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/locations?courierId=55752&createdAt=2016-08-17%2020:00:00&page=1&count=3' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "orderId": 2255,
    "deliveryStatusId": 6,
    "returnReasonId": null,
    "longitude": 30.33342890000000,
    "latitude": 60.03194500000000,
    "accuracy": 24,
    "createdAt": "2017-05-15 13:21:13"
  },
  {
    "orderId": 2255,
    "deliveryStatusId": 6,
    "returnReasonId": null,
    "longitude": 30.33342890000000,
    "latitude": 60.03194500000000,
    "accuracy": 24,
    "createdAt": "2017-05-15 13:21:13"
  }
]

Заказы #

Общие параметры раздела

ПараметрТипОписаниеПример
orderIdИдентификатор заказа в вашей системе209900

POSTСоздание заказов#

/orders

Тело запроса

ПолеТипОписание
orderIdУникальный идентификатор заказа в вашей системе
codeAliasЕсли задано, значение этого свойства будет отображаться в приложении вместо значения "orderId".
isInternetPaymentПризнак расчета в Интернет. Тэг 1125. Принимает значение "1" или "0". Если стоит значение "1" - заказ оплачен в Интернет и должен быть заполнен еще один атрибут "internetPaymentUrl". По умолчанию установлено значение "0".
internetPaymentUrlАдрес сайта (места расчета) если 'isInternetPayment' имеет значение '1'. Передается в тэг 1187 "Место расчетов".
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
courierIdИдентификатор курьерапример: 1
clientIdИдентификатор клиентапример: 1
supplierIdИдентификатор поставщика (агентская схема)пример: 1
clientИспользуется только в том случае, если не задано свойство "clientId"
firstnameИмя клиента
lastnameФамилия клиента
emailEmail клиента
paymentIdИдентификатор типа платежапример: 1
amountToPayСумма к оплате без учета скидки
prePaymentSumСумма предоплаты (если задана будет печататься второй чек)
cashСумма наличных у клиента (купюра)
addressFromEntityАдрес откуда везти товар (рекомендуется использовать вместо "addressFrom")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
addressToEntityАдрес куда везти товар (рекомендуется использовать вместо "addressTo")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
descriptionОписание заказа
goodsМассив позиций товаров
элемент массива
goodIdИдентификатор товара
countКоличество товара
priceЦена
totalИтоговая стоимость без учёта скидки
discountTotalСумма скидки (-)/наценки (+)
taxIdИдентификатор налоговой ставки (Если не задан, используется налоговая ставка товара)пример: 1
positionПорядковый номер
unitЕдиница измерения (если задана пустая строка присвоит значение: "шт")
vedCodeКод товарной номенклатуры (1162)
countryCodeСтрана происхождения товара (1230)
customDeclarationCodeНомер таможенной декларации (1231)
markValueЗначение кода маркировки
markBinaryValuedepricated. Декодированное значение кода маркировки
weightВес товара
descriptionОписание товара
warehousesМассив складов с которых нужно забрать товар (на текущий момент можно указать только один склад)
элемент массива
warehouseIdИдентификатор склада
countКоличество товара, которое следует забрать.
specificitiesМассив специфик (На этапе тестирования!!!)
элемент массива
specificityIdИдентификатор специфики
priceЦена специфики (является информационным полем, стоимость должна быть учтена в цене товара)
countКоличество специфик.

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orders' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "orderId": "1",
    "codeAlias": "G-1",
    "isInternetPayment": "1",
    "internetPaymentUrl": "https://site.net",
    "statusId": 0,
    "deliveryStatusId": 6,
    "isAgreed": 0,
    "returnReasonId": null,
    "courierId": "55752",
    "clientId": "3271",
    "supplierId": null,
    "paymentId": "4113",
    "amountToPay": 539.78,
    "prePaymentSum": 0,
    "cash": 1000.00,
    "addressFromEntity": {
      "postindex": "195279",
      "city": "Санкт-Петербург",
      "street": "ул. Передовиков",
      "home": "дом 25",
      "apartment": "кв 16",
      "latitude": 59.947851,
      "longitude": 30.4599682,
      "isUseGoogleGeo": false
    },
    "addressToEntity": {
      "postindex": "197136",
      "city": "Санкт-Петербург",
      "street": "Чкаловский пр.",
      "home": "15литА",
      "apartment": "кв 19",
      "latitude": 0,
      "longitude": 0,
      "isUseGoogleGeo": true
    },
    "phone": "+79123456789",
    "deliveryTimeFrom": "2021-05-15 13:21:13",
    "deliveryTimeTo": "2021-05-15 15:21:13",
    "description": "Новый заказ",
    "goods": [
      {
        "goodId": "355864",
        "count": 1,
        "price": 539.78,
        "total": 539.78,
        "discountTotal": 0,
        "position": 1,
        "description": "Описание позиции",
        "unit": "г",
        "weight": 100,
        "taxId": 1,
        "countryCode": "276",
        "customDeclarationCode": "10113110/070719/0097367",
        "warehouses": [
          {
            "warehouseId": "1099",
            "count": 1.0
          }
        ],
        "specificities": [
          {
            "specificityId": "24",
            "price": 5.00,
            "count": 1.0
          }
        ]
      }
    ]
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

POSTСоздание заказов для кассового возврата#

/orders?isRefund=1

Тело запроса

ПолеТипОписание
orderIdУникальный идентификатор заказа в вашей системе
codeAliasЕсли задано, значение этого свойства будет отображаться в приложении вместо значения "orderId".
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
courierIdИдентификатор курьера
clientIdИдентификатор клиента
supplierIdИдентификатор поставщика (агентская схема)
clientИспользуется только в том случае, если не задано свойство "clientId"
firstnameИмя клиента
lastnameФамилия клиента
paymentIdИдентификатор типа платежа
amountToPayСумма к оплате без учета скидки
prePaymentSumСумма предоплаты (если задана будет печататься второй чек)
cashСумма наличных у клиента (купюра)
addressFromEntityАдрес откуда везти товар (рекомендуется использовать вместо "addressFrom")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
addressToEntityАдрес куда везти товар (рекомендуется использовать вместо "addressTo")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
descriptionОписание заказа
goodsМассив позиций товаров
элемент массива
goodIdИдентификатор товара
countКоличество товара
priceЦена
totalИтоговая стоимость без учёта скидки
discountTotalСумма скидки (-)/наценки (+)
taxIdИдентификатор налоговой ставки (Если не задан, используется налоговая ставка товара)пример: 1
positionПорядковый номер
unitЕдиница измерения (если задана пустая строка присвоит значение: "шт")
vedCodeКод товарной номенклатуры (1162)
countryCodeСтрана происхождения товара (1230)
customDeclarationCodeНомер таможенной декларации (1231)
markValueИсходное значение кода маркировки (марку способны декодировать не все терминалы, поэтому приоритетным является заполнение поля "markBinaryValue")
markBinaryValueДекодированное значение кода маркировки
weightВес товара
descriptionОписание товара
warehousesМассив складов с которых нужно забрать товар (на текущий момент можно указать только один склад)
элемент массива
warehouseIdИдентификатор склада
countКоличество товара, которое следует забрать.
specificitiesМассив специфик (На этапе тестирования!!!)
элемент массива
specificityIdИдентификатор специфики
priceЦена специфики (является информационным полем, стоимость должна быть учтена в цене товара)
countКоличество специфик.
isRefundОпределяет, что этот заказ на возврат
paymentsМассив оплат (задается для заказа на возврат)
элемент массива
paymentIdИдентификатор платежа в вашей системе
paymentTypeIdИдентификатор типа платежа
priceСумма платежа
paidInДата и время платежа
cardMaskМаска карты (если оплата была произведена картой)
rrnУникальный идентификатор банковской транзакции (если оплата была произведена картой)
cardAuthКод авторизации транзакции банка (если оплата была произведена картой)

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orders?isRefund=1' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "orderId": "2",
    "codeAlias": "G-2",
    "statusId": 1,
    "deliveryStatusId": 7,
    "returnReasonId": null,
    "courierId": "55752",
    "clientId": "3271",
    "supplierId": null,
    "paymentId": "4113",
    "amountToPay": 539.78,
    "prePaymentSum": 0,
    "cash": 1000.00,
    "addressToEntity": {
      "postindex": "197136",
      "city": "Санкт-Петербург",
      "street": "Чкаловский пр.",
      "home": "15литА",
      "apartment": "кв 19",
      "latitude": 0,
      "longitude": 0,
      "isUseGoogleGeo": true
    },
    "phone": "+79123456789",
    "deliveryTimeFrom": "2021-05-15 13:21:13",
    "deliveryTimeTo": "2021-05-15 15:21:13",
    "description": "Новый возвратный заказ",
    "goods": [
      {
        "goodId": "355864",
        "count": 1,
        "price": 539.78,
        "total": 539.78,
        "discountTotal": 0,
        "position": 1,
        "description": "Описание позиции",
        "unit": "г",
        "weight": 100,
        "taxId": 1
      }
    ],
    "isRefund": true,
    "payments": [
      {
        "paymentId": "1",
        "paymentTypeId": "4113",
        "price": 200.00,
        "paidIn": "2020-09-08 08:29:59"
      },
      {
        "paymentId": "2",
        "paymentTypeId": "4114",
        "price": 339.78,
        "paidIn": "2020-09-09 08:29:59",
        "cardMask": "************3333",
        "rrn": "025152870125",
        "cardAuth": "012345"
      }
    ]
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение заказа#

/orders?orderId={orderId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
orderIdИдентификатор заказа в вашей системе209900

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orders?orderId=209900' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
orderIdУникальный идентификатор заказа в вашей системе
codeAliasЕсли задано, значение этого свойства будет отображаться в приложении вместо значения "orderId".
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
frReceiptStatusIdОпределяет состояние чека в фискальном регистраторе (распечатан/не распечатан)
courierIdИдентификатор курьера
clientIdИдентификатор клиента
supplierIdИдентификатор поставщика (агентская схема)
clientИспользуется только в том случае, если не задано свойство "clientId"
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
paymentIdПоследний установленный тип платежа (заданный по умолчанию/использованный в ФР)
originalPaymentIdЗаданный по умолчанию тип платежа
frUsedPaymentIdТипа платежа использованный в фискальном регистраторе (ФР)
amountToPayСумма к оплате без учета скидки
prePaymentSumСумма предоплаты (если задана будет печататься второй чек)
cashСумма наличных у клиента (купюра)
addressFromEntityАдрес откуда везти товар (рекомендуется использовать вместо "addressFrom")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
addressToEntityАдрес куда везти товар (рекомендуется использовать вместо "addressTo")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
descriptionОписание заказа
goodsМассив позиций товаров
элемент массива
goodIdИдентификатор товара
countКоличество товара
priceЦена
totalИтоговая стоимость без учёта скидки
discountTotalСумма скидки (-)/наценки (+)
taxIdИдентификатор налоговой ставки (Если не задан, используется налоговая ставка товара)пример: 1
positionПорядковый номер
unitЕдиница измерения (если задана пустая строка присвоит значение: "шт")
vedCodeКод товарной номенклатуры (1162)
countryCodeСтрана происхождения товара (1230)
customDeclarationCodeНомер таможенной декларации (1231)
markValueИсходное значение кода маркировки (марку способны декодировать не все терминалы, поэтому приоритетным является заполнение поля "markBinaryValue")
markBinaryValueДекодированное значение кода маркировки.
weightВес товара
descriptionОписание товара
warehousesМассив складов с которых нужно забрать товар (на текущий момент можно указать только один склад)
элемент массива
warehouseIdИдентификатор склада
countКоличество товара, которое следует забрать
tookCountКоличество товара, которое следует забрать
titleНаименование склада
firstnameИмя отвественного на складе
lastnameФамилия отвественного на складе
phoneТелефон отвественного на складе
cityГород, где расположен склад
streetУлица
houseДом
apartmentОфис
latitudeШирота
longitudeДолгота
descriptionОписание склада
updatedAtДата и время операции
isActive- Определяет состояние склада: 0 - удален; 1 - активен.
specificitiesМассив специфик (На этапе тестирования!!!)
элемент массива
specificityIdИдентификатор специфики
parentIdИдентификатор характеристики элемента
priceЦена специфики (является информационным полем, стоимость должна быть учтена в цене товара)
countКоличество специфик
titleНаименование характеристики
valueЗначение характеристики
imageUrlСсылка на изображение
imageBigUrlСсылка на изображение
articleАртикул специфики
isActive- Определяет состояние специфики: 0 - удален; 1 - активен.
canceledItemsУдаленные курьером позиции заказа.
элемент массива
returnReasonIdПричина отмены позиции заказа
countКоличество удаленных позиций
createdAtДата и время удаления
isReturnedОпределяет, что по этому заказу выполнен возврат
isEditedОпределяет, что у заказа редактировались позиции
isRefundОпределяет, что этот заказ на возврат
paymentsМассив оплат
элемент массива
paymentIdИдентификатор платежа в вашей системе
paymentTypeIdИдентификатор типа платежа
priceСумма платежа
paidInДата и время платежа
cardMaskМаска карты (если оплата была произведена картой)
rrnУникальный идентификатор банковской транзакции (если оплата была произведена картой)
cardAuthКод авторизации транзакции банка (если оплата была произведена картой)
returnedOrder
returnedOrderIdУникальный идентификатор заказа в вашей системе
returnReasonIdПричина отмены заказа
createdAtДата и время возврата
returnedPaymentsМассив возвратных платежей
элемент массива
paymentIdИдентификатор платежа в вашей системе
paymentTypeIdИдентификатор типа платежа
sumСумма платежа
createdAtДата и время возврата
returnedGoodsМассив возвратных товаров
элемент массива
goodIdИдентификатор товара
returnReasonIdПричина отмены позиции заказа
countКоличество возвращенного товара
sumСумма товара
createdAtДата и время операции возврата
Тело ответа
{
  "codeAlias": "G-2",
  "orderId": 209900,
  "statusId": 0,
  "deliveryStatusId": 1,
  "receiptStatusId": 0,
  "frReceiptStatusId": 0,
  "returnReasonId": null,
  "courierId": "",
  "clientId": "3271",
  "paymentId": "4113",
  "originalPaymentId": 4113,
  "frUsedPaymentId": null,
  "client": {
    "firstname": "Алексей",
    "lastname": "Иванов",
    "inn": "",
    "email": "ivanow@email.com"
  },
  "amountToPay": "679.57",
  "prePaymentSum": "0.00",
  "cash": 0,
  "addressFrom": "",
  "addressFromEntity": {
    "postindex": "",
    "city": "",
    "street": "",
    "home": "",
    "apartment": "",
    "latitude": "0.00000000000000",
    "longitude": "0.00000000000000"
  },
  "addressTo": "Санкт-Петербург Улица правды 24 44",
  "addressToEntity": {
    "postindex": "",
    "city": "Санкт-Петербург",
    "street": "Улица правды",
    "home": "24",
    "apartment": "44",
    "latitude": "59.92088839350768",
    "longitude": "30.33911295248004"
  },
  "phone": "+79123456789",
  "deliveryTimeFrom": "2021-04-28 11:34:00",
  "deliveryTimeTo": "2021-04-28 12:34:00",
  "description": "Доставить до двери",
  "supplierId": null,
  "goods": [
    {
      "returnReasonId": {},
      "count": 1,
      "total": 539.78,
      "discountTotal": 0,
      "position": 0,
      "unit": "г",
      "vedCode": "",
      "countryCode": "",
      "customDeclarationCode": "",
      "markValue": "",
      "markBinaryValue": "",
      "specificities": [],
      "warehouses": [],
      "canceledItems": [],
      "parentId": {},
      "goodId": 355864,
      "article": "",
      "taxId": "8286",
      "calcId": "0",
      "title": "Кофе carte noire",
      "weight": "95",
      "multiplicity": 1,
      "price": 539.78,
      "description": "",
      "imageUrl": "",
      "imageBigUrl": "",
      "isActive": 1
    },
    {
      "returnReasonId": null,
      "count": 1,
      "total": 139.79,
      "discountTotal": 0,
      "position": 1,
      "unit": "г",
      "vedCode": "",
      "countryCode": "",
      "customDeclarationCode": "",
      "markValue": "",
      "markBinaryValue": "",
      "specificities": [
        {
          "count": 1,
          "parentId": {},
          "specificityId": "24",
          "title": "Пакет (полиэтиленовый)",
          "value": "",
          "price": 5,
          "imageUrl": "",
          "imageBigUrl": "",
          "isActive": 1,
          "article": "AM-3243"
        }
      ],
      "warehouses": [],
      "canceledItems": [],
      "parentId": null,
      "goodId": 355862,
      "article": "",
      "taxId": "8286",
      "calcId": "0",
      "title": "Сыр маасдам Valio 45% БЗМЖ",
      "weight": "120",
      "multiplicity": 1,
      "price": 139.79,
      "description": "",
      "imageUrl": "",
      "imageBigUrl": "",
      "isActive": 1
    }
  ],
  "payments": [],
  "returnedOrder": null,
  "isAgreed": 0,
  "isRefund": 0,
  "isReturned": 0,
  "isEdited": 0
}

GETПолучение списка заказов#

/orders

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orders' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
orderIdУникальный идентификатор заказа в вашей системе
codeAliasЕсли задано, значение этого свойства будет отображаться в приложении вместо значения "orderId".
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
frReceiptStatusIdОпределяет состояние чека в фискальном регистраторе (распечатан/не распечатан)
courierIdИдентификатор курьера
clientIdИдентификатор клиента
supplierIdИдентификатор поставщика (агентская схема)
clientИспользуется только в том случае, если не задано свойство "clientId"
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
paymentIdПоследний установленный тип платежа (заданный по умолчанию/использованный в ФР)
originalPaymentIdЗаданный по умолчанию тип платежа
frUsedPaymentIdТипа платежа использованный в фискальном регистраторе (ФР)
amountToPayСумма к оплате без учета скидки
prePaymentSumСумма предоплаты (если задана будет печататься второй чек)
cashСумма наличных у клиента (купюра)
addressFromEntityАдрес откуда везти товар (рекомендуется использовать вместо "addressFrom")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
addressToEntityАдрес куда везти товар (рекомендуется использовать вместо "addressTo")
postindexПочтовый индекс
cityГород
streetУлица
homeДом
apartmentКвартира или офис
latitudeширота
longitudeдолгота
isUseGoogleGeoОпределяет нужно ли использовать Google Geocoding API для определения адреса
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
descriptionОписание заказа
goodsМассив позиций товаров
элемент массива
goodIdИдентификатор товара
countКоличество товара
priceЦена
totalИтоговая стоимость без учёта скидки
discountTotalСумма скидки (-)/наценки (+)
taxIdИдентификатор налоговой ставки (Если не задан, используется налоговая ставка товара)пример: 1
positionПорядковый номер
unitЕдиница измерения (если задана пустая строка присвоит значение: "шт")
vedCodeКод товарной номенклатуры (1162)
countryCodeСтрана происхождения товара (1230)
customDeclarationCodeНомер таможенной декларации (1231)
markValueИсходное значение кода маркировки (марку способны декодировать не все терминалы, поэтому приоритетным является заполнение поля "markBinaryValue")
markBinaryValueДекодированное значение кода маркировки
weightВес товара
descriptionОписание товара
warehousesМассив складов с которых нужно забрать товар (на текущий момент можно указать только один склад)
элемент массива
warehouseIdИдентификатор склада
countКоличество товара, которое следует забрать
tookCountКоличество товара, которое следует забрать
titleНаименование склада
firstnameИмя отвественного на складе
lastnameФамилия отвественного на складе
phoneТелефон отвественного на складе
cityГород, где расположен склад
streetУлица
houseДом
apartmentОфис
latitudeШирота
longitudeДолгота
descriptionОписание склада
updatedAtДата и время операции
isActive- Определяет состояние склада: 0 - удален; 1 - активен.
specificitiesМассив специфик (На этапе тестирования!!!)
элемент массива
specificityIdИдентификатор специфики
parentIdИдентификатор характеристики элемента
priceЦена специфики (является информационным полем, стоимость должна быть учтена в цене товара)
countКоличество специфик
titleНаименование характеристики
valueЗначение характеристики
imageUrlСсылка на изображение
imageBigUrlСсылка на изображение
articleАртикул специфики
isActive- Определяет состояние специфики: 0 - удален; 1 - активен.
canceledItemsУдаленные курьером позиции заказа.
элемент массива
returnReasonIdПричина отмены позиции заказа
countКоличество удаленных позиций
createdAtДата и время удаления
isReturnedОпределяет, что по этому заказу выполнен возврат
isEditedОпределяет, что у заказа редактировались позиции
isRefundОпределяет, что этот заказ на возврат
paymentsМассив оплат
элемент массива
paymentIdИдентификатор платежа в вашей системе
paymentTypeIdИдентификатор типа платежа
priceСумма платежа
paidInДата и время платежа
cardMaskМаска карты (если оплата была произведена картой)
rrnУникальный идентификатор банковской транзакции (если оплата была произведена картой)
cardAuthКод авторизации транзакции банка (если оплата была произведена картой)
returnedOrder
returnedOrderIdУникальный идентификатор заказа в вашей системе
returnReasonIdПричина отмены заказа
createdAtДата и время возврата
returnedPaymentsМассив возвратных платежей
элемент массива
paymentIdИдентификатор платежа в вашей системе
paymentTypeIdИдентификатор типа платежа
sumСумма платежа
createdAtДата и время возврата
returnedGoodsМассив возвратных товаров
элемент массива
goodIdИдентификатор товара
returnReasonIdПричина отмены позиции заказа
countКоличество возвращенного товара
sumСумма товара
createdAtДата и время операции возврата
Тело ответа
[
  {
    "codeAlias": "G-2 (replaced)",
    "orderId": 209900,
    "statusId": 0,
    "deliveryStatusId": 1,
    "receiptStatusId": 0,
    "frReceiptStatusId": 0,
    "returnReasonId": {},
    "courierId": "",
    "clientId": 3271,
    "paymentId": "4113",
    "originalPaymentId": 4113,
    "frUsedPaymentId": {},
    "client": {
      "firstname": "Алексей (replaced)",
      "lastname": "Иванов (replaced)",
      "inn": "",
      "email": "ivanow@email.com"
    },
    "amountToPay": "679.57",
    "prePaymentSum": "0.00",
    "cash": 0,
    "addressFrom": "",
    "addressFromEntity": {
      "postindex": "",
      "city": "",
      "street": "",
      "home": "",
      "apartment": "",
      "latitude": "0.00000000000000",
      "longitude": "0.00000000000000"
    },
    "addressTo": "Санкт-Петербург Улица правды 24 44",
    "addressToEntity": {
      "postindex": "",
      "city": "Санкт-Петербург",
      "street": "Улица правды",
      "home": "24",
      "apartment": "44",
      "latitude": "59.92088839350768",
      "longitude": "30.33911295248004"
    },
    "phone": "+77777777",
    "deliveryTimeFrom": "2021-04-28 11:34:00",
    "deliveryTimeTo": "2021-04-28 12:34:00",
    "description": "Доставить до двери (replaced)",
    "supplierId": {},
    "goods": [
      {
        "returnReasonId": {},
        "count": 1,
        "total": 539.78,
        "discountTotal": 0,
        "position": 0,
        "unit": "г",
        "vedCode": "",
        "countryCode": "",
        "customDeclarationCode": "",
        "markValue": "",
        "markBinaryValue": "",
        "specificities": [],
        "warehouses": [],
        "canceledItems": [],
        "parentId": {},
        "goodId": 355864,
        "article": "",
        "taxId": "8286",
        "calcId": "0",
        "title": "Кофе carte noire",
        "weight": "95",
        "multiplicity": 1,
        "price": 539.78,
        "description": "replaced",
        "imageUrl": "",
        "imageBigUrl": "",
        "isActive": 1
      },
      {
        "returnReasonId": null,
        "count": 1,
        "total": 139.79,
        "discountTotal": 0,
        "position": 1,
        "unit": "г",
        "vedCode": "",
        "countryCode": "",
        "customDeclarationCode": "",
        "markValue": "",
        "markBinaryValue": "",
        "specificities": [
          {
            "count": 1,
            "parentId": {},
            "specificityId": "24",
            "title": "Пакет (полиэтиленовый)",
            "value": "",
            "price": 5,
            "imageUrl": "",
            "imageBigUrl": "",
            "isActive": 1,
            "article": "AM-3243"
          }
        ],
        "warehouses": [],
        "canceledItems": [],
        "parentId": null,
        "goodId": 355862,
        "article": "",
        "taxId": "8286",
        "calcId": "0",
        "title": "Сыр маасдам Valio 45% БЗМЖ",
        "weight": "120",
        "multiplicity": 1,
        "price": 139.79,
        "description": "replaced",
        "imageUrl": "",
        "imageBigUrl": "",
        "isActive": 1
      }
    ],
    "payments": [],
    "returnedOrder": null,
    "isAgreed": 0,
    "isRefund": 0,
    "isReturned": 0,
    "isEdited": 0
  }
]

GETAlfa! Получение списка заказов, которые изменили свой статус на указанный в запросе, в определенный период. Запрос возвращает массив заказов, которые за указанный в запросе период имели указанный статус доставки.#

/orders

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orders' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Пример тела ответа в исходной документации не приведён.

PUTРедактирование заказа#

/orders?orderId={orderId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
orderIdИдентификатор заказа в вашей системе209900

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/orders?orderId=209900' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
{
  "orderId": "209900",
  "codeAlias": "G-2 (updated)",
  "statusId": "0",
  "deliveryStatusId": "1",
  "courierId": null,
  "clientId": "3271",
  "supplierId": null,
  "client": {
    "firstname": "Алексей (updated)",
    "lastname": "Иванов (updated)",
    "email": "ivanow@email.com"
  },
  "paymentId": "4113",
  "amountToPay": 679.57,
  "prePaymentSum": 0,
  "cash": "0",
  "addressToEntity": {
    "city": "Санкт-Петербург",
    "street": "Улица правды",
    "home": "24",
    "apartment": "44",
    "latitude": "59.92088839350768",
    "longitude": "30.33911295248004",
    "isUseGoogleGeo": false
  },
  "phone": "+79123456789",
  "deliveryTimeFrom": "2021-04-28 11:34:00",
  "deliveryTimeTo": "2021-04-28 12:34:00",
  "description": "Доставить до двери (updated)",
  "goods": [
    {
      "goodId": "355864",
      "count": 1,
      "price": 539.78,
      "total": 539.78,
      "unit": "г",
      "discountTotal": 0,
      "position": 0,
      "description": "updated",
      "specificities": []
    },
    {
      "goodId": "355862",
      "count": 1,
      "price": 139.79,
      "total": 139.79,
      "unit": "г",
      "discountTotal": 0,
      "position": 1,
      "description": "updated",
      "specificities": [
        {
          "specificityId": "24",
          "price": "5.00",
          "count": "1"
        }
      ]
    }
  ]
}

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

PUTРедактирование массива заказов#

/orders/multipleUpdate

Тело запроса

ПолеТипОписание
orderIdsМассив идентификаторов изменяемых заказов
attributesМассив изменяемых аттрибутов (Для изменения доступны следующие аттрибуты: "statusId", "deliveryStatusId", "returnReasonId", "courierId", "deliveryTimeFrom", "deliveryTimeTo", "addressTo")
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
returnReasonIdПричина отмены заказа
courierIdИдентификатор курьера
addressToАдрес доставки одной строкой
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/orders/multipleUpdate' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"orderIds":["209900"],"attributes":{"statusId":1,"deliveryStatusId":11,"returnReasonId":"5276","courierId":"55750","addressTo":"Санкт-Петербург, ул. Передовиков, дом 25, кв 19","deliveryTimeFrom":"2021-06-15 13:21:13","deliveryTimeTo":"2021-06-15 15:21:13"}}'
Тело запроса
{
  "orderIds": [
    "209900"
  ],
  "attributes": {
    "statusId": 1,
    "deliveryStatusId": 11,
    "returnReasonId": "5276",
    "courierId": "55750",
    "addressTo": "Санкт-Петербург, ул. Передовиков, дом 25, кв 19",
    "deliveryTimeFrom": "2021-06-15 13:21:13",
    "deliveryTimeTo": "2021-06-15 15:21:13"
  }
}

Ответ

204Выполнено успешно, тело ответа пустое · application/json

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование заказов#

/orders/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orders/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "orderId": "209900",
    "codeAlias": "G-2 (replaced)",
    "statusId": "0",
    "deliveryStatusId": "1",
    "courierId": null,
    "clientId": "3271",
    "supplierId": null,
    "client": {
      "firstname": "Алексей (replaced)",
      "lastname": "Иванов (replaced)",
      "email": "ivanow@email.com"
    },
    "paymentId": "4113",
    "amountToPay": 679.57,
    "prePaymentSum": 0,
    "cash": "0",
    "addressToEntity": {
      "city": "Санкт-Петербург",
      "street": "Улица правды",
      "home": "24",
      "apartment": "44",
      "latitude": "59.92088839350768",
      "longitude": "30.33911295248004",
      "isUseGoogleGeo": false
    },
    "phone": "+79123456789",
    "deliveryTimeFrom": "2021-04-28 11:34:00",
    "deliveryTimeTo": "2021-04-28 12:34:00",
    "description": "Доставить до двери (replaced)",
    "goods": [
      {
        "goodId": "355864",
        "count": 1,
        "price": 539.78,
        "total": 539.78,
        "unit": "г",
        "discountTotal": 0,
        "position": 0,
        "description": "replaced",
        "specificities": []
      },
      {
        "goodId": "355862",
        "count": 1,
        "price": 139.79,
        "total": 139.79,
        "unit": "г",
        "discountTotal": 0,
        "position": 1,
        "description": "replaced",
        "specificities": [
          {
            "specificityId": "24",
            "price": "5.00",
            "count": "1"
          }
        ]
      }
    ]
  }
]

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

DELETEУдаление заказа#

/orders?orderId={orderId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
orderIdИдентификатор заказа в вашей системе209900

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/orders?orderId=209900' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTУстанавливает callback на изменение заказа#

/orders/callback

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orders/callback' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"url":"http://example.com/order-callback","isActive":1}'
Тело запроса
{
  "url": "http://example.com/order-callback",
  "isActive": 1
}

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

POSTЗапрос на заданный callback URL#

/you-order-callback

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/you-order-callback' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
{
  "items": [
    {
      "codeAlias": "G-2",
      "orderId": 209900,
      "statusId": 0,
      "deliveryStatusId": 1,
      "receiptStatusId": 0,
      "frReceiptStatusId": 0,
      "returnReasonId": null,
      "courierId": "",
      "clientId": "3271",
      "paymentId": "4113",
      "originalPaymentId": 4113,
      "frUsedPaymentId": null,
      "client": {
        "firstname": "Алексей",
        "lastname": "Иванов",
        "inn": "",
        "email": "ivanow@email.com"
      },
      "amountToPay": "679.57",
      "prePaymentSum": "0.00",
      "cash": 0,
      "addressFrom": "",
      "addressFromEntity": {
        "postindex": "",
        "city": "",
        "street": "",
        "home": "",
        "apartment": "",
        "latitude": "0.00000000000000",
        "longitude": "0.00000000000000"
      },
      "addressTo": "Санкт-Петербург Улица правды 24 44",
      "addressToEntity": {
        "postindex": "",
        "city": "Санкт-Петербург",
        "street": "Улица правды",
        "home": "24",
        "apartment": "44",
        "latitude": "59.92088839350768",
        "longitude": "30.33911295248004"
      },
      "phone": "+79123456789",
      "deliveryTimeFrom": "2021-04-28 11:34:00",
      "deliveryTimeTo": "2021-04-28 12:34:00",
      "description": "Доставить до двери",
      "supplierId": {},
      "goods": [
        {
          "returnReasonId": {},
          "count": 1,
          "total": 539.78,
          "discountTotal": 0,
          "position": 0,
          "unit": "г",
          "vedCode": "",
          "countryCode": "",
          "customDeclarationCode": "",
          "markValue": "",
          "markBinaryValue": "",
          "specificities": [],
          "warehouses": [],
          "canceledItems": [],
          "parentId": {},
          "goodId": 355864,
          "article": "",
          "taxId": "8286",
          "calcId": "0",
          "title": "Кофе carte noire",
          "weight": "95",
          "multiplicity": 1,
          "price": 539.78,
          "description": "",
          "imageUrl": "",
          "imageBigUrl": "",
          "isActive": 1
        },
        {
          "returnReasonId": null,
          "count": 1,
          "total": 139.79,
          "discountTotal": 0,
          "position": 1,
          "unit": "г",
          "vedCode": "",
          "countryCode": "",
          "customDeclarationCode": "",
          "markValue": "",
          "markBinaryValue": "",
          "specificities": [
            {
              "count": 1,
              "parentId": {},
              "specificityId": "24",
              "title": "Пакет (полиэтиленовый)",
              "value": "",
              "price": 5,
              "imageUrl": "",
              "imageBigUrl": "",
              "isActive": 1,
              "article": "AM-3243"
            }
          ],
          "warehouses": [],
          "canceledItems": [],
          "parentId": null,
          "goodId": 355862,
          "article": "",
          "taxId": "8286",
          "calcId": "0",
          "title": "Сыр маасдам Valio 45% БЗМЖ",
          "weight": "120",
          "multiplicity": 1,
          "price": 139.79,
          "description": "",
          "imageUrl": "",
          "imageBigUrl": "",
          "isActive": 1
        }
      ],
      "payments": [],
      "returnedOrder": null,
      "isAgreed": 0,
      "isRefund": 0,
      "isReturned": 0,
      "isEdited": 0
    }
  ]
}

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

GETПолучение списка изменений статусов доставки заказа#

/orders/journalStatuses?orderId={orderId}

Параметры запроса

ПараметрТипОписаниеПример
orderIdИдентификатор заказа в вашей системе209900

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orders/journalStatuses?orderId=209900' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "statusId": 1,
    "returnReasonId": 1,
    "longitude": 0.0,
    "latitude": 0.0,
    "accuracy": 10,
    "createdAt": "2017-05-15 13:21:13"
  },
  {
    "statusId": 1,
    "returnReasonId": 1,
    "longitude": 0.0,
    "latitude": 0.0,
    "accuracy": 10,
    "createdAt": "2017-05-15 13:21:13"
  }
]

Фискальные документы #

GETПолучить чек оплаты#

/orderReceipts?orderId={orderId}

Параметры запроса

ПараметрТипОписаниеПример
orderIdНомер заказа209897

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orderReceipts?orderId=209897' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
orderIdУникальный идентификатор заказа в вашей системе
serialNumberСерийный номер
shiftNumberНомер смены
fnНомер фискального накопителя
fdNumberНомер чека ФН
receiptNumberНомер чека в кассе
fiscalSignФискальный признак документа
dateTimeReceiptДата и время чека

GETПолучить чек возврата#

/orderReturnReceipts?orderId={orderId}

Параметры запроса

ПараметрТипОписаниеПример
orderIdНомер заказа209897

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReceipts?orderId=209897' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
orderIdУникальный идентификатор заказа в вашей системе
serialNumberСерийный номер
shiftNumberНомер смены
fnНомер фискального накопителя
fdNumberНомер чека ФН
receiptNumberНомер чека в кассе
fiscalSignФискальный признак документа
dateTimeReceiptДата и время чека

GETПолучить чек коррекции#

/correctionReceipts?courierId={courierId}&page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
courierIdИдентификатор курьера55752
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)10

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/correctionReceipts?courierId=55752&page=0&count=10' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
correctionReceiptIdУникальный идентификатор чека в системе iRECA
courierIdИдентификатор курьера
serialNumberСерийный номер
amountСумма коррекции
commandExecutedAtДата и время печати чека

Удаленная фискализация с Atol Online #

POSTСоздание/Редактирование настроек#

/atolOnlineSettings/replace

Тело запроса

ПолеТипОписание
settingIdУникальный идентификатор настройки в вашей системе
loginЛогин в аккаунте Atol Online
passwordПароль в аккаунте Atol Online
kktGroupГруппа печати
isProductionПризнак, что вы будете пробивать чеки в рабочей среде (не отладка).
companyНастройки вашей компании
innИНН
taxSystemСистема налогообложения
Members
`osn`– общая СН
`usn_income`упрощенная СН (доходы)
`usn_income_outcome`упрощенная СН (доходыминус расходы);
`envd`единый налог на вмененный доход
`esn`единый сельскохозяйственный налог
`patent` -патентная СН
agentНастройки агенсткой схемы (указывается только если вы используте агентскую схему работы)
type
`bank_paying_agent`Банковский платежный агент. Оказание услуг покупателю (клиенту) пользователем, являющимся банковским платежным агентом.
`bank_paying_subagent`Банковский платежный субагент. Оказание услуг покупателю (клиенту) пользователем, являющимся банковским платежным субагентом.
`paying_agent`Платежный агент. Оказание услуг покупателю (клиенту) пользователем, являющимся платежным агентом.
`paying_subagent`Платежный субагент. Оказание услуг покупателю (клиенту) пользователем, являющимся платежным субагентом.
`attorney`Поверенный. Осуществление расчета с покупателем (клиентом) пользователем, являющимся поверенным.
`commission_agent`Комиссионер.Осуществление расчета с покупателем (клиентом) пользователем, являющимся комиссионером.
`another`Другой тип агента. Осуществление расчета с покупателем (клиентом) пользователем, являющимся агентом и не являющимся банковским платежным агентом (субагентом), платежным агентом (субагентом), поверенным, комиссионером.

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/atolOnlineSettings/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"settingId":1,"login":"login","password":"1234","kktGroup":"group_code_19642","isProduction":1,"company":{"inn":"1234567890","taxSystem":"usn_income"},"agent":{"type":"another"}}'
Тело запроса
{
  "settingId": 1,
  "login": "login",
  "password": "1234",
  "kktGroup": "group_code_19642",
  "isProduction": 1,
  "company": {
    "inn": "1234567890",
    "taxSystem": "usn_income"
  },
  "agent": {
    "type": "another"
  }
}

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

Удаленная фискализация с Pechka54 #

GETПолучение настроек#

/pechka54Settings

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/pechka54Settings' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
urlСсылка для интеграции Pechka54 c сервером iRECA

Журнал изменений заказов #

GETПолучить список изменений заказа#

/journal?entityId={entityId}&startedAt={startedAt}&page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
entityIdИдентификатор заказа209897
startedAtДата и время с которого требуется получить список изменений2021-06-30 10:48:46
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)10

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/journal?entityId=209897&startedAt=2021-06-30%2010:48:46&page=0&count=10' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
eventНаименование события
Members
`create`Заказ был создан
`update`Заказ был изменен
sourceНаименование источника инициировавшего изменение
courierIdИдентификатор курьера
createdAtДата и время события
beforeItemЗначение данных до изменений (Важно! Присутствуют только измененные параметры)
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
frReceiptStatusIdОпределяет состояние чека в фискальном регистраторе (распечатан/не распечатан)
courierIdИдентификатор курьера
clientIdИдентификатор клиента
supplierIdИдентификатор поставщика (агентская схема)
paymentIdТип платежа
amountToPayСумма к оплате без учета скидки
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
client
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
addressToEntity
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
isReturnedОпределяет, что по этому заказу выполнен возврат
isEditedОпределяет, что у заказа редактировались позиции
isRefundОпределяет, что этот заказ на возврат
descriptionОписание заказа
afterItemЗначение данных после изменений (Важно! Присутствуют только измененные параметры)
statusIdСтатус заказа
deliveryStatusIdСтатус состояния доставки заказа
isAgreedОпределяет, что заказ согласован
returnReasonIdПричина отмены заказа
frReceiptStatusIdОпределяет состояние чека в фискальном регистраторе (распечатан/не распечатан)
courierIdИдентификатор курьера
clientIdИдентификатор клиента
supplierIdИдентификатор поставщика (агентская схема)
paymentIdТип платежа
amountToPayСумма к оплате без учета скидки
phoneтелефон (если не задан используется телефон клиента)
deliveryTimeFromДата и время начиная с которого требуется доставить заказ
deliveryTimeToДата и время к которому требуется доставить заказ
client
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
addressToEntity
firstnameИмя клиента
lastnameФамилия клиента
innИНН клиента
emailEmail клиента
isReturnedОпределяет, что по этому заказу выполнен возврат
isEditedОпределяет, что у заказа редактировались позиции
isRefundОпределяет, что этот заказ на возврат
descriptionОписание заказа
Тело ответа
[
  {
    "event": "create",
    "source": "http://site.com",
    "courierId": null,
    "createdAt": "2021-04-20 12:11:07",
    "beforeItem": null,
    "afterItem": null
  },
  {
    "event": "update",
    "source": "Application: iRECA Courier",
    "courierId": "12345",
    "createdAt": "2021-04-20 13:31:30",
    "beforeItem": {
      "statusId": 0,
      "frReceiptStatusId": 0
    },
    "afterItem": {
      "statusId": 1,
      "frReceiptStatusId": 1
    }
  },
  {
    "event": "update",
    "source": "Application: iRECA Courier",
    "courierId": "12345",
    "createdAt": "2021-04-20 13:31:32",
    "beforeItem": {
      "deliveryStatusId": 7
    },
    "afterItem": {
      "deliveryStatusId": 9
    }
  },
  {
    "event": "update",
    "source": "Application: iRECA Courier",
    "courierId": "12345",
    "createdAt": "2021-04-20 13:33:24",
    "beforeItem": {
      "deliveryStatusId": 9
    },
    "afterItem": {
      "deliveryStatusId": 10
    }
  }
]

Каталог товаров #

Общие параметры раздела

ПараметрТипОписаниеПример
goodIdИдентификатор позиции заказа355866

POSTСоздание товаров#

/goods

Тело запроса

ПолеТипОписание
goodIdИдентификатор товара в вашей системе
articleАртикул товара
parentIdИдентификатор родительского элемента
taxIdИдентификатор налоговой ставки
calcIdПризнак предмета расчета
titleНаименование товара
unitЕдиница измерения товара
weightВес товара
multiplicityКратность (шаг инкрементирования/декриментирования товара при его редактировании в приложении)
priceЦена
descriptionОписание товара
imageUrlСсылка на изображение
imageBigUrlСсылка на изображение
warehousesСписок складов на которых есть этот товар
элемент массива
warehouseIdИдентификатор склада в вашей системе
countКоличество товара на складе

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/goods' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"parentId":null,"goodId":"1","article":"G-1","taxId":"8284","calcId":0,"title":"Варенье яблочное FL","unit":"г","weight":"370","multiplicity":1,"price":179.5,"description":"","imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png"}]'
Тело запроса
[
  {
    "parentId": null,
    "goodId": "1",
    "article": "G-1",
    "taxId": "8284",
    "calcId": 0,
    "title": "Варенье яблочное FL",
    "unit": "г",
    "weight": "370",
    "multiplicity": 1,
    "price": 179.5,
    "description": "",
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных товара#

/goods?goodId={goodId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
goodIdИдентификатор позиции заказа355866

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/goods?goodId=355866' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние товара: 0 - удален; 1 - активен.
Тело ответа
{
  "parentId": null,
  "goodId": "355866",
  "article": "G-567",
  "taxId": "8284",
  "calcId": 0,
  "title": "Варенье вишня FL",
  "unit": "г",
  "weight": "370",
  "multiplicity": 1,
  "price": 179.5,
  "description": "",
  "imageUrl": "http://example.com/image.png",
  "imageBigUrl": "http://example.com/image_big.png",
  "isActive": 1
}

GETПолучение списка товаров#

/goods?page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/goods?page=0&count=5' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние товара: 0 - удален; 1 - активен.
Тело ответа
[
  {
    "parentId": null,
    "goodId": "355866",
    "article": "G-567",
    "taxId": "8284",
    "calcId": 0,
    "title": "Варенье вишня FL",
    "unit": "г",
    "weight": "370",
    "multiplicity": 1,
    "price": 179.5,
    "description": "",
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png",
    "isActive": 1
  },
  {
    "parentId": null,
    "goodId": "355865",
    "article": "",
    "taxId": "8284",
    "calcId": 0,
    "title": "Доставка",
    "unit": "",
    "weight": "0",
    "multiplicity": 1,
    "price": 500,
    "description": "",
    "imageUrl": "",
    "imageBigUrl": "",
    "isActive": 1
  }
]

PUTРедактирование товара#

/goods?goodId={goodId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
goodIdИдентификатор позиции заказа355866

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/goods?goodId=355866' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"parentId":null,"goodId":"355866","article":"G-567","taxId":"8284","calcId":0,"title":"Варенье вишня FL (updated)","unit":"г","weight":"370","multiplicity":1,"price":179.5,"description":"","imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png","isActive":1}'
Тело запроса
{
  "parentId": null,
  "goodId": "355866",
  "article": "G-567",
  "taxId": "8284",
  "calcId": 0,
  "title": "Варенье вишня FL (updated)",
  "unit": "г",
  "weight": "370",
  "multiplicity": 1,
  "price": 179.5,
  "description": "",
  "imageUrl": "http://example.com/image.png",
  "imageBigUrl": "http://example.com/image_big.png",
  "isActive": 1
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование товаров#

/goods/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/goods/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"parentId":null,"goodId":"355866","article":"G-567","taxId":"8284","calcId":0,"title":"Варенье вишня FL (replaced)","unit":"г","weight":"370","multiplicity":1,"price":179.5,"description":"","imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png","isActive":1}]'
Тело запроса
[
  {
    "parentId": null,
    "goodId": "355866",
    "article": "G-567",
    "taxId": "8284",
    "calcId": 0,
    "title": "Варенье вишня FL (replaced)",
    "unit": "г",
    "weight": "370",
    "multiplicity": 1,
    "price": 179.5,
    "description": "",
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png",
    "isActive": 1
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление товара#

/goods?goodId={goodId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
goodIdИдентификатор позиции заказа355866

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/goods?goodId=355866' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Характеристики #

Общие параметры раздела

ПараметрТипОписаниеПример
specificityIdИдентификатор характеристики товара26

POSTСоздание характеристик#

/specificities

Тело запроса

ПолеТипОписание
specificityIdИдентификатор характеристики в вашей системе
parentIdИдентификатор характеристики элемента
titleНаименование характеристики
valueЗначение характеристики
priceЦена характеристика
imageUrlСсылка на изображение
imageBigUrlСсылка на изображение
articleАртикул специфики

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/specificities' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"specificityId":1,"parentId":null,"title":"Новая характеристика","value":"Новое значение","price":"250.00","imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png","article":"DP-385-7"}]'
Тело запроса
[
  {
    "specificityId": 1,
    "parentId": null,
    "title": "Новая характеристика",
    "value": "Новое значение",
    "price": "250.00",
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png",
    "article": "DP-385-7"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных характеристик#

/specificities?specificityId={specificityId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
specificityIdИдентификатор характеристики товара26

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/specificities?specificityId=26' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние специфики: 0 - удален; 1 - активен.
Тело ответа
{
  "parentId": null,
  "specificityId": "26",
  "title": "Цвет",
  "value": "Синий",
  "price": 10.5,
  "imageUrl": "http://example.com/image.png",
  "imageBigUrl": "http://example.com/image_big.png",
  "isActive": 1,
  "article": "AM-3245"
}

GETПолучение списка характеристик#

/specificities?page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/specificities?page=0&count=5' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние товара: 0 - удален; 1 - активен.
Тело ответа
[
  {
    "parentId": null,
    "specificityId": "24",
    "title": "Пакет (полиэтиленовый)",
    "value": "",
    "price": 5,
    "imageUrl": "",
    "imageBigUrl": "",
    "isActive": 1,
    "article": "AM-3243"
  },
  {
    "parentId": null,
    "specificityId": "25",
    "title": "Пакет бумажный",
    "value": "",
    "price": 10.5,
    "imageUrl": "",
    "imageBigUrl": "",
    "isActive": 1,
    "article": "AM-3244"
  },
  {
    "parentId": null,
    "specificityId": "26",
    "title": "Цвет",
    "value": "Синий",
    "price": 10.5,
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png",
    "isActive": 1,
    "article": "AM-3245"
  }
]

PUTРедактирование характеристики#

/specificities?specificityId={specificityId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
specificityIdИдентификатор характеристики товара26

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/specificities?specificityId=26' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"parentId":null,"specificityId":"26","title":"Цвет (updated)","value":"Синий (updated)","price":10.5,"imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png","article":"AM-3245"}'
Тело запроса
{
  "parentId": null,
  "specificityId": "26",
  "title": "Цвет (updated)",
  "value": "Синий (updated)",
  "price": 10.5,
  "imageUrl": "http://example.com/image.png",
  "imageBigUrl": "http://example.com/image_big.png",
  "article": "AM-3245"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование характеристики#

/specificities/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/specificities/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"parentId":null,"specificityId":"26","title":"Цвет (replaced)","value":"Синий (replaced)","price":10.5,"imageUrl":"http://example.com/image.png","imageBigUrl":"http://example.com/image_big.png","article":"AM-3245"}]'
Тело запроса
[
  {
    "parentId": null,
    "specificityId": "26",
    "title": "Цвет (replaced)",
    "value": "Синий (replaced)",
    "price": 10.5,
    "imageUrl": "http://example.com/image.png",
    "imageBigUrl": "http://example.com/image_big.png",
    "article": "AM-3245"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление характеристики#

/specificities?specificityId={specificityId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
specificityIdИдентификатор характеристики товара26

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/specificities?specificityId=26' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Склады #

Общие параметры раздела

ПараметрТипОписаниеПример
warehouseIdИдентификатор склада1100

POSTСоздание склада#

/warehouses

Тело запроса

ПолеТипОписание
warehouseIdИдентификатор склада в вашей системе
titleНаименование склада
firstnameИмя отвественного на складе
lastnameФамилия отвественного на складе
phoneТелефон отвественного на складе
cityГород, где расположен склад
streetУлица
houseДом
apartmentОфис
latitudeШирота
longitudeДолгота
descriptionОписание склада

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"warehouseId":"1","title":"Новый склад","firstname":"Иван","lastname":"Венских","phone":"+79063998463","city":"Saint-Petersburg","street":"Nevsky","house":"10","apartment":"55","description":"Наш новый склад"}]'
Тело запроса
[
  {
    "warehouseId": "1",
    "title": "Новый склад",
    "firstname": "Иван",
    "lastname": "Венских",
    "phone": "+79063998463",
    "city": "Saint-Petersburg",
    "street": "Nevsky",
    "house": "10",
    "apartment": "55",
    "description": "Наш новый склад"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных склада#

/warehouses?warehouseId={warehouseId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
warehouseIdИдентификатор склада1100

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses?warehouseId=1100' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние склада: 0 - удален; 1 - активен.
Тело ответа
{
  "warehouseId": "1100",
  "title": "Малый склад",
  "firstname": "Алексей",
  "lastname": "Хранилов",
  "phone": "+79054558899",
  "city": "Санкт-Петербург",
  "street": "пр-т Авиаконструкторов",
  "house": "29к1",
  "apartment": "5",
  "latitude": "0.00000000000000",
  "longitude": "0.00000000000000",
  "description": "",
  "updatedAt": "2021-05-04 15:39:45",
  "isActive": 1
}

GETПолучение списка складов#

/warehouses?page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses?page=0&count=5' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
isActiveОпределяет состояние склада: 0 - удален; 1 - активен.
Тело ответа
[
  {
    "warehouseId": "1099",
    "title": "Главный склад",
    "firstname": "Виктор",
    "lastname": "Складских",
    "phone": "+79054558877",
    "city": "Москва",
    "street": "Мосфильмовская улица",
    "house": "39к3",
    "apartment": "88",
    "latitude": "0.00000000000000",
    "longitude": "0.00000000000000",
    "description": "",
    "updatedAt": "2021-05-04 15:39:45",
    "isActive": 1
  },
  {
    "warehouseId": "1100",
    "title": "Малый склад",
    "firstname": "Алексей",
    "lastname": "Хранилов",
    "phone": "+79054558899",
    "city": "Санкт-Петербург",
    "street": "пр-т Авиаконструкторов",
    "house": "29к1",
    "apartment": "5",
    "latitude": "0.00000000000000",
    "longitude": "0.00000000000000",
    "description": "",
    "updatedAt": "2021-05-04 15:39:45",
    "isActive": 1
  }
]

PUTРедактирование склада#

/warehouses?warehouseId={warehouseId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
warehouseIdИдентификатор склада1100

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses?warehouseId=1100' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"warehouseId":"1100","title":"Малый склад (updated)","firstname":"Алексей (updated)","lastname":"Хранилов (updated)","phone":"+79054558899","city":"Санкт-Петербург","street":"пр-т Авиаконструкторов","house":"29к1","apartment":"5","description":"updated","latitude":"0.00000000000000","longitude":"0.00000000000000"}'
Тело запроса
{
  "warehouseId": "1100",
  "title": "Малый склад (updated)",
  "firstname": "Алексей (updated)",
  "lastname": "Хранилов (updated)",
  "phone": "+79054558899",
  "city": "Санкт-Петербург",
  "street": "пр-т Авиаконструкторов",
  "house": "29к1",
  "apartment": "5",
  "description": "updated",
  "latitude": "0.00000000000000",
  "longitude": "0.00000000000000"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование склада#

/warehouses/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "warehouseId": "1100",
    "title": "Малый склад (replaced)",
    "firstname": "Алексей (replaced)",
    "lastname": "Хранилов (replaced)",
    "phone": "+79054558899",
    "city": "Санкт-Петербург",
    "street": "пр-т Авиаконструкторов",
    "house": "29к1",
    "apartment": "5",
    "description": "replaced",
    "latitude": "0.00000000000000",
    "longitude": "0.00000000000000"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление склада#

/warehouses?warehouseId={warehouseId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
warehouseIdИдентификатор склада1100

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/warehouses?warehouseId=1100' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Курьер #

Общие параметры раздела

ПараметрТипОписаниеПример
courierIdидентификатор курьера в вашей системе55753

POSTСоздание курьеров#

/couriers

Тело запроса

ПолеТипОписание
courierIdИдентификатор курьера в вашей системе
titleИмя и фамилия курьера
emailEmail курьера
phoneТелефон курьера
roleIdРоль пользователя приложения
sourcePasswordИсходный пароль.
innИНН кассира

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/couriers' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"courierId":1,"title":"Новый курьер","email":"courier@email.ru","phone":"+79062893689","roleId":null,"sourcePassword":"1","inn":"1234567890"}]'
Тело запроса
[
  {
    "courierId": 1,
    "title": "Новый курьер",
    "email": "courier@email.ru",
    "phone": "+79062893689",
    "roleId": null,
    "sourcePassword": "1",
    "inn": "1234567890"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных курьера#

/couriers?courierId={courierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
courierIdидентификатор курьера в вашей системе55753

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/couriers?courierId=55753' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "courierId": "55753",
  "title": "Алексей Вестов",
  "email": "vestov@email.com",
  "phone": "+9999999999",
  "roleId": "908",
  "sourcePassword": "2321",
  "inn": "",
  "updatedAt": "2016-11-11 14:51:46"
}

GETПолучение списка курьеров#

/couriers

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/couriers' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "courierId": "55752",
    "title": "Алексей Быстров",
    "email": "abistrov@email.com",
    "phone": "+8888888888",
    "roleId": "908",
    "sourcePassword": "1124",
    "inn": "",
    "updatedAt": "2016-11-11 14:51:46"
  },
  {
    "courierId": "55753",
    "title": "Алексей Вестов",
    "email": "vestov@email.com",
    "phone": "+9999999999",
    "roleId": "908",
    "sourcePassword": "2321",
    "inn": "",
    "updatedAt": "2016-11-11 14:51:46"
  }
]

PUTРедактирование данных курьера#

/couriers?courierId={courierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
courierIdидентификатор курьера в вашей системе55753

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/couriers?courierId=55753' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"courierId":"55753","title":"Алексей Вестов (updated)","email":"vestov@email.com","phone":"+9999999999","roleId":"908","sourcePassword":"2321","inn":"","updatedAt":"2016-11-11 14:51:46"}'
Тело запроса
{
  "courierId": "55753",
  "title": "Алексей Вестов (updated)",
  "email": "vestov@email.com",
  "phone": "+9999999999",
  "roleId": "908",
  "sourcePassword": "2321",
  "inn": "",
  "updatedAt": "2016-11-11 14:51:46"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование курьеров#

/couriers/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/couriers/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"courierId":"55753","title":"Алексей Вестов (replaced)","email":"vestov@email.com","phone":"+9999999999","roleId":"908","sourcePassword":"2321","inn":"","updatedAt":"2016-11-11 14:51:46"}]'
Тело запроса
[
  {
    "courierId": "55753",
    "title": "Алексей Вестов (replaced)",
    "email": "vestov@email.com",
    "phone": "+9999999999",
    "roleId": "908",
    "sourcePassword": "2321",
    "inn": "",
    "updatedAt": "2016-11-11 14:51:46"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление курьера#

/couriers?courierId={courierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
courierIdидентификатор курьера в вашей системе55753

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/couriers?courierId=55753' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Роли приложения #

Общие параметры раздела

ПараметрТипОписаниеПример
roleIdидентификатор роли в вашей системе910

POSTСоздание роли#

/userRoles

Тело запроса

ПолеТипОписание
roleIdИдентификатор роли в вашей системе
titleНаименование роли

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"roleId":1,"title":"Новая роль пользователя приложения"}]'
Тело запроса
[
  {
    "roleId": 1,
    "title": "Новая роль пользователя приложения"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных роли#

/userRoles?roleId={roleId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
roleIdидентификатор роли в вашей системе910

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles?roleId=910' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "roleId": 910,
  "title": "Менеджер",
  "isActive": 1
}

GETПолучение списка ролей#

/userRoles

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "roleId": 908,
    "title": "Курьер",
    "isActive": 1
  },
  {
    "roleId": 909,
    "title": "Кассир",
    "isActive": 1
  },
  {
    "roleId": 910,
    "title": "Менеджер",
    "isActive": 1
  }
]

PUTРедактирование роли#

/userRoles?roleId={roleId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
roleIdидентификатор роли в вашей системе910

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles?roleId=910' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"roleId":910,"title":"Менеджер (updated)"}'
Тело запроса
{
  "roleId": 910,
  "title": "Менеджер (updated)"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование роли#

/userRoles/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"roleId":910,"title":"Менеджер (replaced)"}]'
Тело запроса
[
  {
    "roleId": 910,
    "title": "Менеджер (replaced)"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление роли#

/userRoles?roleId={roleId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
roleIdидентификатор роли в вашей системе910

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/userRoles?roleId=910' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Настройки доступа #

Права доступа поддерживаются на всех устройствах, кроме Эвотор.

Общие параметры раздела

ПараметрТипОписаниеПример
roleIdИдентификатор роли908
permissionIdИдентификатор настройки доступаregistratorShiftOpen

GETПолучение списка настроек доступа#

/permissions?roleId={roleId}&permissionId={permissionId}

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/permissions?roleId=908&permissionId=registratorShiftOpen' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "roleId": 908,
    "actionId": "registratorShiftOpen",
    "roleTitle": "Курьер",
    "isAllowed": "1",
    "description": "Открывает смену для ФР",
    "updatedAt": "2021-05-04 15:39:36"
  }
]

POSTУстановка/сброс настройки доступа#

/permissions/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/permissions/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"roleId":908,"actionId":"registratorShiftOpen","isAllowed":"1"}]'
Тело запроса
[
  {
    "roleId": 908,
    "actionId": "registratorShiftOpen",
    "isAllowed": "1"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Клиент #

Общие параметры раздела

ПараметрТипОписаниеПример
clientIdидентификатор клиента в вашей системе3272

POSTСоздание клиентов#

/clients

Тело запроса

ПолеТипОписание
clientIdИдентификатор клиента в вашей системе
titleНаименование компании
firstnameИмя клиента
lastnameФамилия клиента
birthdayДень рождения клиента
addressEntity
cityГород
streetУлица
homeДом
apartmentНомер офиса или квартиры
innИНН клиента
phoneТелефон клиента
emailАдрес клиента
descriptionОписание клиента

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/clients' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "clientId": 1,
    "title": "Компания нового клиента",
    "firstname": "Дмитрий",
    "lastname": "Новиков",
    "birthday": "1989-03-11",
    "addressEntity": {
      "city": "Санкт-Петербург",
      "street": "пр-кт Заневский",
      "home": "25",
      "apartment": "3"
    },
    "inn": "111122223333",
    "phone": "+7(812)2354788",
    "email": "ivanow@email.com",
    "description": "Наш новый клиент"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных клиента#

/clients?clientId={clientId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
clientIdидентификатор клиента в вашей системе3272

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/clients?clientId=3272' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "clientId": 3272,
  "title": "ООО 'АДМИРАЛ'",
  "firstname": "Андрей",
  "lastname": "Лекалов",
  "birthday": "1986-01-14",
  "addressEntity": {
    "postindex": "",
    "city": "Санкт-Петербург",
    "street": "пр-кт Луначарского",
    "home": "52",
    "apartment": "176",
    "latitude": "60.03442720000000",
    "longitude": "30.37392440000000"
  },
  "inn": "1234567891",
  "phone": "+999999999",
  "email": "lecalov@email.com",
  "description": "",
  "updatedAt": "2017-08-27 17:52:06"
}

GETПолучение списка клиентов#

/clients

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/clients' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "clientId": 1,
    "title": "ООО 'АДМИРАЛ'",
    "firstname": "Алексей",
    "lastname": "Иванов",
    "birthday": "1994-04-12",
    "addressEntity": {
      "city": "Санкт-Петербург",
      "street": "пр-кт Культуры",
      "home": "48",
      "apartment": "59"
    },
    "inn": "1234567890",
    "phone": "+7(812)2354788",
    "email": "ivanow@email.com",
    "description": "Наш ключевой клиент",
    "updatedAt": "2017-08-27 17:52:06"
  },
  {
    "clientId": 3272,
    "title": "ООО 'СИТИ'",
    "firstname": "Андрей",
    "lastname": "Лекалов",
    "birthday": "1986-01-14",
    "addressEntity": {
      "city": "Санкт-Петербург",
      "street": "пр-кт Луначарского",
      "home": "52",
      "apartment": "176"
    },
    "inn": "1234567891",
    "phone": "+999999999",
    "email": "lecalov@email.com",
    "description": "",
    "updatedAt": "2017-08-27 17:52:06"
  }
]

PUTРедактирование данных клиента#

/clients?clientId={clientId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
clientIdидентификатор клиента в вашей системе3272

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/clients?clientId=3272' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
{
  "clientId": 3272,
  "title": "ООО 'СИТИ' (updated)",
  "firstname": "Андрей (updated)",
  "lastname": "Лекалов (updated)",
  "birthday": "1986-01-14",
  "addressEntity": {
    "city": "Санкт-Петербург",
    "street": "пр-кт Луначарского",
    "home": "52",
    "apartment": "176"
  },
  "inn": "1234567891",
  "phone": "+999999999",
  "email": "lecalov@email.com",
  "description": "updated"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование клиента#

/clients/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/clients/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d @request.json
Тело запроса
[
  {
    "clientId": 3272,
    "title": "ООО 'СИТИ' (replaced)",
    "firstname": "Андрей (replaced)",
    "lastname": "Лекалов (replaced)",
    "birthday": "1986-01-14",
    "addressEntity": {
      "city": "Санкт-Петербург",
      "street": "пр-кт Луначарского",
      "home": "52",
      "apartment": "176"
    },
    "inn": "1234567891",
    "phone": "+999999999",
    "email": "lecalov@email.com",
    "description": "replaced"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление клиента#

/clients?clientId={clientId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
clientIdидентификатор клиента в вашей системе3272

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/clients?clientId=3272' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Поставщики #

Предназначены для использования агентской схемы

Общие параметры раздела

ПараметрТипОписаниеПример
supplierIdИдентификатор поставщика52

POSTСоздание поставщика#

/suppliers

Тело запроса

ПолеТипОписание
supplierIdИдентификатор поставщика в вашей системе
titleНаименование поставщика
taxIdИдентификатор налоговой ставки
innИНН поставщика
phoneТелефон поставщика
addressАдрес поставщика
descriptionОписание поставщика

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"supplierId":"1","title":"Новый поставщик","taxId":"5","inn":"1234567890","phone":"+79062558463","address":"Санкт-Петербург, ул. Передовиков, дом 25, кв.16","description":"Описание"}]'
Тело запроса
[
  {
    "supplierId": "1",
    "title": "Новый поставщик",
    "taxId": "5",
    "inn": "1234567890",
    "phone": "+79062558463",
    "address": "Санкт-Петербург, ул. Передовиков, дом 25, кв.16",
    "description": "Описание"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение данных поставщика#

/suppliers?supplierId={supplierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
supplierIdИдентификатор поставщика52

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers?supplierId=52' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "supplierId": "52",
  "title": "ИП Пост",
  "taxId": "5",
  "inn": "1234567891",
  "phone": "+78123254411",
  "address": "Санкт-Петербург, пр-т Заневский д 12к2",
  "description": "Разработчик ПО"
}

GETПолучение списка поставщиков#

/suppliers?page={page}&count={count}

Параметры запроса

ПараметрТипОписаниеПример
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers?page=0&count=5' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "supplierId": "51",
    "title": "ИП Иванов",
    "taxId": "5",
    "inn": "1234567890",
    "phone": "+78123254400",
    "address": "Санкт-Петербург, пр-т Заневский д 30к2",
    "description": "Системный интегратор и разработчик программного обеспечения"
  },
  {
    "supplierId": "52",
    "title": "ИП Пост",
    "taxId": "5",
    "inn": "1234567891",
    "phone": "+78123254411",
    "address": "Санкт-Петербург, пр-т Заневский д 12к2",
    "description": "Разработчик ПО"
  }
]

PUTРедактирование поставщика#

/suppliers?supplierId={supplierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
supplierIdИдентификатор поставщика52

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers?supplierId=52' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"supplierId":"52","title":"ИП Пост (updated)","taxId":"5","inn":"1234567891","phone":"+78123254411","address":"Санкт-Петербург, пр-т Заневский д 12к2 (updated)","description":"Разработчик ПО (updated)"}'
Тело запроса
{
  "supplierId": "52",
  "title": "ИП Пост (updated)",
  "taxId": "5",
  "inn": "1234567891",
  "phone": "+78123254411",
  "address": "Санкт-Петербург, пр-т Заневский д 12к2 (updated)",
  "description": "Разработчик ПО (updated)"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование поставщика#

/suppliers/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"supplierId":"52","title":"ИП Пост (replaced)","taxId":"5","inn":"1234567891","phone":"+78123254411","address":"Санкт-Петербург, пр-т Заневский д 12к2 (replaced)","description":"Разработчик ПО (replaced)"}]'
Тело запроса
[
  {
    "supplierId": "52",
    "title": "ИП Пост (replaced)",
    "taxId": "5",
    "inn": "1234567891",
    "phone": "+78123254411",
    "address": "Санкт-Петербург, пр-т Заневский д 12к2 (replaced)",
    "description": "Разработчик ПО (replaced)"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление поставщика#

/suppliers?supplierId={supplierId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
supplierIdИдентификатор поставщика52

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/suppliers?supplierId=52' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Управление лицензиями #

GETСписок курьеров использующих лицензии#

/licenses

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/licenses' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "licenseUse": 2,
  "licenseTotal": 50,
  "licenses": [
    {
      "courierId": 1,
      "deviceId": "3ebf391b3c596bc8",
      "deviceTitle": "asus ME301T",
      "sessionStartAt": "2017-05-14 13:21:13"
    }
  ]
}

POSTОсвободить лицензию#

/licenses/close?deviceId={deviceId}

Параметры запроса

ПараметрТипОписаниеПример
deviceIdИдентификатор устройства64fa00ec9ffc4b99

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/licenses/close?deviceId=64fa00ec9ffc4b99' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTУстанавливает callback на закрытие сессии курьера#

/licenses/callback

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/licenses/callback' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"url":"http://example.com/session-closed-callback","isActive":1}'
Тело запроса
{
  "url": "http://example.com/session-closed-callback",
  "isActive": 1
}

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

POSTЗапрос на заданный callback URL#

/example

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/example' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"sessionId":1,"courierId":27,"deviceId":"3ebf391b3c596bc8","deviceTitle":"asus ME301T","sessionStartAt":"2017-05-15 13:21:13","sessionFinishAt":"2017-05-15 20:21:13"}'
Тело запроса
{
  "sessionId": 1,
  "courierId": 27,
  "deviceId": "3ebf391b3c596bc8",
  "deviceTitle": "asus ME301T",
  "sessionStartAt": "2017-05-15 13:21:13",
  "sessionFinishAt": "2017-05-15 20:21:13"
}

Ответ

201Объект создан

Пример тела ответа в исходной документации не приведён.

Ошибки банковского терминала #

GETПолучить список ошибок#

/bankTerminalLogs?orderId={orderId}&courierId={courierId}&count={count}&page={page}

Параметры запроса

ПараметрТипОписаниеПример
orderIdИдентификатор заказа209897
courierIdИдентификатор курьера55752
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/bankTerminalLogs?orderId=209897&courierId=55752&count=5&page=0' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
terminalLogIdУникальный идентификатор чека в системе iRECA
courierIdИдентификатор курьера
errorCodeКод ошибки
errorTextНаименование ошибки
cardNumberНомер карты
paymentSystemТип платежной системы
serialNumberСерийный номер
amountСумма оплаты
orderIdИдентификатор заказа
transactionCreatedAtДата и время выполнения операции

Ошибки фискального регистратора #

GETПолучить список ошибок#

/fiscalRegistratorLogs?orderId={orderId}&courierId={courierId}&count={count}&page={page}

Параметры запроса

ПараметрТипОписаниеПример
orderIdИдентификатор заказа209897
courierIdИдентификатор курьера55752
pageНомер страницы0
countКоличество элементов на страницу (по умолчанию - 20, максимум - 500)5

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/fiscalRegistratorLogs?orderId=209897&courierId=55752&count=5&page=0' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Поле ответаТипОписание
frIdУникальный идентификатор чека в системе iRECA
courierIdИдентификатор курьера
errorCodeКод ошибки
errorTextНаименование ошибки
serialNumberСерийный номер
amountСумма оплаты
orderIdИдентификатор заказа
commandExecutedAtДата и время выполнения операции

Причины отмены заказа #

Общие параметры раздела

ПараметрТипОписаниеПример
reasonIdИдентификатор ФР5279

POSTСоздание причин отказа#

/orderReturnReasons

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"reasonId":1,"title":"Новая причина отказа"}]'
Тело запроса
[
  {
    "reasonId": 1,
    "title": "Новая причина отказа"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение причины отказа#

/orderReturnReasons?reasonId={reasonId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
reasonIdИдентификатор ФР5279

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons?reasonId=5279' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "reasonId": "5279",
  "title": "Клиент передумал",
  "type": "standard"
}

GETПолучение списка причин отказа#

/orderReturnReasons

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "reasonId": "5276",
    "title": "Пожелание клиента",
    "type": "standard"
  },
  {
    "reasonId": "5277",
    "title": "Товар испорчен",
    "type": "standard"
  },
  {
    "reasonId": "5278",
    "title": "Клиент передумал",
    "type": "standard"
  },
  {
    "reasonId": "5279",
    "title": "Клиент не присутствовал на месте",
    "type": "standard"
  }
]

PUTРедактирование причины отказа#

/orderReturnReasons?reasonId={reasonId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
reasonIdИдентификатор ФР5279

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons?reasonId=5279' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Клиент не присутствовал на месте (updated)"}'
Тело запроса
{
  "title": "Клиент не присутствовал на месте (updated)"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование причин отказа#

/orderReturnReasons/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"reasonId":"5279","title":"Клиент не присутствовал на месте (replaced)"}]'
Тело запроса
[
  {
    "reasonId": "5279",
    "title": "Клиент не присутствовал на месте (replaced)"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление причины отказа#

/orderReturnReasons?reasonId={reasonId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
reasonIdИдентификатор ФР5279

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/orderReturnReasons?reasonId=5279' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Типы платежей #

Общие параметры раздела

ПараметрТипОписаниеПример
paymentTypeIdИдентификатор Типа платежа в вашей системе4116

POSTСоздание типов платежей#

/paymentTypes

Тело запроса

ПолеТипОписание
closeTypeIdОпределяет тип платежа в ФРпример: 2

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"paymentTypeId":1,"closeTypeId":2,"title":"Банковская карта 3"}]'
Тело запроса
[
  {
    "paymentTypeId": 1,
    "closeTypeId": 2,
    "title": "Банковская карта 3"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение типа платежа#

/paymentTypes?paymentTypeId={paymentTypeId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
paymentTypeIdИдентификатор Типа платежа в вашей системе4116

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes?paymentTypeId=4116' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "title": "Банковская карта 2",
  "closeTypeId": 2,
  "updatedAt": "2017-07-04 10:25:11"
}

GETПолучение списка типов платежей#

/paymentTypes

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "paymentTypeId": "4115",
    "title": "Предоплата",
    "closeTypeId": 3,
    "updatedAt": "2021-04-29 12:08:50"
  },
  {
    "paymentTypeId": "4114",
    "title": "Банковская карта",
    "closeTypeId": 2,
    "updatedAt": "2017-07-04 10:25:11"
  },
  {
    "paymentTypeId": "4116",
    "title": "Банковская карта 2",
    "closeTypeId": 2,
    "updatedAt": "2021-04-29 13:55:42"
  },
  {
    "paymentTypeId": "4113",
    "title": "Наличные",
    "closeTypeId": 1,
    "updatedAt": "2017-07-04 10:25:11"
  }
]

PUTРедактирование типа платежа#

/paymentTypes?paymentTypeId={paymentTypeId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
paymentTypeIdИдентификатор Типа платежа в вашей системе4116

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes?paymentTypeId=4116' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Банковская карта 2 (updated)","closeTypeId":1}'
Тело запроса
{
  "title": "Банковская карта 2 (updated)",
  "closeTypeId": 1
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование типов платежей#

/paymentTypes/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"paymentTypeId":"4116","title":"Банковская карта 2 (replaced)","closeTypeId":2}]'
Тело запроса
[
  {
    "paymentTypeId": "4116",
    "title": "Банковская карта 2 (replaced)",
    "closeTypeId": 2
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление типа платежа#

/paymentTypes?paymentTypeId={paymentTypeId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
paymentTypeIdИдентификатор Типа платежа в вашей системе4116

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/paymentTypes?paymentTypeId=4116' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Налоговые ставки #

Общие параметры раздела

ПараметрТипОписаниеПример
taxIdИдентификатор налоговой ставки8285

POSTСоздание налоговых ставок#

/taxes

Тело запроса

ПолеТипОписание
taxIdИдентификатор налоговой ставки
titleНаименование налоговой ставки

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/taxes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"taxId":"1","title":"10%/110%"}]'
Тело запроса
[
  {
    "taxId": "1",
    "title": "10%/110%"
  }
]

Ответ

201Объект создан · application/json

Пример тела ответа в исходной документации не приведён.

GETПолучение налоговой ставки#

/taxes?taxId={taxId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
taxIdИдентификатор налоговой ставки8285

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/taxes?taxId=8285' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
{
  "title": "10%/110%"
}

GETПолучение списка налоговых ставок#

/taxes

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/taxes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json
Тело ответа
[
  {
    "taxId": "8289",
    "title": "БезНДС"
  },
  {
    "taxId": "8286",
    "title": "20%"
  },
  {
    "taxId": "8285",
    "title": "10%"
  },
  {
    "taxId": "8284",
    "title": "0%"
  }
]

PUTРедактирование налоговой ставки#

/taxes?taxId={taxId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
taxIdИдентификатор налоговой ставки8285

Пример запроса

curl
curl -X PUT 'https://api-courier-ireca.softbalance.ru/api/v1/taxes?taxId=8285' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '{"title":"20%/120%"}'
Тело запроса
{
  "title": "20%/120%"
}

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

POSTСоздание/Редактирование налоговых ставок#

/taxes/replace

Пример запроса

curl
curl -X POST 'https://api-courier-ireca.softbalance.ru/api/v1/taxes/replace' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1' \
  -H 'Content-Type: application/json' \
  -d '[{"taxId":"8285","title":"20%/120%"}]'
Тело запроса
[
  {
    "taxId": "8285",
    "title": "20%/120%"
  }
]

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

DELETEУдаление налоговой ставки#

/taxes?taxId={taxId}

Параметры запроса

Параметры раздела, применимые к этому методу.

ПараметрТипОписаниеПример
taxIdИдентификатор налоговой ставки8285

Пример запроса

curl
curl -X DELETE 'https://api-courier-ireca.softbalance.ru/api/v1/taxes?taxId=8285' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

204Выполнено успешно, тело ответа пустое

Тело ответа отсутствует — это нормально для кода 204.

Справочники #

GETСписок статусов состояния заказа#

/dictionary/orderStatuses

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/orderStatuses' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

IDЗначение
0Не оплачен
1Оплачен
Показать ответ как JSON
[
  {
    "statusId": 0,
    "title": "Не оплачен"
  },
  {
    "statusId": 1,
    "title": "Оплачен"
  }
]

GETСписок статусов доставки заказа#

/dictionary/orderDeliveryStatuses

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/orderDeliveryStatuses' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

IDЗначение
6Подготовлен
7Заказ взят курьером
9Заказ доставлен
10Заказ закрыт
11Заказ отменен
Показать ответ как JSON
[
  {
    "statusId": 6,
    "title": "Подготовлен"
  },
  {
    "statusId": 7,
    "title": "Заказ взят курьером"
  },
  {
    "statusId": 9,
    "title": "Заказ доставлен"
  },
  {
    "statusId": 10,
    "title": "Заказ закрыт"
  },
  {
    "statusId": 11,
    "title": "Заказ отменен"
  }
]

GETСписок типов платежей в фискальном регистраторе#

/dictionary/closeTypes

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/closeTypes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

IDЗначение
1Наличные
2Банковская карта
Показать ответ как JSON
[
  {
    "closeTypeId": 1,
    "title": "Наличные"
  },
  {
    "closeTypeId": 2,
    "title": "Банковская карта"
  }
]

GETСписок предопределенных значений налоговых ставок#

/dictionary/taxTypes

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/taxTypes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

Значение
20%
10%
20%/120%
10%/110%
0%
Показать ответ как JSON
[
  {
    "title": "20%"
  },
  {
    "title": "10%"
  },
  {
    "title": "20%/120%"
  },
  {
    "title": "10%/110%"
  },
  {
    "title": "0%"
  }
]

GETСписок признаков предмета расчета#

/dictionary/goodCalcTypes

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/goodCalcTypes' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

IDЗначение
0Не используется
1Товар, кроме подакцизного
4Услуга
Показать ответ как JSON
[
  {
    "calcId": 0,
    "title": "Не используется"
  },
  {
    "calcId": 1,
    "title": "Товар, кроме подакцизного"
  },
  {
    "calcId": 4,
    "title": "Услуга"
  }
]

GETСписок настроек доступа пользователей приложения#

/dictionary/permissions

Пример запроса

curl
curl -X GET 'https://api-courier-ireca.softbalance.ru/api/v1/dictionary/permissions' \
  -H 'Authorization: Bearer 4066e3217dfd51753d1f52cb7d033fe1'

Ответ

200Запрос выполнен, данные в теле ответа · application/json

Значения справочника:

ОписаниеИдентификатор
Открывает смену для ФРregistratorShiftOpen
Закрывает смену ФРregistratorShiftClose
Печать чека коррекцииprintCorrectionReceipt
Изменение настроек приложенияchangeSettings
Отмена заказаorderCancel
Редактирование места расчетовupdateAddressTo
Внесение наличныхcashIn
Изъятие наличныхcashOut
Отчет по заказуorderReport
Редактирование позиций доставленного заказаdeliveredOrderItemUpdate
Показать ответ как JSON
[
  {
    "description": "Открывает смену для ФР",
    "permissionId": "registratorShiftOpen"
  },
  {
    "description": "Закрывает смену ФР",
    "permissionId": "registratorShiftClose"
  },
  {
    "description": "Печать чека коррекции",
    "permissionId": "printCorrectionReceipt"
  },
  {
    "description": "Изменение настроек приложения",
    "permissionId": "changeSettings"
  },
  {
    "description": "Отмена заказа",
    "permissionId": "orderCancel"
  },
  {
    "description": "Редактирование места расчетов",
    "permissionId": "updateAddressTo"
  },
  {
    "description": "Внесение наличных",
    "permissionId": "cashIn"
  },
  {
    "description": "Изъятие наличных",
    "permissionId": "cashOut"
  },
  {
    "description": "Отчет по заказу",
    "permissionId": "orderReport"
  },
  {
    "description": "Редактирование позиций доставленного заказа",
    "permissionId": "deliveredOrderItemUpdate"
  }
]

Поддержка #

Контакты

E-mail: ireca@softbalance.ru

Сайт продукта: ireca.ru/courier

Разработчик: СофтБаланс

Что приложить к обращению

  • Метод и полный URL запроса
  • Тело запроса и полученный ответ
  • Код состояния HTTP
  • Дату и время запроса в GMT+00:00

iRECA: Курьер — API v1. Документация подготовлена на основе официального описания API.

Поддержка: ireca@softbalance.ru · ireca.ru/courier