Zenky API (v2)

Поддержка API: tech@zenky.io URL: https://openapi.zenky.io/v2/ License: MIT

Последнее обновление: Thu, 03 Sep 2026 19:35:28 GMT

Начало работы

API Zenky.io предоставляет обширный набор методов для работы практически со всеми сущностями системы.

Большинство операций, которые могут быть выполнены в панели управления магазином, можно реализовать с помощью API, в том числе наполнение каталога (создание, редактирование, удаление категорий, товаров, характеристик и т.д.).

Выполнение запросов

Базовый адрес для выполнения запросов к API - https://api.zenky.io/v2. Формат возвращаемых данных - JSON.

HTTP-методы

Каждый метод API может поддерживать один или несколько из перечисленных HTTP-методов:

  • GET для чтения информации;
  • POST для создания нового объекта или для выполнения команд (таких как отправка заказа);
  • PUT для изменения существующего объекта;
  • DELETE для удаления существующего объекта.

Заголовки

Все запросы к API должны выполняться с заголовком Accept: application/json. В некоторых случаях, если заголовок Accept не был передан или его значением не является строка application/json, вы можете получить в ответ HTML-код или перенаправление на внутренние страницы панели управления магазином.

ID магазина

Кроме того, все методы, которые так или иначе связаны с магазином, требуют передачи обязательного HTTP-заголовка X-Store-Id, значением которого должен быть указан идентификатор магазина, с которым в данный момент выполняется работа.

Ответы API

Любой успешный ответ обязательно содержит в себе корневое поле data, в котором, в зависимости от запроса, располагается тело ответа.

Если был выполнен запрос на получение списка объектов, то в поле data будет находиться массив объектов. Если же был выполнен запрос на получение одного объекта, то в поля data будет находиться объект.

Кроме того, на одном уровне с полем data может присутствовать поле meta - в основном оно используется для передачи информации о количестве страниц списка объектов.

Включения ответов

Кроме основной информации об объекте методы могут отдавать расширенную информацию о вложенных сущностях (т.н. включения ответов или includes). У каждого метода, который поддерживает такие включения, имеется свой список возможных включений, которые необходимо передавать с помощью параметра with. Если требуется вернуть несколько включений, их необходимо разделять запятыми.

Включения, которые поддерживаются конкретным методом, перечислены в его описании. Кроме этого, в описании структуры объектов также указаны названия включений тех или иных полей.

Обработка ошибок

Запросы, выполнение которых завершилось с ошибкой, содержат в себе поле error, в котором дано подробное описание произошедшей ошибки. В случае, если вы не можете исправить ошибку самостоятельно или не знаете что именно пошло не так, всегда предоставляйте полное тело ответа при обращении в техподдерж ку.

Возможные коды ошибок и способы их решения перечислены в описании методов.

Магазин

Получить профиль магазина

Этот метод поддерживает следующие включения:

ВключениеОписание
mediaМедиа-файлы магазина
contactsКонтакты магазина
citiesГорода
cities.settingsГорода и настройки
cities.scheduleГорода и режим работы
cities.contactsГорода и контакты
cities.stocksГорода и склады
cities.stocks.addressГорода, склады и адрес склада
cities.stocks.contactsГорода, склады и контакты склада
cities.stocks.scheduleГорода, склады и режим работы склада
cities.stocks.mediaГорода, склады и медиа-файлы склада
cities.delivery_zonesГорода и зоны доставки
settingsНастройки магазина
mobile_app_settingsНастройки канала продаж «Мобильное приложение»
query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Города

Получить список городов

Этот метод поддерживает следующие включения:

ВключениеОписание
settingsНастройки
scheduleРежим работы
contactsКонтакты
stocksСклады
stocks.addressСлады и адрес склада
stocks.contactsСклады и контакты склада
stocks.scheduleСклады и режим работы склада
stocks.mediaСклады и медиа-файлы склада
delivery_zonesЗоны доставки
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать город

Для выполнения этого запроса API токен должен иметь одно из следующих разрешений: catalog.write, catalog.manage.

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название города

timezone
required
string

Часовой пояс города (tzdata)

order_number_reset_at
string

Время сброса номеров заказов (ЧЧ)

lat
number <double>

Широта центра города

lng
number <double>

Долгота центра города

object

Настройки города

Responses

Request samples

