Модификаторы товара
Какие группы модификаторов у товара, по порядку, с правилом выбора и надбавками опций по вариантам.
Модификаторы товара
Объекты
ProductModifierGroups
product_idintegerобязательноID товара. Группы версионируются на его карточке: ETag и If-Match несут версию товара.
versionintegerобязательноВерсия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.
groupsмассив objectобязательноГруппы модификаторов товара по порядку показа. В записи — набор целиком.
Поля · 2
group_idintegerобязательноID группы модификаторов (/v1/modifier-groups).
selection_ruleobject или nullобязательноПравило выбора на этом товаре вместо правила группы; null — правило группы.
Поля · 2
min_selectintegerобязательноСколько опций обязательно выбрать на этом товаре.
max_selectinteger или nullобязательноСколько опций можно выбрать на этом товаре; null — без предела.
option_pricesмассив objectобязательноНадбавка и доступность опций на вариантах товара вместо надбавки опции. В записи заменяет переопределения целиком; без поля прежние остаются, кроме принадлежавших снятым группам.
Поля · 4
option_idintegerобязательноID опции из групп товара.
variant_idintegerобязательноID варианта товара.
is_availablebooleanобязательноfalse — на этом варианте опция не предлагается; надбавки у такой строки нет.
price_deltainteger или nullобязательноНадбавка опции на этом варианте, целым в минорных единицах валюты магазина; null только у недоступной опции.
Методы
Группы модификаторов товара и надбавки их опций по вариантам
get/products/{product}/modifier-groups
Scope: catalog:read
Параметры
Путь
productintegerобязательноID товара.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ProductModifierGroups
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/products/{product}/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"product_id": 0,
"version": 0,
"groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"option_prices": [
{
"option_id": 0,
"variant_id": 0,
"is_available": true,
"price_delta": 0
}
]
}Заменить группы модификаторов товара и надбавки их опций по вариантам
put/products/{product}/modifier-groups
Scope: catalog:write
Параметры
Путь
productintegerобязательноID товара.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Тело запроса application/json
groupsмассив objectобязательноГруппы модификаторов товара по порядку показа. В записи — набор целиком.
- Макс. элементов:
- 50
- Без повторов
Поля · 2
group_idintegerобязательноID группы модификаторов (/v1/modifier-groups).
selection_ruleobject или nullПравило выбора на этом товаре вместо правила группы; null — правило группы.
Поля · 2
min_selectintegerСколько опций обязательно выбрать на этом товаре.
- Минимум:
- 0
- Максимум:
- 99
max_selectinteger или nullСколько опций можно выбрать на этом товаре; null — без предела.
- Минимум:
- 1
- Максимум:
- 99
option_pricesмассив objectНадбавка и доступность опций на вариантах товара вместо надбавки опции. В записи заменяет переопределения целиком; без поля прежние остаются, кроме принадлежавших снятым группам.
- Макс. элементов:
- 2000
Поля · 4
option_idintegerобязательноID опции из групп товара.
is_availablebooleanобязательноfalse — на этом варианте опция не предлагается; надбавки у такой строки нет.
price_deltainteger или nullНадбавка опции на этом варианте, целым в минорных единицах валюты магазина; null только у недоступной опции.
- Минимум:
- -100000000
- Максимум:
- 100000000
variant_idintegerобязательноID варианта товара.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает ProductModifierGroups
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
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PUT "https://api.saleya.app/v1/products/{product}/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 1
}
}
],
"option_prices": [
{
"option_id": 0,
"is_available": true,
"price_delta": 0,
"variant_id": 0
}
]
}{
"product_id": 0,
"version": 0,
"groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"option_prices": [
{
"option_id": 0,
"variant_id": 0,
"is_available": true,
"price_delta": 0
}
]
}