NAV Navbar
cURL

Сущности

Контрагент

Контрагенты

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

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

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

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

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

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

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

Поля реквизитов

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

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

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

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

Счета Контрагентов
Контактные лица Контрагентов
События Контрагента

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

Пример 1

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

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

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

Пример 2

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

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

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

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

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

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

СвернутьПоказать
Описание

Контрагент создается на основе переданного объекта 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 Контрагента.

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

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

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). Успешное удаление События.

Ассортимент

Ассортимент

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

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

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

При использовании фильтров article, 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 - будут выведены все сущности

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

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

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

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

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

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

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

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

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

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

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

Валюта

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

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

Атрибуты Сущности
Атрибут Описание
meta Метаданные объекта
id ID в формате UUID Только для чтения
name Краткое наименование Валюты Необходимое
fullName Полное наименование Валюты
code Цифровой код Валюты Необходимое
isoCode Буквенный код Валюты Необходимое
rate Курс Валюты
multiplicity Кратность курса Валюты
indirect Признак обратного курса Валюты
rateUpdateType Способ обновления курса Валюты Только для чтения
majorUnit Формы единиц целой части Валюты
minorUnit Формы единиц дробной части Валюты
archived Добавлена ли Валюта в архив
system Основана ли валюта на валюте из системного справочника Только для чтения
default Является ли валюта валютой учета Только для чтения
Формы единиц

Поля 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 Изображений.

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

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

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

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

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

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

Типы цен

Типы цен

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

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

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

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

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

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. Подробнее можно узнать по ссылке.

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

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

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

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

Упаковки Товара:
Метаданные Товаров

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

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

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

Штрихкоды:

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

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

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

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

Поставщик Товара:
Цены продажи
Закупочная цена
Минимальная цена
Изображение: структура и загрузка.

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

Загрузка

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

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

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

Группа Товара
Весовой товар
Особенности фильтрации поля archived

Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.

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

Запрос на получение всех Товаров для данной учетной записи. Результат: Объект 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, он будет проигнорирован, и товар создастся без пометки "Алкогольная продукция".

При создании Товара с указанным массивом штрихкодов для каждого штрихкода требуется указать к какому типу относится штрихкод. Например, чтобы создать штрихкод с типом 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 представлений созданных и обновленных товаров.

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

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

Параметры

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

Запрос на удаление Товара с указанным id.

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

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

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

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

Запрос на массовое удаление Товаров.

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

Товар

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

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

Параметры

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

Запрос на получение Товара с указанным id.

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

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

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

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

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

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

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

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

Пример запроса на обновление Товара

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

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

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

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

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

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

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

Пример запроса на изменение Товара с упаковками.

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

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

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

Услуга

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

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

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

Услуги

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

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

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

Метаданные Услуг

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

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

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

Штрих коды:

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

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

Цены продажи
Закупочная цена
Минимальная цена
Группа Услуги
Особенности фильтрации поля archived

Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.

Получить список Услуг

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

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

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

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