Content type
application/json
{
  • "name": "Улан-Удэ",
  • "timezone": "Asia/Irkutsk",
  • "order_number_reset_at": "00",
  • "lat": 51.836438566112,
  • "lng": 107.57642430078,
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить город

Этот метод поддерживает следующие включения:

ВключениеОписание
settingsНастройки
scheduleРежим работы
contactsКонтакты
stocksСклады
stocks.addressСлады и адрес склада
stocks.contactsСклады и контакты склада
stocks.scheduleСклады и режим работы склада
stocks.mediaСклады и медиа-файлы склада
delivery_zonesЗоны доставки
path Parameters
city
required
string

ID города

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить город

Authorizations:
Bearer
path Parameters
city
required
string

ID города

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название города

timezone
required
string

Часовой пояс города (tzdata)

order_number_reset_at
string

Время сброса номеров заказов (ЧЧ)

lat
number <double>

Широта центра города

lng
number <double>

Долгота центра города

object

Настройки города

Responses

Request samples

Content type
application/json
{
  • "name": "Улан-Удэ",
  • "timezone": "Asia/Irkutsk",
  • "order_number_reset_at": "00",
  • "lat": 51.836438566112,
  • "lng": 107.57642430078,
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить город

Authorizations:
Bearer
path Parameters
city
required
string

ID города

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Склады

Получить список складов

Этот метод поддерживает следующие включения:

ВключениеОписание
addressАдрес склада
contactsКонтакты склада
scheduleРежим работы склада
mediaМедиа-файлы склада
external_identifierВнешний идентификатор
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Создать склад

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название склада

display_name
string or null

Публичное название склада

description
string or null

Описание склада

hidden
boolean or null

Флаг скрытия склада

object

Адрес склада

images_id
Array of strings or null

ID изображений

Responses

Request samples

Content type
application/json
{
  • "name": "Еврозона",
  • "display_name": "ТЦ «Еврозона»",
  • "description": null,
  • "hidden": false,
  • "address": {
    },
  • "images_id": [
    ]
}

Response samples

Content type
application/json
{}

Получить склад

Этот метод поддерживает следующие включения:

ВключениеОписание
addressАдрес склада
contactsКонтакты склада
scheduleРежим работы склада
mediaМедиа-файлы склада
external_identifierВнешний идентификатор
path Parameters
stock
required
string

ID склада

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Изменить склад

Authorizations:
Bearer
path Parameters
stock
required
string

ID склада

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название склада

display_name
string or null

Публичное название склада

description
string or null

Описание склада

hidden
boolean or null

Флаг скрытия склада

object

Адрес склада

images_id
Array of strings or null

ID изображений

Responses

Request samples

Content type
application/json
{
  • "name": "Еврозона",
  • "display_name": "ТЦ «Еврозона»",
  • "description": null,
  • "hidden": false,
  • "address": {
    },
  • "images_id": [
    ]
}

Response samples

Content type
application/json
{}

Удалить склад

Authorizations:
Bearer
path Parameters
stock
required
string

ID склада

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Зоны доставки

Получить список зон доставки

path Parameters
city
required
string

ID города

query Parameters
count
integer

Количество записей

page
integer

Номер страницы

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать зону доставки

Authorizations:
Bearer
path Parameters
city
required
string

ID города

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
stock_id
required
string

ID склада

visible
boolean

Статус отображения зоны

active
boolean

Статус работы зоны

name
required
string

Название зоны

Array of objects

Координаты вершин зоны

description
string

Описание зоны

color
string

HEX-код цвета зоны

min_price
number

Минимальная сумма заказа

free_delivery_price
number

Минимальная сумма заказа для бесплатной доставки

delivery_price
number

Стоимость платной доставки

delivery_time
string

Среднее время доставки

Responses

Request samples

Content type
application/json
{
  • "stock_id": "94c72ed9-d25e-4bda-947b-340eae97462e",
  • "visible": true,
  • "active": true,
  • "name": "Первая зона",
  • "coordinates": [
    ],
  • "description": "Первая зона",
  • "color": "#21c07b",
  • "min_price": "2000",
  • "free_delivery_price": "2500",
  • "delivery_price": "500",
  • "delivery_time": "1 час"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить зону доставки

path Parameters
city
required
string

ID города

deliveryZone
required
string

ID зоны доставки

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить зону доставки

Authorizations:
Bearer
path Parameters
city
required
string

ID города

deliveryZone
required
string

ID зоны доставки

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
stock_id
required
string

ID склада

visible
boolean

Статус отображения зоны

active
boolean

Статус работы зоны

name
required
string

Название зоны

Array of objects

Координаты вершин зоны

description
string

Описание зоны

color
string

HEX-код цвета зоны

min_price
number

Минимальная сумма заказа

free_delivery_price
number

Минимальная сумма заказа для бесплатной доставки

delivery_price
number

Стоимость платной доставки

delivery_time
string

Среднее время доставки

Responses

Request samples

Content type
application/json
{
  • "stock_id": "94c72ed9-d25e-4bda-947b-340eae97462e",
  • "visible": true,
  • "active": true,
  • "name": "Первая зона",
  • "coordinates": [
    ],
  • "description": "Первая зона",
  • "color": "#21c07b",
  • "min_price": "2000",
  • "free_delivery_price": "2500",
  • "delivery_price": "500",
  • "delivery_time": "1 час"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить зону доставки

Authorizations:
Bearer
path Parameters
city
required
string

ID города

deliveryZone
required
string

ID зоны доставки

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Проверить вхождение адреса

С помощью этого метода можно проверить в какую зону доставки входит указанный адрес.

path Parameters
city
required
string

ID города

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
delivery_address
required
string

Полный адрес доставки одной строкой

Responses

Request samples

Content type
application/json
{
  • "delivery_address": "г. Улан-Удэ, ул. Жердева, 104Б"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

События

Зарегистрировать события

Используйте этот метод для регистрации пользовательских событий на сайте или в приложении. Зарегистрированные события используются для аналитики товаров, заказов, а также для предложений по улучшению работы магазина.

Подробности работы с событиями читайте в отдельной статье.

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
required
Array of objects (CommerceEventItemPayload)

Список событий

Array
event_id
required
string

Уникальный ID события

event_name
required
string
Enum: "page_viewed" "category_viewed" "products_collection_viewed" "product_viewed" "product_added_to_cart" "product_removed_from_cart" "cart_viewed" "checkout_started" "banner_clicked"

Название события

schema_version
required
number

Версия структуры события. Всегда 1.

occurred_at
required
string

Дата и время создания события в формате ISO-8601. Таймштампы с часовым поясом будут переведены в UTC, таймштампы без часового пояса будут расценены как UTC.

source
required
string
Enum: "web" "mobile"

Источник события

anonymous_id
string

Гостевой ID покупателя

session_id
string

ID текущей сессии

order_id
string

ID связанного заказа. Обязательно для событий product_added_to_cart, product_removed_from_cart, cart_viewed, checkout_started

object

Контекст события

object

Доп. параметры события

Responses

Request samples

Content type
application/json
{
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Категории

Получить дерево категорий

Этот метод поддерживает следующие включения:

ВключениеОписание
settingsНастройки категории
mediaМедиа-файлы категории
seoSEO
external_identifierВнешний идентификатор
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Получить список категорий

Этот метод поддерживает следующие включения:

ВключениеОписание
settingsНастройки категории
mediaМедиа-файлы категории
seoSEO
external_identifierВнешний идентификатор

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

featured
boolean

Вернуть только избранные категории

visibility
string
Default: "visible"
Enum: "visible" "hidden" "all"

Статус отображения категорий
* Параметр доступен только сотрудникам магазина

treeview
boolean

Вернуть дерево категорий вместо обычного списка

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Создать категорию

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название категории

description
string

Описание категории

parent_id
string or null

ID родительской категории

hidden
boolean or null

Скрытая категория

featured
boolean or null

Избранная категория

cover_image_id
string or null

ID изображения обложки

object or null

Настройки категории

Responses

Request samples

Content type
application/json
{
  • "name": "Смартфоны",
  • "description": "<p>Смартфоны различных производителей.</p>",
  • "parent_id": null,
  • "hidden": false,
  • "featured": true,
  • "cover_image_id": "29201a65-3228-47a9-9a6b-44c1ba3c5e02",
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Получить категорию

Этот метод поддерживает следующие включения:

ВключениеОписание
settingsНастройки категории
mediaМедиа-файлы категории
seoSEO
external_identifierВнешний идентификатор
path Parameters
category
required
string

ID категории

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Изменить категорию

Authorizations:
Bearer
path Parameters
category
required
string

ID категории

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название категории

description
string

Описание категории

parent_id
string or null

ID родительской категории

hidden
boolean or null

Скрытая категория

featured
boolean or null

Избранная категория

cover_image_id
string or null

ID изображения обложки

object or null

Настройки категории

Responses

Request samples

Content type
application/json
{
  • "name": "Смартфоны",
  • "description": "<p>Смартфоны различных производителей.</p>",
  • "parent_id": null,
  • "hidden": false,
  • "featured": true,
  • "cover_image_id": "29201a65-3228-47a9-9a6b-44c1ba3c5e02",
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Удалить категорию

Authorizations:
Bearer
path Parameters
category
required
string

ID категории

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Получить список характеристик для категории

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

path Parameters
category
required
string

ID категории

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Получить список групп характеристик для категории

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

path Parameters
category
required
string

ID категории

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Характеристики

Получить список характеристик

Этот метод поддерживает следующие включения:

ВключениеОписание
valuesЗначения характеристики
values.external_identifierЗначения и их внешние идентификаторы
external_identifierВнешний идентификатор характеристики

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

only_filterable
boolean

Вернуть только фильтры

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать характеристику

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название характеристики

field_type
required
string
Enum: "select" "multiple_select" "checkboxes" "radios" "range" "text"

Тип поля

range_type
string
Enum: "integer" "float"

Тип диапазона

filterable
boolean

Характеристика является фильтром

Array of objects

Список значений характеристики

Responses

Request samples

Content type
application/json
{
  • "name": "Объём оперативной памяти",
  • "field_type": "checkboxes",
  • "filterable": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить характеристику

Этот метод поддерживает следующие включения:

ВключениеОписание
valuesЗначения характеристики
values.external_identifierЗначения и их внешние идентификаторы
external_identifierВнешний идентификатор характеристики
path Parameters
feature
required
string

ID характеристики

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить характеристику

Authorizations:
Bearer
path Parameters
feature
required
string

ID характеристики

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название характеристики

field_type
required
string
Enum: "select" "multiple_select" "checkboxes" "radios" "range" "text"

Тип поля

range_type
string
Enum: "integer" "float"

Тип диапазона

filterable
boolean

Характеристика является фильтром

Array of objects

Список значений характеристики

Responses

Request samples

Content type
application/json
{
  • "name": "Объём оперативной памяти",
  • "field_type": "checkboxes",
  • "filterable": true,
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить характеристику

Authorizations:
Bearer
path Parameters
feature
required
string

ID характеристики

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Группы характеристик

Получить список групп характеристик

Этот метод поддерживает следующие включения:

ВключениеОписание
featuresХарактеристики
Authorizations:
Bearer
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

visibility
string
Enum: "visible" "hidden" "all"

Отображение групп

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать группу характеристик

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
visible
required
boolean

Отображение группы

name
required
string

Название группы

description
string

Описание группы

Responses

Request samples

Content type
application/json
{
  • "visible": true,
  • "name": "Внешний вид",
  • "description": "Внешний вид устройств."
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить группу характеристик

Этот метод поддерживает следующие включения:

ВключениеОписание
featuresХарактеристики
Authorizations:
Bearer
path Parameters
featuresGroup
required
string

ID группы характеристик

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить группу характеристик

Authorizations:
Bearer
path Parameters
featuresGroup
required
string

ID группы характеристик

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
visible
required
boolean

Отображение группы

name
required
string

Название группы

description
string

Описание группы

Responses

Request samples

Content type
application/json
{
  • "visible": true,
  • "name": "Внешний вид",
  • "description": "Внешний вид устройств."
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить группу характеристик

Authorizations:
Bearer
path Parameters
featuresGroup
required
string

ID группы характеристик

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Коллекции товаров

Получить список коллекций

Этот метод поддерживает следующие включения:

ВключениеОписание
mediaМедиа-файлы коллекций

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
sortingПо заданной сортировке (asc)
-sortingПо заданной сортировке (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

visibility
string
Default: "visible"
Enum: "visible" "hidden" "all"

Статус отображения коллекций
* Параметр доступен только сотрудникам магазина

app_visibility
string
Default: "visible"
Enum: "visible" "hidden" "all"

Статус отображения коллекций в моб. приложении
* Параметр доступен только сотрудникам магазина

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Создать коллекцию

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название коллекции

description
string

Описание коллекции

selection_type
required
string
Enum: "manual" "criterias"

Тип отбора товаров (manual – ручной отбор, criterias – отбор по критериям)

criteria_match
string
Enum: "all" "any"

Тип сравнения критериев (all – все критерии, режим «AND», any – любой критерий, режим «OR»)

show_in_mobile
boolean

Показывать в мобильном приложении (по умолчанию – false)

hidden
boolean

Скрытая коллекция (по умолчанию – false)

cover_image_id
string

ID изображения-обложки коллекции

Array of objects

Список критериев отбора товаров (если тип отбора – criterias)

products
Array of strings

Список товаров (если тип отбора – manual)

Responses

Request samples

Content type
application/json
{
  • "name": "Аксессуары",
  • "description": "В комплекте нет зарядника? Легко исправить!",
  • "selection_type": "criterias",
  • "criteria_match": "all",
  • "hidden": false,
  • "show_in_mobile": true,
  • "criteria": [
    ]
}

Response samples

Content type
application/json
{}

Получить коллекцию

Этот метод поддерживает следующие включения:

ВключениеОписание
mediaМедиа-файлы коллекции
path Parameters
collection
required
string

ID коллекции

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Изменить коллекцию

Authorizations:
Bearer
path Parameters
collection
required
string

ID коллекции

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название коллекции

description
string

Описание коллекции

selection_type
required
string
Enum: "manual" "criterias"

Тип отбора товаров (manual – ручной отбор, criterias – отбор по критериям)

criteria_match
string
Enum: "all" "any"

Тип сравнения критериев (all – все критерии, режим «AND», any – любой критерий, режим «OR»)

show_in_mobile
boolean

Показывать в мобильном приложении (по умолчанию – false)

hidden
boolean

Скрытая коллекция (по умолчанию – false)

cover_image_id
string

ID изображения-обложки коллекции

Array of objects

Список критериев отбора товаров (если тип отбора – criterias)

removed_criteria
Array of strings

ID удалённых критериев

products
Array of strings

Список товаров (если тип отбора – manual)

removed_products
Array of strings

ID удалённых товаров

Responses

Request samples

Content type
application/json
{
  • "name": "Аксессуары",
  • "description": "В комплекте нет зарядника? Легко исправить!",
  • "selection_type": "criterias",
  • "criteria_match": "all",
  • "hidden": false,
  • "show_in_mobile": true,
  • "criteria": [
    ],
  • "removed_criteria": [
    ]
}

Response samples

Content type
application/json
{}

Удалить коллекцию

Authorizations:
Bearer
path Parameters
collection
required
string

ID коллекции

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Группы товаров

Получить список групп товаров

Этот метод поддерживает следующие включения:

ВключениеОписание
productsТовары
products.variantsТовары и их варианты
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать группу товаров

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название группы

products
required
Array of strings

ID товаров

Responses

Request samples

Content type
application/json
{
  • "name": "Айфоны",
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить группу товаров

Этот метод поддерживает следующие включения:

ВключениеОписание
productsТовары
products.variantsТовары и их варианты
path Parameters
group
required
string

ID группы товаров

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

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

Authorizations:
Bearer
path Parameters
group
required
string

ID группы товаров

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название группы

products
required
Array of strings

ID товаров

Responses

Request samples

Content type
application/json
{
  • "name": "Айфоны",
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить группу товаров

Authorizations:
Bearer
path Parameters
group
required
string

ID группы товаров

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Опции вариантов

Получить список опций вариантов

Этот метод поддерживает следующие включения:

ВключениеОписание
valuesЗначения опции
values.external_identifierЗначения и внешний идентификатор
external_identifierВнешний идентификатор
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать опцию вариантов

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название опции

required
Array of objects

Значения опции

Responses

Request samples

Content type
application/json
{
  • "name": "Объём оперативной памяти",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить опцию вариантов

Этот метод поддерживает следующие включения:

ВключениеОписание
valuesЗначения опции
values.external_identifierЗначения и внешний идентификатор
external_identifierВнешний идентификатор
path Parameters
option
required
string

ID опции вариантов

query Parameters
with
string

Список включений

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

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

path Parameters
option
required
string

ID опции вариантов

Request Body schema: application/json
required
name
required
string

Название опции

required
Array of objects

Значения опции

Responses

Request samples

Content type
application/json
{
  • "name": "Объём оперативной памяти",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить опцию вариантов

path Parameters
option
required
string

ID опции вариантов

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Типы цен

Получить список типов цен

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
kindПо виду (asc)
-kindПо виду (desc)
nameПо названию (asc)
-nameПо названию (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать тип цены

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название типа цены

kind
required
string
Enum: "retail" "wholesale" "purchase"

Вид типа цены

Responses

Request samples

Content type
application/json
{
  • "name": "Розничная",
  • "kind": "retail"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить тип цены

path Parameters
type
required
string

ID типа цены

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить тип цены

Authorizations:
Bearer
path Parameters
type
required
string

ID типа цены

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название типа цены

Responses

Request samples

Content type
application/json
{
  • "name": "Розничная"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить тип цены

Возможные ошибки API

Во время выполнения этого запроса вы можете столкнуться со следующими ошибками:

HTTPКодПричинаРешение
422price_types.in_useВозникает при попытке удалить тип цены, с которым связаны цены.Отвязать цены от этого типа цены.
422price_types.retailВозникает при попытке удалить единственный тип цены с назначением "Розничная" (retail).Создать дополнительный тип цены с назначением "Розничная" (retail) и повторить удаление.
Authorizations:
Bearer
path Parameters
type
required
string

ID типа цены

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

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

Получить список модификаторов

Этот метод возвращает только одиночные (не привязанные ни к одной группе) модификаторы.

Этот метод поддерживает следующие включения:

ВключениеОписание
external_identifierВнешний идентификатор

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
display_nameПо публичному названию (asc)
-display_nameПо публичному названию (desc)
priceПо цене (asc)
-priceПо цене (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
Authorizations:
Bearer
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Создать модификатор

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название модификатора

display_name
string or null

Публичное название модификатора

string or number or null

Цена модификатора

sku
string or null

Артикул модификатора

Responses

Request samples

Content type
application/json
{
  • "name": "Подар. упаковк.",
  • "display_name": "Подарочная упаковка",
  • "price": 100,
  • "sku": "GIFT-WRAPPING-01"
}

Response samples

Content type
application/json
{}

Получить модификатор

Этот метод поддерживает следующие включения:

ВключениеОписание
external_identifierВнешний идентификатор
Authorizations:
Bearer
path Parameters
modifier
required
string

ID модификатора

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Изменить модификатор

Authorizations:
Bearer
path Parameters
modifier
required
string

ID модификатора

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название модификатора

display_name
string or null

Публичное название модификатора

string or number or null

Цена модификатора

sku
string or null

Артикул модификатора

Responses

Request samples

Content type
application/json
{
  • "name": "Подар. упаковк.",
  • "display_name": "Подарочная упаковка",
  • "price": 100,
  • "sku": "GIFT-WRAPPING-01"
}

Response samples

Content type
application/json
{}

Удалить модификатор

Authorizations:
Bearer
path Parameters
modifier
required
string

ID модификатора

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Группы модификаторов

Получить список групп модификаторов

Этот метод поддерживает следующие включения:

ВключениеОписание
modifiersМодификаторы
modifiers.external_identifierМодификаторы и их внешние идентификаторы
external_identifierВнешний идентификатор

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
display_nameПо публичному названию (asc)
-display_nameПо публичному названию (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
Authorizations:
Bearer
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Создать группу модификаторов

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название группы

display_name
string or null

Публичное название группы

required
Array of objects

Список модификаторов

Responses

Request samples

Content type
application/json
{
  • "name": "Apple Care",
  • "display_name": "План «Apple Care»",
  • "modifiers": [
    ]
}

Response samples

Content type
application/json
{}

Получить группу модификаторов

Этот метод поддерживает следующие включения:

ВключениеОписание
modifiersМодификаторы
modifiers.external_identifierМодификаторы и их внешние идентификаторы
external_identifierВнешний идентификатор
Authorizations:
Bearer
path Parameters
group
required
string

ID группы

query Parameters
with
string

Список включений

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{}

Изменить группу модификаторов

Authorizations:
Bearer
path Parameters
group
required
string

ID группы

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
string or null

Название группы

display_name
string or null

Публичное название группы

required
Array of objects

Список модификаторов

Responses

Request samples

Content type
application/json
{
  • "name": "Apple Care",
  • "display_name": "План «Apple Care»",
  • "modifiers": [
    ]
}

Response samples

Content type
application/json
{}

Удалить группу модификаторов

Authorizations:
Bearer
path Parameters
group
required
string

ID группы

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Товары

Получить список товаров

Метод списка товаров поддерживает модификаторы поиска (для параметра search):

  • external:<значение> — поиск по внешнему идентификатору товара (например, products?search=external:1234);
  • barcode:<значение> — поиск по штрихкоду товара (например, products?search=barcode:4601234567890);
  • sku:<значение> — поиск по артикулу товара (например, products?search=sku:SKU12345).

Этот метод поддерживает следующие включения:

ВключениеОписание
mediaИзображения товара
categoriesКатегории
categories.seoКатегории и SEO
featuresХарактеристики
features_groupsГруппы характеристик
modifiersМодификаторы
modifiers.mediaМодификаторы и медиа-файлы
modifiers_groupsГруппы модификаторов
modifiers_groups.mediaГруппы модификаторов и медиа-файлы модификаторов
custom_fieldsПользовательские поля
variantsВарианты товара
variants.pricesВарианты и цены
variants.dimensionsВарианты и габариты
variants.remaindersВарианты и остатки
variants.option_valuesВарианты и значения опций вариантов
variants.option_values.optionВарианты, значения и опции вариантов
variants.external_identifierВарианты и внешние идентификаторы
variants.modifiersВарианты и модификаторы
variants.modifiers_groupsВарианты и группы модификаторов
variants.custom_fieldsВарианты и пользовательские поля
settingsНастройки товара
seoSEO
external_identifierВнешний идентификатор

Этот метод поддерживает следующие поля сортировки (передаются в параметре order_by):

ПолеОписание
nameПо названию (asc)
-nameПо названию (desc)
priceПо цене (asc)
-priceПо цене (desc)
manualПо заданной сортировке (asc)
-manualПо заданной сортировке (desc)
created_atПо дате создания (asc)
-created_atПо дате создания (desc)
updated_atПо дате изменения (asc)
-updated_atПо дате изменения (desc)
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

category_id
string

ID категории

features
Array of strings

ID значений характеристик (ключи - ID характеристик)

f
Array of strings

Алиасы значений характеристик (ключи – алиасы характеристик). Несколько значений можно разделять запятой.

city_id
string

ID города (несовместим с stock_id)

stock_id
string

ID склада (несовместим с city_id)

collection_id
string

ID коллекции товаров

group_id
string

ID группы товаров

number or string

Минимальная цена

number or string

Максимальная цена

visibility
string
Default: "visible"
Enum: "visible" "hidden" "all"

Видимость товаров
* Параметр доступен только сотрудникам магазина

featured_categories
boolean

Товары из избранных категорий

promotion_reward
string
Default: "no"
Enum: "yes" "no" "all"

Товары-подарки за акции

context_type
string
Enum: "category" "group" "variant_option" "variant_option_value"

Тип контекста товаров (используется вместе с context_id)

context_id
string

ID контекста товаров (используется вместе с context_type)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать товар

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название товара

description
string or null

Описание товара

unit_type
string or null
Enum: "piece" "gram" "kilogram" "meter" null

Единица измерения

weight
number or null

Вес в граммах

override_quantity_step
boolean

Перезаписать шаг изменения товара в корзине

quantity_step
number <float>

Шаг изменения товара в корзине (от 0.1 до 1.0 включительно). Требует передачи override_quantity_step=true

images_id
Array of strings or null

ID изображений

hidden
boolean or null

Скрытый товар

ordering_enabled
boolean or null

Товар доступен для заказа

promotion_reward
boolean or null

Товар является подарком за акцию

vat_mode
string or null

Статус НДС

vat
integer or null

Ставка НДС

Array of objects or null

Список вариантов

categories
Array of strings or null

Список ID категорий

Array of objects or null

Список характеристик

Array of objects or null

Список модификаторов

Array of objects or null

Список модификаторов

object or null

Настройки товара

Responses

Request samples

Content type
application/json
{
  • "name": "Apple iPhone 12 Pro Max",
  • "description": "Это iPhone 12 Pro Max.",
  • "unit_type": "piece",
  • "weight": 226,
  • "images_id": [
    ],
  • "hidden": false,
  • "ordering_enabled": true,
  • "promotion_reward": false,
  • "vat_mode": "enabled",
  • "vat": 20,
  • "variants": [
    ],
  • "categories": [
    ],
  • "features": [
    ],
  • "modifiers": [
    ],
  • "modifiers_groups": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить товар

Этот метод поддерживает следующие включения:

ВключениеОписание
mediaИзображения товара
categoriesКатегории
categories.seoКатегории и SEO
featuresХарактеристики
modifiersМодификаторы
modifiers.mediaМодификаторы и медиа-файлы
modifiers_groupsГруппы модификаторов
modifiers_groups.mediaГруппы модификаторов и медиа-файлы модификаторов
custom_fieldsПользовательские поля
variantsВарианты товара
variants.pricesВарианты и цены
variants.dimensionsВарианты и габариты
variants.remaindersВарианты и остатки
variants.option_valuesВарианты и значения опций вариантов
variants.option_values.optionВарианты, значения и опции вариантов
variants.external_identifierВарианты и внешние идентификаторы
variants.modifiersВарианты и модификаторы
variants.modifiers_groupsВарианты и группы модификаторов
variants.custom_fieldsВарианты и пользовательские поля
settingsНастройки товара
seoSEO
external_identifierВнешний идентификатор
path Parameters
product
required
string

ID товара

query Parameters
with
string

Список включений

stock_id
string

ID склада

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

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

Authorizations:
Bearer
path Parameters
product
required
string

ID товара

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название товара

description
string or null

Описание товара

unit_type
string or null
Enum: "piece" "gram" "kilogram" "meter" null

Единица измерения

weight
number or null

Вес в граммах

override_quantity_step
boolean

Перезаписать шаг изменения товара в корзине

quantity_step
number <float>

Шаг изменения товара в корзине (от 0.1 до 1.0 включительно). Требует передачи override_quantity_step=true

images_id
Array of strings or null

ID изображений

hidden
boolean or null

Скрытый товар

ordering_enabled
boolean or null

Товар доступен для заказа

promotion_reward
boolean or null

Товар является подарком за акцию

vat_mode
string or null

Статус НДС

vat
integer or null

Ставка НДС

Array of objects or null

Список вариантов

categories
Array of strings or null

Список ID категорий

Array of objects or null

Список характеристик

Array of objects or null

Список модификаторов

Array of objects or null

Список модификаторов

object or null

Настройки товара

Responses

Request samples

Content type
application/json
{
  • "name": "Apple iPhone 12 Pro Max",
  • "description": "Это iPhone 12 Pro Max.",
  • "unit_type": "piece",
  • "weight": 226,
  • "images_id": [
    ],
  • "hidden": false,
  • "ordering_enabled": true,
  • "promotion_reward": false,
  • "vat_mode": "enabled",
  • "vat": 20,
  • "variants": [
    ],
  • "categories": [
    ],
  • "features": [
    ],
  • "modifiers": [
    ],
  • "modifiers_groups": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить товар

Authorizations:
Bearer
path Parameters
product
required
string

ID товара

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Получить цену варианта товара

Вычисляет цену варианта товара с выбранными модификаторами. Передавайте параметр city_id, чтобы получить переопределённую для выбранного города цену. Поле modifiers_hash из ответа следует использовать для поиска такого же варианта в корзине текущего заказа.

path Parameters
product
required
string

ID товара

variant
required
string

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

query Parameters
city_id
string

ID текущего города.

stock_id
string

ID выбранного склада.

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
Array of objects

Выбранные модификаторы

Array
modifier_id
string

ID модификатора

modifiers_group_id
string or null

ID группы модификаторов

quantity
integer

Количество модификаторов

Responses

Request samples

Content type
application/json
{
  • "modifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить список ограничений товара

Этот метод позволяет проверить список ограничений товара на текущий момент. Используйте его, если вам необходимо знать значение поля is_blocking у отдельного товара, а не позиции заказа.

path Parameters
product
required
string

ID товара

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Адреса

Получить подсказки адресов

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
query
required
string

Строка поиска адреса

city_id
string

Город, в котором нужно искать адреса

count
number

Количество записей (по умолчанию 5, не более 20)

Responses

Request samples

Content type
application/json
{
  • "query": "улан-удэ, жердева 104б",
  • "count": 10
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Получить подсказки адресов по координатам.

Этот метод может вернуть подсказки с уровнем ниже, чем "до дома" (например, город или регион).

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
latitude
required
number

Широта точки

longitude
required
number

Долгота точки

count
number

Количество записей (по умолчанию 5, не более 20)

Responses

Request samples

Content type
application/json
{
  • "latitude": 51.8121373,
  • "longitude": 107.6641822,
  • "count": 10
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Статусы заказов

Получить список статусов заказов

Authorizations:
Bearer
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

created_from
string

Начальная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

created_till
string

Конечная дата создания (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать статус заказа

Authorizations:
Bearer
header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название статуса

progress_bar_name
string

Название статуса для прогресс-бара

kind
required
string
Enum: "pending" "awaiting_payment" "submitted" "exported" "packing" "ready" "awaiting_delivery" "delivering" "delivered" "rejected" "cancelled" "completed" "custom"

Назначение статуса

color
required
string

Цвет статуса (HEX)

visible
boolean

Флаг отображения (по умолчанию true)

roles
Array of strings
Items Enum: "manager" "cashier" "courier"

Роли сотрудников, которым доступен статус (если не указано, доступен всем). Владельцу магазина доступны все статусы.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "progress_bar_name": "string",
  • "kind": "pending",
  • "color": "string",
  • "visible": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить статус заказов

Authorizations:
Bearer
path Parameters
orderStatus
required
string

ID статуса

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Изменить статус заказа

Authorizations:
Bearer
path Parameters
orderStatus
required
string

ID статуса

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
name
required
string

Название статуса

progress_bar_name
string

Название статуса для прогресс-бара

kind
required
string
Enum: "pending" "awaiting_payment" "submitted" "exported" "packing" "ready" "awaiting_delivery" "delivering" "delivered" "rejected" "cancelled" "completed" "custom"

Назначение статуса

color
required
string

Цвет статуса (HEX)

visible
boolean

Флаг отображения (по умолчанию true)

roles
Array of strings
Items Enum: "manager" "cashier" "courier"

Роли сотрудников, которым доступен статус (если не указано, доступен всем). Владельцу магазина доступны все статусы.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "progress_bar_name": "string",
  • "kind": "pending",
  • "color": "string",
  • "visible": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Удалить статус заказа

Authorizations:
Bearer
path Parameters
orderStatus
required
string

ID статуса

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Заказы

Получить список заказов

Этот метод поддерживает следующие включения:

ВключениеОписание
variantsПозиции заказа
variants.variantПозиции заказа и варианты товаров
variants.variant.external_identifierПозиции, варианты и внешние идентификаторы
variants.variant.option_valuesПозиции, варианты и значения опций вариантов
variants.variant.option_values.optionПозиции, варианты, значения и опции вариантов
variants.modifiersПозиции и выбранные модификаторы товаров
variants.modifiers.modifierПозиции, выбранные модификаторы и оригинальные модификаторы
variants.modifiers.modifier.external_identifierПозиции, модификаторы, ориг. модификаторы и внешн. идентификаторы
variants.modifiers.modifiers_groupПозиции, выбранные модификаторы и оригинальные группы модификаторов
variants.modifiers.modifiers_group.external_identifierПозиции, модификаторы, группы и внешн. идентификаторы
variants.productПозиции заказа и товары
variants.product.external_identifierПозиции заказа, товары и внешние идентификаторы
variants.product.mediaПозиции заказа, товары и изображения
variants.product.categoriesПозиции заказа, товары и категории
cityГород
city.settingsГород и настройки
stockСклад
stock.external_identifierСклад и внешний идентификатор
customerПокупатель
customer.external_identifierПокупатель и внешний идентификатор
delivery_addressАдрес доставки
delivery_zoneЗона доставки
statusesИстория изменения статусов
statuses.statusИстория статусов и оригинальные статусы
statuses_progressПрогресс изменения статусов
paymentsПлатёжные транзакции
payments_summaryСводная информация о платежах
deliver_at_localОтложенное время доставки по местному времени
management_tokenРасширенный токен заказа (включение доступно только сотрудникам магазина)
delivery_intervalИнтервал доставки
analytics_dataДанные аналитики заказа
analytics_data.integrationДанные аналитики заказа и интеграция, которая собрала данные
Authorizations:
Bearer
query Parameters
with
string

Список включений

count
integer

Количество записей

page
integer

Номер страницы

search
string

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

order_by
string

Поле сортировки

submitted_from
string

Начальная дата оформления заказа (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

submitted_till
string

Конечная дата оформления заказа (поддерживаемые форматы: YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD)

order_status_id
string

ID статуса заказа (можно перечислять несколько через запятую)

city_id
string

ID города

submission_period
string

Период оформленных заказов. Поддерживаются следующие периоды: сутки (24h), неделя (7d), месяц (30d), год (1y). Не рекомендуется использовать вместе с submitted_from/submitted_till.

header Parameters
X-Store-Id
required
string

ID магазина

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Создать заказ

header Parameters
X-Store-Id
required
string

ID магазина

Request Body schema: application/json
required
city_id
required
string

ID города

Responses

Request samples

Content type
application/json
{
  • "city_id": "dcb2f209-c9a4-482c-8427-fc6e651e3ddf"
}

Response samples

Content type
application/json
{
  • "data": {