Navbar
cURL
Search

Сущности

Контрагент

Контрагенты

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление списка Контрагентов.

СвернутьПоказать

Получить список всех Контрагентов. Результат: Объект 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, который содержит представление нового Контрагента.

Пример 1

СвернутьПоказать

Response 200. Успешный запрос. Результат - JSON представление созданного Контрагента.

СвернутьПоказать

Пример 2

СвернутьПоказать

Response 200. Успешный запрос. Результат - JSON представление созданного Контрагента.

СвернутьПоказать

Пример 3

СвернутьПоказать

Response 200. Успешный запрос. Результат - JSON представление созданного Контрагента.

СвернутьПоказать

Пример с дополнительными полями

СвернутьПоказать

Response 200. Успешный запрос. Результат - JSON представление созданного Контрагента.

СвернутьПоказать

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

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

СвернутьПоказать

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

СвернутьПоказать

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

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

Параметры

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

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

СвернутьПоказать

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

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

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

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

СвернутьПоказать

Успешный запрос. Результат - JSON информация об удалении Контрагентов.

СвернутьПоказать

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

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

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

СвернутьПоказать

Успешный запрос. Результат - JSON представление доп. полей Контрагентов.

СвернутьПоказать

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

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

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

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

Параметры

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

Запрос на получение информации по отдельному дополнительному полю.

СвернутьПоказать

Response 200 (application/json). Успешный запрос. Результат - JSON представление отдельного доп. поля.

СвернутьПоказать

Контрагент

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

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

Параметры

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

Пример 1

СвернутьПоказать

Response 200 (application/json). Результат - JSON представление Контрагента с указанным id.

СвернутьПоказать

Пример 2

СвернутьПоказать

Response 200 (application/json). Успешный запрос. Результат - JSON представление Контрагента типа Индивидуальный Предприниматель с указанным id.

СвернутьПоказать

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

Описание

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

Параметры

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

Пример

СвернутьПоказать

Response 200 (application/json) Успешное обновление. Результат - JSON представление обновленного Контрагента.

СвернутьПоказать

Пример с дополнительными полями

СвернутьПоказать

Response 200 (application/json). Успешное обновление. Результат - JSON представление обновленного Контрагента.

СвернутьПоказать

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

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

Список счетов Контрагента с указанным 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 - Отступ в выдаваемом списке сущностей.

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

СвернутьПоказать

Response 200 (application/json). Возвращает массив JSON представлений счетов Контрагента.

СвернутьПоказать

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

Параметры

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

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

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

СвернутьПоказать

Response 200 (application/json). Возвращает 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 Отступ в выдаваемом списке сущностей.

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

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

СвернутьПоказать

Response 200 (application/json). Возвращает массив JSON представлений контактных лиц Контрагента.

СвернутьПоказать

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

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

Параметры

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

Пример запроса на создание контактного лица Контрагента.

СвернутьПоказать

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

СвернутьПоказать

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

Параметры

Параметр Описание
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Контрагента.
contactpersonId 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 Отступ в выдаваемом списке сущностей.

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

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

СвернутьПоказать

Response 200 (application/json). Возвращает JSON представление отдельного контактного лица Контрагента.

СвернутьПоказать

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

Параметры

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

Описание

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

Пример запроса на обновление контактного лица Контрагента.

СвернутьПоказать

