Группы модификаторов
Выбор к позиции: соусы, добавки, размер порции. Группа задаёт границы выбора, опции — надбавку и состав.
Группы модификаторов
Объекты
ModifierGroup
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullобязательноВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
versionintegerобязательноВерсия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.
nameсловарь stringобязательноНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
min_selectintegerобязательноСколько опций покупатель обязан выбрать: 0 — группа необязательна. Товар может задать своё правило (selection_rule).
max_selectinteger или nullобязательноСколько опций можно выбрать всего, с повторами; null — без предела.
is_activebooleanобязательноfalse — группа выключена: на товарах её не предлагают.
adds_ingredientsbooleanобязательноМеняют ли опции группы состав блюда; опция без своего состава при true делает состав позиции неизвестным (аллергены).
optionsмассив objectобязательноОпции по порядку показа. В записи — набор целиком: строка находит опцию по id или external_id, у найденной пишутся пришедшие поля, строка без опции — новая и несёт name; опция, которой нет в наборе, уходит в архив и снимается из открытых черновиков заказов.
Поля · 12
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullобязательноВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
nameobjectобязательноНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
price_deltaintegerобязательноНадбавка к цене позиции за одну порцию опции, целым в минорных единицах валюты магазина; отрицательная — скидка. Товар может задать свою надбавку по варианту.
max_quantityinteger или nullобязательноСколько раз можно взять эту опцию в одной позиции; null — без своего предела, держит только max_select группы.
duration_minutesinteger или nullобязательноНа сколько минут опция удлиняет услугу по записи, кратно 5; null — не удлиняет. У позиций других видов не действует.
is_activebooleanобязательноfalse — опция выключена и не предлагается.
is_defaultbooleanобязательноОпция выбрана заранее: витрина и касса отмечают её сразу, обязательную группу без выбора ею заполняет сервер.
adds_ingredientsboolean или nullобязательноМеняет ли эта опция состав; null — как у группы (adds_ingredients).
recipe_per_variantbooleanобязательноРасход зависит от блюда: общего состава нет, закладку задаёт тех-карта каждого варианта (option_recipes); без неё на варианте опция не предлагается.
nutritionobject или nullобязательноПищевая ценность одного применения опции, заявленная магазином: все четыре числа или null — тогда её считает состав опции.
Поля · 4
kcalintegerобязательноЭнергия, ккал.
protein_mgintegerобязательноБелки, мг.
fat_mgintegerобязательноЖиры, мг.
carbs_mgintegerобязательноУглеводы, мг.
recipeмассив objectобязательноОбщий состав опции — что она списывает в любом блюде: сырьё и заготовки с закладкой. У опции с расходом по блюду пуст. В записи — список целиком, пустой очищает; без поля состав не трогается.
Поля · 2
variant_idintegerобязательноID варианта товара.
quantitystring или nullобязательноЗакладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу: в составе, но не списывается.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
deleted_atstring (date-time) или nullобязательноКогда запись отправлена в архив; null у живой записи.
Методы
Группы модификаторов с опциями, изменённые с указанного момента
get/modifier-groups
Scope: catalog:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Создать группу модификаторов с опциями
post/modifier-groups
Scope: catalog:write
Параметры
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
nameсловарь string или nullобязательноНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
min_selectintegerСколько опций покупатель обязан выбрать: 0 — группа необязательна. Товар может задать своё правило (selection_rule).
- Минимум:
- 0
- Максимум:
- 99
max_selectinteger или nullСколько опций можно выбрать всего, с повторами; null — без предела.
- Минимум:
- 1
- Максимум:
- 99
is_activebooleanfalse — группа выключена: на товарах её не предлагают.
adds_ingredientsbooleanМеняют ли опции группы состав блюда; опция без своего состава при true делает состав позиции неизвестным (аллергены).
optionsмассив objectобязательноОпции по порядку показа. В записи — набор целиком: строка находит опцию по id или external_id, у найденной пишутся пришедшие поля, строка без опции — новая и несёт name; опция, которой нет в наборе, уходит в архив и снимается из открытых черновиков заказов.
- Мин. элементов:
- 1
- Макс. элементов:
- 100
- Без повторов
Поля · 11
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
price_deltaintegerНадбавка к цене позиции за одну порцию опции, целым в минорных единицах валюты магазина; отрицательная — скидка. Товар может задать свою надбавку по варианту.
- Минимум:
- -100000000
- Максимум:
- 100000000
max_quantityinteger или nullСколько раз можно взять эту опцию в одной позиции; null — без своего предела, держит только max_select группы.
- Минимум:
- 1
- Максимум:
- 99
duration_minutesinteger или nullНа сколько минут опция удлиняет услугу по записи, кратно 5; null — не удлиняет. У позиций других видов не действует.
- Минимум:
- 5
- Максимум:
- 120
is_activebooleanfalse — опция выключена и не предлагается.
is_defaultbooleanОпция выбрана заранее: витрина и касса отмечают её сразу, обязательную группу без выбора ею заполняет сервер.
adds_ingredientsboolean или nullМеняет ли эта опция состав; null — как у группы (adds_ingredients).
recipe_per_variantbooleanРасход зависит от блюда: общего состава нет, закладку задаёт тех-карта каждого варианта (option_recipes); без неё на варианте опция не предлагается.
nutritionobject или nullПищевая ценность одного применения опции, заявленная магазином: все четыре числа или null — тогда её считает состав опции.
Поля · 4
kcalintegerЭнергия, ккал.
- Минимум:
- 0
- Максимум:
- 1000000
protein_mgintegerБелки, мг.
- Минимум:
- 0
- Максимум:
- 100000000
fat_mgintegerЖиры, мг.
- Минимум:
- 0
- Максимум:
- 100000000
carbs_mgintegerУглеводы, мг.
- Минимум:
- 0
- Максимум:
- 100000000
recipeмассив objectОбщий состав опции — что она списывает в любом блюде: сырьё и заготовки с закладкой. У опции с расходом по блюду пуст. В записи — список целиком, пустой очищает; без поля состав не трогается.
- Макс. элементов:
- 100
Поля · 2
variant_idintegerобязательноID варианта товара.
quantitystring или nullобязательноЗакладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу: в составе, но не списывается.
- Макс. длина:
- 32
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
Ответы
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает ModifierGroup
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
record_limit_reachedДостигнут потолок записей - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Группа модификаторов с опциями
get/modifier-groups/{group}
Scope: catalog:read
Параметры
Путь
groupintegerобязательноID группы модификаторов.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ModifierGroup
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Изменить группу модификаторов и её набор опций
patch/modifier-groups/{group}
Scope: catalog:write
Параметры
Путь
groupintegerобязательноID группы модификаторов.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 1
modifier_product_minimumstringУ товаров со своим правилом выбора минимум станет равен числу включённых опций группы, иначе их нельзя будет купить.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Тело запроса application/json
optionsмассив objectОпции по порядку показа. В записи — набор целиком: строка находит опцию по id или external_id, у найденной пишутся пришедшие поля, строка без опции — новая и несёт name; опция, которой нет в наборе, уходит в архив и снимается из открытых черновиков заказов.
- Мин. элементов:
- 1
- Макс. элементов:
- 100
- Без повторов
Поля · 12
idintegerID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
price_deltaintegerНадбавка к цене позиции за одну порцию опции, целым в минорных единицах валюты магазина; отрицательная — скидка. Товар может задать свою надбавку по варианту.
- Минимум:
- -100000000
- Максимум:
- 100000000
max_quantityinteger или nullСколько раз можно взять эту опцию в одной позиции; null — без своего предела, держит только max_select группы.
- Минимум:
- 1
- Максимум:
- 99
duration_minutesinteger или nullНа сколько минут опция удлиняет услугу по записи, кратно 5; null — не удлиняет. У позиций других видов не действует.
- Минимум:
- 5
- Максимум:
- 120
is_activebooleanfalse — опция выключена и не предлагается.
is_defaultbooleanОпция выбрана заранее: витрина и касса отмечают её сразу, обязательную группу без выбора ею заполняет сервер.
adds_ingredientsboolean или nullМеняет ли эта опция состав; null — как у группы (adds_ingredients).
recipe_per_variantbooleanРасход зависит от блюда: общего состава нет, закладку задаёт тех-карта каждого варианта (option_recipes); без неё на варианте опция не предлагается.
nutritionobject или nullПищевая ценность одного применения опции, заявленная магазином: все четыре числа или null — тогда её считает состав опции.
Поля · 4
kcalintegerЭнергия, ккал.
- Минимум:
- 0
- Максимум:
- 1000000
protein_mgintegerБелки, мг.
- Минимум:
- 0
- Максимум:
- 100000000
fat_mgintegerЖиры, мг.
- Минимум:
- 0
- Максимум:
- 100000000
carbs_mgintegerУглеводы, мг.
- Минимум:
- 0
- Максимум:
- 100000000
recipeмассив objectОбщий состав опции — что она списывает в любом блюде: сырьё и заготовки с закладкой. У опции с расходом по блюду пуст. В записи — список целиком, пустой очищает; без поля состав не трогается.
- Макс. элементов:
- 100
Поля · 2
variant_idintegerобязательноID варианта товара.
quantitystring или nullобязательноЗакладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу: в составе, но не списывается.
- Макс. длина:
- 32
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
min_selectintegerСколько опций покупатель обязан выбрать: 0 — группа необязательна. Товар может задать своё правило (selection_rule).
- Минимум:
- 0
- Максимум:
- 99
max_selectinteger или nullСколько опций можно выбрать всего, с повторами; null — без предела.
- Минимум:
- 1
- Максимум:
- 99
is_activebooleanfalse — группа выключена: на товарах её не предлагают.
adds_ingredientsbooleanМеняют ли опции группы состав блюда; опция без своего состава при true делает состав позиции неизвестным (аллергены).
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ModifierGroup
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"options": [
{
"id": 0,
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true,
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Архивировать группу модификаторов
delete/modifier-groups/{group}
Scope: catalog:write
Параметры
Путь
groupintegerобязательноID группы модификаторов.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 1
modifier_group_archivestringАрхив группы снимает её с товаров, ломает выбор в корзинах покупателей и убирает её опции из открытых черновиков заказов.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Ответы
204Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
Без тела
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
in_use_conflictЗапись используется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X DELETE "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'Группа модификаторов по внешнему id
get/modifier-groups/by-external-id/{external_id}
Scope: catalog:read
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ModifierGroup
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/modifier-groups/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Создать или изменить группу модификаторов по внешнему id
patch/modifier-groups/by-external-id/{external_id}
Scope: catalog:write
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 1
modifier_product_minimumstringУ товаров со своим правилом выбора минимум станет равен числу включённых опций группы, иначе их нельзя будет купить.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringETag записи из последнего чтения. Обязателен, если запись с этим внешним id уже есть (иначе 428), и не передаётся, если её нет.
- Пример:
"7"
If-None-Matchstring* — только создать: если запись с этим внешним id уже есть, запрос получит 412.
- Значения:
*
Тело запроса application/json
optionsмассив objectОпции по порядку показа. В записи — набор целиком: строка находит опцию по id или external_id, у найденной пишутся пришедшие поля, строка без опции — новая и несёт name; опция, которой нет в наборе, уходит в архив и снимается из открытых черновиков заказов.
- Мин. элементов:
- 1
- Макс. элементов:
- 100
- Без повторов
Поля · 12
idintegerID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
price_deltaintegerНадбавка к цене позиции за одну порцию опции, целым в минорных единицах валюты магазина; отрицательная — скидка. Товар может задать свою надбавку по варианту.
- Минимум:
- -100000000
- Максимум:
- 100000000
max_quantityinteger или nullСколько раз можно взять эту опцию в одной позиции; null — без своего предела, держит только max_select группы.
- Минимум:
- 1
- Максимум:
- 99
duration_minutesinteger или nullНа сколько минут опция удлиняет услугу по записи, кратно 5; null — не удлиняет. У позиций других видов не действует.
- Минимум:
- 5
- Максимум:
- 120
is_activebooleanfalse — опция выключена и не предлагается.
is_defaultbooleanОпция выбрана заранее: витрина и касса отмечают её сразу, обязательную группу без выбора ею заполняет сервер.
adds_ingredientsboolean или nullМеняет ли эта опция состав; null — как у группы (adds_ingredients).
recipe_per_variantbooleanРасход зависит от блюда: общего состава нет, закладку задаёт тех-карта каждого варианта (option_recipes); без неё на варианте опция не предлагается.
nutritionobject или nullПищевая ценность одного применения опции, заявленная магазином: все четыре числа или null — тогда её считает состав опции.
Поля · 4
kcalintegerЭнергия, ккал.
- Минимум:
- 0
- Максимум:
- 1000000
protein_mgintegerБелки, мг.
- Минимум:
- 0
- Максимум:
- 100000000
fat_mgintegerЖиры, мг.
- Минимум:
- 0
- Максимум:
- 100000000
carbs_mgintegerУглеводы, мг.
- Минимум:
- 0
- Максимум:
- 100000000
recipeмассив objectОбщий состав опции — что она списывает в любом блюде: сырьё и заготовки с закладкой. У опции с расходом по блюду пуст. В записи — список целиком, пустой очищает; без поля состав не трогается.
- Макс. элементов:
- 100
Поля · 2
variant_idintegerобязательноID варианта товара.
quantitystring или nullобязательноЗакладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу: в составе, но не списывается.
- Макс. длина:
- 32
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
min_selectintegerСколько опций покупатель обязан выбрать: 0 — группа необязательна. Товар может задать своё правило (selection_rule).
- Минимум:
- 0
- Максимум:
- 99
max_selectinteger или nullСколько опций можно выбрать всего, с повторами; null — без предела.
- Минимум:
- 1
- Максимум:
- 99
is_activebooleanfalse — группа выключена: на товарах её не предлагают.
adds_ingredientsbooleanМеняют ли опции группы состав блюда; опция без своего состава при true делает состав позиции неизвестным (аллергены).
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ModifierGroup
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает ModifierGroup
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
record_limit_reachedДостигнут потолок записей - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/modifier-groups/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"options": [
{
"id": 0,
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}