Варианты

То, что реально продаётся и лежит на складе: артикул, штрихкоды, цены, единица и способ продажи. Варианты правятся под версией карточки своего товара.

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

Варианты

Объекты

Variant

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

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

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

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

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

    Версия карточки товара: варианты правятся под общей версией карточки, поэтому правка любого варианта или карточки сдвигает её.

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

    ID товара.

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

    Артикул (SKU); null, если не задан.

  • nameсловарь stringобязательно

    Название варианта по языкам, например {"es": "Grande"}.

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

    Позиция среди вариантов товара: меньшая идёт первой.

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

    false снимает вариант с продажи.

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

    Штрихкоды варианта.

    Поля · 3
    • valuestringобязательно

      Штрихкод.

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

      Символика: ean13, ean8, upca, upce, code128, code39, gtin, itf, qr, datamatrix или other.

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

      Основной штрихкод варианта: его печатают этикетки и чеки.

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

    Значения опций варианта: по одному значению каждой опции товара.

    Поля · 2
    • option_idintegerобязательно

      ID опции из options товара.

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

      ID значения из values этой опции.

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

    Как продаётся вариант: each — поштучно; weight — на вес; volume — на объём.

    Значения:
    eachweightvolume
  • unitstringобязательно

    Единица всех количеств варианта: pcs — штуки; g — граммы; ml — миллилитры.

    Значения:
    pcsgml
  • quantity_decimalsintegerобязательно

    Знаков после запятой в количествах варианта: 0 у штучного, 3 у весового и объёмного.

    Значения:
    03
  • priceintegerобязательно

    Цена за price_per_quantity единиц, целым в минимальных единицах currency.

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

    Цена до скидки, показывается зачёркнутой; null, если скидки нет.

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

    Цена, как её назначил владелец, в минимальных единицах list_price_currency; null — цена назначена в деньгах учёта (price). У такой позиции price считает система по курсу прайса и во входе его не принимает.

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

    Валюта назначенной цены (прайс магазина в чужой валюте); null — цена в валюте магазина currency. Во входе — валюта прайса магазина или currency.

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

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

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

    За сколько единиц цена, десятичной строкой: за одну штуку или за 1000 — цена килограмма у весового варианта. null, если у весового или объёмного варианта она не задана.

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

    Шаг количества в строке весового или объёмного варианта, в его единице; null, если не задан.

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

    Наименьшее количество в строке весового или объёмного варианта; null, если не задано.

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

    Наибольшее количество в строке весового или объёмного варианта; null, если не задано.

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

    Мера нетто одной штуки: пачка 500 г, бутылка 1000 мл. У упаковки из нескольких единиц другого варианта выводится из него, у фасованной штуки — из её меры; записать можно только у обычного штучного варианта. null у весового и объёмного и у штуки без меры.

    Поля · 2
    • quantitystringобязательно

      Мера десятичной строкой в unit: "500", "0.5".

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

      Единица меры: g — граммы; ml — миллилитры.

      Значения:
      gml
  • sale_starts_atstring (date-time) или nullобязательно

    Когда начинается распродажа: compare_at_price показывается с этого момента; null — без начала.

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

    Когда распродажа заканчивается; null — без конца.

  • cost_price_microinteger или null

    Себестоимость за cost_per_quantity единиц в миллионных долях минимальной единицы currency: 1,50 USD = 150000000. Только со scope costs:read.

  • cost_per_quantitystring

    За сколько единиц себестоимость, десятичной строкой: закупочная единица, например 1000 г. Только со scope costs:read.

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

    Магазин ведёт остаток варианта; false — продаёт без учёта остатка.

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

    У упаковки из нескольких единиц другого варианта — этот вариант. Упаковка продаётся из его остатка, своих уровней остатка у неё нет. null у обычного варианта.

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

    Сколько базового варианта забирает одна штука упаковки, десятичной строкой в единице базового варианта; null у обычного варианта.

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

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

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

    Длина упаковки в миллиметрах; null, если не задана.

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

    Ширина упаковки в миллиметрах; null, если не задана.

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

    Высота упаковки в миллиметрах; null, если не задана.

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

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

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

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

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

    Когда запись отправлена в архив; null у живой записи.