Response 200 (application/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 Отступ в выдаваемом списке сущностей.

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

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

СвернутьПоказать

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

СвернутьПоказать

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

Параметры

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

Запрос на добавление нового события.

СвернутьПоказать

Response 200 (application/json). Успешный запрос. Результат - JSON представление добавленного события.

СвернутьПоказать

Событие

Параметры

Параметр Описание
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 представление отдельного события Контрагента.

СвернутьПоказать

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

Описание

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

Параметры

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

Пример запроса на обновление события Контрагента.

СвернутьПоказать

Response 200 (application/json). Успешное обновление.

СвернутьПоказать

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

Параметры

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

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

СвернутьПоказать

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

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

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

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

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

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

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

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

Запрос на получение настроек справочника контрагентов

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление настроек справочника контрагентов.

СвернутьПоказать

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

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

Запрос на изменение метаданных справочника контрагентов.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление настроек справочника контрагентов.

СвернутьПоказать

Ассортимент

Ассортимент

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

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

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

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

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

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

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

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

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

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

СвернутьПоказать

Response 200 (application/json). Успешный запрос. Результат - JSON представление списка всех товаров, услуг, модификация и серий.

СвернутьПоказать

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

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

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

СвернутьПоказать

Успешный запрос. Результат - JSON информация об удалении позиций в Ассортименте.

СвернутьПоказать

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

Запрос на получение настроек справочника товаров

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление настроек компании.

СвернутьПоказать

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

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

Запрос на изменение метаданных справочника товаров.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление настроек справочника товаров.

СвернутьПоказать

Валюта

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

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

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление списка Валют.

СвернутьПоказать

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

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

Запрос на создание новой валюты.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление созданной Валюты.

СвернутьПоказать

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

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив JSON представлений созданных и обновленных Валют.

СвернутьПоказать

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

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

Параметры

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

Запрос на удаление Валюты

СвернутьПоказать

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

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

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

Запрос на массовое удаление Валют

СвернутьПоказать

Успешный запрос. Результат - JSON информация об удалении Валют.

СвернутьПоказать

Валюта

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

Параметры

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление запрошенной Валюты.

СвернутьПоказать

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

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

Параметры

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление обновленной Валюты.

СвернутьПоказать

Изображение

Изображения

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

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

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

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

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

Запрос на получение всех Изображений Товара, Комплекта или Модификации для данной учетной записи. Результат: Объект 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 Отступ в выдаваемом списке сущностей.

Получить список Изображений для Товара

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив всех Изображений Товара.

СвернутьПоказать

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

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

Описание

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

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

Параметры

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

Пример добавления Изображения к Товару

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив всех Изображений Товара.

СвернутьПоказать

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

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

Параметры

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

Пример изменения списка Изображений у Товара

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - измененный массив всех Изображений Товара.

СвернутьПоказать

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

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

Параметры

Параметр Описание
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) Успешное удаление Изображений.

Файлы

Работа с Файлами в рамках отдельных Операции, Номенклатуры, Задачи или Контрагента

При создании и обновлении Операции, Номенклатуры, Задачи или Контрагента можно указать поле files со списком элементов, имеющих следующие атрибуты:

Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
filename String(255) Имя Файла с расширением. Например - "doc.pdf" — нет нет
content String Файл, закодированный в формате Base64. — нет нет

В таком случае, массив Файлов воспринимается как множество всех Файлов объекта и полностью заменяет (в случае запроса на обновление) все уже существующие Файлы в объекте. В случае запроса на обновление, все Файлы, которые существовали ранее в объекте будут удалены, а новые Файлы будут добавлены в список Файлов. Если в запросе на обновление files будет содержать пустой массив элементов, то все Файлы у Операции, Номенклатуры, Задачи или Контрагента будут удалены, т.к. сервер посчитает, что пользователь хочет обновить список Файлов Операции, Номенклатуры, Задачи или Контрагента.

Лимит Файлов сохраняемых вместе с объектом равен 10, если вам нужно загрузить больше Файлов для одного объекта, нужно использовать способ описанный в разделе Работа с Файлами Операции, Номенклатуры, Задачи или Контрагента с помощью специальных ресурсов.

Работа с Файлами Операции, Номенклатуры, Задачи или Контрагента с помощью специальных ресурсов

Средствами JSON API можно создавать и обновлять сведения по Файлам для всех типов операций, номенклатуры и контрагентов, запрашивать списки Файлов, а также сведения по отдельным Файлам.

Операции, номенклатура и контрагенты могут содержать множество одинаковых Файлов. Файлы считаются одинаковыми, если при добавлении Файлов у них совпадало filename и content. У одинаковых Файлов одинаковое значение параметра id. У объекта может быть не более 100 Файлов.

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

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

Получить список Файлов Операции, Номенклатуры, Задачи или Контрагента

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

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

Параметры

Параметр Описание
type string (required) Example: product тип сущности, для которой запрашиваются Файлы.
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 - имя Файла с расширением.

В одном запросе можно добавить максимум 10 Файлов.

Параметры

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

Пример добавления Файлов к Товару

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив всех Файлов Товара.

СвернутьПоказать

Удалить Файл

При удалении Файла удаляется первый найденный с данным идентификатором Файла у Операции, Номенклатуры, Задачи или Контрагента.

Параметры

Параметр Описание
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. Кодом сущности для Типа цен в составе JSON API является ключевое слово pricetype.

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

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

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив всех типов цен

