Модификаторы товара

Какие группы модификаторов у товара, по порядку, с правилом выбора и надбавками опций по вариантам.

Загружаем поисковый индекс…

Модификаторы товара

Объекты

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"
Пример ответа · 200
{
  "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-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же 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

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
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
Тело запроса — 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
    }
  ]
}
Пример ответа · 200
{
  "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
    }
  ]
}