Navbar
Search

Сущности

Ассортимент

Ассортимент

Сущность assortment представляет собой список всех товаров, услуг, комплектов, серий и модификаций с полями stock, reserve, inTransit, quantity, показывающими остаток, резерв, ожидание и доступно каждой из сущностей (для комплектов и услуг эти поля не выводятся). Данные поля могут быть рассчитаны в зависимости от даты и склада с использованием параметров фильтрации stockMoment и stockStore.

Атрибуты доступные для фильтрации

Результаты запроса можно отфильтровать, используя параметр filter.

Название Описание
alcoholic.type параметр для фильтрации по коду вида алкогольной продукции. Можно использовать операторы = и !=. Значение параметра - целое число. Можно передать пустое значение, тогда в выборку попадут товары с заполненным или незаполненным значением кода вида продукции.
archived параметр для фильтрации по признаку архивности товаров. Возможные значения: true, false. Для выдачи как обычных, так и товаров в архиве, нужно передать сразу два значения true и false. По умолчанию в выдачу попадают только обычные товары.
article параметр для фильтрации по артикулам товаров и комплектов. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений. Можно указать пустое значение.
barcode параметр для фильтрации по штрихкодам сущностей. Допустимый оператор - =. Можно передать несколько значений. Можно указать пустое значение.
code параметр для фильтрации по кодам сущностей. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений. Можно указать пустое значение.
description параметр для фильтрации по описаниям сущностей. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений. Можно указать пустое значение.
externalCode параметр для фильтрации по внешним кодам сущностей. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений. Можно указать пустое значение.
group параметр для фильтрации по владельцу-отделу. Можно использовать операторы = и !=. Значение параметра - ссылка на отдел. Можно передать несколько значений.
id параметр для фильтрации по идентификаторам сущностей. Можно использовать операторы = и !=. Можно передать несколько значений.
isSerialTrackable параметр для фильтрации по использованию серийных номеров
name параметр для фильтрации по наименованиям сущностей. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений.
owner параметр для фильтрации по владельцу-сотруднику. Можно использовать операторы = и !=. Значение параметра - ссылка на сотрудника. Можно передать несколько значений. Можно указать пустое значение.
pathname параметр для фильтрации по наименованию групп товаров. Можно использовать операторы =, !=, ~, ~=, =~. Можно передать несколько значений. Можно указать пустое значение.
productFolder параметр для фильтрации по нескольким группам товаров. Можно использовать операторы = и !=. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. В выборку попадут товары, которые находятся (или не находятся) непосредственно в указанных группах.
quantityMode параметр для фильтрации по значению доступно. Значение по умолчанию all. Доступные значения
search префиксный поиск по строковым полям, выводимым в ассортименте. Для данного параметра нужно использовать оператор =. Поиск по штрихкодам выполняется по полному соотвествию. Можно передать только одно значение.Подробнее тут
shared параметр для фильтрации по признаку общего доступа. Возможные значения: true, false.
stockMode параметр для фильтрации по значению остатка. Значение по умолчанию all. Доступные значения
stockMoment момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
stockStore параметр для фильтрации по нескольким складам. Можно использовать операторы = и !=. Значение параметра - ссылка на склад, который должен быть учтен в выборке или исключен из нее. Можно передать несколько значений.
supplier параметр для фильтрации по нескольким поставщикам. Можно использовать операторы = и !=. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанными поставщиками. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
type параметр для фильтрации по типу сущности (product, service, bundle, variant, consignment). Используется с оператором =. Можно передать несколько значений.
updated параметр для фильтрации по времени последнего обновления сущностей. Можно использовать операторы =, <, <=, >, >=. Действие строгих операторов синонимично нестрогим. Передается в виде строки в формате дата-время.
updatedBy параметр для фильтрации по автору последнего обновления. Можно использовать операторы = и !=. Значение параметра - uid (admin@admin). Можно передать несколько значений.
weighed параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
withSubFolders параметр учета вложенных подгрупп. Работает только при наличии непустого фильтра по productFolder. По умолчанию true, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
доп. поле(url) параметром фильтрации служит url дополнительного поля. Оператор фильтрации зависит от типа доп. поля. Подробнее тут.

Также доступна фильтрация по доп. полям. Подробнее про фильтрацию по доп. полям можно посмотреть в соответствующем разделе.

Доступные значения для stockMode

Значение по умолчанию all.

Значение Описание
all Любое значение остатка
positiveOnly Положительный остаток
negativeOnly Отрицательный остаток
empty Нулевой остаток
nonEmpty Ненулевой остаток
underMinimum Остаток ниже неснижаемого остатка
Доступные значения для quantityMode

Значение по умолчанию all.

Значение Описание
all Любое значение остатка
positiveOnly Положительный остаток
negativeOnly Отрицательный остаток
empty Нулевой остаток
nonEmpty Ненулевой остаток
underMinimum Остаток ниже неснижаемого остатка

Для данного параметра нужно использовать оператор =. Поиск по штрихкодам выполняется по полному соотвествию. Можно передать только одно значение.

При использовании фильтров alcoholic.type, weighed и фильтров stockMode, quantityMode со значениями, отличными от all, в выдачу не попадают услуги и комлекты.

Фильтрация доп. полей

Подробнее функциональность описана в разделе Фильтрация по дополнительным полям.

Примеры фильтрации:

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
groupBy string (optional) Параметр группировки. Принимает одно из значений: product - будут выведены только товары, variant - будут выведены товары и модификации (аналогично отсутствию параметра), consignment - будут выведены все сущности

Настройки справочника

Под сущностями справочника товаров подразумеваются товары, услуги, комплекты и группы товаров. Настройки справочника позволяют пользователю менять проверку уникальности кода, установку уникального кода при создании сущностей, установку уникального штрихкода EAN13, использование префиксов штрихкода для весовых товаров и настройку общего доступа к этим сущностям.

Атрибуты сущности

Название Тип Описание
meta Meta Метаданные Настроек справочника
Обязательное при ответе
uniqueCodeRules Object Настройки уникальности кода для сущностей справочника. Подробнее тут
Обязательное при ответе
barcodeRules Object Настройки правил штрихкодов для сущностей справочника. Подробнее тут
Обязательное при ответе
createdShared Boolean Создавать новые документы с меткой «Общий»
Обязательное при ответе

Атрибуты вложенных сущностей

Настройки уникальности кода для сущностей справочника
Название Тип Описание
checkUniqueCode Boolean Проверка уникальности кода сущностей справочника товаров
Обязательное при ответе
fillUniqueCode Boolean Устанавливать уникальный код при создании создании сущностей справочника товаров
Обязательное при ответе
Настройки правил штрихкодов для сущностей справочника
Название Тип Описание
fillEAN13Barcode Boolean Автоматически создавать штрихкод EAN13 для новых товаров, комплектов, модификаций и услуг
Обязательное при ответе
weightBarcode Boolean Использовать префиксы штрихкодов для весовых товаров
Обязательное при ответе
weightBarcodePrefix Int Префикс штрихкодов для весовых товаров. Возможные значения: число формата X или XX
Обязательное при ответе

Получить Ассортимент

Массовое удаление позиций в Ассортименте

В теле запроса нужно передать массив, содержащий JSON метаданных позиций в Ассортименте, которые вы хотите удалить.

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

Изменить настройки справочника товаров

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

Бонусная операция

Бонусные операции

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

Атрибуты сущности
Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные Контрагента, связанного с бонусной операцией
Обязательное при ответе Expand Необходимо при создании
applicable Boolean = != Отметка о проведении
Обязательное при ответе
bonusProgram Meta = != Метаданные бонусной программы
Expand
bonusValue Int = != < > <= >= Количество бонусных баллов
categoryType Enum Категория бонусной операции. Возможные значения: REGULAR, WELCOME
Только для чтения
code String(255) = != ~ ~= =~ Код Бонусной операции
created DateTime = != < > <= >= Момент создания Бонусной операции
Обязательное при ответе
executionDate DateTime Дата начисления бонусной операции.
externalCode String(255) = != ~ ~= =~ Внешний код Бонусной операции
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Бонусной операции
Обязательное при ответе Только для чтения
meta Meta Метаданные Бонусной операции
Обязательное при ответе
moment DateTime = != < > <= >= Время проведения бонусной операции
name String(255) = != ~ ~= =~ Наименование Бонусной операции
organization Meta = != Метаданные юрлица
Expand
owner Meta = != Владелец (Сотрудник)
Expand
parentDocument Meta Метаданные связанного документа бонусной операции
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
transactionStatus Enum Статус бонусной операции. Возможные значения: WAIT_PROCESSING, COMPLETED, CANCELED
Только для чтения
transactionType Enum Тип бонусной операции. Возможные значения: EARNING, SPENDING
Обязательное при ответе Необходимо при создании
updated DateTime = != < > <= >= Момент последнего обновления Бонусной операции
Обязательное при ответе
updatedBy UID = != Автор последнего обновления бонусной операции в формате uid (admin@admin) (Атрибут используется только для фильтрации)
Атрибут "executionDate".

При создании или редактировании бонусной операции начисления данный атрибут позволяет указать дату обработки операции. Если атрибут не указан, то операция будет обработана сразу, без задержки.

Для возможности указания даты обработки в будущем должна быть включена тарифная опция "Расширенная бонусная программа".

Получить Бонусные операции

Запрос на получение списка всех Бонусных операций для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Бонусные операции.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Бонусную операцию

Запрос на создание новой бонусной операции на данной учетной записи. Обязательные для создания поля:

Название Тип Описание
agent Meta Метаданные Контрагента, связанного с бонусной операцией
Обязательное при ответе Expand Необходимо при создании
bonusProgram Meta Метаданные Бонусной программы
Обязательное при ответе Expand Необходимо при создании
transactionType Enum Тип бонусной операции
Обязательное при ответе Необходимо при создании

Массовое создание и обновление Бонусных операций

Массовое создание и обновление Бонусных операций. В теле запроса нужно передать массив, содержащий JSON представления Бонусных операций, которые вы хотите создать или обновить. Обновляемые Бонусные операции должны содержать идентификатор в виде метаданных.

Удалить Бонусную операцию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.

Response 200 (application/json) Успешное удаление Бонусной операции.

Массовое удаление Бонусных операций

В теле запроса нужно передать массив, содержащий JSON метаданных Бонусных операций, которые вы хотите удалить.

Бонусная операция

Получить Бонусную операцию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.

Изменить Бонусную операцию

Запрос на изменение объекта, представляющего собой бонусную операцию. Невозможно изменение типа бонусной операции.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.

Бонусная программа

Бонусные программы

Кодом сущности для Бонусных программ в составе JSON API является ключевое слово bonusprogram. Перед работой со скидками настоятельно рекомендуем вам прочитать вот эту статью на портале поддержки МоегоСклада.

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
active Boolean Индикатор, является ли бонусная программа активной на данный момент
Обязательное при ответе
agentTags Array(String) Тэги контрагентов, к которым применяется бонусная программа. В случае пустого значения контрагентов в результате выводится пустой массив.
Обязательное при ответе
allAgents Boolean Индикатор, действует ли скидка на всех контрагентов (см. Скидки)
Обязательное при ответе
allProducts Boolean Индикатор, действует ли бонусная программа на все товары (всегда true, см. Скидки)
Обязательное при ответе
earnRateRoublesToPoint Int Курс начисления
earnWhileRedeeming Boolean Разрешить одновременное начисление и списание бонусов. Если true - бонусы будут начислены на денежную часть покупки, даже при частичной оплате покупки баллами.
Обязательное при ответе
id UUID ID Бонусной программы
Обязательное при ответе Только для чтения
maxPaidRatePercents Int Максимальный процент оплаты баллами
meta Meta Метаданные Бонусной программы
Обязательное при ответе
name String(255) Наименование Бонусной программы
postponedBonusesDelayDays Int Баллы начисляются через [N] дней
Тарифная опция «Расширенная бонусная программа»
spendRatePointsToRouble Int Курс списания
welcomeBonusesEnabled Boolean Возможность начисления приветственных баллов
Обязательное при ответе
welcomeBonusesMode Enum Условие начисления приветственных баллов. Не может быть пустым, если welcomeBonusesEnabled = true. Подробнее тут
welcomeBonusesValue Int Количество приветственных баллов, начисляемых участникам бонусной программы. Не может быть отрицательным. Не может быть пустым, если welcomeBonusesEnabled = true
Условия бонусных баллов
Название Описание
REGISTRATION Приветственные баллы начисляются участиникам после регистрации в бонусной программе.
FIRST_PURCHASE Приветственные баллы начисляются участиникам бонусной программы после совершения первой покупки.

Получить все Бонусные программы

Запрос на получение всех бонусных программ учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Бонусные программы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Бонусная программа

Создать Бонусную программу

Запрос на создание новой бонусной программы. Обязательные поля для заполнения: name (имя скидки), active (активна ли скидка), allProducts (действует ли скидка на все товары), allAgents (действует ли скидка на всех контрагентов) earnRateRoublesToPoint (курс начисления), spendRatePointsToRouble (курс списания), maxPaidRatePercents (максимальный процент оплаты баллами)

Изменить Бонусную программу

Параметры