СвернутьПоказать

Редактирование списка типов цен

Типы цен возможно редактировать только полным списком.

Ограничения:

Пример создания нового типа цены.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление обновленного списка типов цен.

СвернутьПоказать

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление обновленного списка типов цен.

СвернутьПоказать

Тип цены

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

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

Параметры

Параметр Описание
id string (required) Example: a8967d6b-b026-11e7-9464-d04800000000 id типа цены

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - обновленный тип цены.

СвернутьПоказать

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

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - тип цены по умолчанию.

СвернутьПоказать

Товар

Товары

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

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

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

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

Атрибут pathName сам по себе является атрибутом только для чтения, однако его можно изменить с помощью обновления атрибута productFolder.

Тип маркируемой продукции

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

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

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

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

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

Значение Описание
TAX_SYSTEM_SAME_AS_GROUP Совпадает с группой
GENERAL_TAX_SYSTEM ОСН
SIMPLIFIED_TAX_SYSTEM_INCOME УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME УСН. Доход-Расход
UNIFIED_AGRICULTURAL_TAX ЕСХН
PRESUMPTIVE_TAX_SYSTEM ЕНВД
PATENT_BASED Патент
Код вида номенклатурной классификации медицинских средств индивидуальной защиты

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

Значение Описание
2400001323807 маска лицевая для защиты дыхательных путей, многоразового использования
2400003675805 маска лицевая для защиты дыхательных путей, одноразового использования
2400001807703 респиратор общего применения
2400001818303 респиратор хирургический
2400002186203 респиратор хирургический антибактериальный
2400001368105 средство назальное для защиты от загрязненного воздуха, местного действия
2400001225408 перчатки смотровые (процедурные) из латекса гевеи, неопудренные, нестерильные
2400001225606 перчатки смотровые (процедурные) из латекса гевеи, опудренные
2400001226108 перчатки смотровые (процедурные) из латекса гевеи, неопудренные, стерильные
2400001393503 перчатки смотровые (процедурные) из полихлоропрена, неопудренные
2400001858309 перчатки смотровые (процедурные) нитриловые, неопудренные, нестерильные
2400001858507 перчатки смотровые (процедурные) нитриловые, опудренные
2400002052805 перчатки смотровые (процедурные) виниловые, неопудренные
2400002052904 перчатки смотровые (процедурные) виниловые, опудренные
2400002984502 перчатки смотровые (процедурные) из гваюлового латекса, неопудренные
2400003117107 перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, стерильные
2400003117206 перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, нестерильные
2400003207907 перчатки смотровые (процедурные) нитриловые, неопудренные, антибактериальные
2400003215308 перчатки смотровые (процедурные) полиизопреновые, неопудренные
2400003297700 перчатки смотровые (процедурные) нитриловые, неопудренные, стерильные
2400003356704 перчатки смотровые (процедурные) виниловые, неопудренные, стерильные
2400003356803 перчатки смотровые (процедурные) виниловые, опудренные, стерильные
2400003433108 перчатки смотровые (процедурные) из латекса гевеи, опудренные, стерильные
2400003492303 перчатки смотровые (процедурные) полиизопреновые, опудренные
2400003495700 перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные
2400003495809 перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные
2400003495908 перчатки смотровые (процедурные) нитриловые, опудренные, стерильные
2400003496004 перчатки смотровые (процедурные) полиизопреновые, неопудренные, стерильные
2400003496103 перчатки смотровые (процедурные) полиизопреновые, опудренные, стерильные
2400001226306 перчатки хирургические из латекса гевеи, неопудренные
2400001226405 перчатки хирургические из латекса гевеи, опудренные
2400001393107 перчатки хирургические из полихлоропрена, неопудренные
2400001393602 перчатки смотровые (процедурные) из полихлоропрена, опудренные
2400001565306 перчатки хирургические из блоксополимера стирола, неопудренные, антибактериальные
2400001857203 перчатки хирургические нитриловые, опудренные
2400001857005 перчатки хирургические нитриловые, неопудренные
2400002015909 перчатки хирургические полиизопреновые, неопудренные
2400002016005 перчатки хирургические полиизопреновые, неопудренные, антибактериальные
2400002016104 перчатки хирургические полиизопреновые, опудренные
2400003161209 перчатки хирургические из блоксополимера стирола, неопудренные
2400003227806 перчатки хирургические полимерно-композитные, неопудренные
2400003237409 перчатки хирургические полимерно-композитные, неопудренные
2400003263408 перчатки хирургические из латекса гевеи, неопудренные, антибактериальные
2400003356902 перчатки хирургические из гваюлового латекса, неопудренные
2400003356902 перчатки хирургические из полихлоропрена, опудренные
2400002886806 набор гигиенической одежды для посетителей
2400002886707 комбинезон гигиенический для посетителей

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

