Инструкция: интеграция CHIBBIS Partner Notifications API
В этой статье рассказывается, как настроить интеграцию партнера с CHIBBIS через CHIBBIS Partner Notifications API.
Интеграция позволяет:
передавать в CHIBBIS статусы заказа;
передавать в CHIBBIS статусы магазина;
запускать синхронизацию зон доставки, меню и стоп-листа.
Интеграция позволяет:
передавать в CHIBBIS статусы заказа;
передавать в CHIBBIS статусы магазина;
запускать синхронизацию зон доставки, меню и стоп-листа.
важно!
Для подключения партнеру необходимы базовый URL API и ключ авторизации. Эти данные предоставляет команда CHIBBIS.
Содержание:
Что потребуется для подключения
- Получить от команды CHIBBIS базовый URL интеграции.
- Получить ключ для заголовка Authorization.
- Подготовить систему партнера к отправке HTTP POST запросов в формате JSON.
- Согласовать, какие магазины партнера будут участвовать в интеграции и какие значения будут использоваться в поле externalStoreId.
Авторизация
Все методы API требуют передачи ключа авторизации в заголовке Authorization.
POST /partner-triggers/order-status-change HTTP/1.1
Host: <base-url>
Authorization: <api-key>
Content-Type: application/json
POST /partner-triggers/order-status-change HTTP/1.1
Host: <base-url>
Authorization: <api-key>
Content-Type: application/json
Передача статусов заказа
Для уведомления CHIBBIS об изменении статуса заказа используйте метод POST /partner-triggers/order-status-change.
Обязательные поля запроса:
Дополнительно можно передать:
Пример запроса:
{
"externalStoreId": "STORE-001",
"externalOrderId": "EXT-12345",
"newStatus": 7,
"completeBefore": "2025-03-05T14:00:00+03:00",
"comment": "Готовится"
}
Поддерживаемые статусы заказа:
0 — BeingProcessed
1 — Accepted
2 — Delivered
3 — Cancelled
7 — Cooking
8 — Delivering
10 — Ready
Обязательные поля запроса:
- externalStoreId — внешний идентификатор магазина партнера;
- externalOrderId — внешний идентификатор заказа;
- newStatus — новый статус заказа.
Дополнительно можно передать:
- completeBefore — время в формате ISO 8601;
- comment — комментарий к изменению статуса.
Пример запроса:
{
"externalStoreId": "STORE-001",
"externalOrderId": "EXT-12345",
"newStatus": 7,
"completeBefore": "2025-03-05T14:00:00+03:00",
"comment": "Готовится"
}
Поддерживаемые статусы заказа:
0 — BeingProcessed
1 — Accepted
2 — Delivered
3 — Cancelled
7 — Cooking
8 — Delivering
10 — Ready
Передача статусов магазина
Для уведомления CHIBBIS об изменении статуса магазина используйте метод POST /partner-triggers/store-status-change.
Обязательные поля запроса:
Дополнительно можно передать:
⚠️ Параметры closeAfter и openAfter используются только при newStatus = 1 (TemporaryClosed).
Пример запроса:
{
"externalStoreId": "STORE-001",
"newStatus": 1,
"comment": "Технический перерыв",
"openAfter": "2025-03-06T09:00:00+03:00"
}
Поддерживаемые статусы магазина:
0 — Open
1 — TemporaryClosed
2 — Blocked
Обязательные поля запроса:
- externalStoreId — внешний идентификатор магазина партнера;
- newStatus — новый статус магазина.
Дополнительно можно передать:
- comment — комментарий;
- closeAfter — время закрытия в формате ISO 8601;
- openAfter — время открытия в формате ISO 8601.
⚠️ Параметры closeAfter и openAfter используются только при newStatus = 1 (TemporaryClosed).
- Если closeAfter не передан, магазин закроется сразу.
- Если closeAfter передан, магазин закроется в указанное время.
- Если openAfter не передан, магазин не откроется автоматически.
Пример запроса:
{
"externalStoreId": "STORE-001",
"newStatus": 1,
"comment": "Технический перерыв",
"openAfter": "2025-03-06T09:00:00+03:00"
}
Поддерживаемые статусы магазина:
0 — Open
1 — TemporaryClosed
2 — Blocked
Запуск синхронизации данных
Для ручного запуска синхронизаций используются отдельные методы:
POST /partner-triggers/delivery-areas — синхронизация зон доставки;
POST /partner-triggers/menu — синхронизация меню;
POST /partner-triggers/stop-list — синхронизация стоп-листа.
POST /partner-triggers/delivery-areas — синхронизация зон доставки;
POST /partner-triggers/menu — синхронизация меню;
POST /partner-triggers/stop-list — синхронизация стоп-листа.
важно!
Ручной запуск интеграции разрешается на чаще, чем раз в 30 минут.
Во всех трех методах можно передать необязательный query-параметр externalStoreId, чтобы ограничить запуск одним магазином партнера.
POST /partner-triggers/menu?externalStoreId=STORE-001
Authorization: <api-key>
POST /partner-triggers/menu?externalStoreId=STORE-001
Authorization: <api-key>
Проверка интеграции
После настройки рекомендуется выполнить минимальный набор проверок:
- Отправить тестовый статус заказа и убедиться, что CHIBBIS принимает запрос без ошибок.
- Отправить тестовый статус магазина с newStatus = 1 и проверить обработку closeAfter/openAfter.
- Запустить тестовую синхронизацию меню или стоп-листа для одного магазина через externalStoreId.
Что передать в CHIBBIS
Для запуска интеграции со стороны CHIBBIS партнеру необходимо согласовать и передать:
- список магазинов, участвующих в интеграции;
- значения externalStoreId для каждого магазина.