VariantRecipe

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

    Id варианта, которому принадлежит тех-карта: блюдо, заготовка или другая позиция из компонентов.

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

    Id товара варианта. Тех-карта версионируется на его карточке: ETag и If-Match несут версию товара.

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

    Версия карточки товара — счётчик, который сверяет If-Match. Правка тех-карты сдвигает её, тот же состав ещё раз — нет.

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

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

    Поля · 3
    • variant_idintegerобязательно

      Id варианта-компонента: сырья или заготовки магазина.

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

      Закладка компонента на порцию блюда или на партию заготовки, десятичной строкой в единице компонента (stock_unit его товара); null — по вкусу: компонент в составе, но не списывается.

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

      Как производство замеряет компонент: fixed — по плану; captured — взвешивается при производстве; proportional — пересчитывается от взвешенного. Читает только производство заготовок.

      Значения:
      fixedcapturedproportional
  • yield_quantitystring или nullобязательно

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

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

    Закладки опций с расходом по блюду (recipe_per_variant) в этом варианте: блок на каждую такую опцию групп товара. Пустой состав — закладки нет, и на этом варианте опция не предлагается. В записи блок задаёт закладку опции целиком, пустой состав снимает её; опции, которых нет в списке, и раздел без поля не трогаются.

    Поля · 2
    • option_idintegerобязательно

      Id опции с расходом по блюду из групп модификаторов товара.

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

      Что списывает опция, когда её берут к этому варианту: сырьё и заготовки с закладкой.

      Поля · 2
      • variant_idintegerобязательно

        ID варианта товара.

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

        Закладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу.

Методы

Варианты товаров: артикул, штрихкоды, цены и единицы

get/variants

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} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • product_idinteger

    Только записи этого товара.

    Минимум:
    1
  • skustring

    Только вариант с этим артикулом.

    Макс. длина:
    64
  • barcodestring

    Только варианты с этим штрихкодом.

    Макс. длина:
    512

Ответы

200Успешно

application/json

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

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

  • 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/variants" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "external_id": "string",
      "version": 0,
      "product_id": 0,
      "sku": "string",
      "name": {
        "key": "string"
      },
      "position": 0,
      "is_active": true,
      "barcodes": [
        {
          "value": "string",
          "type": "string",
          "is_primary": true
        }
      ],
      "option_values": [
        {
          "option_id": 0,
          "value_id": 0
        }
      ],
      "sold_by": "each",
      "unit": "pcs",
      "quantity_decimals": 0,
      "price": 0,
      "compare_at_price": 0,
      "list_price": 0,
      "list_price_currency": "string",
      "currency": "string",
      "price_per_quantity": "string",
      "measure_step": "string",
      "min_measure_qty": "string",
      "max_measure_qty": "string",
      "net_content": {
        "quantity": "string",
        "unit": "g"
      },
      "sale_starts_at": "2026-01-15T12:00:00Z",
      "sale_ends_at": "2026-01-15T12:00:00Z",
      "cost_price_micro": 0,
      "cost_per_quantity": "string",
      "track_inventory": true,
      "stock_source_variant_id": 0,
      "stock_source_quantity": "string",
      "weight_grams": 0,
      "length_mm": 0,
      "width_mm": 0,
      "height_mm": 0,
      "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/variants

Scope: catalog:write

Параметры