Упаковки Товара:
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
id UUID ID упаковки товара Только для чтения да нет
uom Meta Метаданные единиц измерения — да да
quantity Float Количество Товаров в упаковке данного вида Необходимое при создании да нет
barcodes Array(Object) Массив штрихкодов упаковок товаров. Данный массив может содержать не более одного штрихкода. Если штрихкод в массиве отсутствует, то данное поле не выводится — нет нет

В версии API 1.2 был удален отдельный ресурс для работы с упаковками товаров. Теперь упаковки - вложенная коллекция. Для того, чтобы создать новую упаковку для данного товара, нужно в запросе на обновление товара указать ее как элемент поля packs, а в ее составе указать ссылку в формате meta на единицу измерения и количество товаров в упаковке. Для упаковки товара нельзя указать ссылку на единицу измерения, совпадающую с единицей измерения товара, иначе возникнет ошибка. При обновлении штрихкодов упаковки в рамках обновления товара, переданная коллекция штрихкодов упаковки полностью заменяет имеющуюся до этого коллекцию. Для обновления списка упаковок товара, необходимо в рамках обновления товара передать новую коллекцию упаковок. Новая коллекия упаковок товара полностью заменит старую коллекцию.

Метаданные Товаров

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

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

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

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

Штрихкоды:

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

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

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

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

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

Объект, содержащий поля алкогольной продукции
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
excise Boolean Содержит акцизную марку — нет нет
type Int Код вида продукции — нет нет
strength Float Крепость — нет нет
volume Float Объём тары — нет нет
Поставщик Товара:
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
meta Meta Метаданные, содержащие ссылку на группу поставщика. — да нет

Тип поставщика - Контрагент. Описание сущности Контрагент вы можете посмотреть здесь

Цены продажи
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
value Float Значение цены — да нет
currency Meta Ссылка на валюту в формате Метаданных — да да
priceType Object Тип цены — да нет
Закупочная цена
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
value Float Значение цены — да нет
currency Meta Ссылка на валюту в формате Метаданных — да да
Минимальная цена
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
value Float Значение цены — да нет
currency Meta Ссылка на валюту в формате Метаданных — да да
Изображение: структура и загрузка.

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

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

Загрузка

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

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

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

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

Группа Товара
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
meta Meta Метаданные, содержащие ссылку на группу Товара. — да нет

Описание сущности Группа вы можете посмотреть здесь Обновление этого атрибута также обновит атрибут pathName.

Весовой товар
Название Тип Описание Свойство поля в запросе Обязательное при ответе Expand
weighed Boolean Поле, показывающее является ли товар весовым. Если его значение false - поле не отображается. — да нет

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

Особенности фильтрации поля 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 Отступ в выдаваемом списке сущностей.

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление списка Товаров.

СвернутьПоказать

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

Создать новый Товар.

Описание

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

Название Описание
excise Содержит акцизную марку
type Код вида продукции
strength Крепость
volume Объем тары

Будет передана с значением. Иначе, при передаче пустого объекта alcoholic, он будет проигнорирован, и товар создастся без пометки "Алкогольная продукция".

При создании Товара с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом Code 128, в массив штрихкодов должен быть добавлен JSON-объект с полем code128 со значением штрихкода.

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

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление созданного Товара.

СвернутьПоказать

Пример запроса на создание Товара с единственным необходимым полем.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление созданного Товара.

СвернутьПоказать

Пример запроса на создание Товара с доп. полями.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление созданного Товара.

СвернутьПоказать

Пример запроса на создание Товара с загрузкой изображения.

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - JSON представление созданного Товара с изображением.

СвернутьПоказать

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

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

Пример создания и обновления нескольких товаров

СвернутьПоказать

Response 200 (application/json) Успешный запрос. Результат - массив JSON представлений созданных и обновленных товаров.

СвернутьПоказать