Товары
Карточки товаров: названия, описания, категории, опции и фото. У вариантов свои методы; товар создаётся и пишется вместе с ними.
Товары
Объекты
Product
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
external_idstring или nullобязательноВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
versionintegerобязательноВерсия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.
typestringобязательноВид товара: goods — товар для продажи; dish — блюдо, готовится под заказ; ingredient — сырьё для техкарт; prep — полуфабрикат собственного приготовления; manufactured — продукция собственного производства; meal_program — программа питания по подписке; bundle — набор из других товаров; gift_card — подарочная карта; service — услуга по записи.
- Значения:
goodsdishingredientprepmanufacturedmeal_programbundlegift_cardserviceservice_package
stock_unitobject или nullобязательноЕдиница учёта позиции со складом по мере (сырьё, заготовка, производимый товар): в ней остатки, тех-карты и выход. null у товара и блюда — их единица задаётся осью продажи варианта.
Поля · 3
unitstringобязательноБазовая единица: g — граммы, ml — миллилитры, pcs — штуки. Количества вариантов товара — десятичные строки в этой единице.
- Значения:
gmlpcs
purchase_unitstring или nullобязательноНазвание тары закупки, например кг или коробка; null — позицию закупают в базовой единице.
purchase_quantitystringобязательноСколько базовых единиц в одной таре закупки, десятичной строкой: например, 1000 для килограмма позиции, которую учитывают в граммах.
nameсловарь stringобязательноНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
short_descriptionсловарь stringобязательноКраткое описание по языкам, простой текст для списков товаров.
descriptionсловарь stringобязательноОписание по языкам в Markdown (GitHub Flavored): объект заполненных языков.
slugstringобязательноАдрес товара на витрине, уникальный в магазине.
brand_idinteger или nullобязательноID бренда товара; null, если не задан.
tax_class_idinteger или nullобязательноID налогового класса товара (/v1/tax-classes); null — класс магазина по умолчанию. Продажа запоминает ставку позиции: смена класса меняет только будущие продажи.
category_idsмассив integerобязательноID категорий товара по возрастанию.
primary_category_idinteger или nullобязательноОсновная категория из category_ids; null, если основная не выбрана.
optionsмассив objectобязательноОпции, которыми различаются варианты, например размер или цвет, по порядку.
Поля · 5
idintegerобязательноID опции.
keystringобязательноМашинный ключ опции, уникальный в товаре, например size.
nameсловарь stringобязательноНазвание опции по языкам.
positionintegerобязательноПозиция опции: меньшая идёт первой.
valuesмассив objectобязательноЗначения опции по порядку.
Поля · 4
idintegerобязательноID значения. Варианты ссылаются на него в option_values.
valueсловарь stringобязательноЗначение по языкам, например {"es": "Rojo", "ru": "Красный"}.
swatch_colorstring или nullобязательноЦвет образца, шестнадцатеричный код вида #C0392B; null, если у значения нет образца.
positionintegerобязательноПозиция значения: меньшая идёт первой.
modifier_groupsмассив objectобязательноГруппы модификаторов товара по порядку показа с правилом выбора на этом товаре. Надбавки опций по вариантам — GET /v1/products/{product}/modifier-groups; заменяет группы PUT того же адреса.
Поля · 2
group_idintegerобязательноID группы модификаторов (/v1/modifier-groups).
selection_ruleobject или nullобязательноПравило выбора на этом товаре вместо правила группы; null — правило группы.
Поля · 2
min_selectintegerобязательноСколько опций обязательно выбрать на этом товаре.
max_selectinteger или nullобязательноСколько опций можно выбрать на этом товаре; null — без предела.
mediaмассив objectобязательноФото и видео галереи по порядку: те же объекты, что в /v1/products/{product}/media.
Поля · 7
idintegerобязательноID файла в медиатеке. Файл стоит в галерее товара не больше одного раза.
kindstringобязательноimage — фото, video — видео.
- Значения:
imagevideo
urlstringобязательноПубличный адрес файла.
mimestringобязательноMIME-тип файла, например image/webp.
altсловарь stringобязательноАльтернативный текст по языкам — для экранных чтецов и поисковиков.
positionintegerобязательноМесто в галерее, с нуля.
is_primarybooleanобязательноГлавное фото: витрина показывает его первым.
is_activebooleanобязательноfalse снимает товар с продажи и скрывает его с витрины.
published_atstring (date-time) или nullобязательноКогда товар появляется на витрине; null — сразу.
unpublished_atstring (date-time) или nullобязательноКогда товар уходит с витрины; null — остаётся.
sale_scheduleмассив object или nullобязательноКогда позицию можно заказать — окна недели в часовом поясе магазина; null — всегда. Вне окна товар виден и кладётся в корзину, а оформление сверяет расписание со временем исполнения заказа.
Поля · 3
daysмассив integerобязательноДни окна по ISO: 1 — понедельник, 7 — воскресенье.
fromstringобязательноНачало окна, «HH:MM» по часам магазина.
tostringобязательноКонец окна, «HH:MM», сам момент не входит; «24:00» — до конца дня. Конец раньше начала — окно через полночь, оно принадлежит дню начала.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
deleted_atstring (date-time) или nullобязательноКогда товар отправлен в архив вместе с вариантами; null у живого товара.
Методы
Товары: категории, опции и фото, без вариантов
get/products
Scope: catalog:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/products" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Создать товар вместе с вариантами
post/products
Scope: catalog:write
Параметры
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
nameсловарь string или nullобязательноНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
short_descriptionсловарь string или null или nullКраткое описание по языкам, простой текст для списков товаров.
- Макс. длина:
- 500
descriptionсловарь string или null или nullОписание по языкам в Markdown (GitHub Flavored): объект заполненных языков.
- Макс. длина:
- 50000
slugstringАдрес товара на витрине, уникальный в магазине.
- Макс. длина:
- 160
brand_idinteger или nullID бренда товара; null, если не задан.
tax_class_idinteger или nullID налогового класса товара (/v1/tax-classes); null — класс магазина по умолчанию. Продажа запоминает ставку позиции: смена класса меняет только будущие продажи.
category_idsмассив integerID категорий товара по возрастанию.
primary_category_idinteger или nullОсновная категория из category_ids; null, если основная не выбрана.
is_activebooleanfalse снимает товар с продажи и скрывает его с витрины.
published_atstring (date-time) или nullКогда товар появляется на витрине; null — сразу.
unpublished_atstring (date-time) или nullКогда товар уходит с витрины; null — остаётся.
sale_scheduleмассив object или nullКогда позицию можно заказать — окна недели в часовом поясе магазина; null — всегда. Вне окна товар виден и кладётся в корзину, а оформление сверяет расписание со временем исполнения заказа.
- Макс. элементов:
- 14
Поля · 3
daysмассив integerобязательноДни окна по ISO: 1 — понедельник, 7 — воскресенье.
- Мин. элементов:
- 1
- Макс. элементов:
- 7
- Минимум:
- 1
- Максимум:
- 7
fromstringобязательноНачало окна, «HH:MM» по часам магазина.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
tostringобязательноКонец окна, «HH:MM», сам момент не входит; «24:00» — до конца дня. Конец раньше начала — окно через полночь, оно принадлежит дню начала.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
typestringВид товара: goods — товар для продажи; dish — блюдо, готовится под заказ; ingredient — сырьё для техкарт; prep — полуфабрикат собственного приготовления; manufactured — продукция собственного производства; meal_program — программа питания по подписке; bundle — набор из других товаров; gift_card — подарочная карта; service — услуга по записи.
- Значения:
goodsdishingredientprep
stock_unitobject или nullЕдиница учёта позиции со складом по мере (сырьё, заготовка, производимый товар): в ней остатки, тех-карты и выход. null у товара и блюда — их единица задаётся осью продажи варианта.
Поля · 3
unitstringБазовая единица: g — граммы, ml — миллилитры, pcs — штуки. Количества вариантов товара — десятичные строки в этой единице.
- Значения:
gmlpcs
purchase_unitstring или nullНазвание тары закупки, например кг или коробка; null — позицию закупают в базовой единице.
- Макс. длина:
- 16
purchase_quantitystring или nullСколько базовых единиц в одной таре закупки, десятичной строкой: например, 1000 для килограмма позиции, которую учитывают в граммах.
- Макс. длина:
- 32
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
variantsмассив objectобязательноСтроки вариантов, записываемые вместе с карточкой. Строка находится по своему external_id: вариант товара с этим ID правится присланными полями, без такого — заводится; неупомянутые варианты не трогаются. Для создания товара нужна хотя бы одна строка с ценой.
- Мин. элементов:
- 1
- Макс. элементов:
- 200
Поля · 23
external_idstring или nullВнешний id варианта — его id в вашей системе: ключ, по которому находится строка.
skustring или nullАртикул (SKU); null, если не задан.
- Макс. длина:
- 64
nameсловарь string или null или nullНазвание варианта по языкам, например {"es": "Grande"}.
- Макс. длина:
- 255
priceintegerобязательноЦена за price_per_quantity единиц, целым в минимальных единицах currency.
- Минимум:
- 0
- Максимум:
- 10000000000
track_inventorybooleanМагазин ведёт остаток варианта; false — продаёт без учёта остатка.
is_activebooleanfalse снимает вариант с продажи.
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Основной штрихкод варианта: его печатают этикетки и чеки.
Ответы
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает Product
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
plan_limit_reachedДостигнут лимит тарифа - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/products" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
1
],
"from": "string",
"to": "string"
}
],
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"external_id": "string",
"variants": [
{
"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
}
]
}
]
}{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Товар
get/products/{product}
Scope: catalog:read
Параметры
Путь
productintegerобязательноID товара.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Product
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}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Изменить карточку товара: поля, категории, внешний id
patch/products/{product}
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
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
short_descriptionсловарь string или null или nullКраткое описание по языкам, простой текст для списков товаров.
- Макс. длина:
- 500
descriptionсловарь string или null или nullОписание по языкам в Markdown (GitHub Flavored): объект заполненных языков.
- Макс. длина:
- 50000
slugstringАдрес товара на витрине, уникальный в магазине.
- Макс. длина:
- 160
brand_idinteger или nullID бренда товара; null, если не задан.
tax_class_idinteger или nullID налогового класса товара (/v1/tax-classes); null — класс магазина по умолчанию. Продажа запоминает ставку позиции: смена класса меняет только будущие продажи.
category_idsмассив integerID категорий товара по возрастанию.
primary_category_idinteger или nullОсновная категория из category_ids; null, если основная не выбрана.
is_activebooleanfalse снимает товар с продажи и скрывает его с витрины.
published_atstring (date-time) или nullКогда товар появляется на витрине; null — сразу.
unpublished_atstring (date-time) или nullКогда товар уходит с витрины; null — остаётся.
sale_scheduleмассив object или nullКогда позицию можно заказать — окна недели в часовом поясе магазина; null — всегда. Вне окна товар виден и кладётся в корзину, а оформление сверяет расписание со временем исполнения заказа.
- Макс. элементов:
- 14
Поля · 3
daysмассив integerобязательноДни окна по ISO: 1 — понедельник, 7 — воскресенье.
- Мин. элементов:
- 1
- Макс. элементов:
- 7
- Минимум:
- 1
- Максимум:
- 7
fromstringобязательноНачало окна, «HH:MM» по часам магазина.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
tostringобязательноКонец окна, «HH:MM», сам момент не входит; «24:00» — до конца дня. Конец раньше начала — окно через полночь, оно принадлежит дню начала.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
external_idstring или nullВнешний id — id записи в вашей системе; null, если приложение его не задало. Каждое приложение видит только свои ID.
variantsмассив objectСтроки вариантов, записываемые вместе с карточкой. Строка находится по своему external_id: вариант товара с этим ID правится присланными полями, без такого — заводится; неупомянутые варианты не трогаются. Для создания товара нужна хотя бы одна строка с ценой.
- Мин. элементов:
- 1
- Макс. элементов:
- 200
Поля · 24
external_idstring или nullВнешний id варианта — его id в вашей системе: ключ, по которому находится строка.
skustring или nullАртикул (SKU); null, если не задан.
- Макс. длина:
- 64
nameсловарь string или null или nullНазвание варианта по языкам, например {"es": "Grande"}.
- Макс. длина:
- 255
priceintegerЦена за price_per_quantity единиц, целым в минимальных единицах currency.
- Минимум:
- 0
- Максимум:
- 10000000000
track_inventorybooleanМагазин ведёт остаток варианта; false — продаёт без учёта остатка.
is_activebooleanfalse снимает вариант с продажи.
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 этой опции.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Product
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/products/{product}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
1
],
"from": "string",
"to": "string"
}
],
"external_id": "string",
"variants": [
{
"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
}
]
}
]
}{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Архивировать товар вместе с вариантами
delete/products/{product}
Scope: catalog:write
Параметры
Путь
productintegerобязательноID товара.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 4
recipe_ingredientstringПозиция — ингредиент действующих техкарт и уйдёт из них.
- Мин. длина:
- 64
- Макс. длина:
- 64
production_draftstringЧерновики производственных актов с позицией будут отменены.
- Мин. длина:
- 64
- Макс. длина:
- 64
program_menustringБлюдо уйдёт из меню программ питания по подписке.
- Мин. длина:
- 64
- Макс. длина:
- 64
live_subscriptionsstringПрограмма с действующими подписками уйдёт из продажи.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Ответы
204Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
Без тела
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
in_use_conflictЗапись используется - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X DELETE "https://api.saleya.app/v1/products/{product}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'Товар по внешнему id
get/products/by-external-id/{external_id}
Scope: catalog:read
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Ответы
200Успешно
Заголовки
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Product
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/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Создать или изменить товар вместе с вариантами по внешнему id
patch/products/by-external-id/{external_id}
Scope: catalog:write
Параметры
Путь
external_idstringобязательноВнешний id — id записи в вашей системе.
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringETag записи из последнего чтения. Обязателен, если запись с этим внешним id уже есть (иначе 428), и не передаётся, если её нет.
- Пример:
"7"
If-None-Matchstring* — только создать: если запись с этим внешним id уже есть, запрос получит 412.
- Значения:
*
Тело запроса application/json
nameсловарь string или nullНазвание по языкам: объект заполненных языков, например {"es": "Café", "ru": "Кофе"}.
- Макс. длина:
- 255
short_descriptionсловарь string или null или nullКраткое описание по языкам, простой текст для списков товаров.
- Макс. длина:
- 500
descriptionсловарь string или null или nullОписание по языкам в Markdown (GitHub Flavored): объект заполненных языков.
- Макс. длина:
- 50000
slugstringАдрес товара на витрине, уникальный в магазине.
- Макс. длина:
- 160
brand_idinteger или nullID бренда товара; null, если не задан.
tax_class_idinteger или nullID налогового класса товара (/v1/tax-classes); null — класс магазина по умолчанию. Продажа запоминает ставку позиции: смена класса меняет только будущие продажи.
category_idsмассив integerID категорий товара по возрастанию.
primary_category_idinteger или nullОсновная категория из category_ids; null, если основная не выбрана.
is_activebooleanfalse снимает товар с продажи и скрывает его с витрины.
published_atstring (date-time) или nullКогда товар появляется на витрине; null — сразу.
unpublished_atstring (date-time) или nullКогда товар уходит с витрины; null — остаётся.
sale_scheduleмассив object или nullКогда позицию можно заказать — окна недели в часовом поясе магазина; null — всегда. Вне окна товар виден и кладётся в корзину, а оформление сверяет расписание со временем исполнения заказа.
- Макс. элементов:
- 14
Поля · 3
daysмассив integerобязательноДни окна по ISO: 1 — понедельник, 7 — воскресенье.
- Мин. элементов:
- 1
- Макс. элементов:
- 7
- Минимум:
- 1
- Максимум:
- 7
fromstringобязательноНачало окна, «HH:MM» по часам магазина.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
tostringобязательноКонец окна, «HH:MM», сам момент не входит; «24:00» — до конца дня. Конец раньше начала — окно через полночь, оно принадлежит дню начала.
- Шаблон:
^(?:[01]\d|2[0-3]):[0-5]\d$|^24:00$
typestringВид товара: goods — товар для продажи; dish — блюдо, готовится под заказ; ingredient — сырьё для техкарт; prep — полуфабрикат собственного приготовления; manufactured — продукция собственного производства; meal_program — программа питания по подписке; bundle — набор из других товаров; gift_card — подарочная карта; service — услуга по записи.
- Значения:
goodsdishingredientprep
stock_unitobject или nullЕдиница учёта позиции со складом по мере (сырьё, заготовка, производимый товар): в ней остатки, тех-карты и выход. null у товара и блюда — их единица задаётся осью продажи варианта.
Поля · 3
unitstringБазовая единица: g — граммы, ml — миллилитры, pcs — штуки. Количества вариантов товара — десятичные строки в этой единице.
- Значения:
gmlpcs
purchase_unitstring или nullНазвание тары закупки, например кг или коробка; null — позицию закупают в базовой единице.
- Макс. длина:
- 16
purchase_quantitystring или nullСколько базовых единиц в одной таре закупки, десятичной строкой: например, 1000 для килограмма позиции, которую учитывают в граммах.
- Макс. длина:
- 32
variantsмассив objectСтроки вариантов, записываемые вместе с карточкой. Строка находится по своему external_id: вариант товара с этим ID правится присланными полями, без такого — заводится; неупомянутые варианты не трогаются. Для создания товара нужна хотя бы одна строка с ценой.
- Мин. элементов:
- 1
- Макс. элементов:
- 200
Поля · 24
external_idstring или nullВнешний id варианта — его id в вашей системе: ключ, по которому находится строка.
skustring или nullАртикул (SKU); null, если не задан.
- Макс. длина:
- 64
nameсловарь string или null или nullНазвание варианта по языкам, например {"es": "Grande"}.
- Макс. длина:
- 255
priceintegerЦена за price_per_quantity единиц, целым в минимальных единицах currency.
- Минимум:
- 0
- Максимум:
- 10000000000
track_inventorybooleanМагазин ведёт остаток варианта; false — продаёт без учёта остатка.
is_activebooleanfalse снимает вариант с продажи.
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 этой опции.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Product
201Создано
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
Locationstring (uri)обязательноАдрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.
application/json
Возвращает Product
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
external_id_archivedЗапись с этим внешним id в архиве - 409
external_id_in_useВнешний id занят - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
plan_limit_reachedДостигнут лимит тарифа - 412
precondition_failedЗапись изменилась - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен - 428
precondition_requiredНужен If-Match
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X PATCH "https://api.saleya.app/v1/products/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
1
],
"from": "string",
"to": "string"
}
],
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"variants": [
{
"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
}
]
}
]
}{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Заменить опции товара целиком и разложить по ним его варианты
put/products/{product}/options
Scope: catalog:write
Параметры
Путь
productintegerобязательноID товара.
Строка запроса
consentobjectСогласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.
Поля · 1
variant_axesstringВарианты с одинаковой комбинацией сольются, а названные к архиву уйдут в архив вместе со своими зависимостями.
- Мин. длина:
- 64
- Макс. длина:
- 64
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringобязательноETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.
- Пример:
"7"
Тело запроса application/json
optionsмассив objectобязательноОпции, которыми различаются варианты, например размер или цвет, по порядку.
- Макс. элементов:
- 10
Поля · 4
keystringобязательноМашинный ключ опции, уникальный в товаре, например size.
- Макс. длина:
- 32
- Шаблон:
^[a-z][a-z0-9_]*$
nameсловарь string или nullобязательноНазвание опции по языкам.
- Макс. длина:
- 120
valuesмассив objectобязательноЗначения опции по порядку.
- Мин. элементов:
- 1
- Макс. элементов:
- 50
Поля · 3
valueсловарь string или nullобязательноЗначение по языкам, например {"es": "Rojo", "ru": "Красный"}.
- Макс. длина:
- 120
swatch_colorstring или nullЦвет образца, шестнадцатеричный код вида #C0392B; null, если у значения нет образца.
- Макс. длина:
- 16
- Шаблон:
^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
idinteger или nullID значения. Варианты ссылаются на него в option_values.
idinteger или nullID опции.
variantsмассив objectобязательноРаскладка каждого живого варианта товара: комбинация значений или архив. Вариант, которого нет в раскладке, — отказ: его могли создать после того, как вы прочитали товар.
- Макс. элементов:
- 200
Поля · 3
idintegerобязательноID варианта.
archivebooleantrue — отправить вариант в архив вместо значений.
value_indexesмассив integerЗначения варианта: для каждой опции — индекс значения в options[i].values этого запроса, так называются и новые значения без id.
- Макс. элементов:
- 10
- Минимум:
- 0
- Максимум:
- 49
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
ETagstringобязательноВерсия записи. Передайте её в If-Match, чтобы изменить запись.
- Пример:
"7"
application/json
Возвращает Product
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
412Запись изменилась после чтения: версия в If-Match не текущая
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
428Запросу нужен If-Match с ETag записи
application/problem+json
Возвращает Problem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
consent_requiredНужно согласие на последствия - 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 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}/options" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"options": [
{
"key": "string",
"name": {
"key": "string"
},
"values": [
{
"value": {
"key": "string"
},
"swatch_color": "string",
"id": 0
}
],
"id": 0
}
],
"variants": [
{
"id": 0,
"archive": true,
"value_indexes": [
0
]
}
]
}{
"id": 0,
"external_id": "string",
"version": 0,
"type": "goods",
"stock_unit": {
"unit": "g",
"purchase_unit": "string",
"purchase_quantity": "string"
},
"name": {
"key": "string"
},
"short_description": {
"key": "string"
},
"description": {
"key": "string"
},
"slug": "string",
"brand_id": 0,
"tax_class_id": 0,
"category_ids": [
0
],
"primary_category_id": 0,
"options": [
{
"id": 0,
"key": "string",
"name": {
"key": "string"
},
"position": 0,
"values": [
{
"id": 0,
"value": {
"key": "string"
},
"swatch_color": "string",
"position": 0
}
]
}
],
"modifier_groups": [
{
"group_id": 0,
"selection_rule": {
"min_select": 0,
"max_select": 0
}
}
],
"media": [
{
"id": 0,
"kind": "image",
"url": "string",
"mime": "string",
"alt": {
"key": "string"
},
"position": 0,
"is_primary": true
}
],
"is_active": true,
"published_at": "2026-01-15T12:00:00Z",
"unpublished_at": "2026-01-15T12:00:00Z",
"sale_schedule": [
{
"days": [
0
],
"from": "string",
"to": "string"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}