Заголовок

  • Idempotency-Keystring

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

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

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

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

    ID товара.

  • external_idstring или null

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

  • skustring или null

    Артикул (SKU); null, если не задан.

    Макс. длина:
    64
  • nameсловарь string или null или null

    Название варианта по языкам, например {"es": "Grande"}.

    Макс. длина:
    255
  • priceintegerобязательно

    Цена за price_per_quantity единиц, целым в минимальных единицах currency.

    Минимум:
    0
    Максимум:
    10000000000
  • track_inventoryboolean

    Магазин ведёт остаток варианта; false — продаёт без учёта остатка.

  • is_activeboolean

    false снимает вариант с продажи.

  • positioninteger

    Позиция среди вариантов товара: меньшая идёт первой.

    Минимум:
    0
    Максимум:
    2147483647
  • list_priceinteger

    Цена, как её назначил владелец, в минимальных единицах list_price_currency; null — цена назначена в деньгах учёта (price). У такой позиции price считает система по курсу прайса и во входе его не принимает.

    Минимум:
    0
    Максимум:
    10000000000
  • list_price_currencystring или null

    Валюта назначенной цены (прайс магазина в чужой валюте); null — цена в валюте магазина currency. Во входе — валюта прайса магазина или currency.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUBnull
  • compare_at_priceinteger или null

    Цена до скидки, показывается зачёркнутой; null, если скидки нет.

    Максимум:
    10000000000
  • weight_gramsinteger или null

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

    Минимум:
    0
    Максимум:
    2147483647
  • length_mminteger или null

    Длина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • width_mminteger или null

    Ширина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • height_mminteger или null

    Высота упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • sale_starts_atstring (date-time) или null

    Когда начинается распродажа: compare_at_price показывается с этого момента; null — без начала.

  • sale_ends_atstring (date-time) или null

    Когда распродажа заканчивается; null — без конца.

  • sold_bystring

    Как продаётся вариант: each — поштучно; weight — на вес; volume — на объём.

    Значения:
    eachweightvolume
  • price_per_quantitystring или null

    За сколько единиц цена, десятичной строкой: за одну штуку или за 1000 — цена килограмма у весового варианта. null, если у весового или объёмного варианта она не задана.

    Макс. длина:
    32
  • measure_stepstring или null

    Шаг количества в строке весового или объёмного варианта, в его единице; null, если не задан.

    Макс. длина:
    32
  • min_measure_qtystring или null

    Наименьшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • max_measure_qtystring или null

    Наибольшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • net_contentobject

    Мера нетто одной штуки: пачка 500 г, бутылка 1000 мл. У упаковки из нескольких единиц другого варианта выводится из него, у фасованной штуки — из её меры; записать можно только у обычного штучного варианта. null у весового и объёмного и у штуки без меры.

    Поля · 2
    • quantitystring

      Мера десятичной строкой в unit: "500", "0.5".

      Макс. длина:
      32
    • unitstring

      Единица меры: g — граммы; ml — миллилитры.

      Значения:
      gml
  • barcodesмассив object или null

    Штрихкоды варианта.

    Макс. элементов:
    20
    Поля · 3
    • typestringобязательно

      Символика: ean13, ean8, upca, upce, code128, code39, gtin, itf, qr, datamatrix или other.

      Значения:
      ean13ean8upcaupcecode128code39gtinitfqrdatamatrixother
    • valuestringобязательно

      Штрихкод.

    • is_primaryboolean или null

      Основной штрихкод варианта: его печатают этикетки и чеки.

  • option_valuesмассив object

    Значения опций варианта: по одному значению каждой опции товара.

    Макс. элементов:
    10
    Поля · 2
    • option_idintegerобязательно

      ID опции из options товара.

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

      ID значения из values этой опции.

  • stock_source_variant_idinteger или null

    У упаковки из нескольких единиц другого варианта — этот вариант. Упаковка продаётся из его остатка, своих уровней остатка у неё нет. null у обычного варианта.

  • stock_source_quantitystring или null

    Сколько базового варианта забирает одна штука упаковки, десятичной строкой в единице базового варианта; null у обычного варианта.

    Макс. длина:
    32
  • sibling_nameсловарь string или null

    Название по языкам единственного варианта товара, который этот запрос делает одним из нескольких: у единственного варианта своего названия нет, у одного из нескольких оно обязательно.

    Макс. длина:
    255

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает Variant

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

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

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