Параметр Описание
id string (required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.

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

Получить Бонусную программу

Параметры

Параметр Описание
id string (required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.

Удалить Бонусную программу

Параметры

Параметр Описание
id string (required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.

Response 200 (application/json) Успешное удаление Бонусной программы

Массовое удаление Бонусных программ

В теле запроса нужно передать массив, содержащий JSON метаданных Бонусных программ, которые вы хотите удалить.

Валюта

Средствами JSON API можно запрашивать списки валют и сведения по отдельным валютам, а также создавать новые и обновлять сведения по уже существующим валютам. Кодом сущности для валют в составе JSON API является ключевое слово currency. Больше о валютах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов валют на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты Сущности
Название Тип Фильтрация Описание
archived Boolean = != Добавлена ли Валюта в архив
Обязательное при ответе
code String(255) = != ~ ~= =~ Цифровой код Валюты
Обязательное при ответе Необходимо при создании
default Boolean = != Является ли валюта валютой учета
Обязательное при ответе Только для чтения
fullName String(255) = != ~ ~= =~ Полное наименование Валюты
id UUID = != ID Валюты
Обязательное при ответе Только для чтения
indirect Boolean Признак обратного курса Валюты
Обязательное при ответе
isoCode String(255) = != ~ ~= =~ Буквенный код Валюты
Обязательное при ответе Необходимо при создании
majorUnit Object Формы единиц целой части Валюты. Подробнее тут
Обязательное при ответе
margin Double Наценка при автоматическом обновлении курса
Обязательное при ответе
meta Meta Метаданные Валюты
Обязательное при ответе
minorUnit Object Формы единиц дробной части Валюты. Подробнее тут
Обязательное при ответе
multiplicity Int = != < > <= >= Кратность курса Валюты
Обязательное при ответе
name String(255) = != ~ ~= =~ Краткое наименование Валюты
Обязательное при ответе Необходимо при создании
rate Double Курс Валюты
Обязательное при ответе
rateUpdateType String(255) Способ обновления курса Валюты. auto или manual
Обязательное при ответе Только для чтения
system Boolean Основана ли валюта на валюте из системного справочника
Только для чтения
Формы единиц

Поля majorUnit и minorUnit содержат в себе следующие атрибуты:

Атрибут Описание
gender Грамматический род единицы валюты (допустимые значения masculine - мужской, feminine - женский)
s1 Форма единицы, используемая при числительном 1
s2 Форма единицы, используемая при числительном 2
s5 Форма единицы, используемая при числительном 5

В JSON API валюты в основном представлены в составе сущностей в формате Метаданные. Для того, чтобы раскрыть их в составе другого объекта нужно воспользоваться параметром expand

Получить Валюты

Результат успешного запроса - JSON представление списка валют с перечисленными полями:

Поле Описание
meta Метаданные о выдаче
context Метаданные о сотруднике, выполнившем запрос
rows Массив JSON объектов, представляющих собой валюты

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать новую Валюту

Обязательные поля для создания валюты: name, code и isoCode. В теле запроса нельзя указать курс валюты (rate) равным нулю.

Создать системную валюту

Системной является валюта, для которой в МоемСкладе уже есть все параметры и возможность автоматического обновления курса. Для добавления системной валюты необходимо указать system=true и один из параметров code или isoCode. Дополнительно можно указать rateUpdateType и margin

Массовое создание и обновление Валют

Массовое создание и обновление Валют. В теле запроса нужно передать массив, содержащий JSON представления Валют, которые вы хотите создать или обновить. Обновляемые Валюты должны содержать идентификатор в виде метаданных.

Удалить Валюту

Запрос на удаление Валюты с указанным id. Валюту учета удалить нельзя.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты

Response 200 (application/json) Успешное удаление Валюты

Массовое удаление Валют

В теле запроса нужно передать массив, содержащий JSON метаданных Валют, которые вы хотите удалить.

Валюта

Получить Валюту

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты

Изменить Валюту

Запрос на обновление существующей валюты. В теле запроса нельзя указать курс валюты (rate) равным нулю, а также пустые поля name, code, isoCode. Нельзя изменять значения полей name, fullName, code, isoCode, majorUnit, minorUnit для валют, основанных на системном справочнике валют. Нельзя изменять курс валюты учета. Нельзя изменить курс валюты с автоматическим обновлением.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты

Вебхуки

С помощью средств JSON API можно работать с вебхуками.

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

С помощью API версии 1.2 можно просматривать, изменять, удалять вебхуки, созданные только с помощью API версии 1.2.

Набор возможностей также зависит от вашего тарифа. При бесплатном тарифе отправка вебхуков не производится, нельзя создать новый или изменить существующий вебхук.

Управление вебхуками доступно только администратору аккаунта.

Пример вебхука

Пример того, в каком виде будут передаваться данные:

Атрибуты сущности отправляемого вебхука

Название Тип Описание
events Object Данные о событии, вызвавшем срабатывание вебхука
Обязательное при ответе
auditContext Object Контекст аудита, соответствующий событию вебхука

Атрибуты сущности событие

Название Тип Описание
meta Meta Метаданные измененной сущности
Обязательное при ответе
action Enum Действие, которое вызвало срабатывание вебхука. Возможные значения: [CREATE, UPDATE, DELETE, PROCESSED]
Обязательное при ответе
accountId UUID ID учетной записи Кассира
Обязательное при ответе
updatedFields Array(String) Поля сущности, измененные пользователем

Для отображения атрибута сущности событие updatedFields нужно, чтобы вебхук имел diffType=FIELDS и action=UPDATE

Атрибуты сущности контекст аудита

Название Тип Описание
meta Meta Метаданные контекста аудита
Обязательное при ответе
uid String(255) Логин Сотрудника
Обязательное при ответе Только для чтения
moment DateTime Дата изменения
Обязательное при ответе Только для чтения

В массиве events может быть несколько объектов. Параметр запроса requestId - идентификатор уведомления.

В ответ на наш запрос мы ожидаем получить ответ с HTTP статусом 200 или 204 в течение 1500 миллисекунд. При невалидном ответе от клиентского приложения наша система осуществляет еще 3 попытки отправки.

Данные попытки осуществляются последовательно, без таймаутов между ними. Если все попытки закончились неудачно или истекло время ожидания ответа - данное уведомление считается неотправленным и в дальнейшем удаляется, в клиентское приложение оно отправлено не будет, т.к. проблема на стороне клиентского приложения.

Чтобы попытки отправки уведомления не заканчивались неудачей из-за истечения времени ожидания ответа сервером, рекомендуется разделить прием вебхуков и их обработку. Понять, что уведомление о событии было отправлено повторно, можно по параметру запроса requestId - при повторной отправке уведомления идентификатор останется прежним.

С помощью API версии 1.2 можно просматривать, изменять, удалять вебхуки созданные только с помощью API версии 1.2.

Заголовок временного отключения через API

Через JSON API или POS API при запросах можно отключить уведомления вебхуков в контексте данного запроса. Для этого нужно указать заголовок X-Lognex-WebHook-Disable с произвольным значением.

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

SSL Handshake

Если на адресе получателя используется SSL сертификат, то необходимо удостовериться, что сертификат имеет корректные Certification Paths. Проверить сертификат можно в сервисе https://www.ssllabs.com/ssltest/index.html

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе
action Enum Действие, которое отслеживается вебхуком. Возможные значения: [CREATE, UPDATE, DELETE, PROCESSED]. Задать значение PROCESSED возможно только для асинхронных задач
Обязательное при ответе Необходимо при создании
authorApplication Meta Метаданные Приложения, создавшего вебхук
diffType Enum Режим отображения изменения сущности. Указывается только для действия UPDATE. Возможные значения: [NONE, FIELDS] (по умолчанию NONE)
enabled Boolean Флажок состояние вебхука (включен / отключен)
Обязательное при ответе
entityType String(255) Тип сущности, к которой привязан вебхук
Обязательное при ответе Необходимо при создании
id UUID ID вебхука
Обязательное при ответе
meta Meta Метаданные вебхука
Обязательное при ответе
method Enum HTTP метод, с которым будет происходить запрос. Возможные значения: POST
Обязательное при ответе
url URL URL, по которому будет происходить запрос. Допустимая длина до 255 символов
Обязательное при ответе Необходимо при создании

Доступные типы сущностей

Создание вебхуков доступно для всех типов сущностей и документов, кроме следующих:

Получить список вебхуков

Создать вебхук

Пример запроса на создание нового вебхука. Убедитесь, что создаете еще не существующий вебхук: сочетание entityType, action, url должно быть уникальным. Всего на одно уникальное сочетание entityType, action может быть создано не более 5 вебхуков с разными url для пользователей и не более 1 для приложения.

Массовое создание и обновление вебхуков

Массовое создание и обновление вебхуков. В теле запроса нужно передать массив, содержащий JSON представления вебхуков, которые вы хотите создать или обновить. Обновляемые вебхуки должны содержать идентификатор в виде метаданных.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.

Получить отдельный вебхук

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.

Изменить вебхук

Пример запроса на изменение сведений о вебхуке.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.

Отключить вебхук

Пример запроса на отключение вебхука.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.

Удалить вебхук

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.

Response 200 (application/json) Успешное удаление вебхука.

Массовое удаление вебхуков

В теле запроса нужно передать массив, содержащий JSON метаданных вебхуков, которые вы хотите удалить.

Вебхук на изменение остатков

Вебхуки позволяют получать уведомления об изменениях остатков товаров. Уведомления отправляются пользователю каждые 1-5 минут, если произошло изменение остатков. Чтобы получать уведомления, создайте вебхук на изменения остатков и включите его. Ключевое слово для вебхуков на изменение остатков в рамках JSON API — webhookstock.

Набор возможностей также зависит от вашего тарифа:

Описание вебхука на изменение остатков

Атрибуты отправляемого сообщения

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе
stockType Enum Тип остатков, изменение которых вызывает вебхук на изменение остатков. Возможные значения: [stock]
Обязательное при ответе
reportType Enum Тип отчета остатков, к которым привязан вебхук на изменение остатков. Возможные значения: [all, bystore]
Обязательное при ответе
reportUrl String(255) URL на получения данных по изменившейся номенклатуре за указанный период
Обязательное при ответе

Параметр запроса requestId — идентификатор уведомления.

При отправке запроса система ожидает получить ответ от клиентского приложения с HTTP-статусом 200 или 204 в течение 1500 миллисекунд. Если система получает неверный ответ, она осуществляет еще 3 попытки отправки. Попытки осуществляются последовательно, без таймаутов между ними. Если все попытки закончились неудачно или истекло время ожидания ответа, уведомление считается неотправленным и удаляется.

Чтобы попытки отправки уведомления не заканчивались неудачей из-за истечения времени ожидания ответа сервером, разделите прием вебхуков и их обработку. Параметр запроса requestId говорит о том, что уведомление о событии было отправлено повторно. При повторной отправке уведомления идентификатор останется прежним.

SSL Handshake

Если на адресе получателя используется SSL сертификат, то необходимо удостовериться, что сертификат имеет корректные Certification Paths. Проверить сертификат можно в сервисе https://www.ssllabs.com/ssltest/index.html

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе
authorApplication Meta Метаданные Приложения, создавшего вебхук на изменение остатков
Только для чтения
enabled Boolean Флажок состояния вебхука на изменение остатков (включен / отключен)
Обязательное при ответе
stockType Enum Тип остатков, изменение которых вызывает вебхук. Возможные значения: [stock]
Обязательное при ответе Необходимо при создании
reportType Enum Тип отчета остатков, к которым привязан вебхук на изменение остатков. Возможные значения: [all, bystore]
Обязательное при ответе Необходимо при создании
id UUID ID вебхука на изменение остатков
Обязательное при ответе
meta Meta Метаданные вебхука на изменение остатков
Обязательное при ответе
url URL URL, по которому будет происходить обработка вебхука. Допустимая длина до 255 символов
Обязательное при ответе Необходимо при создании

Получить список вебхуков на изменение остатков

Создать вебхук на изменение остатков

Сочетание stockType, reportType, url должно быть уникальным. Всего на одно уникальное сочетание stockType, reportType может быть создано не более 5 вебхуков на изменение остатков с разными url для пользователей и не более 1 для приложения.

Массовое создание и обновление вебхуков на изменение остатков

Массовое создание и обновление вебхуков на изменение остатков. В теле запроса нужно передать массив, содержащий JSON представления вебхуков на изменение остатков, которые вы хотите создать или обновить. Обновляемые вебхуки на изменение остатков должны содержать идентификатор в виде метаданных.

Получить отдельный вебхук на изменение остатков

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.

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

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.

Отключить вебхук на изменение остатков

Пример запроса на отключение вебхука на изменение остатков.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.

Удалить вебхук на изменение остатков

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.

Response 200 (application/json) Успешное удаление вебхука на изменение остатков.

Массовое удаление вебхуков на изменение остатков

В теле запроса нужно передать массив, содержащий JSON метаданных вебхуков на изменение остатков, которые вы хотите удалить.

Грузовая таможенная декларация (ГТД)

Грузовая таможенная декларация (ГТД)

Название Тип Описание
name String(255) Номер ГТД

В версии API 1.2 отсутствует отдельный ресурс для работы с ГТД. ГТД - вложенная сущность документа.

Группа техкарт

Средствами JSON API можно создавать и обновлять сведения о Группах техкарт, запрашивать списки Групп техкарт и сведения по отдельным Группам техкарт. Кодом сущности для Группы техкарт в составе JSON API является ключевое слово processingplanfolder.

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

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean Добавлена ли Группа техкарт в архив
Обязательное при ответе
externalCode String(255) Внешний код Группы техкарт
Обязательное при ответе
code String(255) Код Группы техкарт
description String(4096) Описание Группы техкарт
group Meta Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID ID Группы техкарт
Обязательное при ответе Только для чтения
meta Meta Метаданные Группы техкарт
Обязательное при ответе
name String(255) Наименование Группы техкарт
Обязательное при ответе Необходимо при создании
owner Meta Метаданные владельца (Сотрудника)
Expand
pathName String Наименование Группы техкарт, в которую входит данная Группа техкарт
Обязательное при ответе Только для чтения
shared Boolean Общий доступ
Обязательное при ответе
updated DateTime Момент последнего обновления сущности
Обязательное при ответе Только для чтения

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

Запрос всех Групп техкарт на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Группы техкарт

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать новую Группу техкарт

Запрос на создание новой Группы техкарт Обязательные для создания Группы техкарт поля:

Название Описание
name Наименование Группы техкарт

Массовое создание и обновление Групп техкарт

Массовое создание и обновление Групп техкарт. В теле запроса нужно передать массив, содержащий JSON представления Групп техкарт, которые вы хотите создать или обновить. Обновляемые Группы техкарт должны содержать идентификатор в виде метаданных.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарт.

Response 200 (application/json) Успешное удаление Группы техкарт.

Массовое удаление Групп техкарт

В теле запроса нужно передать массив, содержащий JSON метаданных Групп техкарт, которые вы хотите удалить.

Метаданные Групп техкарт

Метаданные Групп техкарт

Запрос на получение метаданных Групп техкарт. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные Групп техкарт
Обязательное при ответе

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Группа техкарт

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарты

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

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

Запрос на обновление Группы техкарт с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Группы техкарт, кроме тех, что помечены Только для чтения в описании атрибутов Группы техкарт. Для обновления поля pathName нужно обновить ссылку на родительскую Группу техкарт, т.е. обновить поле processingplanfolder

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарт.

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

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

Средствами JSON API можно создавать и обновлять сведения о Группах товаров, запрашивать списки Групп товаров и сведения по отдельным Группам товаров. Кодом сущности для Группы товаров в составе JSON API является ключевое слово productfolder. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке.

Поиск среди объектов групп товаров на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлена ли Группа товаров в архив
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код Группы товаров
description String(4096) = != ~ ~= =~ Описание Группы товаров
effectiveVat Int Реальный НДС %
Только для чтения
effectiveVatEnabled Boolean Дополнительный признак для определения разграничения реального НДС = 0 или "без НДС". (effectiveVat = 0, effectiveVatEnabled = false) -> "без НДС", (effectiveVat = 0, effectiveVatEnabled = true) -> 0%.
Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Группы товаров
Обязательное при ответе
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Группы товаров
Обязательное при ответе Только для чтения
meta Meta Метаданные Группы товаров
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Группы товаров
Обязательное при ответе Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
pathName String = != ~ ~= =~ Наименование Группы товаров, в которую входит данная Группа товаров
Обязательное при ответе Только для чтения
productFolder Meta Ссылка на Группу товаров, в которую входит данная Группа товаров, в формате Метаданных
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
taxSystem Enum Код системы налогообложения. Подробнее тут
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения
useParentVat Boolean Используется ли ставка НДС родительской группы. Если true для единицы ассортимента будет применена ставка, установленная для родительской группы.
Обязательное при ответе
vat Int НДС %
vatEnabled Boolean Включен ли НДС для группы. С помощью этого флага для группы можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.

Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
PATENT_BASED Патент
PRESUMPTIVE_TAX_SYSTEM ЕНВД
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
TAX_SYSTEM_SAME_AS_GROUP Совпадает с группой
UNIFIED_AGRICULTURAL_TAX ЕСХН

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

Запрос всех Групп товаров на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой группы товаров.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Запрос на создание новой Группы товаров. Обязательные для создания Группы товаров поля:

Название Описание
name Наименование Группы товаров

Массовое создание и обновление Групп товаров

Массовое создание и обновление Групп товаров. В теле запроса нужно передать массив, содержащий JSON представления Групп товаров, которые вы хотите создать или обновить. Обновляемые Группы товаров должны содержать идентификатор в виде метаданных.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.

Response 200 (application/json) Успешное удаление Группы товаров.

Массовое удаление Групп товаров

В теле запроса нужно передать массив, содержащий JSON метаданных Групп товаров, которые вы хотите удалить.

Метаданные Групп товаров

Метаданные Групп товаров

Запрос на получение метаданных Групп товаров. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные Групп товаров
Обязательное при ответе
attributes Array(Object) Коллекция доп. полей

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Отдельное доп. поле

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.

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

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

Запрос на обновление Группы товаров с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Группы товаров, кроме тех, что помечены Только для чтения в описании атрибутов Группы товаров. Для обновления поля pathName нужно обновить ссылку на родительскую Группу товаров, т.е. обновить поле productFolder

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.

Договор

Договоры

Средствами JSON API можно создавать и обновлять сведения о Договорах, запрашивать списки Договоров и сведения по отдельным Договорам. Кодом сущности для Договора в составе JSON API является ключевое слово contract. Больше о Договорах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов Договора на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
agent Meta = != Метаданные Контрагента
Обязательное при ответе Expand Необходимо при создании
agentAccount Meta Метаданные счета контрагента
Обязательное при ответе Expand
archived Boolean = != Добавлен ли Договор в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция доп. полей
code String(255) = != ~ ~= =~ Код Договора
contractType Enum Тип Договора. Возможные значения: Договор комиссии, Договор купли-продажи
Обязательное при ответе
description String(4096) = != ~ ~= =~ Описание Договора
externalCode String(255) = != ~ ~= =~ Внешний код Договора
Обязательное при ответе
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Договора
Обязательное при ответе Только для чтения
meta Meta Метаданные Договора
Обязательное при ответе
moment DateTime = != < > <= >= Дата Договора
Обязательное при ответе
name String(255) = != ~ ~= =~ Номер договора
Обязательное при ответе
organizationAccount Meta Метаданные счета вашего юрлица
Expand
ownAgent Meta = != Метаданные вашего юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
rate Meta Метаданные валюты
Обязательное при ответе Expand
rewardPercent Int Вознаграждение в процентах (от 0 до 100)
rewardType Enum Тип Вознаграждения. Возможные значения: Процент от суммы продажи, Не рассчитывать
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные статуса договора
Expand
sum Int Сумма Договора
Обязательное при ответе
printed Boolean Напечатан ли документ
Обязательное при ответе Только для чтения
published Boolean Опубликован ли документ
Обязательное при ответе Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Таблица полей, их значений и их значений в JSON представлении:

Имя поля Возможные Значения Соответствующее значение в JSON Значение по умолчанию
contractType Договор комиссии Commission Договор купли-продажи
Договор купли-продажи Sales
rewardType Процент от суммы продажи PercentOfSales Не рассчитывать
Не рассчитывать None

О работе с доп. полями Договоров можно прочитать здесь

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

Запрос на получение списка всех договоров на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой договора.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать новый Договор

Запрос на создание нового Договора. Обязательные для создания Договора поля:

Название Тип Описание
name String(255) Номер договора
Обязательное при ответе
ownAgent Meta Метаданные вашего юрлица
Обязательное при ответе Expand Необходимо при создании
agent Meta Метаданные Контрагента
Обязательное при ответе Expand Необходимо при создании

Массовое создание и обновление Договоров

Массовое создание и обновление Договоров. В теле запроса нужно передать массив, содержащий JSON представления Договоров, которые вы хотите создать или обновить. Обновляемые Договора должны содержать идентификатор в виде метаданных.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.

Response 200 (application/json) Успешное удаление Договора.

Массовое удаление Договоров

В теле запроса нужно передать массив, содержащий JSON метаданных Договоров, которые вы хотите удалить.

Метаданные Договоров

Метаданные Договоров

Запрос на получение метаданных Договоров. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные Заказа покупателя
Обязательное при ответе
attributes Array(Object) Коллекция доп. полей
states Array(Object) Массив статусов договоров
createShared Boolean Создавать новые договора с меткой "Общий"
Обязательное при ответе

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Отдельное доп. поле

Договор

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.

Получить Договор

Изменить Договор

Запрос на обновление отдельного Договора с указанным id. При обновлении полей organization и agent нужно также обновить поля organizationAccount и agentAccount соответственно, иначе произойдет ошибка.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.

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

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

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

Поиск среди объектов единиц измерения на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код Единицы измерения
description String(4096) = != ~ ~= =~ Описание Единциы измерения
externalCode String(255) = != ~ ~= =~ Внешний код Единицы измерения
Обязательное при ответе
group Meta = != Отдел сотрудника
Expand Для пользовательских ед. измерений
id UUID = != ID Единицы измерения
Обязательное при ответе Только для чтения
meta Meta Метаданные Единицы измерения
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Единицы измерения
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand Для пользовательских ед. измерений
shared Boolean = != Общий доступ
Обязательное при ответе Для пользовательских ед. измерений
updated DateTime = != < > <= >= Момент последнего обновления Единицы измерения
Обязательное при ответе Только для чтения

Получить Единицы измерения

Запрос на получение списка всех единиц измерения для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Единицы измерения.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Единицу измерения

Запрос на создание новой единицы измерения на данной учетной записи. Единственное поле, которое обязательно должно присутствовать в теле запроса на создание Единицы измерения - поле name.

Массовое создание и обновление единиц измерения

Массовое создание и обновление единиц измерения. В теле запроса нужно передать массив, содержащий JSON представления единиц измерения, которые вы хотите создать или обновить. Обновляемые единицы измерения должны содержать идентификатор в виде метаданных.

Удалить Единицу измерения

Запрос на удаление единицы измерения. Невозможно удаление предустановленных единиц измерения (единиц измерений имеющихся на учетной записи по умолчанию). Удалить можно только единицы измерения, созданные через основной интерфейс или через метод POST.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Единицы измерения.

Response 200 (application/json) Успешное удаление Розничной продажи.

Массовое удаление Единиц измерения

В теле запроса нужно передать массив, содержащий JSON метаданных Единиц измерения, которые вы хотите удалить.

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

Получить Единицу измерения

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Единицы измерения.

Изменить Единицу измерения

Запрос на изменение объекта, представляющего собой единицу измерения. Невозможно изменение предустановленных единиц измерения (единиц измерения имеющихся на учетной записи по умолчанию). Изменить можно только единицы измерения, созданные через основной интерфейс или через метод POST.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Единицы измерения.

Задача

Средствами JSON API можно создавать и обновлять сведения о задачах, запрашивать списки задач и сведения по отдельным задачам. Кодом сущности для задачи в составе JSON API является ключевое слово task. Больше о задачах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Задачи

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи Кассира
Обязательное при ответе Только для чтения
agent Meta = != Метаданные Контрагента или юрлица, связанного с задачей. Задача может быть привязана либо к конрагенту, либо к юрлицу, либо к документу
Expand
assignee Meta = != Метаданные ответственного за выполнение задачи
Обязательное при ответе Expand Необходимо при создании
author Meta = != Метаданные Сотрудника, создавшего задачу (администратор аккаунта, если автор - Приложение)
Обязательное при ответе Только для чтения Expand
authorApplication Meta Метаданные Приложения, создавшего задачу
Только для чтения Expand
completed DateTime Время выполнения задачи
Обязательное при ответе Только для чтения
created DateTime = != < > <= >= Момент создания
Обязательное при ответе Только для чтения
description String(4096) = != ~ ~= =~ Текст задачи
Обязательное при ответе Необходимо при создании
done Boolean = != Отметка о выполнении задачи
Обязательное при ответе
dueToDate DateTime = != < > <= >= Срок задачи
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
id UUID = != ID Задачи
Обязательное при ответе Только для чтения
implementer Meta Метаданные Сотрудника, выполнившего задачу
Только для чтения Expand
meta Meta Метаданные Задачи
Обязательное при ответе
state Meta Метаданные Типа задачи
Expand
notes Meta Метаданные комментария к задаче
Обязательное при ответе Expand
operation Meta = != Метаданные Документа, связанного с задачей. Задача может быть привязана либо к конрагенту, либо к юрлицу, либо к документу
Expand
updated DateTime = != < > <= >= Момент последнего обновления Задачи
Обязательное при ответе Только для чтения

Комментарии задачи

Объект комментария к задаче содержит следующие поля:

Название Тип Описание
author Meta Метаданные Сотрудника, создавшего комментарий (администратор аккаунта, если автор - приложение)
Обязательное при ответе Только для чтения
authorApplication Meta Метаданные Приложения, создавшего комментарий
Только для чтения
moment DateTime Момент создания комментария
Обязательное при ответе Только для чтения
description String(4096) Текст комментария
Обязательное при ответе Необходимо при создании

Тип задачи

Объект типа задачи содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
color Int Цвет Типа задачи
Обязательное при ответе Необходимо при создании
entityType String(255) Тип сущности - всегда является task
Обязательное при ответе Только для чтения
id UUID ID Типа задачи
Обязательное при ответе Только для чтения
meta Meta Метаданные Типа задачи
Обязательное при ответе Только для чтения
name String(255) Наименование Типа задачи
Обязательное при ответе Необходимо при создании
stateType Enum Тип Статуса
Обязательное при ответе

Поле color передается в АПИ как целое число состоящее из 4х байт. Т.к. цвет передается в цветовом пространстве ARGB, каждый байт отвечает за свой цвет соответственно: 1 - за прозрачность, 2 - за красный цвет, 3 - за зеленый, 4 - за синий. Каждый байт принимает значения от 0 до 255 как и цвет в каждом из каналов цветового пространства. Получившееся в итоге из 4 записанных последовательно байт число, переведенное в 10-чную систему счисления и является представлением цвета статуса в JSON API.

Пример: цвету rgb(162, 198, 23) будет соответствовать следующее значение поля "color": 10667543.

Отображение списка по умолчанию

Для администратора

Если текущий сотрудник обладает правами администратора, то при запросе списка задач ему будут выведены все активные (done = false) задачи, как те, что относятся к нему (сотрудник является создателем или исполнителем задачи), так и те, что относятся к другим сотрудникам.

Для сотрудника

Для сотрудника, не являющегося администратором, но имеющего право на просмотр всех задач, список задач по умолчанию будет аналогичен списку задач, выводимому для администратора. В противном случае, при запросе списка задач без каких-либо фильтров, будут выведены активные (done = false) задачи, которые создал текущий сотрудник и задачи, за которые ответственен текущий сотрудник.

Фильтры из web-интерфейса

В основном интерфейсе МоегоСклада для отображения списка задач существует 3 группы фильтров:

Чтобы реализовать подобную фильтрацию списка для JSON API, нужно использовать следующие фильтры для списка задач:

Права доступа

Операция Доступ
Выполнение задачи необходима тарифная опция CRM, администратор, создатель задачи, ответственный
Отмена выполнения задачи необходима тарифная опция CRM, администратор, создатель задачи, ответственный
Просмотр задач в которых текущий пользователь является ответственным или автором Все
Просмотр любых задач пользователь с правом на просмотр всех задач или администратор
Редактирование задачи необходима тарифная опция CRM, администратор, создатель задачи
Создание задачи необходима тарифная опция CRM, все
Удаление задачи Администратор, создатель задачи

Получить задачи

Получить список задач. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Задачи.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Задачу

Создать новую задачу. Для создания новых задач необходима активная тарифная опция CRM. Обязательные для создания поля:

Название Тип Описание
description String(4096) Текст задачи
Обязательное при ответе Необходимо при создании
assignee Meta Метаданные Сотрудника, ответственного за выполнение задачи
Обязательное при ответе Expand Необходимо при создании

Массовое создание и обновление Задач

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

Удалить задачу

Запрос на удаление задачи с указанным id. Для удаления задач необходима активная тарифная опция CRM. Также нельзя удалить задачи, созданные другими сотрудниками, без прав администратора.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.

Response 200 (application/json) Успешное удаление задачи.

Массовое удаление Задач

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

Задача

Получить задачу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.

Изменить задачу

Описание

Изменить задачу с указанным id. Для изменения задач необходима активная тарифная опция CRM. Также нельзя изменять задачи, созданные другими сотрудниками, без прав администратора.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.

Комментарии Задачи

Отдельный ресурс для управления комментариями Задачи. С его помощью вы можете управлять комментариями задачи, в которой количество комментариев превышает лимит на количество комментариев, сохраняемых вместе с задачей. Этот лимит равен 1000.

Получить комментарии Задачи

Запрос на получение списка всех комментариев данной Задачи.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих комментарий к Задаче.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.
limit number (optional) Default: 25 Example: 100 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 100.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей
updatedBy string (optional) Example: admin@admin Один из параметров фильтрации выборки. Формат строки : uid
updatedFrom string (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки. Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)
updatedTo string (optional) Example: 2016-04-15 15:48:46 Один из параметров фильтрации выборки. Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм], Часовой пояс: MSK (Московское время)

Создать комментарий Задачи

Запрос на создание нового комментария к Задаче. Для успешного создания необходимо в теле запроса указать следующие поля:

Название Тип Описание
text String(4096) Текст комментария
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.

Комментарий к задаче

Получить комментарий к Задаче

Отдельный комментарий к Задаче с указанным id комментария.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.
tasknoteID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id комментария к Задаче.

Изменить комментарий к Задаче

Запрос на обновление отдельного комментария к Задаче. Для успешного создания необходимо в теле запроса указать следующие поля:

Название Тип Описание
text String(4096) Текст комментария
Обязательное при ответе Необходимо при создании

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.
tasknoteID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id комментария к Задаче.

Удалить комментарий

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id задачи.
tasknoteID string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id комментария к Задаче.

Response 200 (application/json) Успешное удаление комментария к Задаче.

Массовое удаление коментариев к задаче

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

Response 200 (application/json) Успешное удаление комментариев к Задаче.

Тип задачи

Получить типы задач

Создать тип задачи

Тип задачи создается на основе переданного объекта JSON, который содержит представление нового Типа. Результат - JSON представление созданного Типа. Для создания нового Типа, необходимо и достаточно в переданном объекте заполнить поля name и color.

Изменить тип задачи

Изменить существующий тип задачи.

Описание

Тип задачи меняется на основе переданного объекта JSON. Результат - JSON представление обновленного или созданного Типа. Для обновления Типа, необходимо указать в переданном объекте одно или несколько полей с новыми значениями: name и color.

Параметры

Параметр Описание
id string (required) Example: 4dcb3f23-60c4-11e7-6adb-ede500000019 id Типа задачи.

Массовое создание и обновление Типов задач

Массовое создание и обновление Типов задач. В теле запроса нужно передать массив, содержащий JSON представления Типов, которые вы хотите создать или обновить. Обновляемые Типы должны содержать идентификатор в виде метаданных.

Удалить Тип задачи

Параметры

Параметр Описание
id string (required) Example: 4dcb3f23-60c4-11e7-6adb-ede500000019 id Типа задачи.

Response 200 (application/json) Успешное удаление Типа задачи.

Изображение

Изображения

Средствами JSON API можно создавать и обновлять сведения по Изображениям для Товаров, Комплектов и Модификаций, запрашивать списки Изображений, а также сведения по отдельным Изображениям.

Товары, Комплекты и Модификации могут содержать множество одинаковых Изображений. Изображения считаются одинаковыми, если при добавлении Изображений у них совпадало filename и content. У одинаковых Изображений одинаковое значение параметра id. У Товара, Комплекта или Модификации может быть не более 10 Изображений.

Атрибуты сущности

Название Тип Описание
filename String(255) Имя файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
updated DateTime Время загрузки файла на сервер
Обязательное при ответе

Получить список Изображений Товара, Комплекта и Модификации

Запрос на получение всех Изображений Товара, Комплекта или Модификации для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Изображения.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Изображениями.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Добавить Изображение к Товару, Комплекту или Модификации

Добавить новое Изображение к Товару, Комплекту или Модификации.

Описание

Изображение загружается и добавляется к Изображениям на основе переданного объекта JSON, который содержит представление нового Изображения. Результат - JSON представление обновленного списка Изображений. Для создания и добавления нового Изображения к Товару, Комплекту или Модификации, необходимо и достаточно указать в url запросе id сущности, к которой добавляется Изображение, и указать не пустые поля filename и content в переданном объекте.

В поле content нужно указать изображение, закодированное в Base64, в поле filename - имя файла с расширением.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Изображениями.

Изменение списка Изображений у Товара, Комплекта или Модификации

В теле запроса нужно передать массив, содержащий JSON представления Изображений, которые вы хотите установить для Товара, Комплекта или Модификации. Если необходимо оставить некоторые Изображения у Товара, Комплекта или Модификации, то тело запроса должно содержать их идентификаторы в виде метаданных.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Изображениями.

Удалить Изображение

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Изображениями.
idImage string (required) Example: 19f1edc0-fc42-4001-94cb-c9ec9c62ec10 id Изображениями.

Response 200 (application/json) Успешное удаление Изображения.

Удалить группу Изображений

При удалении нескольких изображений у Товара, Комплекта или Модификации, удаляются первые найденые по id изображения, указанные в теле запроса.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Изображениями.

Response 200 (application/json) Успешное удаление Изображений.

Канал продаж

Каналы продаж

Средствами JSON API можно создавать и обновлять сведения о Каналах продаж, запрашивать списки Каналов продаж и сведения по отдельным Каналам продаж. Кодом сущности для Канала продаж в составе JSON API является ключевое слово saleschannel. Больше о Каналах продаж и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов канала продаж на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли Канал продаж в архив
Обязательное при ответе
code String(255) = != ~ ~= =~ Код Канала продаж
description String(4096) = != ~ ~= =~ Описание Канала продаж
externalCode String(255) = != ~ ~= =~ Внешний код Канала продаж
Обязательное при ответе
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Канала продаж
Обязательное при ответе Только для чтения
meta Meta Метаданные Канала продаж
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Канала продаж
Обязательное при ответе Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
type Enum = != Тип Канала продаж Подробнее тут
Обязательное при ответе Необходимо при создании
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Тип канала продаж

Перечисление значений, представляющих тип Канала продаж:

Название Описание
MESSENGER Мессенджер
SOCIAL_NETWORK Социальная сеть
MARKETPLACE Маркетплейс
ECOMMERCE Интернет-магазин
CLASSIFIED_ADS Доска объявлений
DIRECT_SALES Прямые продажи
OTHER Другое

Атрибуты доступные для фильтрации

Значение Описание
accountId ID учетной записи
archived Добавлен ли Канал продаж в архив
description Описание Канала продаж
externalCode Внешний код Канала продаж
group Отдел сотрудника
id ID Канала продаж
name Наименование Канала продаж
owner Ссылка на Владельца (Сотрудника)
shared Общий доступ
type Тип Канала продаж
updated Момент последнего обновления сущности

Получить Каналы продаж

Запрос на получение списка всех каналов продаж на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой каналы продаж.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Канал продаж

Запрос на создание нового канала продаж. Необходимыми полями в теле запроса для создания канала продаж являются name и type.

Массовое создание и обновление Каналов продаж

Массовое создание и обновление Каналов продаж. В теле запроса нужно передать массив, содержащий JSON представления Каналов продаж, которые вы хотите создать или обновить. Обновляемые Каналы продаж должны содержать идентификатор в виде метаданных. Для Каналов продаж, созданных при подключении интернет-магазина, нельзя обновить тип. При изменении наименования таких каналов продаж наименование связанного интернет-магазина изменится.

Удалить Канал продаж

Параметры

Параметр Описание
id string (required) Example: d94605a8-2033-11ec-9621-0242ac130002 id Канала продаж.

Response 200 (application/json) Успешное удаление Канала продаж.

Массовое удаление Каналов продаж

В теле запроса нужно передать массив, содержащий JSON метаданных Каналов продаж, которые вы хотите удалить.

Канал продаж

Параметры

Параметр Описание
id string (required) Example: d94605a8-2033-11ec-9621-0242ac130002 id Канала продаж.

Получить Канал продаж

Изменить Канал продаж

Запрос на изменение объекта Канала продаж. Для Каналов продаж, которые были созданы при подключении интернет-магазина, нельзя изменить тип. Если изменить наименование такого Канала продаж, то будет изменено наименование связанного интернет-магазина.

Параметры

Параметр Описание
id string (required) Example: b2dc42f0-203e-11ec-9621-0242ac130002 id Канала продаж.

Кассир

Кассиры

Средствами JSON API можно запрашивать списки Кассиров и сведения по отдельным кассирам. Кодом сущности для кассира в составе JSON API является ключевое слово cashier.

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи Кассира
Обязательное при ответе Только для чтения
employee Meta Метаданные сотрудника, которого представляет собой кассир
Обязательное при ответе Expand
id UUID ID Кассира
Обязательное при ответе Только для чтения
meta Meta Метаданные Кассира
Обязательное при ответе Только для чтения
retailStore Meta Метаданные точки продаж, к которой прикреплен кассир
Обязательное при ответе Expand

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

Запрос на получение списка всех кассиров на данной точке продаж. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Кассиров.

Параметры

Параметр Описание
retailStoreId string (required) Example: ea05e0c9-8667-11e7-8a7f-40d000000060 id Точки продаж.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Кассир

Получить Кассира

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Кассира.
retailStoreId string (required) Example: ea05e0c9-8667-11e7-8a7f-40d000000060 id Точки продаж.

Коды маркировки

Код маркировки

Средствами JSON API можно получать, создавать, редактировать и удалять Коды маркировки. Сущность представлена в виде идентификатора, текстового кода, типа кода и массива вложенных Кодов маркировки. Коды маркировки относятся к отдельной позиции конкретного документа. Порядок вывода КМ первого уровня фиксирован - вложенные КМ могут выводиться в случайном порядке.

Атрибуты сущности

Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
id UUID ID кода маркировки Только для чтения да нет
cis String Код маркировки в стандартном формате Необходимое при создании нет нет
cis_1162 String Код маркировки в формате тега 1162 Только для чтения нет нет
type String Тип кода маркировки Необходимое при создании да нет
trackingCodes Array(Object) Массив вложенных кодов маркировки - нет нет

Пример запроса: Сущности и документы - /entity/[entityType]/[entityId]/positions/[positionId]/trackingCodes

Получить Коды маркировки позиции документа

Параметры

Параметр Описание
limit number (optional) Default: 100 Example: 50 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 100.
offset number (optional) Default: 0 Example: 50 Отступ в выдаваемом списке сущностей.
codetype number (optional) Default: gs1 Формат получаемых кодов маркировки.

Возможные значения codetype

Результат успешного запроса - JSON представление списка Кодов маркировки с перечисленными полями:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой коды маркировки.

Массовое создание и обновление Кодов маркировки

Массовое создание и обновление КМ указанной позиции. В теле запроса нужно передать массив, содержащий JSON представления Кодов маркировки, которые вы хотите создать или обновить. Обновляемые Коды маркировки должны содержать идентификатор.

Результат успешного запроса - массив JSON представлений созданных и обновленных Приемок.

Вложенные КМ заменяются указанными в запросе.

Массовое удаление Кодов маркировки

В теле запроса нужно передать массив, содержащий JSON метаданных Кода маркировки, которые вы хотите удалить, либо список с идентификаторами.

Если указанный в запросе КМ содержит вложенные коды, они тоже подлежат удалению.

Комплект

Комплекты

Средствами JSON API можно создавать и обновлять сведения о Комплектах, запрашивать списки Комплектов и сведения по отдельным Комплектам. Кодом сущности для Комплекта в составе JSON API является ключевое слово bundle.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли Комплект в архив
Обязательное при ответе
article String(255) = != ~ ~= =~ Артикул
attributes Array(Object) Операторы доп. полей Коллекция доп. полей
barcodes Array(Object) = != ~ ~= =~ Штрихкоды Комплекта. Подробнее тут
code String(255) = != ~ ~= =~ Код Комплекта
components MetaArray Массив компонентов Комплекта
Expand
country Meta Метаданные Страны
Expand
description String(4096) = != ~ ~= =~ Описание Комплекта
discountProhibited Boolean Признак запрета скидок
Обязательное при ответе
effectiveVat Int Реальный НДС %
Только для чтения
effectiveVatEnabled Boolean Дополнительный признак для определения разграничения реального НДС = 0 или "без НДС". (effectiveVat = 0, effectiveVatEnabled = false) -> "без НДС", (effectiveVat = 0, effectiveVatEnabled = true) -> 0%.
Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Комплекта
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Expand
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Комплекта
Обязательное при ответе Только для чтения
images MetaArray Массив метаданных Изображений (Максимальное количество изображений - 10)
Expand
meta Meta Метаданные Комплекта
Обязательное при ответе
minPrice Object Минимальная цена. Подробнее тут
name String(255) = != ~ ~= =~ Наименование Комплекта
Обязательное при ответе Необходимо при создании
overhead Object Дополнительные расходы. Подробнее тут
owner Meta = != Метаданные владельца (Сотрудника)
Expand
partialDisposal Boolean Управление состоянием частичного выбытия маркированного товара. «true» - возможность включена.
pathName String = != ~ ~= =~ Наименование группы, в которую входит Комплект
Обязательное при ответе Только для чтения
paymentItemType Enum Признак предмета расчета. Подробнее тут
productFolder Meta Метаданные группы Комплекта
Expand
salePrices Array(Object) Цены продажи
shared Boolean = != Общий доступ
Обязательное при ответе
syncId UUID = != ID синхронизации
Только для чтения Заполнение при создании
taxSystem Enum Код системы налогообложения. Подробнее тут
tnved String(255) Код ТН ВЭД
trackingType Enum Тип маркируемой продукции. Подробнее тут
uom Meta Единицы измерения
Expand
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения
useParentVat Boolean Используется ли ставка НДС родительской группы. Если true для единицы ассортимента будет применена ставка, установленная для родительской группы.
Обязательное при ответе
vat Int НДС %
vatEnabled Boolean Включен ли НДС для товара. С помощью этого флага для товара можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
volume Int = != < > <= >= Объем
weight Int = != < > <= >= Вес
Тип маркируемой продукции

Значения поля trackingType.

Значение Описание
BEER_ALCOHOL Пиво и слабоалкогольная продукция
ELECTRONICS Фотокамеры и лампы-вспышки
FOOD_SUPPLEMENT Биологически активные добавки к пище
LP_CLOTHES Тип маркировки "Одежда"
LP_LINENS Тип маркировки "Постельное белье"
MILK Молочная продукция
NCP Никотиносодержащая продукция
NOT_TRACKED Без маркировки
OTP Альтернативная табачная продукция
PERFUMERY Духи и туалетная вода
SANITIZER Антисептики
SHOES Тип маркировки "Обувь"
TIRES Шины и покрышки
TOBACCO Тип маркировки "Табак"
WATER Упакованная вода
Признак предмета расчета

Значения поля paymentItemType.

Значение Описание
GOOD Товар
EXCISABLE_GOOD Подакцизный товар
COMPOUND_PAYMENT_ITEM Составной предмет расчета
ANOTHER_PAYMENT_ITEM Иной предмет расчета
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
PATENT_BASED Патент
PRESUMPTIVE_TAX_SYSTEM ЕНВД
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
TAX_SYSTEM_SAME_AS_GROUP Совпадает с группой
UNIFIED_AGRICULTURAL_TAX ЕСХН

Комплект как позиция документа

Комплект может выступать в роли позиции документа. Он также как и товары, услуги и модификации может быть передан в составе позиции в формате метаданных.
Вот некоторые ограничения, связанные с использованием комплектов как позиций:

Атрибуты вложенных сущностей

Дополнительные расходы

Структура объекта overhead.

Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Минимальная цена

Структура объекта minPrice.

Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand

Компоненты Комплекта

Компоненты Комплекта - это список товаров/услуг/модификаций, который входят в состав комплекта. Компонентов у комплекта может быть от 1 до 50. Объект компонента Комплекта содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара/услуги/серии, которую представляет собой компонент
Обязательное при ответе Expand
id UUID ID компонента
Обязательное при ответе Только для чтения
quantity Int Количество товаров/услуг данного вида в компоненте
Обязательное при ответе Только для чтения
Метаданные Комплектов

Метаданные Комплектов содержат информацию о дополнительных полях.

Посмотреть все созданные в основном интерфейсе доп. поля Комплектов, а также все типы цен можно с помощью запроса на получение метаданных Товаров.

Структуры объектов отдельных коллекций:

Штрихкоды:

При создании штрихкода требуется описать объект с полем, являющимся форматом представления штрихкода в нижнем регистре, со строковым значением самого штрихкода. Наименование полей отдельного объекта, представляющего штрихкод:

Название Описание
ean13 штрихкод в формате EAN13, если требуется создать штрихкод в формате EAN13
ean8 штрихкод в формате EAN8, если требуется создать штрихкод в формате EAN8
code128 штрихкод в формате Code128, если требуется создать штрихкод в формате Code128
gtin штрихкод в формате GTIN, если требуется создать штрихкод в формате GTIN. Валидируется на соответствие формату GS1
upc штрихкод в формате UPC, если требуется создать штрихкод в формате UPC

Для обновления списка штрихкодов необходимо передавать их полный список, включающий как старые, так и новые значения. Отсутствующие значения штрихкодов при обновлении будут удалены. При обновлении списка штрихкодов валидируются только новые значения. Ранее сохраненные штрихкоды не валидируются. То есть, если один из старых штрихкодов не соответствует требованиям к валидации, то ошибки при обновлении списка не будет. Если на вход передан пустой список штрихкодов или список из пустых значений, то ранее созданные штрихкоды будут удалены.

Особенности создания списка штрихкодов при создании комплекта:

О работе с доп. полями Комплектов можно прочитать здесь

Изображение: структура и загрузка.

При запросе Комплекта с изображениями будет выведено json представление этого Комплекта, содержащее поле images. Данное поле является массивом элементов. Элементы поля images имеют поля:

Название Тип Описание
filename String(255) Имя файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
updated DateTime Время загрузки файла на сервер
Обязательное при ответе

Загрузка

Для загрузки изображения нужно в теле запроса на создание или обновление Комплекта указать поле images со списком элементов, имеющих следующие атрибуты:

Название Описание
filename имя файла с расширением. Например - "банан.png"
content Изображение, закодированное в формате Base64.

Если в запросе на обновление images будет содержать пустой массив элементов, то все Изображения у Комплекта будут удалены, т.к. сервер посчитает, что пользователь хочет обновить список Изображений Комплекта.

Документация API по работе с Изображениями приведена в главе Изображение.

О работе с доп. полями Комплектов можно прочитать здесь

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

Запрос на получение всех комплектов для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой комплекты.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Комплект

Создать новый комплект.

Описание

Комплект создается на основе переданного объекта JSON, который содержит представление нового Комплекта. Результат - JSON представление созданного Комплекта. Для создания нового Комплекта необходимо и достаточно указать в переданном объекте не пустое поле name и не пустое множество компонентов components. Максимальное число компонентов в Комплекте - 50.

Массовое создание и обновление Комплектов

Массовое создание и обновление Комплектов. В теле запроса нужно передать массив, содержащий JSON представления Комплектов, которые вы хотите создать или обновить. Обновляемые Комплекты должны содержать идентификатор в виде метаданных.

Метаданные Комплектов

Посмотреть все созданные в основном интерфейсе доп. поля Комплектов, а также все типы цен можно с помощью запроса на получение метаданных Товаров.

Комплект

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Получить Комплект

Изменить Комплект

Запрос на обновление существующего Комплекта. Типы цен в ценах продаж, дополнительные поля и компоненты обновляются как элементы вложенных коллекций:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Удалить Комплект

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Response 200 (application/json) Успешное удаление Комплекта.

Массовое удаление Комплектов

В теле запроса нужно передать массив, содержащий JSON метаданных Комплектов, которые вы хотите удалить.

Компоненты Комплекта

Отдельный ресурс для управления компонентами Комплекта.

Получить компоненты Комплекта

Запрос на получение списка всех компонентов данного Комплекта.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Комплекта.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Добавить компонент Комплекта

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Компонент Комплекта

Параметры

Параметр Описание
id string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id компонента Комплекта.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Получить компонент

Изменить компонент

Параметры

Параметр Описание
id string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id компонента Комплекта.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Запрос на изменение отдельного компонента Комплекта с указанным id.

Удалить компонент

Параметры

Параметр Описание
id string (required) Example: 34f6344f-015e-11e6-9464-e4de0000006c id компонента Комплекта.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Комплекта.

Response 200 (application/json) Успешное удаление компонента Комплекта.

Массовое удаление компонентов Комплекта

В теле запроса нужно передать массив, содержащий JSON метаданных компонентов Комплекта, которые требуется удалить.

Response 200 (application/json) Успешное удаление компонентов Комплекта.

Контрагент

Контрагенты

Средствами JSON API можно создавать и обновлять сведения о Контрагентах, запрашивать списки Контрагентов и сведения по отдельным Контрагентам. Счетами Контрагента и его контактными лицами можно управлять как в составе отдельного Контрагента, так и отдельно - с помощью специальных ресурсов для управления счетами и контактными лицами Контрагента. Кодом сущности для Контрагента в составе JSON API является ключевое слово counterparty. Больше о Контрагентах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке.

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

Первое условие поиска:

Второе условие поиска:

Третье условие поиска по полям из всех контактных лиц фирмы контрагента (contactpersons):

Четвертое условие поиска по полям из всех контактных лиц фирмы контрагента (contactpersons):

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
accounts MetaArray Массив счетов Контрагентов. Подробнее тут
Обязательное при ответе Expand
actualAddress String(255) = != ~ ~= =~ Фактический адрес Контрагента
actualAddressFull Object Фактический адрес Контрагента с детализацией по отдельным полям. Подробнее тут
archived Boolean = != Добавлен ли Контрагент в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Массив метаданных доп. полей
bonusPoints Int Бонусные баллы по активной бонусной программе
Только для чтения
bonusProgram Meta Метаданные активной Бонусной программы
Expand
code String(255) = != ~ ~= =~ Код Контрагента
companyType Enum = != Тип Контрагента. В зависимости от значения данного поля набор выводимых реквизитов контрагента может меняться. Подробнее тут
Обязательное при ответе
contactpersons MetaArray Массив контактных лиц фирмы Контрагента. Подробнее тут
Expand
created DateTime = != < > <= >= Момент создания
Обязательное при ответе
description String(4096) = != ~ ~= =~ Комментарий к Контрагенту
discountCardNumber String(255) = != ~ ~= =~ Номер дисконтной карты Контрагента
discounts Array(Object) Массив скидок Контрагента. Массив может содержать персональные и накопительные скидки. Персональная скидка выводится, если хотя бы раз изменялся процент скидки для контрагента, значение будет указано в поле personalDiscount
email String(255) = != ~ ~= =~ Адрес электронной почты
externalCode String(255) = != ~ ~= =~ Внешний код Контрагента
Обязательное при ответе
fax String(255) = != ~ ~= =~ Номер факса
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Обязательное при ответе Expand
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Контрагента
Обязательное при ответе Только для чтения
meta Meta Метаданные Контрагента
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Контрагента
Обязательное при ответе Необходимо при создании
notes MetaArray Массив событий Контрагента. Подробнее тут
Expand
owner Meta = != Владелец (Сотрудник)
Expand
phone String(255) = != ~ ~= =~ Номер городского телефона
priceType Object = != Тип цены Контрагента. Подробнее тут
salesAmount Int Сумма продаж
Обязательное при ответе Только для чтения
shared Boolean = != Общий доступ
Обязательное при ответе
state Meta = != Метаданные Статуса Контрагента
Expand
syncId UUID = != ID синхронизации
После заполнения недоступно для изменения
tags Array(String) = != Группы контрагента
updated DateTime = != < > <= >= Момент последнего обновления Контрагента
Обязательное при ответе Только для чтения
Поля реквизитов
Название Тип Фильтрация Описание
birthDate DateTime Дата рождения Контрагента типа [Физическое лицо]. Игнорируется для Контрагентов типов [Индивидуальный предприниматель, Юридическое лицо]
certificateDate DateTime Дата свидетельства
certificateNumber String(255) Номер свидетельства
inn String(255) = != ~ ~= =~ ИНН
kpp String(255) = != ~ ~= =~ КПП
legalAddress String(255) = != ~ ~= =~ Юридический адрес Контрагента
legalAddressFull Object Юридический адрес Контрагента с детализацией по отдельным полям
legalFirstName String(255) Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalLastName String(255) Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalMiddleName String(255) Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalTitle String(4096) = != ~ ~= =~ Полное наименование для Контрагента типа [Юридическое лицо]. Игнорируется для Контрагентов типа [Индивидуальный предприниматель, Физическое лицо], если передано одно из значений для ФИО и формируется автоматически на основе получаемых ФИО Контрагента
ogrn String(255) ОГРН
ogrnip String(255) ОГРНИП
okpo String(255) ОКПО
sex String(255) Пол Контрагента. Подробнее тут

Накопительная скидка выводится, если для контрагента хотя бы раз устанавливалась коррекция суммы накоплений по скидке, значение будет указано в поле demandSumCorrection или при выполнении условий накопительной скидки Проценты скидок при определенной сумме продаж, актуальное значение будет отображено в поле accumulationDiscount. Формат вывода скидок можно посмотреть в разделе Скидки.

Атрибуты вложенных сущностей

Аттрибуты сущности Адрес

Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому аттрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле actualAddress передать пустую строку "".

Счета Контрагентов
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
accountNumber String(255) Номер счета
Обязательное при ответе Необходимо при создании
bankLocation String(255) Адрес банка
bankName String(255) Наименование банка
bic String(255) БИК
correspondentAccount String(255) Корр счет
id UUID ID Счета
Обязательное при ответе Только для чтения
isDefault Boolean Является ли счет основным счетом Контрагента
Обязательное при ответе
meta Meta Метаданные Счета Контрагента
Обязательное при ответе
updated DateTime Момент последнего обновления Контрагента
Обязательное при ответе Только для чтения
Контактные лица Контрагентов
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
agent Meta Метаданные контрагента
Обязательное при ответе Expand
description String(4096) Описание контактного лица
email String(255) Адрес электронной почты контактного лица
externalCode String(255) Внешний код контактного лица
id UUID ID Контактного лица
Обязательное при ответе Только для чтения
meta Meta Метаданные Контактного лица Контрагента
Обязательное при ответе
name String(255) ФИО контактного лица
Обязательное при ответе Необходимо при создании
phone String(255) Номер телефона контактного лица
position String(255) Должность контактного лица
updated DateTime Момент последнего обновления
Обязательное при ответе Только для чтения
События Контрагента
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
agent Meta Метаданные Контрагента
Обязательное при ответе Только для чтения Expand
author Meta Метаданные Сотрудника - создателя события (администратор аккаунта, если автор - приложение)
Обязательное при ответе Только для чтения
authorApplication Meta Метаданные Приложения - создателя события
Только для чтения
created DateTime Момент создания события Контрагента
Обязательное при ответе Только для чтения
description String(4096) Текст события Контрагента
Обязательное при ответе Необходимо при создании
id UUID ID События
Обязательное при ответе Только для чтения
meta Meta Метаданные событий контрагента
Обязательное при ответе

Тип Контрагента

В зависимости от типа контрагента companyType в составе его объекта будут выводиться разные наборы реквизитов. Типы контрагента и соответствующие значения, которые могут быть переданы в данном поле:

Значение поля companyType Тип контрагента
legal Юридическое лицо
entrepreneur Индивидуальный предприниматель
individual Физическое лицо

Если тип контрагента Юридическое лицо, будут выведены следующие поля реквизитов:

Название Описание
inn ИНН
kpp КПП
legalAddress Юридического адреса Контрагента
legalTitle Полное наименование Контрагента
ogrn ОГРН
okpo ОКПО
tags Группы (массив)

Если тип контрагента Индивидуальный предприниматель, будут выведены следующие поля реквизитов:

Название Описание
certificateDate Дата свидетельства
certificateNumber Номер свидетельства
inn ИНН
legalAddress Юридический адрес Контрагента
legalAddressFull Юридический адрес Контрагента с детализацией по отдельным полям
legalFirstName Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalLastName Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalMiddleName Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalTitle Полное наименование Контрагента. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
ogrnip ОГРНИП
okpo ОКПО

Если тип контрагента Физическое лицо, будут выведены следующие поля реквизитов:

Название Описание
birthDate Дата рождения Контрагента типа [Физическое лицо]. Игнорируется для Контрагентов типа [Индивидуальный предприниматель, Юридическое лицо]
inn ИНН
legalAddress Юридический адрес Контрагента
legalAddressFull Юридический адрес Контрагента с детализацией по отдельным полям
legalFirstName Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalLastName Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalMiddleName Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalTitle Полное наименование Контрагента. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
sex Пол Контрагента. Подробнее тут

О работе с доп. полями Контрагентов можно прочитать здесь

Пол Контрагента

Пол Контрагента используется только для Контрагента типа [Физическое лицо]. Игнорируется для Контрагентов типа [Индивидуальный предприниматель, Юридическое лицо]

Значение поля sex Пол контрагента
MALE Мужской
FEMALE Женский

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

Получить список всех Контрагентов. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой контрагентов.

Параметры

Параметр Описание
limit number (optional) Defaul: 1000 Example: 1000. Максимальное количество сущностей для извлечения. Допустимые значения 1 - 1000
offset number (optional) Defaul: 0 Example: 40. Отступ в выдаваемом списке сущностей
tags string(optional) Example: рабочие. Подробнее про данный параметр можно посмотреть в разделе Фильтрация выборки с помощью параметра filter. Формат строки : string

Создать Контрагента

Обязательные для создания поля:

Название Описание
name Наименование Контрагента
Описание

Контрагент создается на основе переданного объекта JSON, который содержит представление нового Контрагента.

Массовое создание и обновление Контрагентов

Массовое создание и обновление Контрагентов. В теле запроса нужно передать массив, содержащий JSON представления Контрагентов, которые вы хотите создать или обновить. Обновляемые Контрагенты должны содержать идентификатор в виде метаданных.

Удалить Контрагента

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b1. id Контрагента

Response 200. Успешное удаление Контрагента.

Массовое удаление Контрагентов

В теле запроса нужно передать массив, содержащий JSON метаданных Контрагентов, которые вы хотите удалить.

Метаданные Контрагентов

Метаданные Контрагентов

Запрос на получение метаданных Контрагентов. Результат - объект JSON, включающий в себя:

Параметр Описание
meta Ссылка на метаданные Контрагентов
attributes Массив объектов доп. полей Контрагентов в формате Метаданных
states Массив статусов Контрагентов
createShared создавать новых Контрагентов с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 - id Доп. поля.

Контрагент

Получить Контрагента

Контрагент, обращение к которому происходит по значению его id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

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

Описание

Обновляется представление Контрагента с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Контрагента, кроме тех, что помечены Только для чтения в описании атрибутов Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются. Поля account и contactpersons обновляются как элементы вложенных коллекций. При обновлении, переданные элементы данных коллекций обрабатываются как "Все элементы данной коллекции" и полностью заменяют элементы, ранее присутствовавшие в ней.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

Счета Контрагента

Получить счета Контрагента

Список счетов Контрагента с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
limit number (optional) Default: 1000 Example: 1000 - Максимальное количество сущностей для извлечения. Допустимые значения 1 - 1000
offset number (optional) Default: 0 Example: 40 - Отступ в выдаваемом списке сущностей.

Создать счет Контрагента

Создать счет Контрагента с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

Счет Контрагента

Параметры

Параметр Описание
accountId string (required) (required) Example: 7944ef04-f831-11e5-7a69-971500188b18 - id Счета.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить счет Контрагента

Изменить счет Контрагента

Параметры

Параметр Описание
accountId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b18 - id счёта.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

Описание

Обновить счет Контрагента с указанным id. Поля, которые не были указаны в JSON запроса, не изменяются.

Контактные лица Контрагента

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Список контактных лиц

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

Создать контактное лицо Контрагента с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

Контактное лицо

Параметры

Параметр Описание
contactpersonId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id контактного лица.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

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

Параметры

Параметр Описание
contactpersonId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id контактного лица.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.

Описание

Обновить контактное лицо Контрагента с указанным id. Обновляются все поля, указанные в JSON объекте запроса, кроме помеченных Только для чтения в описании атрибутов контактных лиц Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются.

События Контрагента

Параметры

Параметр Описание
id string (required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056 - id Контрагента.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Добавить событие

Параметры

Параметр Описание
id string (required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056 - id Контрагента.

Событие

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
noteId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id события.

Получить событие

Изменить событие

Описание

Обновить событие Контрагента с указанным id. Обновляются все поля, указанные в JSON объекте запроса, кроме помеченных Только для чтения в описании атрибутов событий Контрагента. Поля, которые не были указаны в JSON запроса, не изменяются.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
noteId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id события.

Удалить событие

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
noteId string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id события.

Response 200 (application/json). Успешное удаление События.

Настройки справочника контрагентов

Средствами JSON API можно управлять настройками справочника контрагентов.

Атрибуты настроек справочника контрагентов

Название Тип Описание
meta Meta Метаданные Настроек справочника контрагентов
Обязательное при ответе
uniqueCodeRules Object Настройки кодов контрагентов
Обязательное при ответе
createShared Boolean Создавать новые документы с меткой «Общий»
Обязательное при ответе

Настройки кодов контрагентов

Название Тип Описание
checkUniqueCode Boolean Проверка уникальности кода справочника
Обязательное при ответе
fillUniqueCode Boolean Устанавливать уникальный код
Обязательное при ответе

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

Изменить настройки справочника контрагентов

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

Модификация

Модификации

Средствами JSON API можно создавать и обновлять сведения о Модификациях товаров, запрашивать списки Модификаций товаров и сведения по отдельным Модификациям. Кодом сущности для Модификации в составе JSON API является ключевое слово variant. Больше о Модификациях товаров и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке, а также больше о работе с товарами здесь. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов модификаций на соответствие поисковой строке будет осуществлен по следующим полям:

Возможна фильтрация списка Модификаций по id товара - параметр фильтрации productid. Доступные операторы фиьтрации = != . Подробнее про фильтрацию можно прочитать в разделе Фильтрация выборки с помощью параметра filter

Примеры:

Атрибуты Сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли товар в архив
Обязательное при ответе
barcodes Array(Object) = != ~ ~= =~ Массив штрихкодов модификации. Подробнее тут
buyPrice Object Закупочная цена
characteristics Array(Object) Характеристики Модификации. Подробнее тут
Обязательное при ответе Необходимо при создании
code String(255) = != ~ ~= =~ Код Модификации
description String(4096) = != ~ ~= =~ Описание Модификации
discountProhibited Boolean Признак запрета скидок
Обязательное при ответе
externalCode String(255) = != ~ ~= =~ Внешний код Модификации
Обязательное при ответе
id UUID = != ID Модификации
Обязательное при ответе Только для чтения
images MetaArray Массив метаданных Изображений (Максимальное количество изображений - 10)
Обязательное при ответе Expand
meta Meta Метаданные Модификации
Обязательное при ответе
minPrice Object Минимальная цена. Подробнее тут
name String(255) = != ~ ~= =~ Наименование товара с Модификацией
Обязательное при ответе
packs Array(Object) Упаковки модификации Подробнее тут
product Meta Метаданные товара, к которому привязана Модификация
Обязательное при ответе Expand Необходимо при создании
salePrices Array(Object) Цены продажи. Подробнее тут
things Array(String) Серийные номера
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Атрибуты доступные для сортировки

Название Описание
code Код Модификации
externalCode Внешний код Модификации
archived Добавлен ли товар в архив

Атрибуты вложенных сущностей

Штрихкоды:

При создании штрихкода требуется описать объект с полем, являющимся форматом представления штрихкода в нижнем регистре, со строковым значением самого штрихкода. Наименование полей отдельного объекта, представляющего штрихкод:

Название Описание
ean13 штрихкод в формате EAN13, если требуется создать штрихкод в формате EAN13
ean8 штрихкод в формате EAN8, если требуется создать штрихкод в формате EAN8
code128 штрихкод в формате Code128, если требуется создать штрихкод в формате Code128
gtin штрихкод в формате GTIN, если требуется создать штрихкод в формате GTIN. Валидируется на соответствие формату GS1
upc штрихкод в формате UPC, если требуется создать штрихкод в формате UPC

Для обновления списка штрихкодов необходимо передавать их полный список, включающий как старые, так и новые значения. Отсутствующие значения штрихкодов при обновлении будут удалены. При обновлении списка штрихкодов валидируются только новые значения. Ранее сохраненные штрихкоды не валидируются. То есть, если один из старых штрихкодов не соответствует требованиям к валидации, то ошибки при обновлении списка не будет. Если на вход передан пустой список штрихкодов или список из пустых значений, то ранее созданные штрихкоды будут удалены.

Особенности создания списка штрихкодов при создании комплекта:

О работе с доп. полями Комплектов можно прочитать здесь

Метаданные Модификаций

Метаданные Модификаций содержат информацию о характеристиках Модификаций, а также о типах цен. Характеристики Модификации - внутренняя коллекция characteristics. Представлена в виде массива объектов с полями:

Название Тип Описание
id UUID ID соответствующей характеристики
Обязательное при ответе
meta Meta Метаданные характеристики
Обязательное при ответе
name String(255) Наименование характеристики
Обязательное при ответе
value String(255) Значение характеристики
Обязательное при ответе Необходимо при создании

Посмотреть все созданные в основном интерфейсе характеристики Модификаций, а также все типы цен можно с помощью запроса на получение метаданных Модификаций. Ответ - объект, со следующей структурой:

Название Тип Описание
meta Meta Метаданные
Обязательное при ответе
characteristics Array(Object) Коллекция всех созданных характеристик Модификаций
Обязательное при ответе

Структуры отдельных объектов коллекций:

Характеристики модификации
Название Тип Описание
id UUID ID соответствующей характеристики
Обязательное при ответе
meta Meta Метаданные характеристики
Обязательное при ответе
name String(255) Наименование характеристики
Обязательное при ответе
required Boolean Флаг о том, является ли характеристика обязательной
Обязательное при ответе
type String(255) Тип значения характеристики
Обязательное при ответе
Изображение: структура и загрузка.

При запросе Модификации с изображениями будет выведено json представление этой Модификации, содержащее поле images. Данное поле является массивом элементов. Элементы поля images имеют поля:

Название Тип Описание
filename String(255) Имя файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
updated DateTime Время загрузки файла на сервер
Обязательное при ответе

Загрузка

Для загрузки изображений нужно в теле запроса на создание или обновление модификации указать поле images со списком элементов, имеющих следующие атрибуты:

Название Описание
filename имя файла с расширением. Например - "банан.png"
content Изображение, закодированное в формате Base64.

Если в запросе на обновление images будет содержать пустой массив элементов, то все Изображения у Модификации будут удалены, т.к. сервер посчитает, что пользователь хочет обновить список Изображений Модификации.

Документация API по работе с Изображениями приведена в главе Изображение.

Цены продажи

Если у модификации не заданы отдельные цены продажи, в ответе будут выведены соответствующие цены продажи товара.

Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
priceType Object Тип цены
Обязательное при ответе
Минимальная цена
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Упаковки Модификации
Название Тип Описание
barcodes Array(Object) Массив штрихкодов упаковки модификации. Данный массив может содержать только один штрихкод
Обязательное при ответе
id UUID ID упаковки модификации
Обязательное при ответе Только для чтения
parentpack Meta Метаданные родительской упаковки (упаковки товара), для которой переопределяется штрихкод
Обязательное при ответе Expand

Получить список Модификаций

Запрос на получение списка всех Модификаций на данной учетной записи. Результат успешного запроса - JSON представление списка Модификаций с перечисленными полями:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой модификации.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Модификацию

Создать новую Модификацию. Для создания новой Модификации необходимы поля product, characteristics. Поле characteristics указывается как массив объектов со следующей структурой:

Название Тип Описание
id UUID ID характеристики
name String(255) Наименование характеристики
value String(255) Значение характеристики
Обязательное при ответе Необходимо при создании

Если поле id не указано у какого-либо объекта характеристики, производится поиск соответствующей этому объекту характеристики по полю name. Если же не указаны ни id, ни name, то произойдет ошибка.

Массовое создание и обновление Модификаций

Массовое создание и обновление Модификаций. В теле запроса нужно передать массив, содержащий JSON представления Модификаций, которые вы хотите создать или обновить. Обновляемые Модификации должны содержать идентификатор в виде метаданных.

Удалить Модификацию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id модификации.

Response 200 (application/json) Успешное удаление Модификации.

Массовое удаление Модификаций

В теле запроса нужно передать массив, содержащий JSON метаданных Модификаций, которые вы хотите удалить.

Метаданные Модификаций

Метаданные Модификаций

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

Название Тип Описание
meta Meta Метаданные
Обязательное при ответе
characteristics Array(Object) Коллекция всех созданных характеристик Модификаций
Обязательное при ответе

Модификация

Работа с Модификацией с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id модификации.

Получить Модификацию

Изменить Модификацию

Запрос на обновление Модификации с указанным id. Типы цен в ценах продаж обновляются как элементы вложенных коллекций:

При обновлении характеристик Модификации поле characteristics указывается как массив объектов со следующей структурой:

Название Тип Описание
id UUID ID характеристики
name String(255) Наименование характеристики
value String(255) Значение характеристики
Обязательное при ответе Необходимо при создании

Если поле id не указано у какого-либо объекта характеристики, производится поиск соответствующей этому объекту характеристики по полю name. Если же не указаны ни id, ни name, то произойдет ошибка. При обновлении поле characteristics в теле запроса обрабатывается как "все характеристики модификации", т.е. полностью заменяет предыдущий массив характеристик. Если какая-то из характеристик, имевшая значение в обновляемом объекте, не указана в запросе на обновление, после запроса ее значение будет аннулированно.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id модификации.

Настройки компании

На данный момент можно получить информацию о текущих настройках компании и типах цен товаров.

Настройки компании

Атрибуты сущности

Название Тип Описание
checkMinPrice Boolean Автоматически устанавливать минимальную цену. Если включено, при сохранении документов продажи с ценами меньше минимальных цен (указанных в карточках товара) цены будут автоматически увеличены до минимальных.
Обязательное при ответе
checkShippingStock Boolean Запретить отгрузку отсутствующих товаров. Если запрет установлен (true значение), пользователи не смогут провести отгрузку со склада отсутствующих товаров.
Обязательное при ответе
companyAddress String(255) Адрес компании для электронных писем
currency Meta Метаданные стандартной валюты
Обязательное при ответе
discountStrategy Enum Совместное применение скидок. Подробнее тут
Обязательное при ответе Необходимо при создании
globalOperationNumbering Boolean Использовать сквозную нумерацию документов. Если проставлен true, будет установлена сквозная нумерация за всю историю, иначе нумерация документов будет начинаться заново каждый календарный год.
Обязательное при ответе
meta Meta Метаданные Настроек компании
Обязательное при ответе
priceTypes Array(Object) Коллекция всех существующих типов цен. Подробнее тут
Обязательное при ответе
useCompanyAddress Boolean Использовать адрес компании для электронных писем. Если включено, письма будут отправляться с адреса, указанного в companyAddress, иначе письма будут отправляться с адреса пользователя.
Обязательное при ответе
useRecycleBin Boolean Использовать корзину. Если включено, то все документы при удалении будут помещаться в корзину. Также появится возможность восстанавливать ошибочно удаленные документы.
Обязательное при ответе
accountCountry String(255) Передается для информации о том, какая страновая конфигурация активна на аккаунте пользователя. Возможные значения: RU, BY, KZ.
Обязательное при ответе Только для чтения

Тип цены

Структура отдельного объекта, представляющего тип цены:

Название Тип Описание
externalCode String(255) Внешний код Типа цены
Обязательное при ответе
id UUID ID Типа цены
Обязательное при ответе Только для чтения
meta Meta Метаданные Типа цены
Обязательное при ответе Только для чтения
name String(255) Наименование Типа цены
Обязательное при ответе Необходимо при создании

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

Перечисление значений, представляющих совместное применение скидок:

Название Описание
bySum Сумма скидок. Означает, что должна действовать сумма скидок.
byPriority Приоритетная. Должна действовать одна, наиболее выгодная для покупателя скидка.

Метаданные настроек

В метаданных Настроек компании, в поле customEntities показан список пользовательских справочников. Каждый пользовательский справочник содержит поля:

Название Тип Описание
meta Meta Метаданные Пользовательского справочника
Обязательное при ответе Только для чтения
entityMeta URL Ссылка на список сущностей данного пользовательского справочника
name String(255) Наименование справочника

Получить Настройки компании

Изменить Настройки компании

Редактировать можно следующие настройки компании:

Название Тип Описание
checkMinPrice Boolean Автоматически устанавливать минимальную цену. Если включено, при сохранении документов продажи с ценами меньше минимальных цен (указанных в карточках товара) цены будут автоматически увеличены до минимальных.
checkShippingStock Boolean Запретить отгрузку отсутствующих товаров. Если запрет установлен (true значение), пользователи не смогут провести отгрузку со склада отсутствующих товаров.
companyAddress String(255) Адрес компании для электронных писем
discountStrategy Enum Совместное применение скидок. Подробнее тут
globalOperationNumbering Boolean Использовать сквозную нумерацию документов. Если проставлен true, будет установлена сквозная нумерация за всю историю, иначе нумерация документов будет начинаться заново каждый календарный год.
useCompanyAddress Boolean Использовать адрес компании для электронных писем. Если включено, письма будут отправляться с адреса, указанного в companyAddress, иначе письма будут отправляться с адреса пользователя.
useRecycleBin Boolean Использовать корзину. Если включено, то все документы при удалении будут помещаться в корзину. Также появится возможность восстанавливать ошибочно удаленные документы.

Допускается частичное редактирование - отредактированы будут только присутствующие в запросе поля.

Метаданные настроек компании

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

Настройки пользователя

Средствами JSON API можно получать и редактировать настройки пользователя.

Настройки пользователя

Атрибуты сущности

Название Тип Описание
autoShowReports Boolean Строить ли отчеты автоматически при переходе на вкладку с отчетом
Обязательное при ответе
defaultCompany Meta Метаданные Организации, которая будет использоваться по умолчанию в документах
Обязательное при ответе
defaultCustomerCounterparty Meta Метаданные Покупателя, который будет использоваться по умолчанию в документах раздела "Продажи"
Обязательное при ответе
defaultPlace Meta Метаданные Склада, который будет использоваться по умолчанию в документах
Обязательное при ответе
defaultProject Meta Метаданные Проекта, который будет использоваться по умолчанию в документах
Обязательное при ответе
defaultPurchaseCounterparty Meta Метаданные Поставщика, который будет использоваться по умолчанию в документах раздела "Закупки"
Обязательное при ответе
defaultScreen Enum Страница, которая открывается у пользователя при логине
Обязательное при ответе
fieldsPerRow Int Количество столбцов, в которых будут располагаться дополнительные поля в документах
Обязательное при ответе
locale Enum Язык системы. Допустимые значения "ru_RU" и "en_US"
Обязательное при ответе
mailFooter Boolean Подставляется в подпись в письмах, отправляемых из МС
Обязательное при ответе
meta Meta Метаданные настроек
Обязательное при ответе
printFormat Enum Правила печати документов
Обязательное при ответе

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

Допустимые правила печати:

Правила печати документов Значение поля printFormat
Скачать в формате PDF pdf
Скачать в формате Excel xls
Скачать в формате Open Office Calc ods
Предлагать выбор "" (пустая строка)
Открыть в браузере individual

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

Допустимые значения стартового экрана:

Стартовый экран Значение поля defaultScreen
Аудит audit
Валюты currency
Ввод в оборот кодов маркировки enrollorder
Взаиморасчеты customersbalancelist
Внесения retaildrawercashin
Внутренние заказы internalorder
Возврат в оборот enrollreturn
Возвраты retailsalesreturn
Возвраты покупателей salesreturn
Возвраты поставщикам purchasereturn
Возвраты предоплат prepaymentreturn
Воронка продаж purchasefunnel
Вывод из оборота retireorder
Выданные отчеты комиссионера commissionreportout
Выплаты retaildrawercashout
Движение денежных средств cashflow
Договоры contract
Документы operation
Единицы измерения uom
Журнал запросов в ИС МП crptlog
Журнал запросов в систему лояльности loyaltylog
Задачи purpose
Заказ кодов маркировки crptdemand
Заказы на производство processingorder
Заказы покупателей customerorder
Заказы поставщикам purchaseorder
Запросы evotorrequest
Звонки phonecall
Изъятие из упаковки crptpackageitemremoval
Импорт import
Импорт из Excel importgoods
Импорт приемки importedo
Импорт справочника importcustom
Инвентаризации inventory
Контрагенты company
Корзина recyclebin
Корректировки adjustment
Массовое редактирование bulkEdit
Настройка обмена с Эвотор evotormapping
Настройки companysettings
Начало работы homepage
Новости feed
Обороты turnover
Операции с баллами bonustransaction
Описание остатков remainsorder
Оприходования enter
Остатки stockreport
Отгрузки demand
Отчеты комиссионера commissionreport
Очередь облачных чеков fiscalevent
Очередь облачных чеков fiscalqueue
Перемаркировка remarkingorder
Перемещения move
Платежи finance
Подписка payments
Показатели dashboard
Полученные отчеты комиссионера commissionreportin
Прайс-листы pricelist
Предоплаты prepayment
Прибыли и убытки pnl3
Прибыльность pnl
Приемки supply
Приложения apps
Приложения embed-apps
Проверка комплектации checkequipment
Продажи retaildemand
Проекты project
Просмотр информации о КМ или ТУ trackingidentify
Расформирование упаковки crptpackagedisaggregation
Сбор заказа orderassembly
Сер. номера serialnumbers
Синхронизация connectorsettings
Скидки discount
Склады warehouse
Смены retailshift
События обмена с Эвотор evotorevent
Сотрудники employee
Спецпредложения specialoffers
Списание кодов маркировки crptcancellation
Списания loss
Страны country
Сценарии scripttemplate
Счета покупателям invoiceout
Счета поставщиков invoicein
Счета-фактуры выданные factureout
Счета-фактуры полученные facturein
Техкарты processingplan
Техоперации processing
Товары и услуги good
Товары на реализации commissiongoods
Точки продаж retailstore
Уведомления notifications
Управление закупками purchasecontrol
Учетная запись account
Формирование упаковки crptpackagecreation
Характеристика feature
Экспорт export
Юр. лица mycompany

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

Изменить Настройки пользователя

Редактировать можно следующие настройки пользователя:

Название Тип Описание
autoShowReports Boolean Строить ли отчеты автоматически при переходе на вкладку с отчетом
defaultCompany Meta Метаданные Организации, которая будет использоваться по умолчанию в документах
defaultCustomerCounterparty Meta Метаданные Покупателя, который будет использоваться по умолчанию в документах раздела "Продажи"
defaultPlace Meta Метаданные Склада, который будет использоваться по умолчанию в документах
defaultProject Meta Метаданные Проекта, который будет использоваться по умолчанию в документах
defaultPurchaseCounterparty Meta Метаданные Поставщика, который будет использоваться по умолчанию в документах раздела "Закупки"
defaultScreen Enum Страница, которая открывается у пользователя при логине
fieldsPerRow Int Количество столбцов, в которых будут располагаться дополнительные поля в документах
locale Enum Язык системы. Допустимые значения "ru_RU" и "en_US"
mailFooter Boolean Подставляется в подпись в письмах, отправляемых из МС
printFormat Enum Правила печати документов

Допускается частичное редактирование - отредактированы будут только присутствующие в запросе поля.

Отдел

Отделы

Средствами JSON API можно запрашивать и изменять списки Отделов и сведения по отдельным Отделам. Кодом сущности для Отдела в составе JSON API является ключевое слово group. Больше об Отделах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов отделов на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
id UUID = != ID отдела
Обязательное при ответе Только для чтения
index Int Порядковый номер в списке отделов
meta Meta Метаданные Отдела
Обязательное при ответе
name String(255) Наименование Отдела
Обязательное при ответе

Получить Отделы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Отдел

Получить Отдел

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Отдела.

Создать Отдел

Создать новый Отдел.

Описание

Отдел создается на основе переданного объекта JSON, который содержит представление нового Отдела. Результат - JSON представление созданного Отдела. Для создания нового Отдела, необходимо и достаточно указать в переданном объекте не пустое поле name. Новый отдел будет добавлен в конец списка. Если необходимо поместить новый отдел в начало списка, достаточно передать 0 в поле index

Изменить Отдел

Запрос на обновление названия и/или порядкового номера Отдела.

Удалить Отдел

Параметры

Параметр Описание
id string (required) Example: a4047c9a-0fca-11eb-ac13-000700000003 id Отдела.

Response 200 (application/json) Успешное удаление Отдела.

Печать этикеток и ценников

Средствами JSON API можно запрашивать печать этикеток и ценников с помощью шаблонов печатных форм. При запросе на формирование печатной формы сервер (при готовности этикеток и ценников, корректной печатной форме и правильном формате запроса) отвечает пустым телом ответа с http кодом 303. В заголовке Location ответа содержится адрес временного расположения готовой к загрузке печатной формы. Файл во временном расположении доступен для загрузки в течение 5 минут.

Сервер может вернуть ответ 202 и заголовок Location с адресом для опроса готовности печатной формы к загрузке. Данный вариант будет реализован позже.

Печать этикеток и ценников доступна для товаров, услуг, комплектов и модификаций.

Печать этикеток и ценников

Запрос на печать этикеток и ценников

Запрос на печать этикеток и ценников по шаблону печатной формы.

Атрибуты запроса

Название Тип Описание
organization Meta Метаданные Юрлица
Обязательное при ответе
count Int Количество ценников/термоэтикеток. Максимальное количество - 1000
Обязательное при ответе
salePrice Object Цена продажи. Подробнее тут
Обязательное при ответе
template Meta Метаданные Шаблона печати
Обязательное при ответе Expand
Цена продажи

Атрибуты вложенной сущности

Название Тип Описание
priceType Meta Метаданные типа цены
Обязательное при ответе

Параметры

Параметр Описание
id string (required) Example: a86708d2-f8d3-4e67-8f04-6101158da808 id сущности, для которой запрашивается печать.
type string (required) Example: product тип сущности, для которой запрашивается печать.

Подписка компании

Получить информацию о действующей подписке компании.

Подписка компании

Атрибуты сущности

Название Тип Описание
role String(255) Роль авторизованного пользователя (USER/ADMIN)
Обязательное при ответе Только для чтения
tariff String(255) Действующий тариф Аккаунта
Обязательное при ответе Только для чтения
isSubscriptionChangeAvailable Boolean Доступность изменения подписки
Обязательное при ответе Только для чтения
subscriptionEndDate Long Дата (в миллисекундах) окончания действия текущего тарифа, если тариф отличается от “Пробный” и “Бесплатный”
Обязательное при ответе Только для чтения

Действующий тариф аккаунта

Значения поля tariff

Значение Описание
BASIC Тариф "Базовый"
CORPORATE Тариф "Корпоративный"
FREE Тариф "Бесплатный 2014"
MINIMAL Тариф "Индивидуальный"
PROFESSIONAL Тариф "Профессиональный"
RETAIL Тариф "Бесплатный"
START Тариф "Старт"
TRIAL Тариф "Пробный"

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

Пользовательские роли

Пользовательская роль

Средствами JSON API можно запрашивать и изменять пользовательские роли. Получать и изменять роли можно от лица сотрудника с правами Системного администратора или от лица Приложения.

Атрибуты сущности

Название Тип Описание
id UUID ID пользовательской роли
Обязательное при ответе Только для чтения
meta Meta Метаданные пользовательской роли
Обязательное при ответе
name String(255) Наименование пользовательской роли
Обязательное при ответе Необходимо при создании
permissions Array(Object) Список пермиссий
Обязательное при ответе

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

Параметры

Параметр Описание
id string (required) Example: 736da682-ad8b-11eb-0a80-17ef000000d4 id Роли.

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

Создать пользовательскую роль

Обновить пользовательскую роль

Параметры

Параметр Описание
id string (required) Example: 736da682-ad8b-11eb-0a80-17ef000000d4 id Роли.

Удалить пользовательскую роль

Параметры

Параметр Описание
id string (required) Example: ae6e61ad-ad8c-11eb-0a80-380e00001e6c id Роли.

Response 200 (application/json) Успешный запрос.

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

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

Атрибуты сущности

Название Тип Описание
id UUID ID Пользовательского справочника
Обязательное при ответе Только для чтения
meta Meta Метаданные Пользовательского справочника
Обязательное при ответе
name String(255) Наименование Пользовательского справочника
Обязательное при ответе Необходимо при создании

Список пользовательских справочников

Для работы с пользовательскими справочниками вам нужно знать id каждого справочника. Этот id обозначен в URI-параметрах запросов к данной сущности как . Его можно получить выполнив запрос на получение метаданных настроек компании. В полученном списке сущностей в полях типа meta будет указана ссылка на каждый из справочников. В этой ссылке, последняя подстрока отделенная знаком / и является идентификатором для данного справочника.

Пример: Выполнив вышеуказанный запрос и найдя среди списка справочника интересующих нас, мы вычленяем следующую ссылку из поля meta: https://api.moysklad.ru/api/remap/1.2/context/companysettings/metadata/customEntities/eaacabaf-2655-11e6-8a84-bae500000045 Из данной сылки вычленяем нужного нам пользовательского справочника : eaacabaf-2655-11e6-8a84-bae500000045 и этот id используем для работы с данным пользовательским справочником в рамках ресурса Пользовательский справочник.

Создать справочник

Единственным необходимым полем для создания пользовательского справочника является поле name. Действие доступно только для пользователя с правами администратора.

Название Описание
name Название справочника

Изменить справочник

Запрос на изменение справочника. Действие доступно только для пользователя с правами администратора.

Параметры

Параметр Описание
metadata_id string (required) Example: 3f9a2f30-76af-11e7-6adb-ede50000000b id пользовательского справочника.

Удалить справочник

Запрос на удаление пользовательского справочника. Действие доступно только для пользователя с правами администратора.

Параметры

Параметр Описание
metadata_id string (required) Example: 3f9a2f30-76af-11e7-6adb-ede50000000b id пользовательского справочника.

Response 200 (application/json) Успешное удаление пользовательского справочника.

Элементы Пользовательского справочника

Атрибуты элемента

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код элемента Пользовательского справочника
description String(4096) = != ~ ~= =~ Описание элемента Пользовательского справочника
externalCode String(255) = != ~ ~= =~ Внешний код элемента Пользовательского справочника
Обязательное при ответе
id UUID = != ID элемента Пользовательского справочника
Обязательное при ответе Только для чтения
meta Meta Метаданные элемента Пользовательского справочника
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование элементе Пользовательского справочника
Обязательное при ответе Необходимо при создании
updated DateTime = != < > <= >= Момент последнего обновления элементе Пользовательского справочника
Обязательное при ответе Только для чтения
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
owner Meta = != Владелец (Сотрудник)
Expand
shared Boolean = != Общий доступ
Обязательное при ответе

Получить элементы справочника

Запрос на получение всех элементов в указанном пользовательском справочнике. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих элементы Пользовательского справочника.

Параметры

Параметр Описание
metadata_id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id пользовательского справочника.

Создать элемент справочника

Единственным необходимым полем для создания элемента пользовательского справочника является поле name.

Параметры

Параметр Описание
metadata_id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id пользовательского справочника.

Удалить элемент справочника

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

Параметры

Параметр Описание
id string (required) Example: 6343f631-265d-11e6-8a84-bae500000014 id элемента пользовательского справочника.
metadata_id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id пользовательского справочника.

Response 200 (application/json) Успешное удаление элемента пользовательского справочника.

Элемент пользовательского справочника

Получить элемент

Параметры

Параметр Описание
id string (required) Example: 6343f631-265d-11e6-8a84-bae500000014 id элемента пользовательского справочника.
metadata_id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id пользовательского справочника.

Изменить элемент

Запрос на изменение объекта, представляющего собой элемент пользовательского справочника.

Параметры

Параметр Описание
id string (required) Example: 6343f631-265d-11e6-8a84-bae500000014 id элемента пользовательского справочника.
metadata_id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id пользовательского справочника.

Проект

Проекты

Средствами JSON API можно создавать и обновлять сведения о Проектах, запрашивать списки Проектов и сведения по отдельным Проектам. Кодом сущности для Проекта в составе JSON API является ключевое слово project. Больше о Проектах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов проекта на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли Проект в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция доп. полей
code String(255) = != ~ ~= =~ Код Проекта
description String(4096) = != ~ ~= =~ Описание Проекта
externalCode String(255) = != ~ ~= =~ Внешний код Проекта
Обязательное при ответе
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID проекта
Обязательное при ответе Только для чтения
meta Meta Метаданные Проекта
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Проекта
Обязательное при ответе Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

О работе с доп. полями Проектов можно прочитать здесь

Получить Проекты

Запрос на получение списка всех проектов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой проекты.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Проект

Запрос на создание нового проекта. Единственным необходимым полем в теле запроса для создания проекта является name.

Массовое создание и обновление Проектов

Массовое создание и обновление Проектов. В теле запроса нужно передать массив, содержащий JSON представления Проектов, которые вы хотите создать или обновить. Обновляемые Проекты должны содержать идентификатор в виде метаданных.

Удалить Проект

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Проекта.

Response 200 (application/json) Успешное удаление Проекта.

Массовое удаление Проектов

В теле запроса нужно передать массив, содержащий JSON метаданных Проектов, которые вы хотите удалить.

Метаданные Проектов

Метаданные Проектов

Запрос на получение метаданных Проектов. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные Проекта
Обязательное при ответе
attributes Array(Object) Коллекция доп. полей
createShared Boolean Создавать новые Проекты с меткой "Общий"
Обязательное при ответе

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Проект

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Проекта.

Получить Проект

Изменить Проект

Запрос на обновление существующего проекта с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Проекта.

Регион

Регионы

Средствами JSON API можно запрашивать список регионов России и сведения по отдельным регионам. Кодом сущности для Регионов в составе JSON API является ключевое слово region.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код Региона
externalCode String(255) = != ~ ~= =~ Внешний код Региона
Обязательное при ответе
id UUID = != ID Региона
Обязательное при ответе Только для чтения
meta Meta Метаданные о Регионе
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Региона
Обязательное при ответе Необходимо при создании
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения
version Int Версия сущности
Обязательное при ответе Только для чтения

Атрибуты доступные для сортировки

Название Описание
code Код Региона
externalCode Внешний код Региона
id ID в формате UUID
name Наименование Региона
updated Момент последнего обновления сущности
version Версия сущности

Получить Регионы

Получить список всех Регионов. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Регионы.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Регион

Получить Регион

Параметры

Параметр Описание
id string (required) Example: 00000000-0000-0000-0000-000000000077 id Региона.

Серийный номер

Серийные номера

Средствами JSON API можно запрашивать списки Серийных номеров и сведения по отдельным Серийным номерам. Кодом сущности для Серийного номера в составе JSON API является ключевое слово thing.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
description String(4096) = != ~ ~= =~ Описание Серийного номера
id UUID = != ID Серийного номера
Обязательное при ответе Только для чтения
meta Meta Метаданные о Серийном номере
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Серийного номера
Обязательное при ответе Необходимо при создании

Получить Серийные номера

Запрос на получение списка всех Серийных номеров для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче.
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Серийные номера.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Серийный номер

Получить Серийный номер

Параметры

Параметр Описание
id string (required) Example: 3840d8d8-9f2d-11ee-8c90-0242ac120002 id Серийного номера.

Серия

Серии

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

Поиск среди объектов Серии на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
attributes Meta Операторы доп. полей Метаданные ссылки или модификации
Обязательное при ответе Необходимо при создании
barcodes Array(Object) = != ~ ~= =~ Штрихкоды серии
code String(255) = != ~ ~= =~ Код Серии
description String(4096) = != ~ ~= =~ Описание Серии
externalCode String(255) = != ~ ~= =~ Внешний код Серии
Обязательное при ответе
id UUID = != ID Серии
Обязательное при ответе Только для чтения
image Meta Изображение товара, к которому относится данная серия
label String(255) Метка Серии
Обязательное при ответе Необходимо при создании
meta Meta Метаданные Серии
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Серии. "Собирается" и отображается как "Наименование товара / Метка Серии"
Обязательное при ответе Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Атрибуты вложенных сущностей

Метаданные Серий

Посмотреть все созданные в основном интерфейсе характеристики Серий можно с помощью запроса на получение метаданных Серий. Ответ - объект, со следующей структурой:

Название Тип Описание
meta Meta Метаданные Серии
Обязательное при ответе
attributes Array(Object) Коллекция доп. полей

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

Запрос на получение списка всех пользовательских Серий на данной учетной записи. Серии по умолчанию выведены не будут. Результат успешного запроса - JSON представление списка Серий с перечисленными полями:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой серии.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать серию

Запрос на создание новой серии. Для успешного создания серии, обязательно должны быть переданы поля label и assortment.

Удалить серию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Серии.

Response 200 (application/json) Успешное удаление Серии.

Массовое удаление Серий

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

Массовое создание и обновление Серий

Массовое создание и обновление Серий. В теле запроса нужно передать массив, содержащий JSON представления Серий, которые вы хотите создать или обновить. Обновляемые Серии должны содержать идентификатор в виде метаданных.

Метаданные Серий

Метаданные Серий

Запрос на получение метаданных Серий. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Метаданные
Обязательное при ответе
attributes Array(Object) Коллекция доп. полей

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 958b275e-3bbf-11e7-8a7f-40d000000004 id Доп. поля.

Отдельное доп. поле

Серия

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Серии.

Получить серию

Изменить серию

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Серии.

Запрос на обновление серии. Обновить можно только те поля, что не помечены Только для чтения

Скидки

Скидки

Кодом сущности для Скидок в составе JSON API является ключевое слово discount. Операции создания, изменения и удаления не поддерживаются. Перед работой со скидками настоятельно рекомендуем вам прочитать вот эту статью на портале поддержки МоегоСклада.

Атрибуты сущности

Общие поля

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
active Boolean Индикатор, является ли скидка активной на данный момент
Обязательное при ответе
agentTags Array(String) Тэги контрагентов, к которым применяется скидка, если применяется не ко всем контрагентам
allProducts Boolean Индикатор, действует ли скидка на все товары
Обязательное при ответе
assortment Array(Object) Массив метаданных Товаров и Услуг, которые были выбраны для применения скидки, если та применяется не ко всем товарам
id UUID ID Скидки
Обязательное при ответе Только для чтения
meta Meta Метаданные Скидки
Обязательное при ответе
name String(255) Наименование Скидки
Обязательное при ответе

Поля Спец. цен

Название Тип Описание
productfolders Array(Object) Массив метаданных Групп товаров, к которым применяется скидка, если применяется не ко всем товарам
discount Int Процент скидки если выбран фиксированный процент
specialPrice Object Спец. цена (если выбран тип цен). Подробнее тут

specialPrice

Название Тип Описание
priceType Object Тип цены
Обязательное при ответе
value Int Значение цены, если выбрано фиксированное значение

Поля накопительных скидок

Название Тип Описание
productfolders Array(Object) Массив метаданных Групп товаров, к которым применяется скидка, если применяется не ко всем товарам
levels Array(Object) Проценты скидок при определенной сумме продаж. Подробнее тут

levels

Название Тип Описание
amount Int Сумма накоплений в копейках
Обязательное при ответе
discount Int Процент скидки, соответствующий данной сумме

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

Запрос на получение всех скидок учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой скидки.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать накопительную скидку

Запрос на создание новой накопительной скидки. Обязательные поля для заполнения: name (имя скидки), active (активна ли скидка), allProducts (действует ли скидка на все товары), allAgents (действует ли скидка на всех контрагентов)

Получить накопительную скидку

Запрос на получение накопительной скидки.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Изменить накопительную скидку

Запрос на изменение накопительной скидки. В теле запроса необходимо передать поля, которые будут обновлены. При обновлении полей-массивов необходимо передавать новый массив полностью. При передаче пустого массива или null значение поля удаляется.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Удалить накопительную скидку

Запрос на удаление накопительной скидки

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Response 200 (application/json) Успешное удаление накопительной скидки

Создать персональную скидку

Запрос на создание новой персональной скидки. Обязательные поля для заполнения: name (имя скидки), active (активна ли скидка), allProducts (действует ли скидка на все товары), allAgents (действует ли скидка на всех контрагентов)

Получить персональную скидку

Запрос на получение персональной скидки.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Изменить персональную скидку

Запрос на изменение персональной скидки. В теле запроса необходимо передать поля, которые будут обновлены. При обновлении полей-массивов необходимо передавать новый массив полностью. При передаче пустого массива или null значение поля удаляется.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Удалить персональную скидку

Запрос на удаление персональной скидки

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Response 200 (application/json) Успешное удаление персональной скидки

Создать специальную цену

Запрос на создание новой специальной цены. Обязательные поля для заполнения: name (имя скидки), active (активна ли скидка), allProducts (действует ли скидка на все товары), allAgents (действует ли скидка на всех контрагентов), usePriceType (использовать ли специальную цену).

Получить специальную цену

Запрос на получение специальной цены.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Изменить специальную цену

Запрос на изменение специальной цены. В теле запроса необходимо передать поля, которые будут обновлены. При обновлении полей-массивов необходимо передавать новый массив полностью. При передаче пустого массива или null значение поля удаляется.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Удалить специальную цену

Запрос на удаление специальной цены

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки.

Response 200 (application/json) Успешное удаление специальной цены

Изменить округление копеек

Запрос на изменение округления копеек. В теле запроса необходимо передать поля, которые будут обновлены (name или active). В ответе также будут приходить поля agentTags и allAgents, но их нельзя изменить.

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id скидки округления копеек.

Склад

Склады

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

Поиск среди объектов складов на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
address String(255) = != ~ ~= =~ Адрес склада
addressFull Object Адрес с детализацией по отдельным полям. Подробнее тут
archived Boolean = != Добавлен ли Склад в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Массив метаданных дополнительных полей склада
code String(255) = != ~ ~= =~ Код Склада
description String(4096) = != ~ ~= =~ Комментарий к Складу
externalCode String(255) = != ~ ~= =~ Внешний код Склада
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Склада
Обязательное при ответе Только для чтения
meta Meta Метаданные Склада
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Склада
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
parent Meta = != Метаданные родительского склада (Группы)
Expand
pathName String = != ~ ~= =~ Группа Склада
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления Склада
Обязательное при ответе Только для чтения
zones MetaArray Зоны склада. Подробнее тут
Только для чтения Expand
slots MetaArray Ячейки склада. Подробнее тут
Только для чтения Expand

Аттрибуты сущности Адрес

Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому аттрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле address передать пустую строку "".

О работе с доп. полями Складов можно прочитать здесь

Получить Склады

Получить список всех Складов. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче.
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Склады.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Создать новый Склад.

Описание

Склад создается на основе переданного объекта JSON, который содержит представление нового Склада. Необходимое для создания поле - name не должно быть пустым.

Массовое создание и обновление Складов

Массовое создание и обновление Складов. В теле запроса нужно передать массив, содержащий JSON представления Складов, которые вы хотите создать или обновить. Обновляемые Склады должны содержать идентификатор в виде метаданных.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Склада.

Response 200 (application/json) Успешное удаление Склада.

Массовое удаление Складов

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

Метаданные Складов

Метаданные Складов

Запрос на получение метаданных Складов. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Ссылка на метаданные Складов
attributes Array(Object) Массив объектов доп. полей Складов в формате Метаданных
createShared Boolean создавать новые Склады с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Склад

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Склада.

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

Описание

Обновляется представление Склада с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Склада, кроме полей, помеченных Только для чтения в описании атрибутов Склада.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Склада.

Зоны склада

Доступ к зонам склада осуществляется при наличии права видеть соответствующий склад.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
externalCode String(255) Внешний код Зоны
Обязательное при ответе
id UUID ID Зоны
Обязательное при ответе Только для чтения
meta Meta Метаданные Зоны
Обязательное при ответе
name String(255) Наименование Зоны
Обязательное при ответе Необходимо при создании
updated DateTime Момент последнего обновления Зоны
Обязательное при ответе Только для чтения

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

Получить список всех Зон. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче.
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Зоны.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Описание

Зона склада создается на основе переданного объекта JSON, который содержит представление новой Зоны склада. Результат - JSON представление созданной Зоны склада. Для создания новой Зоны склада, необходимо и достаточно указать в переданном объекте не пустое поле name. В рамках одного склада имена Зон должны быть уникальны.

Массовое создание и обновление зон склада

Массовое создание и обновление Зон склада. В теле запроса нужно передать массив, содержащий JSON представления Зон склада, которые вы хотите создать или обновить. Обновляемые Зоны склада должны содержать идентификатор в виде метаданных.

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

При удалении зоны к которой привязаны ячейки, ячейки отвязываются от данной зоны.

Параметры

Параметр Описание
store_id string (required) Example: 7a6a11b6-12c5-11e6-9464-e4de00000006 id Склада.
zone_id string (required) Example: 7d479c5f-75f9-11ed-ac1a-000d00000003 id Зоны склада.

Response 200 (application/json) Успешное удаление Зоны склада.

Массовое удаление зон склада

В теле запроса нужно передать массив, содержащий JSON метаданных Зон склада, которые вы хотите удалить.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b18 id Зоны.

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

В теле запроса нужно передать JSON представление Зоны склада, которую вы хотите обновить.

Параметры

Параметр Описание
store_id string (required) Example: 7a6a11b6-12c5-11e6-9464-e4de00000006 id Склада.
zone_id string (required) Example: 7d479c5f-75f9-11ed-ac1a-000d00000003 id Зоны склада.

Ячейки склада

Доступ к ячейкам склада осуществляется при наличии права видеть соответствующий склад.

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
externalCode String(255) Внешний код Ячейки
Обязательное при ответе
id UUID ID Ячейки
Обязательное при ответе Только для чтения
meta Meta Метаданные Ячейки
Обязательное при ответе
name String(255) Наименование Ячейки
Обязательное при ответе Необходимо при создании
updated DateTime Момент последнего обновления Ячейки
Обязательное при ответе Только для чтения
barcode String(255) Штрихкод ячейки
zone Meta Зона ячейки. Подробнее тут
Только для чтения Expand

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

Получить список всех Ячеек Склада. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче.
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Ячейки Склада.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать ячейку склада

Описание

Ячейка склада создается на основе переданного объекта JSON, который содержит представление новой Ячейки склада. Результат - JSON представление созданной Ячейки склада. Для создания новой Ячейки склада, необходимо и достаточно указать в переданном объекте не пустое поле name. В рамках одного склада имена и штрихкоды Ячеек должны быть уникальны.

Массовое создание и обновление ячеек склада

Массовое создание и обновление Ячеек склада. В теле запроса нужно передать массив, содержащий JSON представления Ячеек склада, которые вы хотите создать или обновить. Обновляемые Ячейки склада должны содержать идентификатор в виде метаданных.

Удалить ячейку склада

Параметры

Параметр Описание
store_id string (required) Example: 7a6a11b6-12c5-11e6-9464-e4de00000006 id Склада.
slot_id string (required) Example: 7d479c5f-75f9-11ed-ac1a-000d00000003 id Ячейки склада.

Response 200 (application/json) Успешное удаление Ячейки склада.

Массовое удаление ячеек склада

В теле запроса нужно передать массив, содержащий JSON метаданных Ячеек склада, которые вы хотите удалить.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b18 id Ячейки Склада.

Изменить ячейку склада

В теле запроса нужно передать JSON представление Ячейки склада, которую вы хотите обновить.

Параметры

Параметр Описание
store_id string (required) Example: 7a6a11b6-12c5-11e6-9464-e4de00000006 id Склада.
slot_id string (required) Example: 7d479c5f-75f9-11ed-ac1a-000d00000003 id Ячейки склада.

Сотрудник

Сотрудники

Средствами JSON API можно запрашивать списки Сотрудников и сведения по отдельным Сотрудникам. Кодом сущности для Сотрудника в составе JSON API является ключевое слово employee. Больше о Сотрудниках и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке.

Поиск среди объектов сотрудников на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли Сотрудник в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Дополнительные поля Сотрудника
cashiers MetaArray Массив кассиров. Подробнее тут
Только для чтения Expand
code String(255) = != ~ ~= =~ Код Сотрудника
created DateTime Момент создания Сотрудника
Обязательное при ответе Только для чтения
description String(4096) = != ~ ~= =~ Комментарий к Сотруднику
email String(255) = != ~ ~= =~ Электронная почта сотрудника
externalCode String(255) = != ~ ~= =~ Внешний код Сотрудника
Обязательное при ответе
firstName String(255) = != ~ ~= =~ Имя
fullName String(255) Имя Отчество Фамилия
Только для чтения
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Сотрудника
Обязательное при ответе Только для чтения
image Object Фотография сотрудника. Подробнее тут
inn String(255) ИНН сотрудника (в формате ИНН физического лица)
lastName String(255) = != ~ ~= =~ Фамилия
Обязательное при ответе Необходимо при создании
meta Meta Метаданные Сотрудника
Обязательное при ответе
middleName String(255) = != ~ ~= =~ Отчество
name String(255) = != ~ ~= =~ Наименование Сотрудника
Обязательное при ответе Только для чтения
owner Meta = != Владелец (Сотрудник)
Обязательное при ответе Expand
phone String(255) = != ~ ~= =~ Телефон сотрудника
position String(255) Должность сотрудника
shared Boolean = != Общий доступ
Обязательное при ответе
shortFio String(255) Краткое ФИО
Только для чтения
uid String(255) = != ~ ~= =~ Логин Сотрудника
Только для чтения
updated DateTime = != < > <= >= Момент последнего обновления Сотрудника
Обязательное при ответе Только для чтения

Поля owner, group и archived может изменять только администратор. Поле email может изменять администратор и сам сотрудник.

Атрибуты вложенных сущностей

Кассир
Название Тип Описание
accountId UUID ID учетной записи Кассира
Обязательное при ответе Только для чтения
employee Meta Метаданные сотрудника, которого представляет собой кассир
Обязательное при ответе Только для чтения Expand
id UUID ID Кассира
Обязательное при ответе Только для чтения
retailStore Meta Метаданные точки продаж, к которой прикреплен кассир
Обязательное при ответе Только для чтения Expand
Фотография сотрудника: структура и загрузка.

Структура поля image, которое вы получите при запросе сотрудника с фотографией:

Название Тип Описание
filename String(255) Имя файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
updated DateTime Время последнего изменения
Обязательное при ответе

Загрузка

Для загрузки фотографии сотрудника необходимо сформировать запрос на обновление сотрудника (PUT) и в теле запроса указать поле image со следующими атрибутами:

Название Описание
filename имя файла с расширением. Например - "cashier.png"
content Изображение, закодированное в формате Base64

Если в запросе на обновление не будет полей filename и content, то весь объект image, если он присутствует в Body, будет проигнорирован, т.к. сервер посчитает, что его обновление не требуется.

О работе с доп. полями Сотрудников можно прочитать здесь

Получить Сотрудников

Запрос на получение списка всех сотрудников для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Сотрудника.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Массовое обновление Сотрудников

Массовое обновление Сотрудников. В теле запроса нужно передать массив, содержащий JSON представления Сотрудников, которые вы хотите обновить. Обновляемые Сотрудники должны содержать идентификатор в виде метаданных.

Удалить Сотрудника

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Response 200 (application/json) Успешное удаление Сотрудника.

Массовое удаление Сотрудников

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

Метаданные Сотрудников

Метаданные Сотрудников

Запрос на получение метаданных Сотрудников. Результат - объект JSON, включающий в себя:

Название Тип Описание
meta Meta Ссылка на метаданные Сотрудников
attributes Array(Object) Массив объектов доп. полей Сотрудников в формате Метаданных
createShared Boolean Создавать новых Сотрудников с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Отдельное доп. поле

Сотрудник

Получить Сотрудника

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Создать Сотрудника

Запрос на создание сотрудника. Обязательные для создания поля:

Название Описание
lastName Фамилия

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

Запрос на обновление существующего Сотрудника. В теле запроса обязательно следует указать поле lastName.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Работа с правами Сотрудника

В данном разделе приведены примеры запросов на получение и изменение прав сотрудника. Получать и изменять права может только сотрудник с правами Системный администратор.

Атрибуты сущности

Название Тип Описание
authorizedHosts Array(String) Список ipv4 адресов, с которых разрешен доступ на аккаунт
authorizedIpNetmask String(255) Маска подсети с правом доступа на аккаунт
authorizedIpNetwork String(255) Ipv4 адрес, идентифицирующий соответствующую подсеть, с правом доступа на аккаунт
email String(255) Почта сотрудника
group Object Метаданные Группы, а также ее идентификатор и имя
Обязательное при ответе
isActive Boolean Доступ к сервису МойСклад
Обязательное при ответе
login String(255) Логин сотрудника для входа в МойСклад
role Object Информация о роли Сотрудника

Атрибуты вложенных сущностей

Роль

Роли бывают пяти типов: Системный администратор, Кассир, Сотрудник производства, Пользовательская роль и Индивидуальная роль. Роль Сотрудник производства доступна только при подключенной опции Управление производством. Использовать Индивидуальную роль (с пермиссиями не по умолчанию) и Пользовательскую роль можно только на тарифах Профессиональный или Корпоративный. Для Индивидуальной роли можно настраивать список пермиссий, заполняя поле permissions. Если в поле permissions указывать не все пермиссии, то не переданные будут выключены. Значения по умолчанию выставляются, если пользователь, не указывая индивидуальные пермиссии, задает индивидуальную роль сотруднику, у которого ранее не было задано индивидуальных пермиссий.

Название Тип Описание
meta Meta Метаданные роли
Обязательное при ответе
permissions Array(Object) Список пермиссий
Список пользовательских пермиссий
Название Возможные значения Значение по умолчанию Описание
apiRequest Boolean true Доступ по АПИ
deleteFromRecycleBin Boolean true Очищать корзину
editCurrencyRateOfDocument Boolean true Редактировать курс валюты документа
editDocumentTemplates Boolean true Редактировать шаблоны документов и отчетов
editDocumentsOfRestrictedPeriod Boolean false Редактировать документы закрытого периода
exportData Boolean true Экспортировать данные
importData Boolean true Импортировать данные
listenCalls Boolean true Прослушивание звонков
onlineShops Boolean true Интернет магазины
purchaseControl Boolean true Управление закупками
restoreFromRecycleBin Boolean true Восстанавливать документы
sendEmail Boolean true Отправлять почту
subscriptionControl Boolean false Управление подпиской
viewAudit Boolean false Просматривать аудит
viewCashFlow Boolean true Просматривать движение денежных средств
viewCommissionGoods Boolean true Просматривать товары на реализации
viewCompanyCRM Boolean true Просматривать показатели
viewCustomerBalanceList Boolean true Просматривать взаиморасчеты
viewDashboard Boolean true Просматривать показатели
viewMoneyDashboard Boolean false Видеть остатки денег
viewProductCostAndProfit Boolean true Видеть себестоимость, цену закупки и прибыль товаров
viewProfitAndLoss Boolean true Просматривать прибыль и убытки
viewPurchaseFunnel Boolean true Просматривать воронку продаж
viewRecycleBin Boolean true Просматривать корзину
viewSaleProfit Boolean true Просматривать прибыльность
viewSerialNumbers Boolean true Просматривать серийные номера
viewStockReport Boolean true Просматривать остатки по товарам
viewTurnover Boolean true Просматривать обороты
Список пермиссий сущностей

Имеется три возможных типа значений пермиссий сущности: OPERATION, DICTIONARY, BASE. Данные типы имеют следующие поля:

типы значений пермиссий сущности view create update delete print approve
OPERATION + + + + + +
DICTIONARY + + + + + -
BASE + + + + - -
Название Описание Ограничения
view Смотреть нет
create Создавать совпадает с view или отсутствует
update Редактировать не шире, чем у view или отсутствует
delete Удалять совпадает с update или отсутствует
print Печатать совпадает с view или отсутствует
approve Проводить совпадает с view или отсутствует

Возможные значения полей view, create, update, delete, approve, print:

Название На кого распространяется
NO Ни на кого
OWN Только свои
OWN_SHARED Свои и общие
OWN_GROUP Свои и отдела
OWN_GROUP_SHARED Свои, отдела и общие
ALL Все

Значения в порядке их расширения области действия: NO → OWN → OWN_SHARED → OWN_GROUP_SHARED → ALL и NO → OWN → OWN_GROUP → OWN_GROUP_SHARED → ALL
Если не указывать одно из полей, то данное действие будет запрещено к выполнению для данного сотрудника.

Список пермиссий сущностей

Название Возможные значения Значение по умолчанию Описание
GTINList view, create, delete Все NO Список GTIN
accountAdjustment DICTIONARY Все ALL Корректировка остатков на счете
bonusTransaction OPERATION Все ALL Бонусные баллы
cashIn OPERATION Все ALL Приходной ордер
cashOut OPERATION Все ALL Расходной ордер
cashboxAdjustment DICTIONARY Все ALL Корректировка остатков в кассе
commissionReportIn OPERATION Все ALL Полученный отчет комиссионера
commissionReportOut OPERATION Все ALL Выданный отчет комиссионер
company DICTIONARY Все ALL Контрагенты
contract DICTIONARY Все ALL Договоры
counterpartyAdjustment DICTIONARY Все ALL Корректировка взаиморасчетов
country BASE Все ALL Страны
crptCancellation DICTIONARY Все NO Списание кодов маркировки
crptPackageCreation DICTIONARY Все NO Формирование упаковки
crptPackageDisaggregation DICTIONARY Все NO Расформирование упаковки
crptPackageItemRemoval DICTIONARY Все NO Изъятие из упаковки
currency BASE Все ALL Валюты
customEntity BASE Все ALL Элементы пользовательских справочников
customerOrder OPERATION Все ALL Заказ покупателям
demand OPERATION Все ALL Отгрузка
emissionOrder DICTIONARY Все NO Заказ кодов маркировки
utilizationReport DICTIONARY Все NO Отчет об использовании
atkAggregation DICTIONARY Все NO Формирование АТК
retireOrderOSU DICTIONARY Все NO Вывод из оборота ОСУ
employee BASE Все ALL Сотрудники
enrollOrder DICTIONARY Все NO Ввод в оборот кодов маркировки
enter OPERATION Все ALL Оприходование
factureIn OPERATION Все ALL Счета-фактуры полученные
factureOut OPERATION Все ALL Счета-фактуры выданные
good DICTIONARY Все ALL Товары и Услуги
internalOrder OPERATION Все ALL Внутренние заказы
inventory DICTIONARY Все ALL Инвентаризация
invoiceIn OPERATION Все ALL Счет поставщику
invoiceOut OPERATION Все ALL Счет покупателям
loss OPERATION Все ALL Списание
move OPERATION Все ALL Перемещение
myCompany BASE view: ALL, create: NO, edit: NO, delete: NO Юр. Лица
paymentIn OPERATION Все ALL Входящий платеж
paymentOut OPERATION Все ALL Исходящий платеж
prepayment OPERATION Все ALL Предоплаты
prepaymentReturn OPERATION Все ALL Возврат предоплаты
priceList OPERATION Все ALL Прайс-лист
processing BASE Все ALL Техоперации
processingOrder OPERATION Все ALL Заказ на производство
processingPlan BASE Все ALL Техкарты
processingStage BASE Все ALL Этапы производства
processingProcess BASE Все ALL Техпроцессы
productionTask OPERATION Все ALL Производственные задания
productionStageCompletion DICTIONARY Все ALL Выполнение этапов
project BASE Все ALL Проекты
purchaseOrder OPERATION Все ALL Заказ поставщикам
purchaseReturn OPERATION Все ALL Возврат поставщику
remainsOrder DICTIONARY Все NO Описание остатков
remarkingOrder DICTIONARY Все NO Перемаркировка
retailDemand OPERATION Все ALL Продажи
retailDrawerCashIn OPERATION Все ALL Внесения
retailDrawerCashOut OPERATION Все ALL Выплаты
retailSalesReturn OPERATION Все ALL Возвраты
retailShift DICTIONARY Все ALL Смены
retailStore BASE Все ALL Точка продаж
retireOrder DICTIONARY Все NO Вывод из оборота
salesReturn OPERATION Все ALL Возврат покупателя
supply OPERATION Все ALL Приемки
taxrate BASE Все ALL Ставки НДС
trackingCodeList view, print Все NO Коды маркировки
uom BASE Все ALL Единицы измерения
warehouse BASE Все ALL Склады

Для пермиссий currency, country, taxrate и uom значение view не изменяемое и равно ALL. При попытке изменить значение view для данных пермиссий, будет возвращена ошибка.

Для пермиссий GTINList, trackingCodeList возможные значения полей - ALL или NO.

Пермиссии для задач

Пермиссии script для задач имеют следующие поля:

Название Описание Ограничения Возможные значения
view Смотреть нет NO, AUTHOR_OR_ASSIGNEE, ALL
create Создавать не шире, чем у view или отсутствует NO, ALL
update Редактировать не шире, чем у view или отсутствует NO, AUTHOR, AUTHOR_OR_ASSIGNEE, ALL
delete Удалять не шире значения поля update или отсутствует NO, AUTHOR, AUTHOR_OR_ASSIGNEE, ALL
done Выполнять не шире, чем у view или отсутствует NO, ASSIGNEE, AUTHOR_OR_ASSIGNEE, ALL

Значение NO допустимо для view и done только если все остальные значения NO. В случае, если значение поле view отлично от NO, то поле done обязательно к передаче и значение должно совпадать, со значением поля view.

Возможные значения полей view, create, update, delete, done:

Название На какие задачи распространяется
NO Нет прав ни на какие задачи
AUTHOR_OR_ASSIGNEE Созданные пользователем и назначенные ему
ASSIGNEE Назначенные
AUTHOR Созданные пользователем
ALL Возможность совершать действие над любыми задачами

Получить информацию о правах Сотрудника

Запрос на получение информации о правах Сотрудника.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Изменить информацию о правах Сотрудника

Запрос на изменение информации о правах Сотрудника.

Если у пользователя есть возможность настраивать пермиссии для индивидуальной роли, то при установке индивидуальной роли пермиссии выставятся в соответствии с теми, что были переданы в поле permissions, остальные пермиссии будут выставлены в NO, кроме view равное ALL для currency, country и uom. В случае отсутствия поля permissions будут заданы значения пермиссий, которые были у сотрудника до смены роли (по умолчанию, если не были).

Если тариф не позволяет менять пермиссии и переданные или ранее выставленные пермиссии отличаются от значений по умолчанию, то вернётся ошибка без смены роли.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Активация Сотрудника

Запрос на активацию Сотрудника в сервисе МойСклад.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Если пользователь ранее не был активным, то при запросе необходимо указать поле login. Формат поля аналогичен формату в сервисе МойСклад. Успешным результатом выполнения запроса будет json, содержащий поле mailActivationRequired со значением true. Это означает, что на указанную у сотрудника почту было выслано письмо со ссылкой на вход для сотрудника.

Если пользователь уже был ранее активным, то при активации не нужно указывать поле login. Успешным результатом выполнения запроса будет json, содержащий поле mailActivationRequired со значением false. В данном случае можно использовать ранее заданный пароль для данного пользователя.

Деактивация Сотрудника

Запрос на деактивацию Сотрудника в сервисе МойСклад.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Response 204

Сброс пароля Сотрудника

Запрос на сброс пароля Сотрудника в сервисе МойСклад. Новый пароль буде выслан на почту, указанную у данного сотрудника.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Сотрудника.

Response 204

Запрос на получение роли админа

Запрос на получение индивидуальной роли

Запрос на получение роли кассира

Запрос на получение роли сотрудника производства

Роль доступна только при подключенной опции Управление производством

Сохраненные фильтры

Сохраненный фильтр

Средствами JSON API можно получать сохраненные фильтры по id и в виде списка. Сохраненный фильтр - это набор параметров и их значений, настраиваемых пользователями, чтобы отфильтровать список из сущностей и документов. Сущность представлена в виде идентификатора и наименования. Параметры фильтрации не возвращаются.

Сохраненные фильтры можно повторно применять для фильтрации списка сущностей.

Сохраненные фильтры относятся к конкретному типу сущности. Например, можно получить список фильтров для реестра документов Приемки, документов Входящих платежей, справочника Контрагентов. Нельзя получить общий список сохраненных фильтров для всех сущностей пользователя. Для каждого типа сущности будет свой набор параметров фильтрации.

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
id UUID ID фильтра
Обязательное при ответе Только для чтения
meta Meta Метаданные фильтра
Обязательное при ответе
name String Название фильтра
Обязательное при ответе Необходимо при создании
owner Meta Владелец (Сотрудник)
Обязательное при ответе Только для чтения Expand

Пример запроса: Сущности и документы - /entity/[entityType]/namedfilter

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

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

Пользователь с правами администратора или приложение имеют возможность запрашивать сохраненные фильтры других сотрудников на аккаунте. Для этого нужно в параметрах запроса указать параметр owner={href сотрудника}.

Получить фильтр по id

Параметры

Параметр Описание
id string (required) Example: 736da682-ad8b-11eb-0a80-17ef000000d4 id Фильтра.

Применение сохраненного фильтра

Средствами JSON API можно применять сохраненные фильтры ко всем Сущностям, кроме Ассортимента, и Документам. Результатом фильтрации будет список сущностей, удовлетворяющих набору условий, сохраненных в фильтре.

Для применения фильтрации необходимо в специальном параметре запроса namedfilter передать ссылку на нужный сохраненный фильтр.

Пример url с применением сохраненного фильтра: https://api.moysklad.ru/api/remap/1.2/entity/product?namedfilter=https://api.moysklad.ru/api/remap/1.2/entity/product/namedfilter/b5863410-ca86-11eb-ac12-000d00000019


Ограничения:

Ставка НДС

Ставки НДС

Средствами JSON API можно создавать и обновлять сведения о налоговых ставках, запрашивать списки ставок и сведения по отдельным ставкам. Кодом сущности для налоговой ставки в составе JSON API является ключевое слово taxrate. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов налоговых ставок на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе
comment String = Комментарий к налоговой ставке
group Meta = != Отдел-владелец
Expand Для пользовательских ставок
id UUID ID налоговой ставки
Обязательное при ответе Только для чтения
meta Meta Метаданные налоговой ставки
Обязательное при ответе
rate Number = Значение налоговой ставки
Обязательное при ответе Необходимо при создании
owner Meta = != Сотрудник-владелец
Expand Для пользовательских ставок
shared Boolean Флаг общего доступа
Для пользовательских ставок
updated DateTime Момент последнего обновления сущности
Обязательное при ответе Необходимо при создании
archived Boolean = != Флаг принадлежности ставки к архивным ставкам

Получить Ставки НДС

Запрос на получение всех налоговых ставок, имеющихся в справочнике на данной учетной записи. Результат успешного запроса - JSON представление списка налоговых ставок с перечисленными полями.

Поле Тип Описание
context Meta Метаданные о сотруднике, выполнившем запрос
meta Meta Метаданные о выдаче
rows Array(Object) Массив JSON объектов, представляющих собой налоговые ставки

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Ставку НДС

Запрос на создание новой ставки на данной учетной записи. Единственное поле, которое обязательно должно присутствовать в теле запроса - поле rate.

Массовое создание и обновление Ставок НДС

Массовое создание и обновление ставок НДС. В теле запроса нужно передать массив, содержащий JSON представления ставок, которые вы хотите создать или обновить. Обновляемые ставки должны содержать идентификатор в виде метаданных.

Удалить Ставку НДС

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - ID налоговой ставки

Массовое удаление Ставок НДС

В теле запроса нужно передать массив, содержащий JSON метаданных ставок, которые вы хотите удалить.

Ставка НДС

Получить Ставку НДС

Параметры

Параметр Описание
id string (required) Example: 736da682-ad8b-11eb-0a80-17ef000000d4 id налоговой ставки

Изменить Ставку НДС

Запрос на изменение одной из существующих налоговых ставок. Для предустановленных (системных) ставок невозможно изменить значение параметра rate.

Параметры

Параметр Описание
id string (required) Example: 736da682-ad8b-11eb-0a80-17ef000000d4 id налоговой ставки

Статусы документов

Статусы можно добавлять, изменять и удалять через api только с правами администратора.

Статусы

Атрибуты сущности

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
color Int Цвет Статуса
Обязательное при ответе Необходимо при создании
entityType String(255) Тип сущности, к которой относится Статус (ключевое слово в рамках JSON API)
Обязательное при ответе Только для чтения
id UUID ID Статуса
Обязательное при ответе Только для чтения
meta Meta Метаданные Статуса
Обязательное при ответе Только для чтения
name String(255) Наименование Статуса
Обязательное при ответе Необходимо при создании
stateType Enum Тип Статуса
Обязательное при ответе Необходимо при создании
Тип статуса
Название Описание
Regular Обычный (значение по умолчанию)
Successful Финальный положительный
Unsuccessful Финальный отрицательный

Поле color передается в АПИ как целое число состоящее из 4х байт. Т.к. цвет передается в цветовом пространстве ARGB, каждый байт отвечает за свой цвет соответственно: 1 - за прозрачность, 2 - за красный цвет, 3 - за зеленый, 4 - за синий. Каждый байт принимает значения от 0 до 255 как и цвет в каждом из каналов цветового пространства. Получившееся в итоге из 4 записанных последовательно байт число, переведенное в 10-чную систему счисления и является представлением цвета статуса в JSON API.

Пример: цвету rgb(162, 198, 23) будет соответствовать следующее значение поля "color": 10667543.

Посмотреть списки существующих статусов можно в контексте метаданных документа, например сделав GET запрос по URL https://api.moysklad.ru/api/remap/1.2/entity/demand/metadata Список статусов для документа demand(Отгрузка) будет выведен в коллекции states.

Получить метаданные

Параметры

Параметр Описание
entityType string (required) Example: counterparty тип сущности.

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

Создать новый статус.

Описание

Статус создается на основе переданного объекта JSON, который содержит представление нового Статуса. Результат - JSON представление созданного Статуса. Для создания нового Статуса, необходимо и достаточно указать в переданном объекте не пустые поля name, color, stateType.

Параметры

Параметр Описание
entityType string (required) Example: counterparty тип сущности.

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

Изменить существующий статус.

Описание

Статус меняется на основе переданного объекта JSON. Результат - JSON представление обновленного или созданного Статуса. Для обновления Статуса, необходимо указать в переданном объекте одно или несколько полей с новыми значениями: name, color, stateType.

Параметры

Параметр Описание
entityType string (required) Example: counterparty тип сущности.
id string (required) Example: 4dcb3f23-60c4-11e7-6adb-ede500000019 id Статуса.

Массовое создание и обновление Статусов

Массовое создание и обновление Статусов. В теле запроса нужно передать массив, содержащий JSON представления Статусов, которые вы хотите создать или обновить. Обновляемые Статусы должны содержать идентификатор в виде метаданных.

Удалить Статус

Параметры

Параметр Описание
entityType string (required) Example: counterparty тип сущности.
id string (required) Example: 4dcb3f23-60c4-11e7-6adb-ede500000019 id Статуса.

Response 200 (application/json) Успешное удаление Статуса.

Статья расходов

Статьи расходов

Средствами JSON API можно запрашивать списки Статей расходов и сведения по отдельным Статьям расходов. Кодом сущности для Статей расходов в составе JSON API является ключевое слово expenseitem. Больше о Статьях расходов и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов Статей расходов на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код Статьи расходов
description String(4096) = != ~ ~= =~ Описание Статьи расходов
externalCode String(255) = != ~ ~= =~ Внешний код Статьи расходов
Обязательное при ответе
id UUID = != ID Cтатьи расходов
Обязательное при ответе Только для чтения
meta Meta Метаданные о Статье расходов
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Статьи расходов
Обязательное при ответе Необходимо при создании
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Получить Статьи расходов

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Статью расходов

Запрос на создание новой статьи расходов. Обязательное поле для создание статьи расходов - name.

Массовое создание и обновление Статей расходов

Массовое создание и обновление Статей расходов. В теле запроса нужно передать массив, содержащий JSON представления Статей расходов, которые вы хотите создать или обновить. Обновляемые Статьи расходов должны содержать идентификатор в виде метаданных.

Удалить Статью расходов

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Статьи расходов.

Response 200 (application/json) Успешное удаление статьи расходов.

Массовое удаление Статей расходов

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

Статья расходов

Работа со статьей расходов с указанным id.

Получить Статью расходов

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Статьи расходов.

Изменить Статью расходов

Запрос на изменение существующей статьи расходов.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Статьи расходов.

Страна

Страны

Средствами JSON API можно создавать и обновлять сведения о Странах, запрашивать списки Стран и сведения по отдельным Странам. Кодом сущности для Страны в составе JSON API является ключевое слово country. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

Поиск среди объектов стран на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
code String(255) = != ~ ~= =~ Код Страны
description String(4096) = != ~ ~= =~ Описание Страны
externalCode String(255) = != ~ ~= =~ Внешний код Страны
Обязательное при ответе
group Meta = != Отдел-владелец
Expand Для пользовательских стран
id UUID = != ID Страны
Обязательное при ответе Только для чтения
meta Meta Метаданные о Стране
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Страны
Обязательное при ответе Необходимо при создании
owner Meta = != Сотрудник-владелец
Expand Для пользовательских стран
shared Boolean = != Флаг Общий доступ
Для пользовательских стран
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Получить Страны

Запрос на получение списка всех Стран для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Страны.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Страну

Запрос на создание новой страны на данной учетной записи. Единственное поле, которое обязательно должно присутствовать в теле запроса на создание Страны - поле name.

Массовое создание и обновление Стран

Массовое создание и обновление Стран. В теле запроса нужно передать массив, содержащий JSON представления Стран, которые вы хотите создать или обновить. Обновляемые Страны должны содержать идентификатор в виде метаданных.

Удалить Страну

Запрос на удаление страны. Невозможно удаление предустановленных стран (стран имеющихся на учетной записи по умолчанию). Удалить можно только страны, созданные через основной интерфейс или через метод POST.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Страны.

Response 200 (application/json) Успешное удаление Розничной продажи.

Массовое удаление Стран

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

Страна

Параметры

Параметр Описание
id 7944ef04-f831-11e5-7a69-971500188b19 (required, string) - id Страны

Получить Страну

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Страны.

Изменить Страну

Запрос на изменение объекта, представляющего собой страну. Невозможно изменение предустановленных стран (стран имеющихся на учетной записи по умолчанию). Изменить можно только страны, созданные через основной интерфейс или через метод POST.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Страны.

Техкарта

Средствами JSON API можно создавать и обновлять сведения о Техкартах, запрашивать списки Техкарт и сведения по отдельным Техкартам. Позициями Техкарт можно управлять как в составе отдельной Техкарты, так и отдельно - с помощью специальных ресурсов для управления материалами и продуктами Техкарты. Кодом сущности для Техкарты в составе JSON API является ключевое слово processingplan. Больше о Техкартах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Техкарты

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлена ли Техкарта в архив
Обязательное при ответе
code String(255) = != ~ ~= =~ Код Техкарты
cost Double Стоимость производства
costDistributionType Enum Тип распределения себестоимости. Возможные значения: BY_PRICE, BY_PRODUCTION
Обязательное при ответе Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Техкарты
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Техкарты
Обязательное при ответе Только для чтения
stages MetaArray Коллекция метаданных этапов Техкарты
Обязательное при ответе Expand
materials MetaArray Коллекция метаданных материалов Техкарты
Обязательное при ответе Expand
meta Meta Метаданные Техкарты
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Техкарты
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Обязательное при ответе Expand
parent Meta Метаданные группы Техкарты
Обязательное при ответе Expand
pathName String Наименование группы, в которую входит Техкарта
Обязательное при ответе Только для чтения
processingProcess Meta Метаданные Техпроцесса
Обязательное при ответе Expand
products MetaArray Коллекция метаданных готовых продуктов Техкарты
Обязательное при ответе Expand Необходимо при создании
shared Boolean = != Общий доступ
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления Техкарты
Обязательное при ответе Только для чтения

Особенности: Для costDistributionType значение BY_PRODUCTION доступно только для техкарт с двумя и более позициями продукции. При изменении количества позиций продукции на значение меньшее, чем 2 автоматически меняется на BY_PRICE.

Этапы Техкарты

Объект этап Техкарты содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
id UUID ID Материала
Обязательное при ответе Только для чтения
cost Int Стоимость производства, на определенном этапе Обязательное при ответе
labourCost Int Оплата труда, на определенном этапе Обязательное при ответе
processingProcessPosition Meta Метаданные позиции техпроцесса
Обязательное при ответе

Особенности: Этапы Техкарты строго соответствует этапам в позициях привязанного техпроцесса. Нельзя одновременно передавать суммарную стоимость производства для техкарты и стоимость производства для этапа.

Материалы Техкарты

Материалы Техкарты - это список товаров/модификаций, используемых для производства готовых продуктов. Объект материала Техкарты содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара или модификации позиции
Обязательное при ответе Expand
id UUID ID Материала
Обязательное при ответе Только для чтения
product Meta Метаданные товара позиции. В случае, если в поле assortment указана модификация, то это поле содержит товар, к которому относится эта модификация
Обязательное при ответе Expand
quantity Float Количество товаров данного вида в позиции
Обязательное при ответе
processingProcessPosition Meta Метаданные позиции Техпроцесса
Обязательное при ответе
materialProcessingPlan Meta Метаданные техкарты материала
Только для чтения

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

Продукты Техкарты

Продукты Техкарты - это список товаров/модификаций, получаемых при производстве. Объект продукта Техкарты содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
assortment Meta Метаданные товара или модификации позиции
Обязательное при ответе Expand
id UUID ID Продукта
Обязательное при ответе Только для чтения
product Meta Метаданные товара позиции. В случае, если в поле assortment указана модификация, то это поле содержит товар, к которому относится эта модификация
Обязательное при ответе Expand
quantity Float Количество товаров данного вида в позиции
Обязательное при ответе

С материалами и продуктами можно работать с помощью специальных ресурсов для управления позициями Техкарты, а также в составе отдельной Техкарты. При работе в составе отдельной Техкарты, вы можете отправлять запросы на создание отдельной Техкарты с включенными в тело запроса массивами материалов и продуктов Техкарты. Если количество материалов или продуктов превышает максимально допустимое, то для дальнейшего пополнения материалов и продуктов нужно будет работать со специальными ресурсами "Материалы Техкарты" и "Продукты Техкарты". Также, при работе в составе отдельной Техкарты, можно отправлять запросы на обновление списка материалов и продуктов с включенными в тело запроса массивами материалов и продуктов Техкарты. При этом важно помнить, что коллекции материалов и продуктов полностью заменят уже существующие коллекции при обновлении объекта - лишние позиции будут удалены, новые добавлены, существующие - изменены.

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

Запрос всех Техкарт на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Техкарты.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
search string (optional) Example: 0001 Фильтр документов по указанной поисковой строке.

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

Запрос на создание новой Техкарты. При создании Техкарты, если не указан Техпроцесс, то по умолчанию будет подставлен “Основной техпроцесс”. Обязательные для создания поля:

Массовое создание и обновление Техкарт

Массовое создание и обновление Техкарт. В теле запроса нужно передать массив, содержащий JSON представления Техкарт, которые вы хотите создать или обновить. Обновляемые Техкарты должны содержать идентификатор в виде метаданных.

Особенности: Привязка другого Техпроцесса приведет к удалению метериалов, привязанных к старому Техпроцессу. При создании Техкарты, если не указан Техпроцесс, то по умолчанию будет подставлен “Основной техпроцесс”.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.

Response 200 (application/json) Успешное удаление Техкарты.

Массовое удаление Техкарт

В теле запроса нужно передать массив, содержащий JSON метаданных Техкарт, которые вы хотите удалить.

Техкарта

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.

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

Запрос на обновление Техкарты с указанным id. В теле запроса можно указать только те поля, которые необходимо изменить у Техкарты, кроме тех, что помечены Только для чтения в описании атрибутов Техкарты.

Особенности: привязка другого Техпроцесса приведет к удалению метериалов, привязанных к старому Техпроцессу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.

Этапы Техкарты

Отдельный ресурс для управления этапами Техкарты. С его помощью вы можете управлять этапами большого документа, количество этапов в котором превышает лимит на количество позиций, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут. Произвольное создание и удаление этапов Техкарт не поддерживается, этапы Техкарт строго соответствует этапам в позициях связанного Техпроцесса.

Получить этапы Техкарты

Запрос на получение списка всех этапов данной Техкарты.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой этапы Техкарты.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить отдельный этап Техкарты

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
stagesID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id этапа Техкарты.

Изменить отдельный этап Техкарты

Для обновления этапа техкарты нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
stagesID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id этапа Техкарты.

Материалы Техкарты

Отдельный ресурс для управления материалами Техкарты. С его помощью вы можете управлять материалами большого документа, количество материалов в котором превышает лимит на количество материалов, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить материалы Техкарты

Запрос на получение списка всех материалов данной Техкарты.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой материалы Техкарты.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Материал Техкарты

Получить материал

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техкарты.

Создать материал

Запрос на создание нового материала в Техкарте. Если при добавлении материала не указывать связь с позицией Техпроцесса, то по умолчанию материал будет привязан к первой позиции Техпроцесса. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.

Изменить материал

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

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техкарты.

Удалить материал

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 9560e3e3-9609-11e6-8af5-581e00000008 id позиции Техкарты.

Response 200 (application/json) Успешное удаление материала Техкарты.

Массовое удаление материалов

В теле запроса нужно передать массив, содержащий JSON метаданных материалов Техкарты, которые требуется удалить.

Response 200 (application/json) Успешное удаление материалов Техкарты.

Продукты Техкарты

Отдельный ресурс для управления продуктами Техкарты. С его помощью вы можете управлять продуктами большого документа, количество продуктов в котором превышает лимит на количество продуктов, сохраняемых вместе с документом. Этот лимит равен 1000. Более подробно о лимитах на количество строк документа и работе с большими документами можно прочитать тут.

Получить продукты Техкарты

Запрос на получение списка всех продуктов данной Техкарты.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой продукты Техкарты.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Продукт Техкарты

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

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id продукта Техкарты.

Создать продукт

Запрос на создание нового продукта в Техкарте. Для успешного создания необходимо в теле запроса указать следующие поля:

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Техкарты.

Изменить продукт

Запрос на обновление отдельного продукта Техкарты. Для обновления продукта нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id продукта Техкарты.

Удалить продукт

Параметры

Параметр Описание
id string (required) Example: d72b4281-b000-11e6-8af5-581e00000074 id Техкарты.
positionID string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id продукта Техкарты.

Response 200 (application/json) Успешное удаление продукта Техкарты.

Массовое удаление продукта

В теле запроса нужно передать массив, содержащий JSON метаданных продуктов Техкарты, которые требуется удалить.

Response 200 (application/json) Успешное удаление продуктов Техкарты.

Техпроцесс

Средствами JSON API можно создавать и обновлять сведения о Техпроцессах, запрашивать списки Техпроцессов и сведения по отдельным Техпроцессам. Позициями Техпроцессов можно управлять как в составе отдельного Техпроцесса, так и отдельно - с помощью специальных ресурсов для управления позициями Техпроцессов. Кодом сущности для Техпроцессов в составе JSON API является ключевое слово processingprocess. Больше о Техпроцессах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Техпроцессы

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлен ли Техпроцесс в архив
Обязательное при ответе
description String(4096) = != ~ ~= =~ Комментарий Техпроцесса
externalCode String(255) = != ~ ~= =~ Внешний код Техпроцесса
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Техпроцесса
Обязательное при ответе Только для чтения
meta Meta Метаданные Техпроцесса
Обязательное при ответе Только для чтения
name String(255) = != ~ ~= =~ Наименование Техпроцесса
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Обязательное при ответе Expand
positions MetaArray Метаданные позиций Техпроцесса
Обязательное при ответе Необходимо при создании Expand
shared Boolean = != Общий доступ
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения

Атрибуты вложенных сущностей

Позиции Техпроцесса

Позиции Техпроцесса - это список этапов, которые входят в Техпроцесс. У Техпроцесса может быть от 1 до 100 позиций. Объект позиции Техпроцесса содержит следующие поля:

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
id UUID ID позиции
Обязательное при ответе Только для чтения
meta Meta Метаданные позиции Техпроцесса
Обязательное при ответе Только для чтения
processingstage Meta Метаданные этапа, который представляет собой позиция
Обязательное при ответе Необходимо при создании Expand
nextPositions MetaArray Метаданные следующих позиций позиции Техпроцесса

Получить список Техпроцессов

Запрос всех Техпроцессов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Техпроцессы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить Техпроцесс

Параметры

Параметр Описание
id string (required) Example: d2308bcc-8fd9-11ed-ac12-000b000000c1 id Техпроцесса.

Создать Техпроцесс

Запрос на создание нового Техпроцесса. Обязательные для создания поля:

Изменить Техпроцесс

В теле запроса указать поля, которые необходимо изменить у Техпроцесса. Важно: имеется отличие в работе от UI при замене одного Этапа на другой. В web-интерфейсе при изменении Этапа через селектор будет удалена старая позиция и создана новая позиция с выбранным этапом. Замена Этапа через API с передачей меты позиции, не пересоздает позицию, а изменяет ее.

Параметры

Параметр Описание
id string (required) Example: 117cae13-a612-11ed-ac12-000900000022 id Техпроцесса.

Удалить Техпроцесс

Параметры

Параметр Описание
id string (required) Example: d2308bcc-8fd9-11ed-ac12-000b000000c1 id Техпроцесса.

Response 200 (application/json) Успешное удаление Техпроцесса

Позиции Техпроцесса

В сущности установлен лимит на позиции в размере 100 элементов. Более подробно о лимитах на количество строк и работе с большим количеством позиций можно прочитать на примере работы с позициями документов тут.

Атрибуты позиции Техпроцесса

Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
id UUID ID позиции
Обязательное при ответе Только для чтения
meta Meta Метаданные позиции Техпроцесса
Обязательное при ответе Только для чтения
processingstage Meta Метаданные этапа, который представляет собой позиция
Обязательное при ответе Необходимо при создании Expand

Получить позиции Техпроцесса

Запрос на получение списка всех позиций данного Техпроцесса.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой позиции Техпроцесса.

Параметры

Параметр Описание
id string (required) Example: d5069703-988e-11ed-ac19-000400000029 id Техпроцесса.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Получить отдельную позицию Техпроцесса

Параметры

Параметр Описание
id string (required) Example: 1d4adde5-a6bb-11ed-ac12-00090000003f id Техпроцесса.
positionID string (required) Example: 23a62e19-a6bb-11ed-ac12-000900000043 id позиция Техпроцесса.

Создать позиции Техпроцесса

Параметры

Параметр Описание
id string (required) Example: 1d4adde5-a6bb-11ed-ac12-00090000003f id Техпроцесса.

Изменить позицию Техпроцесса

Важно: имеется отличие в работе от UI при замене одного Этапа на другой. В web-интерфейсе при изменении Этапа через селектор будет удалена старая позиция и создана новая позиция с выбранным этапом. Замена Этапа через API не пересоздает позицию, а изменяет ее.

Параметры

Параметр Описание
id string (required) Example: 1d4adde5-a6bb-11ed-ac12-00090000003f id Техпроцесса.
positionID string (required) Example: 23a62e19-a6bb-11ed-ac12-000900000043 id позиции Техпроцесса.

Удалить позицию Техпроцесса

Параметры

Параметр Описание
id string (required) Example: d5069703-988e-11ed-ac19-000400000029 id Техпроцесса.
positionID string (required) Example: d5069da5-988e-11ed-ac19-00040000002a id позиции Техпроцесса.

Response 200 (application/json) Успешное удаление отдельной позиции Техпроцесса

Массовое удаление позиций Техпроцесса

В теле запроса нужно передать массив, содержащий JSON метаданных позиций Техпроцессов, которые требуется удалить.

Response 200 (application/json) Успешное массовое удаление позиций Техпроцесса

Массовое создание и обновление Техпроцессов

При массовом создании и обновлении Техпроцессов в теле запроса нужно передать массив, содержащий JSON представления Техпроцессов, которые вы хотите создать или обновить. Идентификатором у обновляемых Техпроцессов является Meta.

Массовое удаление Техпроцессов

В теле запроса нужно передать массив, содержащий JSON метаданных Техпроцессов, которые вы хотите удалить.

Типы цен

Типы цен

Средствами JSON API можно создавать и обновлять сведения о Типах цен, запрашивать списки Типов цен и сведения по отдельным Типам цен по id. Кодом сущности для Типа цен в составе JSON API является ключевое слово pricetype.

Атрибуты сущности

Название Тип Описание
externalCode String(255) Внешний код Типа цены
Обязательное при ответе
id UUID ID типа цены
Обязательное при ответе Только для чтения
meta Meta Метаданные Типа цены
Обязательное при ответе Только для чтения
name String(255) Наименование Типа цены
Обязательное при ответе Необходимо при создании

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

Редактирование списка типов цен

Типы цен возможно редактировать только полным списком.

Ограничения:

Тип цены

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

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

Параметры

Параметр Описание
id string (required) Example: a8967d6b-b026-11e7-9464-d04800000000 id типа цены

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

Товар

Товары

Средствами JSON API можно создавать и обновлять сведения о Товарах, запрашивать списки Товаров и сведения по отдельным Товарам. Кодом сущности для Товара в составе JSON API является ключевое слово product. Больше о Товарах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки в разделе Товары и склад. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке.

Поиск среди объектов товаров на соответствие поисковой строке будет осуществлен по следующим полям:

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
alcoholic Object Объект, содержащий поля алкогольной продукции. Подробнее тут
archived Boolean = != Добавлен ли Товар в архив
Обязательное при ответе
article String(255) = != ~ ~= =~ Артикул
attributes Array(Object) Операторы доп. полей Коллекция доп. полей
barcodes Array(Object) = != ~ ~= =~ Штрихкоды Комплекта. Подробнее тут
buyPrice Object Закупочная цена. Подробнее тут
code String(255) = != ~ ~= =~ Код Товара
country Meta Метаданные Страны
Expand
description String(4096) = != ~ ~= =~ Описание Товара
discountProhibited Boolean Признак запрета скидок
Обязательное при ответе
effectiveVat Int Реальный НДС %
Только для чтения
effectiveVatEnabled Boolean Дополнительный признак для определения разграничения реального НДС = 0 или "без НДС". (effectiveVat = 0, effectiveVatEnabled = false) -> "без НДС", (effectiveVat = 0, effectiveVatEnabled = true) -> 0%.
Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Товара
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Expand
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Товара
Обязательное при ответе Только для чтения
images MetaArray Массив метаданных Изображений (Максимальное количество изображений - 10)
Expand
isSerialTrackable Boolean = != Учет по серийным номерам. Данная отметка не сочетается с признаками weighed, alcoholic, ppeType, trackingType, onTap.
meta Meta Метаданные Товара
Обязательное при ответе
minPrice Object Минимальная цена. Подробнее тут
minimumBalance Int = != < > <= >= Неснижаемый остаток
name String(255) = != ~ ~= =~ Наименование Товара
Обязательное при ответе Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
packs Array(Object) Упаковки Товара. Подробнее тут
partialDisposal Boolean Управление состоянием частичного выбытия маркированного товара. «true» - возможность включена.
pathName String = != ~ ~= =~ Наименование группы, в которую входит Товар
Обязательное при ответе Только для чтения
paymentItemType Enum Признак предмета расчета. Подробнее тут
ppeType Enum Код вида номенклатурной классификации медицинских средств индивидуальной защиты (EAN-13). Подробнее тут
productFolder Meta Метаданные группы Товара
Expand
salePrices Array(Object) Цены продажи. Подробнее тут
shared Boolean = != Общий доступ
Обязательное при ответе
supplier Meta = != Метаданные контрагента-поставщика
Expand
syncId UUID = != ID синхронизации
Только для чтения Заполнение при создании
taxSystem Enum Код системы налогообложения. Подробнее тут
things Array(String) Серийные номера
tnved String(255) Код ТН ВЭД
trackingType Enum Тип маркируемой продукции. Подробнее тут
uom Meta Единицы измерения
Expand
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения
useParentVat Boolean Используется ли ставка НДС родительской группы. Если true для единицы ассортимента будет применена ставка, установленная для родительской группы.
Обязательное при ответе
variantsCount Int Количество модификаций у данного товара
Обязательное при ответе Только для чтения
vat Int НДС %
vatEnabled Boolean Включен ли НДС для товара. С помощью этого флага для товара можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
volume Int = != < > <= >= Объем
weight Int = != < > <= >= Вес

Атрибут pathName сам по себе является атрибутом только для чтения, однако его можно изменить с помощью обновления атрибута productFolder.

Тип маркируемой продукции

Значения поля trackingType.

Значение Описание
BEER_ALCOHOL Пиво и слабоалкогольная продукция
ELECTRONICS Фотокамеры и лампы-вспышки
FOOD_SUPPLEMENT Биологически активные добавки к пище
LP_CLOTHES Тип маркировки "Одежда"
LP_LINENS Тип маркировки "Постельное белье"
MILK Молочная продукция
NCP Никотиносодержащая продукция
NOT_TRACKED Без маркировки
OTP Альтернативная табачная продукция
PERFUMERY Духи и туалетная вода
SANITIZER Антисептики
SHOES Тип маркировки "Обувь"
TIRES Шины и покрышки
TOBACCO Тип маркировки "Табак"
WATER Упакованная вода
Признак предмета расчета

Значения поля paymentItemType.

Значение Описание
GOOD Товар
EXCISABLE_GOOD Подакцизный товар
COMPOUND_PAYMENT_ITEM Составной предмет расчета
ANOTHER_PAYMENT_ITEM Иной предмет расчета
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
PATENT_BASED Патент
PRESUMPTIVE_TAX_SYSTEM ЕНВД
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
TAX_SYSTEM_SAME_AS_GROUP Совпадает с группой
UNIFIED_AGRICULTURAL_TAX ЕСХН
Код вида номенклатурной классификации медицинских средств индивидуальной защиты

Значения поля ppeType.

Значение Описание
2400001225408 перчатки смотровые (процедурные) из латекса гевеи, неопудренные, нестерильные
2400001225606 перчатки смотровые (процедурные) из латекса гевеи, опудренные
2400001226108 перчатки смотровые (процедурные) из латекса гевеи, неопудренные, стерильные
2400001226306 перчатки хирургические из латекса гевеи, неопудренные
2400001226405 перчатки хирургические из латекса гевеи, опудренные
2400001323807 маска лицевая для защиты дыхательных путей, многоразового использования
2400001368105 средство назальное для защиты от загрязненного воздуха, местного действия
2400001393107 перчатки хирургические из полихлоропрена, неопудренные
2400001393503 перчатки смотровые (процедурные) из полихлоропрена, неопудренные
2400001393602 перчатки смотровые (процедурные) из полихлоропрена, опудренные
2400001565306 перчатки хирургические из блоксополимера стирола, неопудренные, антибактериальные
2400001807703 респиратор общего применения
2400001818303 респиратор хирургический
2400001857005 перчатки хирургические нитриловые, неопудренные
2400001857203 перчатки хирургические нитриловые, опудренные
2400001858309 перчатки смотровые (процедурные) нитриловые, неопудренные, нестерильные
2400001858507 перчатки смотровые (процедурные) нитриловые, опудренные
2400002015909 перчатки хирургические полиизопреновые, неопудренные
2400002016005 перчатки хирургические полиизопреновые, неопудренные, антибактериальные
2400002016104 перчатки хирургические полиизопреновые, опудренные
2400002052805 перчатки смотровые (процедурные) виниловые, неопудренные
2400002052904 перчатки смотровые (процедурные) виниловые, опудренные
2400002186203 респиратор хирургический антибактериальный
2400002886707 комбинезон гигиенический для посетителей
2400002886806 набор гигиенической одежды для посетителей
2400002984502 перчатки смотровые (процедурные) из гваюлового латекса, неопудренные
2400003117107 перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, стерильные
2400003117206 перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, нестерильные
2400003161209 перчатки хирургические из блоксополимера стирола, неопудренные
2400003207907 перчатки смотровые (процедурные) нитриловые, неопудренные, антибактериальные
2400003215308 перчатки смотровые (процедурные) полиизопреновые, неопудренные
2400003227806 перчатки хирургические полимерно-композитные, неопудренные
2400003237409 перчатки хирургические полимерно-композитные, неопудренные
2400003263408 перчатки хирургические из латекса гевеи, неопудренные, антибактериальные
2400003297700 перчатки смотровые (процедурные) нитриловые, неопудренные, стерильные
2400003356704 перчатки смотровые (процедурные) виниловые, неопудренные, стерильные
2400003356803 перчатки смотровые (процедурные) виниловые, опудренные, стерильные
2400003356902 перчатки хирургические из гваюлового латекса, неопудренные
2400003356902 перчатки хирургические из полихлоропрена, опудренные
2400003433108 перчатки смотровые (процедурные) из латекса гевеи, опудренные, стерильные
2400003492303 перчатки смотровые (процедурные) полиизопреновые, опудренные
2400003495700 перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные
2400003495809 перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные
2400003495908 перчатки смотровые (процедурные) нитриловые, опудренные, стерильные
2400003496004 перчатки смотровые (процедурные) полиизопреновые, неопудренные, стерильные
2400003496103 перчатки смотровые (процедурные) полиизопреновые, опудренные, стерильные
2400003675805 маска лицевая для защиты дыхательных путей, одноразового использования

Данная отметка не сочетается с признаками weighed, isSerialTrackable, alcoholic, trackingType, onTap.

Атрибуты вложенных сущностей

Упаковки Товара:
Название Тип Описание
barcodes Array(Object) Массив штрихкодов упаковок товаров. Данный массив может содержать не более одного штрихкода. Если штрихкод в массиве отсутствует, то данное поле не выводится
id UUID ID упаковки товара
Обязательное при ответе Только для чтения
quantity Float Количество Товаров в упаковке данного вида
Обязательное при ответе Необходимо при создании
uom Meta Метаданные единиц измерения
Обязательное при ответе Expand

В версии API 1.2 был удален отдельный ресурс для работы с упаковками товаров. Теперь упаковки - вложенная коллекция. Для того, чтобы создать новую упаковку для данного товара, нужно в запросе на обновление товара указать ее как элемент поля packs, а в ее составе указать ссылку в формате meta на единицу измерения и количество товаров в упаковке. Для упаковки товара нельзя указать ссылку на единицу измерения, совпадающую с единицей измерения товара, иначе возникнет ошибка. При обновлении штрихкодов упаковки в рамках обновления товара, переданная коллекция штрихкодов упаковки полностью заменяет имеющуюся до этого коллекцию. Для обновления списка упаковок товара, необходимо в рамках обновления товара передать новую коллекцию упаковок. Новая коллекия упаковок товара полностью заменит старую коллекцию.

Метаданные Товаров

Метаданные Товаров содержат информацию о дополнительных полях.

Посмотреть все созданные в основном интерфейсе доп. поля Товаров можно с помощью запроса на получение метаданных Товаров. Ответ - объект, со следующей структурой:

Название Тип Описание
meta Meta Метаданные
Обязательное при ответе
attributes Array(Object) Коллекция всех существующих доп. полей Товаров в формате Метаданных
Обязательное при ответе
createShared Boolean Создавать новые Товары с меткой "Общий"
Обязательное при ответе

Структуры объектов отдельных коллекций:

Штрихкоды:

При создании штрихкода требуется описать объект с полем, являющимся форматом представления штрихкода в нижнем регистре, со строковым значением самого штрихкода. Наименование полей отдельного объекта, представляющего штрихкод:

Название Описание
ean13 штрихкод в формате EAN13, если требуется создать штрихкод в формате EAN13
ean8 штрихкод в формате EAN8, если требуется создать штрихкод в формате EAN8
code128 штрихкод в формате Code128, если требуется создать штрихкод в формате Code128
gtin штрихкод в формате GTIN, если требуется создать штрихкод в формате GTIN. Валидируется на соответствие формату GS1
upc штрихкод в формате UPC, если требуется создать штрихкод в формате UPC

Для обновления списка штрихкодов необходимо передавать их полный список, включающий как старые, так и новые значения. Отсутствующие значения штрихкодов при обновлении будут удалены. При обновлении списка штрихкодов валидируются только новые значения. Ранее сохраненные штрихкоды не валидируются. То есть, если один из старых штрихкодов не соответствует требованиям к валидации, то ошибки при обновлении списка не будет. Если на вход передан пустой список штрихкодов или список из пустых значений, то ранее созданные штрихкоды будут удалены.

Особенности создания списка штрихкодов при создании комплекта:

О работе с доп. полями Товаров можно прочитать здесь

Объект, содержащий поля алкогольной продукции
Название Тип Описание
excise Boolean Содержит акцизную марку
type Int Код вида продукции
strength Float Крепость
volume Float Объём тары

Данный объект не сочетается с признаками weighed, isSerialTrackable, ppeType, trackingType.

Поставщик Товара:
Название Тип Описание
meta Meta Метаданные, содержащие ссылку на группу поставщика.
Обязательное при ответе

Тип поставщика - Контрагент. Описание сущности Контрагент вы можете посмотреть здесь

Цены продажи
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
priceType Object Тип цены
Обязательное при ответе
Закупочная цена
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Минимальная цена
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Изображение: структура и загрузка.

При запросе Товара с изображениями будет выведено json представление этого Товара, содержащее поле images. Данное поле является массивом элементов. Элементы поля images имеют поля:

Название Тип Описание
filename String(255) Имя файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
updated DateTime Время загрузки файла на сервер
Обязательное при ответе

Загрузка

Для загрузки изображений нужно в теле запроса на создание или обновление товара указать поле images со списком элементов, имеющих следующие атрибуты:

Название Описание
filename имя файла с расширением. Например - "банан.png"
content Изображение, закодированное в формате Base64.

Если в запросе на обновление images будет содержать пустой массив элементов, то все Изображения у Товара будут удалены, т.к. сервер посчитает, что пользователь хочет обновить список Изображений Товара.

Документация API по работе с Изображениями приведена в главе Изображение.

Группа Товара
Название Тип Описание
meta Meta Метаданные, содержащие ссылку на группу Товара.
Обязательное при ответе

Описание сущности Группа вы можете посмотреть здесь Обновление этого атрибута также обновит атрибут pathName.

Весовой товар
Название Тип Описание
weighed Boolean Поле, показывающее является ли товар весовым. Если его значение false - поле не отображается.
Обязательное при ответе

Данная отметка не сочетается с признаками onTap, isSerialTrackable, ppeType, alcoholic. Маркировка весовых товаров поддерживается только для типа MILK.

Разливной товар
Название Тип Описание
onTap Boolean Поле, показывающее является ли товар разливным. Если его значение false - поле не отображается.
Обязательное при ответе

Данная отметка не сочетается с признаками weighed, isSerialTrackable, ppeType. Маркировка разливных товаров поддерживается только для типов MILK, PERFUMERY.

Особенности фильтрации поля archived

Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.

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

Запрос на получение всех Товаров для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Товаров.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Создать новый Товар.

Описание

Товар создается на основе переданного объекта JSON, который содержит представление нового Товара. Результат - JSON представление созданного Товара. Для создания нового Товара, необходимо и достаточно указать в переданном объекте не пустое поле name. Если вы хотите создать алкогольный товар, то в теле запроса, нужно передать объект alcoholic, у которого как минимум одна из характеристик:

Название Описание
excise Содержит акцизную марку
type Код вида продукции
strength Крепость
volume Объем тары

Будет передана со значением. Иначе, при передаче пустого объекта alcoholic, он будет проигнорирован, и товар создастся без пометки "Алкогольная продукция".

При создании Товара с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом Code 128, в массив штрихкодов должен быть добавлен JSON-объект с полем code128 со значением штрихкода.

Массовое создание и обновление товаров

Массовое создание и обновление товаров. В теле запроса нужно передать массив, содержащий JSON представления товаров, которые вы хотите создать или обновить. Обновляемые товары должны содержать идентификатор в виде метаданных.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара.

Response 200 (application/json) Успешное удаление Товара.

Массовое удаление Товаров

В теле запроса нужно передать массив, содержащий JSON метаданных Товаров, которые вы хотите удалить.

Метаданные Товаров

Метаданные Товаров

Запрос на получение метаданных Товаров, Комплектов и Услуг. Результат - объект JSON, включающий в себя:

Название Описание
meta Метаданные
attributes Метаданные массива доп. полей Товаров
createShared создавать новые комплекты с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id 7944ef04-f831-11e5-7a69-971500188b19 (required, string) - id Доп. поля

Отдельное доп. поле

Товар

Товар, обращение к которому происходит по значению его id.

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара.

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

Запрос на обновление существующего Товара. Типы цен в ценах продаж и дополнительные поля обновляются как элементы вложенных коллекций:

Для обновленя полей алкогольной продукции в теле запроса на обновление товара должен присутствовать объект alcoholic, с вложенными в него полями, отражающими свойства алкогольной продукции:

Название Описание
excise Содержит акцизную марку
type Код вида продукции
strength Крепость
volume Объем тары

Если в запросе на обновление товара, являющегося алкогольной продукцией, передать пустой объект alcoholic, с данного объекта снимется отметка "Алкогольная продукция". Для того чтобы сделать товар, не являющийся алкогольной продукцией алкогольным, нужно в теле запроса передать объект alcoholic, у которого хотя бы одно из свойств будет иметь значение.

При обновлении Товара с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом Code 128, в массив штрихкодов должен быть добавлен JSON-объект с полем code128 со значением штрихкода.

При включенном в основном интерфейсе серийном учете товаров, в запросе на обновление нельзя передать значение true полю weighed, иначе возникнет ошибка, т.к. невозможен серийный учет весовых товаров.

Точка продаж

Точки продаж

Средствами JSON API можно создавать и обновлять сведения о Точках продаж, запрашивать списки Точек продаж и сведения по отдельным Точкам продаж. Также можно получить доступ к специальному ресурсу для управления кассирами точки продаж. Кодом сущности для точки продаж в составе JSON API является ключевое слово retailstore. Больше о точках продаж и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке в разделе "Создание точки продаж в основном интерфейсе". По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.

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

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
acquire Meta Метаданные Банка-эквайера по операциям по карте
Обязательное при ответе Expand
active Boolean = != Состояние точки продаж (Включена/Отключена)
Обязательное при ответе
address String(255) = != ~ ~= =~ Адрес Точки продаж
addressFull Object Адрес с детализацией по отдельным полям. Подробнее тут
allowCreateProducts Boolean Контроль остатков. Не может быть true, если controlShippingStock имеет значение true
Обязательное при ответе
allowCustomPrice Boolean Разрешить продажу по свободной цене
Обязательное при ответе Только для чтения
allowDeleteReceiptPositions Boolean Разрешить удалять позиции в чеке
Обязательное при ответе по умолчанию true
allowSellTobaccoWithoutMRC Boolean Разрешить продавать табачную продукцию не по МРЦ
Обязательное при ответе
archived Boolean Добавлена ли Точка продаж в архив
Обязательное при ответе
authTokenAttached Boolean Создан ли токен для точки продаж
Обязательное при ответе Только для чтения
bankPercent Double Комиссия банка-эквайера по операциям по карте (в процентах)
cashiers Meta Метаданные Кассиров
Обязательное при ответе Expand
controlCashierChoice Boolean Выбор продавца
Обязательное при ответе
controlShippingStock Boolean Контроль остатков. Не может быть true, если AllowCreateProducts имеет значение true
Обязательное при ответе
createAgentsTags Array(Object) Коллекция групп покупателей, представленных в формате строк. Определяет группы, в которые добавляются новые покупатели. Значения null игнорируются
createCashInOnRetailShiftClosing Boolean Создавать ПКО при закрытии смены
Обязательное при ответе
createOrderWithState Meta Метаданные статуса, который будет указан при создании заказа
Expand
createPaymentInOnRetailShiftClosing Boolean Создавать входящий платеж при закрытии смены
Обязательное при ответе
customerOrderStates Meta Метаданные статусов, в которых выгружаются заказы в точку продаж (если указано)
Expand
defaultTaxSystem Enum Код системы налогообложения по умолчанию. Подробнее тут
Обязательное при ответе
demandPrefix String(255) Префикс номера продаж
description String(4096) = != ~ ~= =~ Комментарий к Точке продаж
discountEnable Boolean Разрешить скидки
Обязательное при ответе
discountMaxPercent Int Максимальная скидка (в процентах)
enableReturnsWithNoReason Boolean Разрешить возвраты без основания
Обязательное при ответе
environment Object Информация об окружении. Подробнее тут
Обязательное при ответе Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Точки продаж
Обязательное при ответе Только для чтения
filterAgentsTags Array(Object) Коллекция групп покупателей, представленных в формате строк. Определяет группы, из которых выгружаются покупатели. Значения null игнорируются
fiscalType Enum Тип формирования чеков. Подробнее тут
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Точки продаж
Обязательное при ответе Только для чтения
idQR String(255) Идентификатор устройства QR (IdQR) для приложения оплаты по QR
issueOrders Boolean Выдача заказов
Обязательное при ответе
lastOperationNames Array(Object) Последние операции. Подробнее тут
Обязательное при ответе Только для чтения
markingSellingMode Enum Режим продажи маркированной продукции, если используется формат фискальных документов версии 1.2. Подробнее тут
Обязательное при ответе
marksCheckMode Enum Настройка проверки КМ перед продажей в ГИС МТ (по умолчанию CORRECT_MARKS_ONLY) Подробнее тут
Обязательное при ответе
masterRetailStores Array(Object) Ссылка на точки продаж, которые могут фискализировать операции с текущей точки продаж, если minionToMaster = CHOSEN
Expand
meta Meta Метаданные Точки продаж
Обязательное при ответе
minionToMasterType Enum Стратегия выбора кассы для фискализации облачных чеков. Подробнее тут
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Точки продаж
Обязательное при ответе Необходимо при создании
ofdEnabled Boolean Отправлять электронный чек через ОФД
Обязательное при ответе Только для чтения
onlyInStock Boolean Выгружать только товары в наличии. Доступно только при активном контроле остатков. Влияет только на выгрузку остатков в POS API
Обязательное при ответе
orderTaxSystem Enum Код системы налогообложения для заказов. Подробнее тут
Обязательное при ответе
orderToState Meta Метаданные статуса, который проставится заказу после проведения продажи на его основании (если указано)
Expand
organization Meta = != Метаданные Юрлица
Обязательное при ответе Expand Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
priceType Object Тип цен, с которыми будут продаваться товары в рознице
Обязательное при ответе Необходимо при создании
printAlways Boolean Всегда печатать кассовые чеки
Обязательное при ответе
priorityOfdSend Enum Приоритет отправки электронного чека. Активен только, когда отправка электронных чеков через ОФД включена. Подробнее тут
Обязательное при ответе
productFolders Array(Object) Коллекция Метаданных групп товаров, из которых можно выгружать товары
Expand
qrAcquire Meta Метаданные Банка-эквайера по операциям по QR-коду
Expand
qrBankPercent Double Комиссия банка-эквайера по операция по QR-коду (в процентах)
qrPayEnabled Boolean Возможность оплаты по QR-коду на точке продаж
Обязательное при ответе
qrTerminalId String(255) Идентификатор терминала (TerminalID) для приложения оплаты по QR
receiptTemplate Meta Метаданные шаблона печати кассовых чеков
Expand
requiredFio Boolean Обязательность поля ФИО при создании контрагента
Обязательное при ответе по умолчанию false
requiredPhone Boolean Обязательность поля телефон при создании контрагента
Обязательное при ответе по умолчанию true
requiredEmail Boolean Обязательность поля эл. почта при создании контрагента
Обязательное при ответе по умолчанию false
requiredBirthdate Boolean Обязательность поля дата рождения при создании контрагента
Обязательное при ответе по умолчанию false
requiredSex Boolean Обязательность поля пол при создании контрагента
Обязательное при ответе по умолчанию false
requiredDiscountCardNumber Boolean Обязательность поля номер бонусной карты при создании контрагента
Обязательное при ответе по умолчанию false
reservePrepaidGoods Boolean Резервировать товары, за которые внесена предоплата
Обязательное при ответе
returnFromClosedShiftEnabled Boolean Разрешить возвраты в закрытых сменах
Обязательное при ответе
sellReserves Boolean Учет резервов
Обязательное при ответе
sendMarksForCheck Boolean Для облачных точек — до продажи отправлять коды маркировки на проверку на точку с ККТОбязательное при ответе
sendMarksToChestnyZnakOnCloud Boolean Для облачных точек — отправлять коды маркировки на проверку в Честный ЗнакОбязательное при ответе по умолчанию false
syncAgents Boolean Выгружать покупателей для работы оффлайн
Обязательное при ответе по умолчанию true
shared Boolean = != Общий доступ
Обязательное при ответе
showBeerOnTap Boolean Отображать или нет вскрытые кеги на кассеОбязательное при ответе по умолчанию false
state Object Информация статусе точки продаж. Подробнее тут
Только для чтения
store Meta = != Метаданные Склада
Обязательное при ответе Expand Необходимо при создании
tobaccoMrcControlType Enum Контроль МРЦ для табачной продукции. Подробнее тут
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления Точки продаж
Обязательное при ответе Только для чтения
Код системы налогообложения по умолчанию
Название Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент
Код системы налогообложения для заказов
Название Описание
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент
Тип формирования чеков
Название Описание
STANDARD Стандартное
MASTER Стандартное с обработкой облачных операций
CLOUD Облачное
Стратегия выбора кассы для фискализации облачных чеков
Название Описание
ANY Любая мастер касса
SAME_GROUP Только кассы из того же отдела
CHOSEN Выбранные кассы из списка в поле masterRetailStores
Тип контроля МРЦ для табачной продукции
Название Описание
USER_PRICE Не контролировать МРЦ
MRC_PRICE Продавать по МРЦ указанной на пачке
SAME_PRICE Запрещать продажу, если цена продажи не совпадает с МРЦ
Продажа маркированных товаров:
Название Описание
CORRECT_MARKS_ONLY Только проверенные и правильные коды маркировки
WITHOUT_ERRORS Правильные коды и те, которые не удалось проверить
ALL Все — независимо от результатов проверки кодов
Приоритет отправки электронного чека
Название Описание
phone Приоритет отправки на телефон
email Приоритет отправки на e-mail
none Отсутствие отправки чека
Окружение
Название Тип Описание
device String(255) Информация об устройстве
os String(255) Информация об операционной системе
software Object Информация о ПО. Подробнее тут
chequePrinter Object Данные о ККТ. Подробнее тут
paymentTerminal String(255) Информация о платежном терминале
Аттрибуты сущности ПО
Название Тип Описание
name String(255) Наименование ПО
Обязательное при ответе Необходимо при создании
vendor String(255) Производитель
version String(255) Версия ПО
Аттрибуты сущности ККТ
Название Тип Описание
driver Object Информация об используемом драйвере. Подробнее тут
firmwareVersion String(255) Версия прошивки ККТ
fiscalDataVersion String(255) Формат фискальных данных
fiscalMemory Object Информация о фискальном накопителе. Подробнее тут
name String(255) Наименование ПО
Обязательное при ответе Необходимо при создании
serial String(255) Серийный номер
vendor String(255) Производитель
Аттрибуты сущности Драйвер
Название Тип Описание
name String(255) Наименование драйвера
version String(255) Версия драйвера
Аттрибуты сущности Фискальный накопитель
Название Тип Описание
fiscalDataVersion String(255) Версия фискальной памяти
fiscalValidityDate DateTime Версия фискальной памяти
Аттрибуты сущности Статус
Название Тип Описание
sync Object Состояние синхронизации. Подробнее тут
lastCheckMoment DateTime Дата и время последней синхронизации
fiscalMemory Object Информация о фискальном накопителе. Подробнее тут
paymentTerminal Object Информация о платежном терминале. Подробнее тут
Устаревшее
Аттрибуты сущности Синхронизация
Название Тип Описание
message String(255) Состояние синхронизации
lastAttempMoment DateTime Дата последней сихронизации (не обязательно успешной)
Необходимо при создании
Аттрибуты сущности Фискальная Память
Название Тип Описание
error Object Информация об ошибке ФН. Подробнее тут
notSendDocCount Int Количество неотправленных документов в ОФД
notSendFirstDocMoment DateTime Время начала не отправки документов
Аттрибуты сущности Ошибка
Название Тип Описание
сode String(255) Код ошибки ФН
Обязательное при ответе
message String(255) Описание ошибки
Обязательное при ответе
Аттрибуты сущности Платежный Терминал
Название Тип Описание
acquiringType String(255) Информация о типе эквайера (например: inpas/payme)
Аттрибуты сущности Адрес
Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому аттрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле address передать пустую строку "".

Последние операции

Поле lastOperationNames представляет собой массив объектов со следующей структурой:

Название Тип Описание
entity String(255) Ключевое слово, обозначающее тип последней операции
Только для чтения
name String(255) Наименование (номер) последней операции
Только для чтения

Представляет собой краткий список последних операций на данной точке продаж. Если на данной точке не созданы документы Продажа/Внесение/Выплата/Возврат/Смена, то в ответе данные документы будут с номерами по умолчанию – 00001.

Кассиры

Сущность кассир представляет собой объект, содержащий ссылки на Сотрудника, назначенного кассиром, и Точку продаж, к которой он привязан. Подробнее о сущности Кассира можно посмотреть в разделе Кассиры

Кассир
Название Тип Описание
accountId UUID ID учетной записи Кассира
Обязательное при ответе Только для чтения
employee Meta Метаданные сотрудника, которого представляет собой кассир
Обязательное при ответе Только для чтения Expand
id UUID ID Кассира
Обязательное при ответе Только для чтения
meta Meta Метаданные Кассира
Обязательное при ответе
retailStore Meta Метаданные точки продаж, к которой прикреплен кассир
Обязательное при ответе Только для чтения Expand

Получить точки продаж

Запрос всех Розничных точек продаж данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих Точки продаж.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать точку продаж

Описание

Точка продаж создается на основе переданного объекта JSON, который содержит представление новой Точки продаж. Результат - JSON представление созданной Точки продаж. Для создания новой Точки продаж необходимо и достаточно указать в переданном объекте непустые поля name, organization, store, priceType.

Если не передать поле active при создании, то если позволяет тарифный план, точка продаж создается включенной, иначе - выключенной.

При создании Точки продаж нельзя одновременно указывать значение true для allowCreateProducts и controlShippingStock.

Массовое создание и обновление Точек продаж

Массовое создание и обновление точек продаж. В теле запроса нужно передать массив, содержащий JSON представления точек продаж, которые вы хотите создать или обновить. Обновляемые точки продаж должны содержать идентификатор в виде метаданных.

Удалить точку продаж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Точки продаж.

Response 200 (application/json) Успешное удаление Розничной точки продаж.

Массовое удаление Точек продаж

В теле запроса нужно передать массив, содержащий JSON метаданных Точек продаж, которые вы хотите удалить.

Точка продаж

Получить точку продаж

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Точки продаж.

Изменить Точку продаж

Запрос на обновление существующей Точки продаж.

Услуга

Средствами JSON API можно создавать и обновлять сведения об Услугах, запрашивать списки Услуг и сведения по отдельным Услугам. Кодом сущности для Услуги в составе JSON API является ключевое слово service. Услуга - специальная разновидность товара, без закупочной цены и упаковок. Больше о Товарах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки в разделе Товары и склад.

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

Поиск среди объектов услуг на соответствие поисковой строке будет осуществлен по следующим полям:

Услуги

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
archived Boolean = != Добавлена ли Услуга в архив
Обязательное при ответе
attributes Array(Object) Операторы доп. полей Коллекция доп. полей
barcodes Array(Object) = != ~ ~= =~ Штрихкоды Услуги. Подробнее тут
buyPrice Object Закупочная цена. Подробнее тут
code String(255) = != ~ ~= =~ Код Услуги
description String(4096) = != ~ ~= =~ Описание Услуги
discountProhibited Boolean Признак запрета скидок
Обязательное при ответе
effectiveVat Int Реальный НДС %
Только для чтения
effectiveVatEnabled Boolean Дополнительный признак для определения разграничения реального НДС = 0 или "без НДС". (effectiveVat = 0, effectiveVatEnabled = false) -> "без НДС", (effectiveVat = 0, effectiveVatEnabled = true) -> 0%.
Только для чтения
externalCode String(255) = != ~ ~= =~ Внешний код Услуги
Обязательное при ответе
files MetaArray Метаданные массива Файлов (Максимальное количество файлов - 100)
Expand
group Meta = != Метаданные отдела сотрудника
Обязательное при ответе Expand
id UUID = != ID Услуги
Обязательное при ответе Только для чтения
meta Meta Метаданные Услуги
Обязательное при ответе
minPrice Object Минимальная цена. Подробнее тут
name String(255) = != ~ ~= =~ Наименование Услуги
Обязательное при ответе Необходимо при создании
owner Meta = != Метаданные владельца (Сотрудника)
Expand
pathName String = != ~ ~= =~ Наименование группы, в которую входит Услуга
Обязательное при ответе Только для чтения
paymentItemType Enum Признак предмета расчета. Подробнее тут
productFolder Meta Метаданные группы Комплекта
Expand
salePrices Array(Object) Цены продажи. Подробнее тут
shared Boolean = != Общий доступ
Обязательное при ответе
syncId UUID = != ID синхронизации
Только для чтения Заполнение при создании
taxSystem Enum Код системы налогообложения. Подробнее тут
uom Meta Единицы измерения
Expand
updated DateTime = != < > <= >= Момент последнего обновления сущности
Обязательное при ответе Только для чтения
useParentVat Boolean Используется ли ставка НДС родительской группы. Если true для единицы ассортимента будет применена ставка, установленная для родительской группы.
Обязательное при ответе
vat Int НДС %
vatEnabled Boolean Включен ли НДС для услуги. С помощью этого флага для услуги можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.

Атрибут pathName сам по себе является атрибутом только для чтения, однако его можно изменить с помощью обновления атрибута productFolder.

Признак предмета расчета

Значения поля paymentItemType.

Значение Описание
SERVICE Услуга
WORK Работа
PROVIDING_RID Предоставление РИД
COMPOUND_PAYMENT_ITEM Составной предмет расчета
ANOTHER_PAYMENT_ITEM Иной предмет расчета
Код системы налогообложения

Значения поля taxSystem.

Значение Описание
GENERAL_TAX_SYSTEM ОСН
PATENT_BASED Патент
PRESUMPTIVE_TAX_SYSTEM ЕНВД
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
TAX_SYSTEM_SAME_AS_GROUP Совпадает с группой
UNIFIED_AGRICULTURAL_TAX ЕСХН

Атрибуты вложенных сущностей

Метаданные Услуг

Метаданные Услуг содержат информацию о дополнительных полях.

Посмотреть все созданные в основном интерфейсе доп. поля Услуг, а также все типы цен можно с помощью запроса на получение метаданных Товаров.

Структуры объектов отдельных коллекций:

Штрихкоды:

При создании штрихкода требуется описать объект с полем, являющимся форматом представления штрихкода в нижнем регистре, со строковым значением самого штрихкода. Наименование полей отдельного объекта, представляющего штрихкод:

Название Описание
ean13 штрихкод в формате EAN13, если требуется создать штрихкод в формате EAN13
ean8 штрихкод в формате EAN8, если требуется создать штрихкод в формате EAN8
code128 штрихкод в формате Code128, если требуется создать штрихкод в формате Code128
gtin штрихкод в формате GTIN, если требуется создать штрихкод в формате GTIN. Валидируется на соответствие формату GS1
upc штрихкод в формате UPC, если требуется создать штрихкод в формате UPC

О работе с доп. полями Услуг можно прочитать здесь

Цены продажи
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
priceType Object Тип цены
Обязательное при ответе
Закупочная цена
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Минимальная цена
Название Тип Описание
value Float Значение цены
Обязательное при ответе
currency Meta Ссылка на валюту в формате Метаданных
Обязательное при ответе Expand
Группа Услуги
Название Тип Описание
meta Meta Метаданные, содержащие ссылку на группу Услуги.
Обязательное при ответе

Описание сущности Группа вы можете посмотреть здесь. Обновление этого атрибута также обновит атрибут pathName.

Особенности фильтрации поля archived

Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.

Получить список Услуг

Запрос на получение всех Услуг для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Услуги.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Услугу

Создать новую Услугу.

Описание

Услуга создается на основе переданного объекта JSON, который содержит представление новой Услуги. Результат - JSON представление созданной Услуги. Для создания новой Услуги, необходимо и достаточно указать в переданном объекте не пустое поле name

При создании Услуги с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом Code 128, в массив штрихкодов должен быть добавлен JSON-объект с полем code128 со значением штрихкода.

Массовое создание и обновление Услуг

Массовое создание и обновление Услуг. В теле запроса нужно передать массив, содержащий JSON представления Услуг, которые вы хотите создать или обновить. Обновляемые Услуги должны содержать идентификатор в виде метаданных.

Удалить Услугу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Услуги.

Response 200 (application/json) Успешное удаление Услуги.

Массовое удаление Услуг

В теле запроса нужно передать массив, содержащий JSON метаданных Услуг, которые вы хотите удалить.

Метаданные Услуг

Посмотреть все созданные в основном интерфейсе доп. поля Услуг, а также все типы цен можно с помощью запроса на получение метаданных Товаров.

Услуга

Отдельная Услуга, обращение к которой происходит по значению его id.

Получить Услугу

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Услуги.

Изменить Услугу

Обновить существующую Услугу. Типы цен в ценах продаж и дополнительные поля обновляются как элементы вложенных коллекций:

При обновлении Услуги с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом Code 128, в массив штрихкодов должен быть добавлен JSON-объект с полем code128 со значением штрихкода.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Услуги.

Файлы

Работа с Файлами в рамках отдельных Операции, Номенклатуры, Задачи или Контрагента

При создании и обновлении Операции, Номенклатуры, Задачи или Контрагента можно указать поле files со списком элементов, имеющих следующие атрибуты:

Название Тип Описание
filename String(255) Имя Файла с расширением. Например - "doc.pdf"
content String Файл, закодированный в формате Base64.

В таком случае, массив Файлов воспринимается как множество всех Файлов объекта и полностью заменяет (в случае запроса на обновление) все уже существующие Файлы в объекте. В случае запроса на обновление, все Файлы, которые существовали ранее в объекте будут удалены, а новые Файлы будут добавлены в список Файлов. Если в запросе на обновление files будет содержать пустой массив элементов, то все Файлы у Операции, Номенклатуры, Задачи или Контрагента будут удалены, т.к. сервер посчитает, что пользователь хочет обновить список Файлов Операции, Номенклатуры, Задачи или Контрагента.

Лимит Файлов сохраняемых вместе с объектом равен 10, если вам нужно загрузить больше Файлов для одного объекта, нужно использовать способ описанный в разделе Работа с Файлами Операции, Номенклатуры, Задачи или Контрагента с помощью специальных ресурсов.

Работа с Файлами Операции, Номенклатуры, Задачи или Контрагента с помощью специальных ресурсов

Средствами JSON API можно создавать и обновлять сведения по Файлам для всех типов операций, номенклатуры и контрагентов, запрашивать списки Файлов, а также сведения по отдельным Файлам.

Операции, номенклатура и контрагенты могут содержать множество одинаковых Файлов. Файлы считаются одинаковыми, если при добавлении Файлов у них совпадало filename и content. У одинаковых Файлов одинаковое значение параметра id. У объекта может быть не более 100 Файлов.

Атрибуты сущности

Название Тип Описание
created DateTime Время загрузки Файла на сервер
Обязательное при ответе
createdBy Meta Метаданные сотрудника, загрузившего Файл
Обязательное при ответе Expand
filename String(255) Имя Файла
Обязательное при ответе
meta Meta Метаданные объекта
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения (поле передается только для Файлов изображений)
size Int Размер Файла в байтах
Обязательное при ответе
tiny Meta Метаданные уменьшенного изображения (поле передается только для Файлов изображений)
title String(255) Название Файла
Обязательное при ответе

Получить список Файлов Операции, Номенклатуры, Задачи или Контрагента

Запрос на получение всех Файлов Операции, Номенклатуры, Задачи или Контрагента для данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой Файлы.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Файлами.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
type string (required) Example: product тип сущности, для которой запрашиваются Файлы.

Добавить Файлы к Операции, Номенклатуре или Контрагенту

Добавить новые Файлы к Операции, Номенклатуре или Контрагенту.

Описание

Файлы загружаются и добавляются к Файлам на основе переданного объекта JSON, который содержит массив с представлениями новых Файлов. Результат - JSON представление обновленного списка Файлов. Для создания и добавления новых Файлов к Операции, Номенклатуре или Контрагенту, необходимо и достаточно указать в url запросе id сущности, к которой добавляется Файлы, и указать массив объектов Файлов с полями filename и content.

В поле content нужно указать файл, закодированный в Base64, в поле filename - имя Файла с расширением.

В одном запросе можно добавить максимум 10 Файлов.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Файлами.

Удалить Файл

При удалении Файла удаляется первый найденный с данным идентификатором Файла у Операции, Номенклатуры, Задачи или Контрагента.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Товара c Файлом.
idFile string (required) Example: 19f1edc0-fc42-4001-94cb-c9ec9c62ec10 id Файла.

Response 200 (application/json) Успешное удаление Файла.

Характеристики модификаций

С помощью json api можно добавлять новые Характеристики модификаций

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

Атрибуты сущности

Название Тип Описание
id UUID ID соответствующей Характеристики
Обязательное при ответе Только для чтения
meta Meta Метаданные характеристики
Обязательное при ответе Только для чтения
name String(255) Наименование Характеристики
Обязательное при ответе Необходимо при создании
required Boolean Обязательность указания Характеристики в модификации, всегда имеет значение false
Обязательное при ответе Только для чтения
type String(255) Тип значения Характеристики, всегда имеет значение string
Обязательное при ответе Только для чтения

Посмотреть списки существующих характеристик можно в контексте метаданных модификаций, например сделав GET запрос по URL https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata или https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics Список характеристик модификаций будет выведен в коллекции characteristics.

Получить метаданные

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

Создать новую характеристику.

Описание

Характеристика создается на основе переданного объекта JSON, который содержит представление новой Характеристики. Результат - JSON представление созданной Характеристики. Для создания новой Характеристики, необходимо и достаточно указать в переданном объекте непустое поле name. Пользователь, от лица которого выполняется запрос, должен обладать правами на редактирование товаров.

Массовое создание Характеристик

Массовое создание Характеристик. В теле запроса нужно передать массив, содержащий JSON представления Характеристик, которые вы хотите создать.

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

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Характеристики.

Шаблон печатной формы

Средствами JSON API можно запрашивать списки шаблонов печатных форм для сущностей. Скрытые печатные формы не попадут в результат запроса. Кодом сущности для стандартных шаблонов в составе JSON API является ключевое слово embeddedtemplate, а для пользовательских customtemplate.

Стандартные шаблоны

Атрибуты сущности

Название Тип Описание
content URL Ссылка на скачивание
Обязательное при ответе
id UUID ID шаблона
Обязательное при ответе
meta Meta Метаданные Стандартного шаблона
Обязательное при ответе
name String(255) Наименование шаблона
Обязательное при ответе
type String(255) Тип шаблона (entity - документ)
Обязательное при ответе

Список стандартных шаблонов

Параметры

Параметр Описание
type string (required) Example: demand тип сущности, для которой запрашиваются стандартные шаблоны.

Отдельный стандартный шаблон

Отдельный стандартный шаблон

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id отдельного шаблона.
type string (required) Example: demand тип сущности, для которой запрашиваются стандартные шаблоны.

Стандартные шаблоны для ценников и этикеток

Атрибуты сущности

Название Тип Описание
content URL Ссылка на скачивание
Обязательное при ответе
id UUID ID шаблона
Обязательное при ответе
meta Meta Метаданные Стандартного шаблона
Обязательное при ответе
name String(255) Наименование шаблона
Обязательное при ответе
type String(255) Тип шаблона (mxtemplate - новый тип шаблона для ценников и этикеток)
Обязательное при ответе

Список стандартных ценников и этикеток

Отдельный стандартный шаблон для ценников и этикеток

Отдельный стандартный ценник или этикетка

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id отдельного шаблона.

Пользовательские шаблоны

Атрибуты сущности

Название Тип Описание
content URL Ссылка на скачивание
Обязательное при ответе
id UUID ID шаблона
Обязательное при ответе
meta Meta Метаданные Пользовательского шаблона
Обязательное при ответе
name String(255) Наименование шаблона
Обязательное при ответе
type String(255) Тип шаблона (entity - документ)
Обязательное при ответе

Список пользовательских шаблонов

Параметры

Параметр Описание
type string (required) Example: customerorder тип сущности, для которой запрашиваются пользовательские шаблоны.

Отдельный пользовательский шаблон

Отдельный пользовательский шаблон

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id отдельного шаблона.
type string (required) Example: customerorder тип сущности, для которой запрашивается стандартный шаблон.

Пользовательские шаблоны для ценников и этикеток

Атрибуты сущности

Название Тип Описание
content URL Ссылка на скачивание
Обязательное при ответе
id UUID ID шаблона
Обязательное при ответе
meta Meta Метаданные Пользовательского шаблона
Обязательное при ответе
name String(255) Наименование шаблона
Обязательное при ответе
type String(255) Тип шаблона (mxtemplate - новый тип шаблона для ценников и этикеток)
Обязательное при ответе

Список пользовательских ценников и этикеток

Отдельный пользовательский шаблон для ценников и этикеток

Отдельный пользовательский ценник или этикетка

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id отдельного шаблона.

Юрлицо

Средствами JSON API можно создавать и обновлять сведения о юрлицах, запрашивать списки юрлиц и сведения по отдельным юрлицам. С помощью специального ресурса можно управлять счетами отдельного юрлица. Кодом сущности для юрлица в составе JSON API является ключевое слово organization. По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search. Подробнее можно узнать по ссылке.

Поиск среди объектов юрлиц на соответствие поисковой строке будет осуществлен по следующим полям:

Юрлица

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
actualAddress String(255) = != ~ ~= =~ Фактический адрес Юрлица
actualAddressFull Object Фактический адрес Юрлица с детализацией по отдельным полям. Подробнее тут
archived Boolean = != Добавлено ли Юрлицо в архив
Обязательное при ответе
bonusPoints Int Бонусные баллы по активной бонусной программе
Только для чтения
bonusProgram Meta Метаданные активной бонусной программы
Expand
code String(255) = != ~ ~= =~ Код Юрлица
companyType Enum = != Тип Юрлица . В зависимости от значения данного поля набор выводимых реквизитов контрагента может меняться. Подробнее тут
Обязательное при ответе
created DateTime = != < > <= >= Дата создания
Обязательное при ответе
description String(4096) = != ~ ~= =~ Комментарий к Юрлицу
externalCode String(255) = != ~ ~= =~ Внешний код Юрлица
Обязательное при ответе
group Meta Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Юрлица
Обязательное при ответе Только для чтения
meta Meta Метаданные Юрлица
Обязательное при ответе
name String(255) = != ~ ~= =~ Наименование Юрлица
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Expand
shared Boolean = != Общий доступ
Обязательное при ответе
syncId UUID = != ID синхронизации
После заполнения недоступно для изменения
trackingContractDate DateTime Дата договора с ЦРПТ
trackingContractNumber String(255) Номер договора с ЦРПТ
updated DateTime = != < > <= >= Момент последнего обновления Юрлица
Обязательное при ответе Только для чтения

Поля реквизитов

Название Тип Фильтрация Описание
accounts Array(Object) Метаданные счетов юрлица
Обязательное при ответе Expand
attributes Array(Object) Операторы доп. полей Массив метаданных дополнительных полей юрлица
certificateDate DateTime Дата свидетельства
certificateNumber String(255) Номер свидетельства
chiefAccountSign Object Подпись главного бухгалтера. Подробнее тут
chiefAccountant String(255) Главный бухгалтер
director String(255) Руководитель
directorPosition String(255) Должность руководителя
directorSign Object Подпись руководителя. Подробнее тут
email String(255) = != ~ ~= =~ Адрес электронной почты
fax String(255) = != ~ ~= =~ Номер факса
fsrarId String(255) Идентификатор в ФСРАР
inn String(255) = != ~ ~= =~ ИНН
isEgaisEnable Boolean Включен ли ЕГАИС для данного юрлица
kpp String(255) = != ~ ~= =~ КПП
legalAddress String(255) = != ~ ~= =~ Юридический адреса Юрлица
legalAddressFull Object Юридический адрес Юрлица с детализацией по отдельным полям
legalFirstName String(255) Имя для Юрлица типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Юрлиц типа [Юридическое лицо]
legalLastName String(255) Фамилия для Юрлица типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Юрлиц типа [Юридическое лицо]
legalMiddleName String(255) Отчество для Юрлица типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Юрлиц типа [Юридическое лицо]
legalTitle String(4096) = != ~ ~= =~ Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Юрлица
ogrn String(255) ОГРН
ogrnip String(255) ОГРНИП
okpo String(255) ОКПО
payerVat Boolean Является ли данное юрлицо плательщиком НДС
phone String(255) = != ~ ~= =~ Номер городского телефона
stamp Object Печать. Подробнее тут
utmUrl String(255) IP-адрес УТМ

Атрибуты вложенных сущностей

Аттрибуты сущности Адрес

Название Тип Описание
addInfo String(255) Другое
apartment String(30) Квартира
city String(255) Город
comment String(255) Комментарий
country Meta Метаданные страны
house String(30) Дом
postalCode String(6) Почтовый индекс
region Meta Метаданные региона
street String(255) Улица

Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированный. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле так и в addInfo структурированного адреса. Для адреса не поддерживается значение null. Передача null этому аттрибуту не приведет к его удалению. Для удаления адреса необходимо в строковое поле actualAddress передать пустую строку "".

Подписи и печать
Название Тип Описание
meta Meta Метаданные объекта
Обязательное при ответе
title String(255) Название Изображения
Обязательное при ответе
filename String(255) Имя файла
Обязательное при ответе
size Int Размер файла в байтах
Обязательное при ответе
updated DateTime Время загрузки файла на сервер
Обязательное при ответе
miniature Meta Метаданные миниатюры изображения
Обязательное при ответе
Счета юрлица
Название Тип Описание
accountId UUID ID учетной записи
Обязательное при ответе Только для чтения
accountNumber String(255) Номер счета
Обязательное при ответе Необходимо при создании
agent Meta Метаданные юрлица
Обязательное при ответе
bankLocation String(255) Адрес банка
bankName String(255) Наименование банка
bic String(255) БИК
correspondentAccount String(255) Корр счет
id UUID ID Счета
Обязательное при ответе Только для чтения
isDefault Boolean Является ли счет основным счетом юрлица
Обязательное при ответе
updated DateTime Момент последнего обновления юрлица
Обязательное при ответе Только для чтения

Тип юрлица

В зависимости от типа юрлица companyType в составе его объекта будут выводиться разные наборы реквизитов. Типы юрлица и соответствующие значения, которые могут быть переданы в значение данного поля:

Значение поля companyType Тип контрагента
legal Юридическое лицо
entrepreneur Индивидуальный предприниматель
individual Физическое лицо


Если тип юрлица Юридическое лицо, будут выведены следующие поля реквизитов:

Название Описание
legalTitle Полное наименование юрлица
legalAddress Юридического адреса юрлица
inn ИНН
kpp КПП
ogrn ОГРН
okpo ОКПО


Если тип юрлица Индивидуальный предприниматель, будут выведены следующие поля реквизитов:

Название Описание
certificateDate Дата свидетельства
certificateNumber Номер свидетельства
inn ИНН
legalAddress Юридического адреса юрлица
legalAddressFull Юридический адрес Контрагента с детализацией по отдельным полям
legalFirstName Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalLastName Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalMiddleName Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalTitle Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Юрлица
ogrnip ОГРНИП
okpo ОКПО


Если тип юрлица Физическое лицо, будут выведены следующие поля реквизитов:

Название Описание
legalTitle Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Юрлица
legalLastName Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalFirstName Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalMiddleName Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]. Игнорируется для Контрагентов типа [Юридическое лицо]
legalAddress Юридического адреса юрлица
inn ИНН

О работе с доп. полями юрлиц можно прочитать здесь

Получить список юрлиц

Запрос на получение списка юрлиц на данной учетной записи.

Название Тип Описание
meta Meta Метаданные о выдаче,
context Meta Метаданные о сотруднике, выполнившем запрос.
rows Array(Object) Массив JSON объектов, представляющих собой юрлица.

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать юрлицо

Запрос на создание нового юрлица.

Описание

Юрлицо создается на основе переданного объекта JSON, который содержит представление нового юрлица.

Массовое создание и обновление юрлиц

Массовое создание и обновление юрлиц. В теле запроса нужно передать массив, содержащий JSON представления юрлиц, которые вы хотите создать или обновить. Обновляемые юрлица должны содержать идентификатор в виде метаданных.

Удалить юрлицо

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id юрлица.

Response 200 (application/json) Успешное удаление юрлица.

Массовое удаление Организаций

В теле запроса нужно передать массив, содержащий JSON метаданных Организаций, которые вы хотите удалить.

Метаданные юрлиц

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

Название Тип Описание
meta Meta Ссылка на метаданные юрлиц
attributes Array(Object) Массив объектов доп. полей юрлиц в формате Метаданных
createShared Boolean Создавать новые юрлица с меткой "Общий"

Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.

Отдельное доп. поле

Параметры

Параметр Описание
id string (required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.

Юрлицо

Получить юрлицо

Запрос на получение юрлица с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id юрлица.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

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

Запрос на обновление юрлица с указанным id.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id юрлица.

Счета юрлица

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

Возвращает массив JSON представлений счетов юрлица.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id юрлица.
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Изменить счета юрлица

Описание

Обновляются счета юрлица с указанным id. Обновляются все поля, указанные в JSON объекте запроса, кроме помеченных Только для чтения в описании атрибутов счетов юрлица. Поля, которые не были указаны в JSON запроса, не изменяются.

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id юрлица.

Этап производства

Средствами JSON API можно запрашивать и обновлять списки Этапов и сведения по отдельным Этапам. Кодом сущности для Этапов в составе JSON API является ключевое слово processingstage. Больше об Этапах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.

Этапы

Атрибуты сущности

Название Тип Фильтрация Описание
accountId UUID = != ID учетной записи
Обязательное при ответе Только для чтения
allPerformers Boolean Признак доступности назначения на этап любого сотрудника
Обязательное при ответе
archived Boolean = != Добавлен ли Этап в архив
Обязательное при ответе
description String(4096) = != ~ ~= =~ Комментарий Этапа
externalCode String(255) = != ~ ~= =~ Внешний код Этапа
Обязательное при ответе
group Meta = != Отдел сотрудника
Обязательное при ответе Expand
id UUID = != ID Этапа
Обязательное при ответе Только для чтения
meta Meta Метаданные Этапа
Обязательное при ответе Только для чтения
name String(255) = != ~ ~= =~ Наименование Этапа
Обязательное при ответе Необходимо при создании
owner Meta = != Владелец (Сотрудник)
Обязательное при ответе Expand
performers MetaArray Метаданные возможных исполнителей
Обязательное при ответе
shared Boolean = != Общий доступ
Обязательное при ответе
updated DateTime = != < > <= >= Момент последнего обновления Этапа
Обязательное при ответе Только для чтения

Особенности:
Если флаг allperformers=true И список performers[] пустой, то это состояние: “Любой активный сотрудник может быть назначен исполнителем этого этапа”.
Если флаг allperformers=false И список performers[] пустой, то это состояние: “Никто не может быть назначен исполнителем этого этапа”.
Если флаг allperformers=false И список performers[] вернулся с данными, то это состояние: “Только сотрудник из выборки может быть назначен исполнителем этого этапа”.
При передаче в запросе только allperformers=true массив performers будет автоматически очищен. так же при передаче только массива performers будет автоматически изменено значение allperformers на false.

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

Запрос всех Этапов на данной учетной записи. Результат: Объект JSON, включающий в себя поля:

Название Тип Описание
meta Meta Метаданные о выдаче
context Meta Метаданные о сотруднике, выполнившем запрос
rows Array(Object) Массив JSON объектов, представляющих собой Этапы

Параметры

Параметр Описание
limit number (optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000.
offset number (optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.

Создать Этап

Создать новый Этап.

Описание

Этап создается на основе переданного объекта JSON, который содержит представление нового Этапа. Результат - JSON представление созданного Этапа. Для создания нового Этапа необходимо и достаточно указать в переданном объекте не пустое поле name.

Массовое создание и обновление этапов

Массовое создание и обновление этапов. В теле запроса нужно передать массив, содержащий JSON представления этапов, которые вы хотите создать или обновить. Обновляемые этапы должны содержать идентификатор в виде метаданных.

Удалить Этап

Параметры

Параметр Описание
id string (required) Example: d2308bcc-8fd9-11ed-ac12-000b000000c2 id Этапа.

Response 200 (application/json) Успешное удаление Этапа.

Массовое удаление Этапов

В теле запроса нужно передать массив, содержащий JSON метаданных Этапов, которые вы хотите удалить.

Этап

Получить Этап

Параметры

Параметр Описание
id string (required) Example: d2308bcc-8fd9-11ed-ac12-000b000000c1 id Этапа.

Изменить Этап

Запрос на обновление существующего Этапа.

Параметры

Параметр Описание
id string (required) Example: d2308bcc-8fd9-11ed-ac12-000b000000c1 id Этапа.