Ручные надбавки прайс-листов

Ручные надбавки опций модификаторов в прайс-листах: для одного варианта позиции или для всех, в валюте прайса и в деньгах учёта.

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

Ручные надбавки прайс-листов

Объекты

PriceListModifierItem

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • price_list_idintegerобязательно

    ID прайс-листа.

  • modifier_option_idintegerобязательно

    ID опции модификатора.

  • variant_idinteger или nullобязательно

    Вариант позиции, для которого надбавка своя; null — надбавка для всех вариантов.

  • price_deltaintegerобязательно

    Надбавка опции в минимальных единицах currency — назначенная надбавка в деньгах учёта магазина.

  • list_price_deltainteger или nullобязательно

    Надбавка, как её назначил владелец, в минимальных единицах list_price_currency; null — назначена в деньгах учёта (price_delta).

  • list_price_currencystring или nullобязательно

    Валюта назначенной надбавки; null — надбавка в валюте магазина currency.

  • currencystringобязательно

    Валюта сумм, код ISO 4217: валюта магазина.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Ручные надбавки опций модификаторов в прайс-листах, изменённые с указанного момента

get/price-list-modifier-items

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_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • price_list_idinteger

    Только надбавки этого прайс-листа.

    Минимум:
    1
  • modifier_option_idinteger

    Только надбавки этой опции во всех листах.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив PriceListModifierItemобязательно

    Записи страницы.

  • 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/price-list-modifier-items" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "price_list_id": 0,
      "modifier_option_id": 0,
      "variant_id": 0,
      "price_delta": 0,
      "list_price_delta": 0,
      "list_price_currency": "string",
      "currency": "string",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_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"
}

Ручная надбавка опции в прайс-листе

get/price-list-modifier-items/{price_list_modifier_item}

Scope: catalog:read

Параметры

Путь

  • price_list_modifier_itemintegerобязательно

    ID ручной надбавки в прайс-листе.

Ответы

200Успешно

application/json

Возвращает PriceListModifierItem

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/price-list-modifier-items/{price_list_modifier_item}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "price_list_id": 0,
  "modifier_option_id": 0,
  "variant_id": 0,
  "price_delta": 0,
  "list_price_delta": 0,
  "list_price_currency": "string",
  "currency": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Задать ручные надбавки опций в прайс-листе пачкой

post/price-lists/{price_list}/modifier-items

Scope: catalog:writeилиorders:wholesale

Параметры

Путь

  • price_liststringобязательно

    ID прайс-листа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • itemsмассив objectобязательно

    Ручные надбавки, до 1000 за запрос, пара «опция, вариант» — один раз. Строка, которая уже есть, получает новую надбавку; пачка пишется целиком или не пишется вовсе.

    Мин. элементов:
    1
    Макс. элементов:
    1000
    Поля · 4
    • modifier_option_idintegerобязательно

      ID опции модификатора (/v1/modifier-groups).

    • variant_idinteger или null

      Вариант, для которого надбавка своя; null или без поля — для всех вариантов позиции. Опцию должна предлагать позиция варианта.

    • price_deltainteger или null

      Надбавка в минорных единицах валюты магазина, может быть отрицательной, — у строки в деньгах магазина: list_price_currency строки null, у новой строки — у опции.

      Минимум:
      -10000000000
      Максимум:
      10000000000
    • list_price_deltainteger или null

      Надбавка в минорных единицах валюты прайса, может быть отрицательной, — у строки в валюте прайса. В деньгах магазина её считает система по курсу.

      Минимум:
      -10000000000
      Максимум:
      10000000000

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает PriceList

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 POST "https://api.saleya.app/v1/price-lists/{price_list}/modifier-items" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "items": [
    {
      "modifier_option_id": 0,
      "variant_id": 0,
      "price_delta": 0,
      "list_price_delta": 0
    }
  ]
}
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "kind": "location",
  "name": "string",
  "adjustment_bp": 0,
  "rounding": {
    "mode": "nearest",
    "precision": 0
  },
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Снять ручные надбавки опций в прайс-листе пачкой

post/price-lists/{price_list}/modifier-items/remove

Scope: catalog:writeилиorders:wholesale

Параметры

Путь

  • price_liststringобязательно

    ID прайс-листа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • itemsмассив objectобязательно

    Ручные надбавки, которые снять, до 1000 за запрос. Пара без ручной надбавки пропускается.

    Мин. элементов:
    1
    Макс. элементов:
    1000
    Поля · 2
    • modifier_option_idintegerобязательно

      ID опции модификатора.

    • variant_idinteger или null

      Вариант, надбавку которого снять; null или без поля — надбавку для всех вариантов.

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает PriceList

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 POST "https://api.saleya.app/v1/price-lists/{price_list}/modifier-items/remove" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "items": [
    {
      "modifier_option_id": 0,
      "variant_id": 0
    }
  ]
}
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "kind": "location",
  "name": "string",
  "adjustment_bp": 0,
  "rounding": {
    "mode": "nearest",
    "precision": 0
  },
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}