Пример запроса
curl -X POST "https://api.saleya.app/v1/variants" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "product_id": 0,
  "external_id": "string",
  "sku": "string",
  "name": {
    "key": "string"
  },
  "price": 0,
  "track_inventory": true,
  "is_active": true,
  "position": 0,
  "list_price": 0,
  "list_price_currency": "ARS",
  "compare_at_price": 0,
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "sold_by": "each",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "barcodes": [
    {
      "type": "ean13",
      "value": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "sibling_name": {
    "key": "string"
  }
}
Пример ответа · 201
{
  "id": 0,
  "external_id": "string",
  "version": 0,
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "position": 0,
  "is_active": true,
  "barcodes": [
    {
      "value": "string",
      "type": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "sold_by": "each",
  "unit": "pcs",
  "quantity_decimals": 0,
  "price": 0,
  "compare_at_price": 0,
  "list_price": 0,
  "list_price_currency": "string",
  "currency": "string",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "cost_price_micro": 0,
  "cost_per_quantity": "string",
  "track_inventory": true,
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z",
  "deleted_at": "2026-01-15T12:00:00Z"
}

Вариант товара

get/variants/{variant}

Scope: catalog:read

Параметры

Путь

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

    ID варианта.

Ответы

200Успешно

Заголовки

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

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

    Пример:
    "7"

application/json

Возвращает Variant

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/variants/{variant}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "external_id": "string",
  "version": 0,
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "position": 0,
  "is_active": true,
  "barcodes": [
    {
      "value": "string",
      "type": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "sold_by": "each",
  "unit": "pcs",
  "quantity_decimals": 0,
  "price": 0,
  "compare_at_price": 0,
  "list_price": 0,
  "list_price_currency": "string",
  "currency": "string",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "cost_price_micro": 0,
  "cost_per_quantity": "string",
  "track_inventory": true,
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z",
  "deleted_at": "2026-01-15T12:00:00Z"
}

Изменить вариант товара

patch/variants/{variant}

Scope: catalog:write

Параметры

Путь

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

    ID варианта.

Строка запроса

  • consentobject

    Согласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.

    Поля · 4
    • measure_changestring

      Вариант меняет способ продажи (поштучно или мерой): его остаток, цены и границы пересчитываются.

      Мин. длина:
      64
      Макс. длина:
      64
    • piece_mode_offstring

      Упаковки варианта уйдут в архив, когда он перестаёт продаваться упаковками.

      Мин. длина:
      64
      Макс. длина:
      64
    • stock_sourcestring

      Свой остаток варианта переходит на базовый вариант, и дальше он продаётся из остатка базы.

      Мин. длина:
      64
      Макс. длина:
      64
    • program_menustring

      Блюдо уйдёт из меню программ питания по подписке.

      Мин. длина:
      64
      Макс. длина:
      64

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

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

  • external_idstring или null

    Внешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.

  • skustring или null

    Артикул (SKU); null, если не задан.

    Макс. длина:
    64
  • nameсловарь string или null или null

    Название варианта по языкам, например {"es": "Grande"}.

    Макс. длина:
    255
  • priceinteger

    Цена за price_per_quantity единиц, целым в минимальных единицах currency.

    Минимум:
    0
    Максимум:
    10000000000
  • track_inventoryboolean

    Магазин ведёт остаток варианта; false — продаёт без учёта остатка.

  • is_activeboolean

    false снимает вариант с продажи.

  • positioninteger

    Позиция среди вариантов товара: меньшая идёт первой.

    Минимум:
    0
    Максимум:
    2147483647
  • list_priceinteger

    Цена, как её назначил владелец, в минимальных единицах list_price_currency; null — цена назначена в деньгах учёта (price). У такой позиции price считает система по курсу прайса и во входе его не принимает.

    Минимум:
    0
    Максимум:
    10000000000
  • list_price_currencystring или null

    Валюта назначенной цены (прайс магазина в чужой валюте); null — цена в валюте магазина currency. Во входе — валюта прайса магазина или currency.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUBnull
  • compare_at_priceinteger или null

    Цена до скидки, показывается зачёркнутой; null, если скидки нет.

    Максимум:
    10000000000
  • weight_gramsinteger или null

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

    Минимум:
    0
    Максимум:
    2147483647
  • length_mminteger или null

    Длина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • width_mminteger или null

    Ширина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • height_mminteger или null

    Высота упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • sale_starts_atstring (date-time) или null

    Когда начинается распродажа: compare_at_price показывается с этого момента; null — без начала.

  • sale_ends_atstring (date-time) или null

    Когда распродажа заканчивается; null — без конца.

  • sold_bystring

    Как продаётся вариант: each — поштучно; weight — на вес; volume — на объём.

    Значения:
    eachweightvolume
  • price_per_quantitystring или null

    За сколько единиц цена, десятичной строкой: за одну штуку или за 1000 — цена килограмма у весового варианта. null, если у весового или объёмного варианта она не задана.

    Макс. длина:
    32
  • measure_stepstring или null

    Шаг количества в строке весового или объёмного варианта, в его единице; null, если не задан.

    Макс. длина:
    32
  • min_measure_qtystring или null

    Наименьшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • max_measure_qtystring или null

    Наибольшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • net_contentobject

    Мера нетто одной штуки: пачка 500 г, бутылка 1000 мл. У упаковки из нескольких единиц другого варианта выводится из него, у фасованной штуки — из её меры; записать можно только у обычного штучного варианта. null у весового и объёмного и у штуки без меры.

    Поля · 2
    • quantitystring

      Мера десятичной строкой в unit: "500", "0.5".

      Макс. длина:
      32
    • unitstring

      Единица меры: g — граммы; ml — миллилитры.

      Значения:
      gml
  • barcodesмассив object или null

    Штрихкоды варианта.

    Макс. элементов:
    20
    Поля · 3
    • typestringобязательно

      Символика: ean13, ean8, upca, upce, code128, code39, gtin, itf, qr, datamatrix или other.

      Значения:
      ean13ean8upcaupcecode128code39gtinitfqrdatamatrixother
    • valuestringобязательно

      Штрихкод.

    • is_primaryboolean или null

      Основной штрихкод варианта: его печатают этикетки и чеки.

  • option_valuesмассив object

    Значения опций варианта: по одному значению каждой опции товара.

    Макс. элементов:
    10
    Поля · 2
    • option_idintegerобязательно

      ID опции из options товара.

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

      ID значения из values этой опции.

  • stock_source_variant_idinteger или null

    У упаковки из нескольких единиц другого варианта — этот вариант. Упаковка продаётся из его остатка, своих уровней остатка у неё нет. null у обычного варианта.

  • stock_source_quantitystring или null

    Сколько базового варианта забирает одна штука упаковки, десятичной строкой в единице базового варианта; null у обычного варианта.

    Макс. длина:
    32

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает Variant

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 PATCH "https://api.saleya.app/v1/variants/{variant}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "external_id": "string",
  "sku": "string",
  "name": {
    "key": "string"
  },
  "price": 0,
  "track_inventory": true,
  "is_active": true,
  "position": 0,
  "list_price": 0,
  "list_price_currency": "ARS",
  "compare_at_price": 0,
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "sold_by": "each",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "barcodes": [
    {
      "type": "ean13",
      "value": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string"
}
Пример ответа · 200
{
  "id": 0,
  "external_id": "string",
  "version": 0,
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "position": 0,
  "is_active": true,
  "barcodes": [
    {
      "value": "string",
      "type": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "sold_by": "each",
  "unit": "pcs",
  "quantity_decimals": 0,
  "price": 0,
  "compare_at_price": 0,
  "list_price": 0,
  "list_price_currency": "string",
  "currency": "string",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "cost_price_micro": 0,
  "cost_per_quantity": "string",
  "track_inventory": true,
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z",
  "deleted_at": "2026-01-15T12:00:00Z"
}

Архивировать вариант товара

delete/variants/{variant}

Scope: catalog:write

Параметры

Путь

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

    ID варианта.

Строка запроса

  • consentobject

    Согласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.

    Поля · 4
    • recipe_ingredientstring

      Позиция — ингредиент действующих техкарт и уйдёт из них.

      Мин. длина:
      64
      Макс. длина:
      64
    • production_draftstring

      Черновики производственных актов с позицией будут отменены.

      Мин. длина:
      64
      Макс. длина:
      64
    • program_menustring

      Блюдо уйдёт из меню программ питания по подписке.

      Мин. длина:
      64
      Макс. длина:
      64
    • stock_dependentsstring

      Упаковки, которые продаются из остатка этого варианта, станут обычными вариантами с нулевым остатком.

      Мин. длина:
      64
      Макс. длина:
      64

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

Ответы

204Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

Пример запроса
curl -X DELETE "https://api.saleya.app/v1/variants/{variant}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'

Вариант товара по внешнему id

get/variants/by-external-id/{external_id}

Scope: catalog:read

Параметры

Путь

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

    Внешний id — id записи в вашей системе.

Ответы

200Успешно

Заголовки

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

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

    Пример:
    "7"

application/json

Возвращает Variant

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/variants/by-external-id/{external_id}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "external_id": "string",
  "version": 0,
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "position": 0,
  "is_active": true,
  "barcodes": [
    {
      "value": "string",
      "type": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "sold_by": "each",
  "unit": "pcs",
  "quantity_decimals": 0,
  "price": 0,
  "compare_at_price": 0,
  "list_price": 0,
  "list_price_currency": "string",
  "currency": "string",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "cost_price_micro": 0,
  "cost_per_quantity": "string",
  "track_inventory": true,
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z",
  "deleted_at": "2026-01-15T12:00:00Z"
}

Создать или изменить вариант по внешнему id

patch/variants/by-external-id/{external_id}

Scope: catalog:write

Параметры

Путь

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

    Внешний id — id записи в вашей системе.

Строка запроса

  • consentobject

    Согласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.

    Поля · 4
    • measure_changestring

      Вариант меняет способ продажи (поштучно или мерой): его остаток, цены и границы пересчитываются.

      Мин. длина:
      64
      Макс. длина:
      64
    • piece_mode_offstring

      Упаковки варианта уйдут в архив, когда он перестаёт продаваться упаковками.

      Мин. длина:
      64
      Макс. длина:
      64
    • stock_sourcestring

      Свой остаток варианта переходит на базовый вариант, и дальше он продаётся из остатка базы.

      Мин. длина:
      64
      Макс. длина:
      64
    • program_menustring

      Блюдо уйдёт из меню программ питания по подписке.

      Мин. длина:
      64
      Макс. длина:
      64

Заголовок

  • Idempotency-Keystring

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

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

    ETag записи из последнего чтения. Обязателен, если запись с этим внешним id уже есть (иначе 428), и не передаётся, если её нет.

    Пример:
    "7"
  • If-None-Matchstring

    * — только создать: если запись с этим внешним id уже есть, запрос получит 412.

    Значения:
    *

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

  • product_idinteger

    ID товара.

  • skustring или null

    Артикул (SKU); null, если не задан.

    Макс. длина:
    64
  • nameсловарь string или null или null

    Название варианта по языкам, например {"es": "Grande"}.

    Макс. длина:
    255
  • priceinteger

    Цена за price_per_quantity единиц, целым в минимальных единицах currency.

    Минимум:
    0
    Максимум:
    10000000000
  • track_inventoryboolean

    Магазин ведёт остаток варианта; false — продаёт без учёта остатка.

  • is_activeboolean

    false снимает вариант с продажи.

  • positioninteger

    Позиция среди вариантов товара: меньшая идёт первой.

    Минимум:
    0
    Максимум:
    2147483647
  • list_priceinteger

    Цена, как её назначил владелец, в минимальных единицах list_price_currency; null — цена назначена в деньгах учёта (price). У такой позиции price считает система по курсу прайса и во входе его не принимает.

    Минимум:
    0
    Максимум:
    10000000000
  • list_price_currencystring или null

    Валюта назначенной цены (прайс магазина в чужой валюте); null — цена в валюте магазина currency. Во входе — валюта прайса магазина или currency.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUBnull
  • compare_at_priceinteger или null

    Цена до скидки, показывается зачёркнутой; null, если скидки нет.

    Максимум:
    10000000000
  • weight_gramsinteger или null

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

    Минимум:
    0
    Максимум:
    2147483647
  • length_mminteger или null

    Длина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • width_mminteger или null

    Ширина упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • height_mminteger или null

    Высота упаковки в миллиметрах; null, если не задана.

    Минимум:
    0
    Максимум:
    2147483647
  • sale_starts_atstring (date-time) или null

    Когда начинается распродажа: compare_at_price показывается с этого момента; null — без начала.

  • sale_ends_atstring (date-time) или null

    Когда распродажа заканчивается; null — без конца.

  • sold_bystring

    Как продаётся вариант: each — поштучно; weight — на вес; volume — на объём.

    Значения:
    eachweightvolume
  • price_per_quantitystring или null

    За сколько единиц цена, десятичной строкой: за одну штуку или за 1000 — цена килограмма у весового варианта. null, если у весового или объёмного варианта она не задана.

    Макс. длина:
    32
  • measure_stepstring или null

    Шаг количества в строке весового или объёмного варианта, в его единице; null, если не задан.

    Макс. длина:
    32
  • min_measure_qtystring или null

    Наименьшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • max_measure_qtystring или null

    Наибольшее количество в строке весового или объёмного варианта; null, если не задано.

    Макс. длина:
    32
  • net_contentobject

    Мера нетто одной штуки: пачка 500 г, бутылка 1000 мл. У упаковки из нескольких единиц другого варианта выводится из него, у фасованной штуки — из её меры; записать можно только у обычного штучного варианта. null у весового и объёмного и у штуки без меры.

    Поля · 2
    • quantitystring

      Мера десятичной строкой в unit: "500", "0.5".

      Макс. длина:
      32
    • unitstring

      Единица меры: g — граммы; ml — миллилитры.

      Значения:
      gml
  • barcodesмассив object или null

    Штрихкоды варианта.

    Макс. элементов:
    20
    Поля · 3
    • typestringобязательно

      Символика: ean13, ean8, upca, upce, code128, code39, gtin, itf, qr, datamatrix или other.

      Значения:
      ean13ean8upcaupcecode128code39gtinitfqrdatamatrixother
    • valuestringобязательно

      Штрихкод.

    • is_primaryboolean или null

      Основной штрихкод варианта: его печатают этикетки и чеки.

  • option_valuesмассив object

    Значения опций варианта: по одному значению каждой опции товара.

    Макс. элементов:
    10
    Поля · 2
    • option_idintegerобязательно

      ID опции из options товара.

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

      ID значения из values этой опции.

  • stock_source_variant_idinteger или null

    У упаковки из нескольких единиц другого варианта — этот вариант. Упаковка продаётся из его остатка, своих уровней остатка у неё нет. null у обычного варианта.

  • stock_source_quantitystring или null

    Сколько базового варианта забирает одна штука упаковки, десятичной строкой в единице базового варианта; null у обычного варианта.

    Макс. длина:
    32
  • sibling_nameсловарь string или null

    Название по языкам единственного варианта товара, который этот запрос делает одним из нескольких: у единственного варианта своего названия нет, у одного из нескольких оно обязательно.

    Макс. длина:
    255

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает Variant

201Создано

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает Variant

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

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

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

Пример запроса
curl -X PATCH "https://api.saleya.app/v1/variants/by-external-id/{external_id}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "price": 0,
  "track_inventory": true,
  "is_active": true,
  "position": 0,
  "list_price": 0,
  "list_price_currency": "ARS",
  "compare_at_price": 0,
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "sold_by": "each",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "barcodes": [
    {
      "type": "ean13",
      "value": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "sibling_name": {
    "key": "string"
  }
}
Пример ответа · 200
{
  "id": 0,
  "external_id": "string",
  "version": 0,
  "product_id": 0,
  "sku": "string",
  "name": {
    "key": "string"
  },
  "position": 0,
  "is_active": true,
  "barcodes": [
    {
      "value": "string",
      "type": "string",
      "is_primary": true
    }
  ],
  "option_values": [
    {
      "option_id": 0,
      "value_id": 0
    }
  ],
  "sold_by": "each",
  "unit": "pcs",
  "quantity_decimals": 0,
  "price": 0,
  "compare_at_price": 0,
  "list_price": 0,
  "list_price_currency": "string",
  "currency": "string",
  "price_per_quantity": "string",
  "measure_step": "string",
  "min_measure_qty": "string",
  "max_measure_qty": "string",
  "net_content": {
    "quantity": "string",
    "unit": "g"
  },
  "sale_starts_at": "2026-01-15T12:00:00Z",
  "sale_ends_at": "2026-01-15T12:00:00Z",
  "cost_price_micro": 0,
  "cost_per_quantity": "string",
  "track_inventory": true,
  "stock_source_variant_id": 0,
  "stock_source_quantity": "string",
  "weight_grams": 0,
  "length_mm": 0,
  "width_mm": 0,
  "height_mm": 0,
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z",
  "deleted_at": "2026-01-15T12:00:00Z"
}

Тех-карта варианта: состав и выход заготовки

get/variants/{variant}/recipe

Scope: catalog:read

Параметры

Путь

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

    ID варианта.

Ответы

200Успешно

Заголовки

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

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

    Пример:
    "7"

application/json

Возвращает VariantRecipe

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/variants/{variant}/recipe" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "variant_id": 0,
  "product_id": 0,
  "version": 0,
  "components": [
    {
      "variant_id": 0,
      "quantity": "string",
      "measure_mode": "fixed"
    }
  ],
  "yield_quantity": "string",
  "option_recipes": [
    {
      "option_id": 0,
      "components": [
        {
          "variant_id": 0,
          "quantity": "string"
        }
      ]
    }
  ]
}

Заменить тех-карту варианта: состав и выход заготовки

put/variants/{variant}/recipe

Scope: catalog:write

Параметры

Путь

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

    ID варианта.

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

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

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

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

    Макс. элементов:
    100
    Поля · 3
    • variant_idintegerобязательно

      Id варианта-компонента: сырья или заготовки магазина.

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

      Закладка компонента на порцию блюда или на партию заготовки, десятичной строкой в единице компонента (stock_unit его товара); null — по вкусу: компонент в составе, но не списывается.

      Макс. длина:
      32
    • measure_modestring

      Как производство замеряет компонент: fixed — по плану; captured — взвешивается при производстве; proportional — пересчитывается от взвешенного. Читает только производство заготовок.

      Значения:
      fixedcapturedproportionalby_output
  • yield_quantitystring или null

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

    Макс. длина:
    32
  • option_recipesмассив object

    Закладки опций с расходом по блюду (recipe_per_variant) в этом варианте: блок на каждую такую опцию групп товара. Пустой состав — закладки нет, и на этом варианте опция не предлагается. В записи блок задаёт закладку опции целиком, пустой состав снимает её; опции, которых нет в списке, и раздел без поля не трогаются.

    Макс. элементов:
    50
    Без повторов
    Поля · 2
    • option_idintegerобязательно

      Id опции с расходом по блюду из групп модификаторов товара.

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

      Что списывает опция, когда её берут к этому варианту: сырьё и заготовки с закладкой.

      Макс. элементов:
      100
      Поля · 2
      • variant_idintegerобязательно

        ID варианта товара.

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

        Закладка компонента на одно применение опции, десятичной строкой в единице компонента; null — по вкусу.

        Макс. длина:
        32

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает VariantRecipe

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/variants/{variant}/recipe" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "components": [
    {
      "variant_id": 0,
      "quantity": "string",
      "measure_mode": "fixed"
    }
  ],
  "yield_quantity": "string",
  "option_recipes": [
    {
      "option_id": 0,
      "components": [
        {
          "variant_id": 0,
          "quantity": "string"
        }
      ]
    }
  ]
}
Пример ответа · 200
{
  "variant_id": 0,
  "product_id": 0,
  "version": 0,
  "components": [
    {
      "variant_id": 0,
      "quantity": "string",
      "measure_mode": "fixed"
    }
  ],
  "yield_quantity": "string",
  "option_recipes": [
    {
      "option_id": 0,
      "components": [
        {
          "variant_id": 0,
          "quantity": "string"
        }
      ]
    }
  ]
}