но в ней не появляются новые возможности
API для манипуляции с сущностями и создания отчетов в онлайн-сервисе МойСклад.
Для того чтобы успешно взаимодействовать с JSON API онлайн-сервиса МойСклад, необходимо аутентифицироваться в системе. МойСклад поддерживает аутентификацию по протоколу Basic Auth, при которой вместе с запросом передаётся заголовок Authorization
со значением пары логин:пароль
, закодированным в варианте RFC2045-MIME стандарта Base64. Аутентификация по протоколу Basic Auth с автоматической генерацией соответствующего заголовка поддерживается во многих
HTTP-клиентах, таких как Postman, curl и т.п.
При разработке клиентского приложения необходимо учитывать следующие моменты:
Структура ответов и типы полей поддерживаются нами неизменными
Может быть добавлено новое поле без нарушения структуры ответа
Может быть добавлен новый ресурс
Для JSON API установлены следующие ограничения:
Не более 45 запросов за 3 секундный период от аккаунта
Не более 5 параллельных запросов от одного пользователя
Не более 20 параллельных запросов от аккаунта
Не более 20 Мб данных в одном запросе, отправляемом на сервер
Также накладывается ограничение на максимальное число объектов (позиций, материалов, продуктов), передаваемых в одном массиве в запросе - не более 100 элементов. В случае, если количество элементов коллекции превышает максимально допустимое, произойдёт ошибка со статусом 413. Если количество позиций превышает максимально допустимое, то для дальнейшего пополнения позиций нужно будет работать со специальным ресурсом, описание которого приведено в конкретной сущности.
В JSON есть несколько видов Метаданных. Один из них - поле meta, которое фигурирует в большинстве JSON представлений объектов, и содержит информацию об объекте или о выдаче, а также может использоваться в качестве ссылки на другой объект. Поле meta представляет собой объект со следующими атрибутами:
href - Ссылка на объект
metadataHref - Ссылка на метаданные сущности (Другой вид метаданных. Присутствует не во всех сущностях)
type - Тип объекта
mediaType - Тип данных, которые приходят в ответ от сервиса, либо отправляются
в теле запроса. В рамках данного API всегда равен application/json
uuidHref - Ссылка на объект на UI. Присутствует не во всех сущностях. Может быть использована для получения uuid
Следующие атрибуты объекта meta появляются, как правило, в методах выдачи списка сущностей/строк отчёта. В них содержится информация о выдаче, пришедшей в ответ. В объектах meta, содержащих данные лишь об одном объекте (например поле meta в объекте context) нижеперечисленные атрибуты не фигурируют.
size - Размер выданного списка
limit - Максимальное количество элементов в выданном списке
offset - Отступ в выданном списке
Другой вид Метаданных. Представляет собой отдельный ресурс, содержащий информацию обо всех объектах сущностей данного типа. Есть не у каждой сущности. Присутствует лишь у тех сущностей, у которых в данной документации описан ресурс “Метаданные <наименование_сущности>”. Как правило содержит информацию о вложенных сущностях, коллекциях и дополнительных полях.
JSON API позволяет получить метаданные всех сущностей с помощью метода /entity/metadata
. Также можно ограничить
выборку, указав в фильтре type только необходимые сущности.
Пример URL для запроса на получение метаданных с помощью GET:
/entity/metadata?filter=type=product;type=service;type=demand
Пример тела запроса:
{
"service": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/service/metadata",
"mediaType": "application/json"
},
"priceTypes": [
{
"name": "Цена продажи"
}
]
},
"product": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"mediaType": "application/json"
},
"priceTypes": [
{
"name": "Цена продажи"
}
]
},
"demand": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"mediaType": "application/json"
}
}
}
meta коллекций содержит все те же атрибуты, что и meta сущностей, однако, если в списке появляется больше позиций, чем умещается на одной странице (size > limit) в объект meta добавляются след. поля:
nextHref - Ссылка на предыдущую страницу сущностей.
previousHref - Ссылка на следующую страницу сущностей.
meta с такими полями можно встретить при выполнении запросов на получение всех объектов определённого типа на учетной записи (например запрос всех отгрузок), а также при запросе всех позиций отдельного документа.
Ошибка в данном API представляет собой массив errors, содержащий объекты error, каждый из которых описывает отдельную ошибку.
error - Заголовок ошибки
parameter - Параметр, на котором произошла ошибка
code - Код ошибки (Если поле ничего не содержит, смотрите HTTP status code)
error_message - Сообщение, прилагаемое к ошибке.
HTTP status code | Значение |
---|---|
301 | Запрашиваемый ресурс находится по другому URL. |
303 | Запрашиваемый ресурс может быть найден по другому URI и должен быть найден с использоваием GET запроса |
400 | Ошибка в структуре JSON передаваемого запроса |
401 | Имя и/или пароль пользователя указаны неверно или заблокированы пользователь или аккаунт |
403 | У вас нет прав на просмотр данного объекта |
404 | Запрошенный ресурс не существует |
405 | http-метод указан неверно для запрошенного ресурса |
409 | Указанный объект используется и не может быть удалён |
410 | Версия API больше не поддерживается |
412 | Не указан обязательный параметр строки запроса или поле структуры JSON |
413 | Размер запроса или количество элементов запроса превышает лимит (например, количество позиций, передаваемых в массиве positions, превышает 100) |
429 | Превышен лимит количества запросов |
500 | При обработке запроса возникла непредвиденная ошибка |
502 | Сервис временно недоступен |
503 | Сервис временно отключен |
504 | Превышен таймаут обращения к сервису, повторите попытку позднее |
Также, вместе с телом ответа ошибки, вам могут прийти следующие заголовки (Headers):
X-Lognex-Auth - расширенный код ошибки аутентификации
X-Lognex-Auth-Message - сообщение об ошибке.
X-Lognex-API-Version-Deprecated - дата отключения запрошенной версии API.
Location - URL по которому доступен запрашиваемый ресурс (в случае ответа с кодом 301 или кодом 303)
X-RateLimit-Limit - количество запросов, которые равномерно можно сделать в течение интервала до появления 429 ошибки
X-Lognex-Retry-TimeInterval - интервал в миллисекундах, в течение которого можно сделать эти запросы
X-RateLimit-Remaining - Число запросов, которые можно отправить до получения 429 ошибки
X-Lognex-Reset - время до сброса ограничения в миллисекундах. Равно нулю, если ограничение не установлено
X-Lognex-Retry-After - время до сброса ограничения в миллисекундах.
companysettings/metadata
в массиве customEntities.online.moysklad.ru/api/1.x/...
Версии API различаются между собой по количеству
доступных ресурсов, а также по способу обработки данных и именно поэтому являются важным элементом идентификации того или иного ресурса.variant
невозможна фильтрация по характеристикам модификаций.yyyy-MM-dd HH:mm:ss
Content-Type
со значением application/json
.{entity_name}/new
можно создать только 1 шаблон. Передача массива значений не поддерживается.Необходимое
.Только для чтения
.agent, currency, vatIncluded
в возвратах на несоответствующие значениям этих же полей в документе-основании.name
у разных документов не может быть одинаковым.Отгрузка, Розничная продажа, Заказ покупателя
.Список сущностей, у которых есть доп. поля:
Все документы:
Дополнительные поля сущности - внутренняя коллекция attributes. Представлена в виде массива объектов с полями:
meta - Ссылка на метаданные доп. поля.
id - Id соответствующего доп. поля.
name - Наименование доп. поля
value - Значение, указанное в доп. поле.
Посмотреть все созданные в основном интерфейсе доп. поля можно с помощью запроса на получение метаданных Сущности. Ответ - объект, содержащий метаданные об объектах данного типа, и в случае объектов, для которых определены доп. поля - информацию о доп. полях в виде коллекции attributes, объекты которой содержат следующие поля:
meta - Ссылка на метаданные доп. поля
id - Id доп. поля
name - Наименование доп. поля
type - Тип доп. поля
required - Флажок о том, является ли доп. поле обязательным
Возможные значения типа доп. поля (поле type) и соответствующие им значения типа в JSON, а также типы атрибута value в JSON объекта доп поля при соответствующем type:
Тип атрибута | Значение поля type в JSON | Тип поля value в JSON |
---|---|---|
Строка | string | string |
Число целое | long | number |
Дата | time | string |
Справочник | {entityType} | object ** |
Файл | file | string |
Число дробное | double | number |
Флажок | boolean | boolean |
Текст | text | string |
Ссылка | link | string |
Отдельного упоминания заслуживает тип Атрибута Справочник. Значение type в представлении объекта атрибута будет разным, в зависимости от того, справочник каких сущностей был выбран при создании Атрибута. Ниже представлена таблица, в которой при выбранном типе Атрибута “Справочник” показаны значения поля type в зависимости от выбранного типа сущностей в справочнике.
Если в качестве типа доп. поля выбран пользовательский справочник, то в составе объекта данного доп. поля появится новый атрибут customEntityMeta являющийся ссылкой на метаданные этого справочника. Полный набор атрибутов доп. поля будет выглядеть следующим образом:
meta - Ссылка на метаданные доп. поля
customEntityMeta - Ссылка на метаданные пользовательского справочника
id - ID доп. поля
name - Наименование доп. поля
type - Тип доп. поля
required - Флажок о том, является ли доп. поле обязательным
Тип сущностей справочника | Значение поля type в JSON (entityType) |
---|---|
[Контрагент] | counterparty |
[Товар] | product |
[Склад] | store |
[Проект] | project |
[Договор] | contract |
[Сотрудник] | employee |
Имя_пользовательского справочника | customentity |
При выбранном типе Атрибута “Справочник” атрибут value в его представлении будет объектом со следующими свойствами:
meta - Метаданные, представляющие собой ссылку на сущность из соответствующего справочника
name - Наименование соответствующей сущности
Обнуление доп. поля типа “Справочник” происходит так же, как и при работе с другими доп. полям. В запросе на обновление в коллекции attributes следует указать объект с id данного поля, а в качестве value передать null.
С коллекцией доп. полей можно работать только в контексте отдельной сущности. Доп. поля и их значения можно передать как коллекцию структур {id : uuid, value : “”} в теле запроса как на создание, так и на обновление сущности. Опционально можно передать также значение полей meta и name. В переданном массиве объектов можно указать не все доп. поля - проинициализируются/обновятся только указанные. Если для доп. поля указан id, которого нет в метаданных сущности, то возникнет ошибка.
При обновлении значений доп.полей если в теле запроса на обновление сущности в массиве доп. полей:
Не указаны id каких-либо доп.полей, которым в данной сущности уже присвоено значение - соответствующие доп. поля обновлены не будут.
Указаны id, доп. полей, которым в данной сущности уже присвоено значение - соответствующим доп. полям будет присвоено переданное значение.
Указаны id, доп. полей, которым в данной сущности ещё не присвоено значение - соответствующим доп. полям эти новые значения будут присвоены.
Для загрузки значения для доп. поля типа файл нужно в JSON при создании или обновлении для значения поля указать объект следующей структуры:
filename - Имя файла Необходимое
content - Байты файла, закодированные в base64 Необходимое
Пример указания значения для доп. поля типа файл есть в секции создания товара
API сервиса МойСклад позволяет оперировать с такими документами как Отгрузка, Заказ покупателя, Счёт покупателю, Розничная продажа. Перечисленные документы содержат позиции, работать с которыми можно как в составе отдельного документа, так и с помощью специальных ресурсов для управления позициями документа.
При работе с позициями в рамках отдельного документа, их можно передавать как поле positions, представляющее собой массив позиций документа, в составе объекта, использующегося в запросе на изменение или создание документа. В таком случае, массив позиций воспринимается как множество всех позиций документа и полностью заменяет (в случае запроса на обновление) все уже существующие позиции в документе. В случае запроса на обновление, все позиции, которые существовали ранее в документе, но не были переданы в теле запроса на обновление, будут удалены, все существующие позиции, id которых совпал с id передаваемых позиций в теле запроса, будут обновлены, а новые позиции, которых ранее не было среди существующих позиций документа, будут добавлены в список позиций.
В JSON API предусмотрены специальные ресурсы для управления позициями документов. Эти ресурсы как правило доступны по следующему URI и с помощью них вы сможете удалять позиции из документа, сделав запрос с методом DELETE по URL соответствующего ресурса с указание id позиции:
/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions
Пример URL для запроса на удаление с помощью DELETE:
/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/179dd832-960c-11e6-8a84-bae5000000dc
При работе со специальными ресурсами можно запрашивать список всех позиций документа, создавать новые позиции, а также обновлять существующие. При создании новых позиций с помощью данных ресурсов, можно обходить ограничение в 100 позиций на документ. Также, используя данный ресурс, можно управлять массовым обновлением позиций. Для изменения сведений по отдельным позициям необходимо использовать ресурсы управления отдельными позициями документа, которые доступны по URI:
/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/{id отдельной позиции}
Оба способа работы с позициями также описаны в документации по каждому из документов.
Также возможно массовое удаление позиций документа, используя метод POST по URL соответствующего ресурса. В теле запроса необходимо указать массив удаляемых позиций, указав поле meta у каждой из позиций.
Пример URL для запроса на массовое удаление позиций с помощью POST:
/{код сущности документа, в составе JSON API}/{id отдельного документа}/positions/delete
Пример тела запроса:
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727cf336-0310-11e6-9464-e4de00000013",
"type": "demandposition",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727cfce0-0310-11e6-9464-e4de00000014",
"type": "demandposition",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/405f69c0-019e-11e6-9464-e4de00000085/positions/727d057f-0310-11e6-9464-e4de00000015",
"type": "demandposition",
"mediaType": "application/json"
}
}
]
Сущностям, у которых среди атрибутов присутствует поле syncId, оно необходимо для того, чтобы в случае сбоя при повторной отправке запроса на создание новой сущности не происходило дублирование объектов. Если в теле запроса на создание сущности указать сгенерированный на клиенте syncId, то при повторной отправке этого же запроса (с тем же syncId) вместо создания сущности с идентичными полями в ответ придёт ранее созданная сущность.
При создании объекта достаточно заполнить только поля, помеченные Необходимое
. Данные поля используются только при создании, при обновлении они не требуются.
Поля, помеченные Только для чтения
, игнорируются при создании/обновлении объекта.
При использовании метода POST вы можете указать в теле запроса вместо одной -
массив сущностей. Для этого, вам нужно передать массив (начать тело запроса с [
и закончить ]
), который будет содержать JSON представления
объектов, которые вы хотите создать или обновить. Обновляемые сущности должные содержать идентификатор в виде метаданных.
В рамках JSON API можно удалить значение из поля типа объект (если это поле не является обязательным, или же если данное поле в
основном интерфейсе может содержать пустое значение). Например: поле Договор(contract) в любом из документов. Сделать это можно передав в
запросе на обновление сущносте в данное поле null. Например: { "contract": null }
.
Удаление валюты из документов ({rate: null}
) равносильно изменению валюты документа на валюту по умолчанию. В результате все
цены и суммы будут пересчитаны. Накладные расходы также будут пересчитаны, если они не были указаны явно.
Если какое-то из полей сущности не было заполнено и, при этом оно не является обязательным, оно не будет выдано в JSON представлении этой сущности.
В JSON API поля типа дата-время (момент времени) - это строка в формате:
Без миллисекунд: ГГГГ-ММ-ДД ЧЧ:мм:сс
С миллисекундами: ГГГГ-ММ-ДД ЧЧ:мм:сс.ммм
Для получения полей типа дата-время с миллисекундами в формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС.ммм
нужно добавить специальный заголовок к запросу:
X-Lognex-Format-Millisecond
со значением true
.
Без секунд: ГГГГ-ММ-ДД ЧЧ:мм
Только для параметров фильтрации.
Следующие поля устанавливаются и выводятся в JSON API с точностью до минут, а именно со значением секунд и миллисекунд равным 00
:
incomingDate
commisionPeriodStart
commisionPeriodEnd
certificateDate
moment
deliveryPlannedMoment
paymentPlannedMoment
firstDemandDate
lastDemandDate
дополнительное поле с типом Дата
Для сортировки списка объектов можно использовать url параметр order
.
Значение этого параметра - urlencoded строка с условиями сортировки, перечисленными через ;
. (Все примеры ниже указаны без urlencoded для лучшей читаемости)
Каждое условие сортировки- это сочетание названия поля, запятой (опционально, если указывается направление сортировки), направления сортировки (опционально; может принимать значения asc
и desc
. Значение по умолчанию - asc
).
Сортировка поддерживается для следующих типов полей: числовой, строковый, дата-время, логический и uuid.
Примеры запросов с сортировкой:
https://online.moysklad.ru/api/remap/1.1/entity/supply?order=name
https://online.moysklad.ru/api/remap/1.1/entity/product?order=code,desc
https://online.moysklad.ru/api/remap/1.1/entity/product?order=name;code,desc
https://online.moysklad.ru/api/remap/1.1/entity/product?order=name,desc;code,asc
Для сортировки списка объектов по одному полю возможно использование следующих url параметров:
order - название поля, по которому будет производиться сортировка.
direction - направление сортировки. Может принимать значения asc
и desc
. Значение по умолчанию - asc
.
Примеры запросов с сортировкой:
https://online.moysklad.ru/api/remap/1.1/entity/product?order=name&direction=asc
https://online.moysklad.ru/api/remap/1.1/entity/supply?order=moment&direction=desc
https://online.moysklad.ru/api/remap/1.1/entity/demand?order=applicable&direction=asc
Для перехода с deprecated-формата сортировки на актуальный вы можете воспользоваться таблицей примеров маппинга url параметров
Url параметры (deprecated-формат) | Url параметры (актуальный формат) |
---|---|
order=name |
order=name |
order=name&direction=asc |
order=name,asc либо order=name |
order=moment&direction=desc |
order=moment,desc |
Для фильтрации выборки по нескольким полям можно использовать url параметр filter
.
Значение этого параметра - urlencoded строка с поисковыми условиями, перечисленными через ;
. Для использования самого символа ;
в текстовых фильтрах необходимо указывать два символа \;
. (Все примеры ниже указаны без urlencoded для лучшей читаемости)
Каждое поисковое условие - это сочетание названия поля, оператора и константы.
Фильтровать можно по всем полям, значения которых являются примитивными типами. Т.е. нельзя фильтровать поля-объекты и поля-массивы,
все остальные поля могут быть использованы в параметре filter
.
['=', '>', '<', '>=', '<=', '!=', '~', '~=', '=~']
Если в поисковом запросе несколько раз встречается условие типа “равенство” =
применённое к одному и тому же полю,
то такое условие интерпретируется как совокупность условий, разделённых логическим оператором ИЛИ
.
filter=sum=100;sum=150
будет интерпретировано как sum=100 ИЛИ sum=150
или же sum in (100, 150)
Если же встречается несколько условий вида “не равно” !=
, наложенных на одну и ту же переменную, то они интерпретируются как совокупность
условий разделённых логическим оператором И
.
filter=name!=0001;name!=0002
будет эквивалентно следующим (взаимно эквивалентным) условиям :
name != 0001 И name != 0002
или name not in (0001, 0002)
Если на одно из полей наложено ограничение типа “равенство”, а затем на него накладывается ограничение типа неравенство - в таком случае произойдёт ошибка.
filter=sum=100;sum>99
вызовет ошибку.Допускается использование одновременно нескольких одинаковых операторов сравнения ['>', '<', '>=', '<=']
для одного поля. При этом будет использовано лишь первое значение.
filter=sum>99;sum>100
будет аналогично условию filter=sum>99
.
В будущих версиях такое условие будет вызывать ошибку.Фильтры, применённые к разным полям объединяются через логическое И
, т.е. в запросе вида:
filter=sum=100;moment>2016-10-11 12:00:00
выборка будет отфильтрована и по сумме и по дате.Если в строке фильтрации указать конструкцию вида: <имя_поля>=;
то в выборку попадут только объекты, где
данное поле равно null (т.е. отсутствует значение), а если тип поля - строковое, то будет также выполнена проверка на пустую строку, т.е. поле=’’.
Конструкция <имя_поля>!=;
выполнит проверку на присутствие значения. С помощью данной конструкции можно проверить наличие значения в ссылочном поле.
Для фильтрации выборки документов следует использовать параметр isDeleted. Может принимать значения true
и false
.
При указании значения true
вернутся все документы данного типа, находящиеся в корзине.
При указании значения false
вернутся только неудалённые документы.
Можно вывести все документы: и удалённые, и нет, указав в запросе оба значения данного параметра: filter=isDeleted=true;isDeleted=false
.
Для фильтрации выборки сущностей следует использовать параметр archived. Данный параметр принимает значения true
и false
.
При указании значения true
вернутся все сущности данного типа, находящиеся в архиве.
При указании значения false
вернутся только не архивные сущности.
Можно вывести все сущности: и архивные, и нет, указав в запросе оба значения данного параметра: filter=archived=true;archived=false
.
Фильтровать по параметру archived можно только те сущности, у которых данный параметр присутствует в списке полей.
С помощью filter можно фильтровать ссылочные поля. Если в сущности присутствует ссылочное поле в виде метаданных, можно использовать следующую конструкцию для того чтобы отфильтровать по этому полю выборку:
filter=<имя_поля>=<ссылка>
Пример ссылки:
http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>
Вот несколько примеров:
filter=agent=http://online.moysklad.ru/api/remap/1.1/entity/counterparty/<id>
filter=ownAgent=http://online.moysklad.ru/api/remap/1.1/entity/organization/<id>
Ссылочные поля, доступные для фильтрации:
agent
ownAgent
owner
group
parent
contract
project
organization
store
agentStore
supplier
Для розничных операций (“Розничная смена”, “Розничная продажа”, “Розничный возврат”, “Внесение денег”, “Выплата денег”) также доступна фильтрация по:
Примеры запросов для фильтрации :
https://online.moysklad.ru/api/remap/1.1/entity/demand?filter=moment>2016-10-11 12:00:00;moment<2016-10-11 13:00:00;sum=100;name=0010;name=0011
https://online.moysklad.ru/api/remap/1.1/entity/counterparty?filter=name=Иван;phone=89269269222;email=vanyan@mail.krut
С помощью filter можно фильтровать поля типа ID.
filter=<имя_поля>=<ID>
Пример ID:
94975104-3cad-11e8-1e44-bd4d00000084
Например:
filter=productid=94975104-3cad-11e8-1e44-bd4d00000084
С помощью filter можно фильтровать по дополнительным полям. Список дополнительных полей сущности указан в ее метаданных
https://online.moysklad.ru/api/remap/1.1/entity/product/metadata
Можно использовать следующую конструкцию для того чтобы отфильтровать по дополнительному полю выборку:
filter=<ссылка на доп.поле>=<значение>
для доп.полей типа справочник:
filter=<ссылка на доп.поле>=<ссылка на сущность>
Пример ссылки на доп.поле
http://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id>
Пример ссылки на сущность:
http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>
для доп.полей типа пользовательский справочник
http://online.moysklad.ru/api/remap/1.1/entity/customentity/<customentity_id>/<id>
Примеры фильтра:
filter=https://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id> =42
filter=https://online.moysklad.ru/api/remap/1.1/entity/<type>/metadata/attributes/<id> =http://online.moysklad.ru/api/remap/1.1/entity/<type>/<id>
При фильтрации по сущности, на которую у текущего пользователя нет прав на просмотр в ответе придёт пустой список. Например, при фильтрации задач (task) по автору (author), который является сотрудником, которого не может просматривать текущий пользователь, в ответ вернётся пустой список задач.
В JSON API сервиса МойСклад предусмотрена возможность фильтрации списка сущностей с помощью специальных параметров. Все параметры фильтрации передаются как URL параметры.
updatedFrom Параметр строкового типа. В качестве значения должна быть передана строка в формате дата + время с точностью до секунд. В отфильтрованную выборку попадут все объекты, момент обновления которых больше или равен значению, указанному в параметре.
Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм]
, Часовой пояс: MSK
(Московское время)
updatedTo Параметр строкового типа. В качестве значения должна быть передана строка в формате дата + время с точностью до секунд. В отфильтрованную выборку попадут все объекты, момент обновления которых меньше или равен значению, указанному в параметре.
Формат строки : ГГГГ-ММ-ДД ЧЧ:ММ:СС[.ммм]
, Часовой пояс: MSK
(Московское время)
updatedBy
Параметр строкового типа. В качестве значения должен быть передан uid (логин пользователя, admin@admin
).
В отфильтрованную выборку попадут все объекты, автором последних изменений которых является
пользователь с uid, указанным в значении параметра.
Формат строки : uid
Также есть дополнительные фильтры для Документов:
state.name Параметр строкового типа. В качестве значения должно передаваться наименование статуса, выставленного на документы. В отфильтрованную выборку попадут все документы данного типа, на которые выставлен статус с указанным именем.
state.id Параметр строкового типа. В качестве значения должен передаваться id статуса, выставленного на документы. В отфильтрованную выборку попадут все документы данного типа, на которые выставлен статус с указанным id.
Формат строки : uuid
organization.id Параметр строкового типа. В качестве значения должен передаваться id юрлица, от имени которого создан документ. В отфильтрованную выборку попадут все документы данного типа, которые были созданы юрлицом с указанным id.
Формат строки : uuid
В JSON API можно осуществлять контекстный поиск среди списка сущностей определённого типа по их строковым полям. Для этого используется URI параметр фильтрации search
search
Параметр фильтрации, с помощью которого можно осуществить поиск в списке сущностей. Поиск происходит по основным строковым полям сущностей данного
типа. Результатом поиска будет отсортированный по релевантности список сущностей данного типа, прошедших фильтрацию по переданной поисковой строке. В отличии от фильтрации выборки
с помощью параметра filter, при которой значения проверяются на точное совпадение указанным, при контекстном поиске проверка на совпадение не строгая.
Таким образом, если осуществлять фильтрацию вида ../entity/<entity_type>?filter=name=120
в отфильтрованную выборку попадут только те сущности, поле name
у которых имеет значение 120
и никакие другие. При контекстном поиске вида ../entity/<entity_type>?search=120
будут выведены как сущности с name равным
120
, так и сущности, в имени (или в другом строковом поле) которых 120
является началом какого-то слова, например 12003
, пазл детский 1200 штук
и т.п.
Причем, если ввести несколько слов ../entity/<entity_type>?search=120 возврат
и поиск идёт по полям name и description, то будут выведены как сущности с name равным 1200
и с description
равным возврат из-за деффекта
, так и сущности с именем 777
с описанием розничный возврат на улице 120 летия
.
https://online.moysklad.ru/api/remap/1.1/entity/project?search=реструктуризация
https://online.moysklad.ru/api/remap/1.1/entity/move?search=ул.Вавилова
https://online.moysklad.ru/api/remap/1.1/entity/counterparty?search=петров
В JSON API для строковых полей есть специальный оператор фильтрации “подобие”.
~
обычное подобие. Ищет любое вхождение подстроки, следующей после оператора, в значении поля. Например, ?filter=code~ms
найдёт все сущности, у которых в коде встречается подстрока “ms”.
~=
левое подобие. Ищет соответствие по префиксу значения. Например ?filter=code~=ms
найдёт все сущности, у которых код начинается на “ms”.
=~
правое подобие. Ищет соответствие по постфиксу. Например ?filter=code=~ms
найдёт все сущности, у которых код оканчивается на “ms”.
Операторы подобия работают исключительно с полями строкового типа и не учитывают регистр. К полям типа uuid и дата-время они неприменимы.
В JSON API можно получать ответы от сервера в виде pretty-print JSON (JSON с отступами вместо JSON в одну строку). Для этого нужно добавить специальный заголовок к запросу:
Lognex-Pretty-Print-JSON
со значением true
.
В JSON API можно задавать цены позиций и себестоимость с дробными частями копеек. Для этого нужно добавить специальный заголовок к запросу:
X-Lognex-Precision
со значением true
.
Если не использовать этот заголовок, цены и себестоимость округляются до копеек.
В JSON API для скачивания файла формируется редирект на временный URL файла. Для корректной работы необходимо поддерживать обработку редиректов.
В JSON API, в составе сущностей можно встретить ссылки на связанные объекты. Ссылки выводятся в формате Метаданных. Для того, чтобы вместо ссылок получить связанные объекты, не обязательно делать отдельные запросы для каждого из них. Вместо этого, вместе с запросом на получение сущности, нужно передать параметр expand. В качестве значения данного параметра нужно перечислить через запятую все необходимые поля-ссылки, на месте которых вы бы хотели видеть связанные объекты. В результате запроса с таким параметром, в ответе вы получите объект с развернутыми вложенными объектами вместо ссылок. К примеру, в документах, имеющих в составе поле agent, вместо ссылки на контрагента будет выведен объект со всеми полями сущности “Контрагент”, описанными тут. Максимальный уровень вложенности expand : 3.
Также expand можно применять для результатов операций создания и обновления.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
"type": "salesreturn",
"mediaType": "application/json"
},
...
"demand": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"type": "demand",
"mediaType": "application/json"
}
}
}
/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089
Объект возврата покупателя в его обычном представлении, имеющий ссылку на отгрузку
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
"type": "salesreturn",
"mediaType": "application/json"
},
...
"demand": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"type": "demand",
"mediaType": "application/json"
},
"id": "f99544d7-4a98-11e6-8a84-bae50000007f",
"accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
...
"positions": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f/positions",
"type": "demandposition",
"mediaType": "application/json",
"size": 2,
"limit": 100,
"offset": 0
}
},
"vatEnabled": true,
"vatIncluded": true,
"payedSum": 0,
"returns": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
"type": "salesreturn",
"mediaType": "application/json"
}
}
]
}
}
/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand
Передаём параметр expand=demand. В ответ придёт возврат покупателя, у которого вместо ссылки на отгрузку, по которой производится возврат, будет вложенный объект со всеми полями данной отгрузки.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand,demand.agent",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
"type": "salesreturn",
"mediaType": "application/json"
},
...
"demand": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f?expand=agent",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"type": "demand",
"mediaType": "application/json"
},
...
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/147c1f1b-32ca-11e6-8a84-bae500000004",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
...
"name": "Агент1",
"code": "УТ0003074",
"externalCode": "kAgs4Xbhiz2Sp5oP2OCaB2",
"archived": false,
"legalTitle": "Общество с ограниченной ответственностью «Агент1»",
"legalAddress": "107023, г. Москва, Барабанный переулок, дом № 42, строение 2",
"inn": "7719864242",
"kpp": "771901001",
...
},
...
"positions": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/f99544d7-4a98-11e6-8a84-bae50000007f/positions",
"type": "demandposition",
"mediaType": "application/json",
"size": 2,
"limit": 100,
"offset": 0
}
},
"vatEnabled": true,
"vatIncluded": true,
"payedSum": 0,
"returns": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/salesreturn/metadata",
"type": "salesreturn",
"mediaType": "application/json"
}
}
]
}
...
}
/entity/salesreturn/166909e6-4a99-11e6-8a84-bae500000089?expand=demand,demand.agent
Теперь развернем поле agent у вложенной в возврат отгрузки (demand).
В ответ придёт возврат покупателя с развёрнутой отгрузкой (demand), внутри которой
будет развёрнутый объект контрагента (agent).
В данном запросе продемонстрирован уровень вложенности
параметра expand равный двум.
Пример создания отгрузки с параметром запроса expand.
Content-Type: application/json
{
"name": "0001",
"organization": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"type": "organization",
"mediaType": "application/json"
}
},
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078",
"type": "counterparty",
"mediaType": "application/json"
}
},
"store": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/store/850ee995-f504-11e5-8a84-bae500000160",
"type": "store",
"mediaType": "application/json"
}
}
}
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"type": "demand",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=1c3f30d2-88b9-11e7-9464-e4de00000000"
},
"id": "1c3f30d2-88b9-11e7-9464-e4de00000000",
"accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-08-24 13:43:47",
"name": "0001",
"externalCode": "UoaXR1oZhS9LOHzdUi42R1",
"moment": "2017-08-24 13:43:00",
"applicable": true,
"rate": {
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/d959dce8-6703-11e7-9464-e4de00000058",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#currency/edit?id=d959dce8-6703-11e7-9464-e4de00000058"
}
}
},
"sum": 0,
"store": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/store/d95915ff-6703-11e7-9464-e4de00000053",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/store/metadata",
"type": "store",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=d95915ff-6703-11e7-9464-e4de00000053"
}
},
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=d9593e70-6703-11e7-9464-e4de00000054"
},
"id": "d9593e70-6703-11e7-9464-e4de00000054",
"accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 8,
"updated": "2017-08-18 17:49:23",
"name": "ООО \"Поставщик\"",
"externalCode": "YWKWXePEi9jBAmxriBpc93",
"archived": false,
"created": "2017-07-12 16:13:08",
"companyType": "legal",
"legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
"legalAddress": "г.Москва, ул.Строителей, д.12",
"inn": "7736570901",
"kpp": "773601001",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [
"bbbvcc",
"ss"
],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/d9efdc3b-6703-11e7-9464-e4de00000066",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 4500
},
"organization": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#mycompany/edit?id=d955aa70-6703-11e7-9464-e4de00000051"
}
},
"documents": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/documents",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"created": "2017-08-24 13:43:48",
"positions": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/positions",
"type": "demandposition",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"vatEnabled": true,
"vatIncluded": true,
"vatSum": 0,
"payedSum": 0
}
/entity/demand?expand=agent
Развернем поле agent у создаваемой отгрузки. В ответ придёт созданная отгрузка с развёрнутым объектом контрагента (agent).
Пример редактирования отгрузки с параметром запроса expand.
Content-Type: application/json
{
"name": "3738"
}
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000?expand=agent,organization",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"type": "demand",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#demand/edit?id=1c3f30d2-88b9-11e7-9464-e4de00000000"
},
"id": "1c3f30d2-88b9-11e7-9464-e4de00000000",
"accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 1,
"updated": "2017-08-24 13:53:07",
"name": "3738",
"externalCode": "UoaXR1oZhS9LOHzdUi42R1",
"moment": "2017-08-24 13:43:00",
"applicable": true,
"rate": {
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/d959dce8-6703-11e7-9464-e4de00000058",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#currency/edit?id=d959dce8-6703-11e7-9464-e4de00000058"
}
}
},
"sum": 0,
"store": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/store/d95915ff-6703-11e7-9464-e4de00000053",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/store/metadata",
"type": "store",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#warehouse/edit?id=d95915ff-6703-11e7-9464-e4de00000053"
}
},
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=d9593e70-6703-11e7-9464-e4de00000054"
},
"id": "d9593e70-6703-11e7-9464-e4de00000054",
"accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 8,
"updated": "2017-08-18 17:49:23",
"name": "ООО \"Поставщик\"",
"externalCode": "YWKWXePEi9jBAmxriBpc93",
"archived": false,
"created": "2017-07-12 16:13:08",
"companyType": "legal",
"legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
"legalAddress": "г.Москва, ул.Строителей, д.12",
"inn": "7736570901",
"kpp": "773601001",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [
"bbbvcc",
"ss"
],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/d9593e70-6703-11e7-9464-e4de00000054/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/d9efdc3b-6703-11e7-9464-e4de00000066",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 4500
},
"organization": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#mycompany/edit?id=d955aa70-6703-11e7-9464-e4de00000051"
},
"id": "d955aa70-6703-11e7-9464-e4de00000051",
"accountId": "d8a2e973-6703-11e7-9464-e4de00000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/d9335bf2-6703-11e7-9464-e4de0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=d9335bf2-6703-11e7-9464-e4de0000002a"
}
},
"shared": true,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/d8a5d385-6703-11e7-9464-e4de00000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-07-12 16:13:09",
"name": "reqwy",
"externalCode": "PRLKDfmQgwj7TGtiYWrrZ3",
"archived": false,
"created": "2017-07-12 16:13:08",
"companyType": "legal",
"legalTitle": "reqwy",
"email": "erqw@ss.ru",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/organization/d955aa70-6703-11e7-9464-e4de00000051/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"isEgaisEnable": false,
"payerVat": true,
"director": "Администратор",
"chiefAccountant": "Администратор"
},
"documents": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/documents",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"created": "2017-08-24 13:43:48",
"positions": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000/positions",
"type": "demandposition",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"vatEnabled": true,
"vatIncluded": true,
"vatSum": 0,
"payedSum": 0
}
/entity/demand/1c3f30d2-88b9-11e7-9464-e4de00000000?expand=agent,organization
Теперь обновим эту отгрузку и развернем у неё поля agent и organization. В ответ придёт изменённая отгрузка с развёрнутым объектом контрагента (agent) и развёрнутым объектом юрлица (organization).
В JSON API есть возможность управлять набором существующих доп. полей для каждого из типов сущностей перечисленных тут. Используя соответствующие ресурсы, можно получать список всех доп. полей для указанного типа сущности, а также создавать новые, обновлять и удалять существующие доп. поля.
Структура объекта доп. поля подробно описана в секции Работа с дополнительными полями.
Успешный запрос. Результат - JSON представление списка доп. полей.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata",
"mediaType": "application/json"
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/9862d46e-6500-11e8-9464-e4de00000045",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "9862d46e-6500-11e8-9464-e4de00000045",
"name": "Строковое",
"type": "string",
"required": false
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98630aee-6500-11e8-9464-e4de00000046",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "98630aee-6500-11e8-9464-e4de00000046",
"name": "Целочисленное",
"type": "long",
"required": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98630f62-6500-11e8-9464-e4de00000047",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "98630f62-6500-11e8-9464-e4de00000047",
"name": "Поле-дата",
"type": "time",
"required": false
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986314b4-6500-11e8-9464-e4de00000048",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "986314b4-6500-11e8-9464-e4de00000048",
"name": "Справочник-товар",
"type": "productfolder",
"required": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986318cd-6500-11e8-9464-e4de00000049",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "986318cd-6500-11e8-9464-e4de00000049",
"name": "Файловое",
"type": "file",
"required": false
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98631cbf-6500-11e8-9464-e4de0000004a",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "98631cbf-6500-11e8-9464-e4de0000004a",
"name": "Дробное число",
"type": "double",
"required": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986320d6-6500-11e8-9464-e4de0000004b",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "986320d6-6500-11e8-9464-e4de0000004b",
"name": "Булиновое",
"type": "boolean",
"required": false
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98632583-6500-11e8-9464-e4de0000004c",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "98632583-6500-11e8-9464-e4de0000004c",
"name": "Текстовое",
"type": "text",
"required": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98632a03-6500-11e8-9464-e4de0000004d",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "98632a03-6500-11e8-9464-e4de0000004d",
"name": "Ссылочное",
"type": "link",
"required": false
}
]
}
/entity/{entityType}/metadata/attributes
Запрос всех доп. полей для переданного типа сущностей. Результат: Объект JSON, включающий в себя поля:
meta Метаданные о выдаче,
rows - Массив JSON объектов, представляющих собой доп. поля.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
Пример создания двух новых доп. полей для отгрузок.
Content-Type: application/json
[
{
"name": "Строковое",
"type": "string",
"required": false
},
{
"name": "Целочисленное",
"type": "long",
"required": true
}
]
Успешный запрос. Результат - JSON представление созданных доп. полей отгрузок.
Content-Type: application/json
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bc578d8-6501-11e8-9464-e4de00000004",
"name": "Строковое",
"type": "string",
"required": false
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bd3d688-6501-11e8-9464-e4de00000005",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bd3d688-6501-11e8-9464-e4de00000005",
"name": "Целочисленное",
"type": "long",
"required": true
}
]
Пример создания нового доп. поля Отгрузок и обновления существующего одним запросом.
Content-Type: application/json
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bc578d8-6501-11e8-9464-e4de00000004",
"name": "Строковое поле",
"required": true
},
{
"name": "Целочисленное2",
"type": "long",
"required": true
}
]
Успешный запрос. Результат - JSON представление созданного и обновлённого доп. полей отгрузок.
Content-Type: application/json
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bc578d8-6501-11e8-9464-e4de00000004",
"name": "Строковое поле",
"type": "string",
"required": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/c66edb30-6501-11e8-9464-e4de00000008",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "c66edb30-6501-11e8-9464-e4de00000008",
"name": "Целочисленное2",
"type": "long",
"required": true
}
]
Пример создания дополнительного поля типа пользовательский справочник.
Content-Type: application/json
{
"customEntityMeta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/companysettings/metadata/customEntities/0347beb0-a785-11e9-ac12-000800000003",
"type": "customentitymetadata",
"mediaType": "application/json"
},
"name": "Доп поле типа пользовательский справочник",
"type": "customentity",
"required": false
}
Успешный запрос. Результат - JSON представление созданного доп. поля.
Content-Type: application/json
{
"meta": {
"href": "hhttps://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/53eb36a5-a78a-11e9-ac12-000c00000000",
"type": "attributemetadata",
"mediaType": "application/json"
},
"customEntityMeta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/companysettings/metadata/customEntities/0347beb0-a785-11e9-ac12-000800000003",
"type": "customentitymetadata",
"mediaType": "application/json"
},
"id": "53eb36a5-a78a-11e9-ac12-000c00000000",
"name": "Доп поле типа пользовательский справочник",
"type": "customentity",
"required": false
}
/entity/{entityType}/metadata/attributes
Действие доступно только для пользователя с правами администратора.
Запрос на создание нового доп. поля для указанного типа сущностей.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
Пример запроса на удаление нескольких доп. полей отгрузок.
Content-Type: application/json
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/986318cd-6500-11e8-9464-e4de00000049",
"type": "attributemetadata",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/98631cbf-6500-11e8-9464-e4de0000004a",
"type": "attributemetadata",
"mediaType": "application/json"
}
}
]
/entity/{entityType}/metadata/attributes/delete
Действие доступно только для пользователя с правами администратора.
Запрос на удаление нескольких доп. полей отгрузок.
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
Успешный запрос. Результат - JSON представление отдельного доп. поля отгрузок
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bc578d8-6501-11e8-9464-e4de00000004",
"name": "Строковое поле",
"type": "string",
"required": true
}
/entity/{entityType}/metadata/attributes/{id}
Запрос на получение отдельного доп. поля отгрузок с указанным id.
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id доп. поля
Пример запроса на обновление отдельного доп. поля отгрузок.
Content-Type: application/json
{
"name": "обновлённое Строковое поле",
"required": false
}
Успешный запрос. Результат - JSON представление обновлённого доп. поля отгрузок.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/demand/metadata/attributes/7bc578d8-6501-11e8-9464-e4de00000004",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "7bc578d8-6501-11e8-9464-e4de00000004",
"name": "обновлённое Строковое поле",
"type": "string",
"required": false
}
/entity/{entityType}/metadata/attributes/{id}
Действие доступно только для пользователя с правами администратора.
Запрос на обновление отдельного доп. поля для переданного типа сущностей.
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id доп. поля
/entity/{entityType}/metadata/attributes/{id}
Действие доступно только для пользователя с правами администратора.
Запрос на удаление доп. поля отгрузок с указанным id.
string
(optional) Example: demandтип сущностей, для которых осуществляется управление доп. полями.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id доп. поля
Средствами JSON API можно создавать и обновлять сведения о Контрагентах, запрашивать списки Контрагентов и сведения по отдельным Контрагентам. Счетами Контрагента и его контактными лицами можно управлять как в составе отдельного Контрагента, так и отдельно - с помощью специальных ресурсов для управления счетами и контактными лицами Контрагента. Кодом сущности для Контрагента в составе JSON API является ключевое слово counterparty. Больше о Контрагентах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке.
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке.
Поиск среди объектов Контрагента осуществляется по нескольким условиям. Если значения полей контрагента удовлетворяют хотя бы одному из условий, то контрагент будет найден.
Первое условие поиска:
По наименованию Контрагента name
По коду Контрагента code
По полному наименованию Контрагента legalTitle
По номеру дисконтной карты Контрагента discountCardNumber
По адресу электронной почты email
По комментарию description
По номеру городского телефона phone
Второе условие поиска по всем событиям контрагента:
Третье условие поиска по полям из всех контактных лиц фирмы контрагента (contactpersons):
По имени контактного лица name
По почте контактного лица email
По номеру телефона контактного лица phone
meta - Метаданные объекта
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
shared - Общий доступ
group - Отдел сотрудника в формате Метаданных
syncId - ID синхронизации. После заполнения недоступен для изменения.
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
name - Наименование Контрагента Необходимое
description - Комментарий к Контрагенту
code - Код Контрагента
externalCode - Внешний код Контрагента Только для чтения
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса
actualAddress - Фактический адрес Контрагента
actualAddressFull - Фактический адрес Контрагента с детализацией по отдельным полям.
accounts - Ссылка на счета Контрагента (массив)
companyType - Тип Контрагента. [Юридическое лицо, Индивидуальный предприниматель, Физическое лицо]
.
В зависимости от значения данного поля набор выводимых реквизитов контрагента может меняться. Подробнее тут
discountCardNumber - номер дисконтной карты Контрагента
state - Статус Контрагента в формате Метаданных
salesAmount - Сумма продаж Только для чтения
legalTitle - Полное наименование для Контрагента типа [Юридическое лицо]
. Игнорируется для Контрагентов типа [Индивидуальный предприниматель, Физическое лицо]
, если передано одно из значений для ФИО и формируется автоматически на основе получаемых ФИО Контрагента.
legalLastName - Фамилия для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]
. Игнорируется для Контрагентов типа [Юридическое лицо]
.
legalFirstName - Имя для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]
. Игнорируется для Контрагентов типа [Юридическое лицо]
.
legalMiddleName - Отчество для Контрагента типа [Индивидуальный предприниматель, Физическое лицо]
. Игнорируется для Контрагентов типа [Юридическое лицо]
.
legalAddress - Юридический адрес Контрагента
legalAddressFull - Юридический адрес Контрагента с детализацией по отдельным полям.
inn - ИНН
kpp - КПП
ogrn - ОГРН
ogrnip - ОГРНИП
okpo - ОКПО
certificateNumber - Номер свидетельства
certificateDate - Дата свидетельства
tags - Группы (массив)
contactpersons - Ссылка на контактные лица фирмы Контрагента (массив)
attributes - Коллекция доп. полей в формате Метаданных
discounts - Массив ссылок на скидки в формате Метаданных Только для чтения
Массив может содержать персональные и накопительные скидки. Персональная скидка выводится, если хотя бы раз изменялся процент скидки для контрагента, значение будет указано в поле personalDiscount. Накопительная скидка выводится, если для контрагента хотя бы раз устанавливалась коррекция суммы накоплений по скидке, значение будет указано в поле demandSumCorrection. Формат вывода скидок можно посмотреть в разделе Скидки.
notes - Массив ссылок на события Контрагента в формате Метаданных
priceType - Тип цены Контрагента (строка или null)
postalCode - Почтовый индекс
country - Ссылка на страну в формате Метаданных
region - Ссылка на регион в формате Метаданных
city - Город
street - Улица
house - Дом (Максимальная длина - 30 символов)
apartment - Квартира (Максимальная длина - 30 символов)
addInfo - Другое
comment - Комментарий
Строка адреса является конкатенацией полей структурированного адреса в следующем порядке: postalCode -> country -> region -> city -> street -> house -> apartment -> addInfo, используя запятую в качестве разделителя. При передаче в МойСклад сущностей с адресом используйте либо строковый адрес, либо структурированнй. При передаче обоих адресов строковый будет игнорирован. При передаче только строкового он будет отражаться как в строковом поле, так и в addInfo структурированного адреса.
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
isDefault - Является ли счёт основным счётом Контрагента
accountNumber - Номер счёта Необходимо
bankName - Наименование банка
bankLocation - Адрес банка
correspondentAccount - Корр счет
bic - БИК
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении Контрагента Только для чтения
updated - Момент последнего обновления Контрагента Только для чтения
name - ФИО контактного лица Необходимое
description - Описание контактного лица
externalCode - Внешний код контактного лица
email - Адрес электронной почты контактного лица
phone - Номер телефона контактного лица
position - Должность контактного лица
agent - Ссылка на Контрагента (тип Мета)
meta - Метаданные объекта
id - ID в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
version - Версия сущности. Изменяется при обновлении/удалении события Контрагента Только для чтения
created - Момент создания события Контрагента Только для чтения
description - Текст события Контрагента Необходимое
agent - Ссылка на Контрагента (тип Мета) Только для чтения
author - Создатель события, ссылка на сотрудника (тип Мета) Только для чтения
В зависимости от типа контрагента companyType в составе его объекта будут выводиться разные наборы реквизитов. Типы контрагента и соответствующие значения, которые могут быть переданы в данном поле:
Тип контрагента | Значение поля companyType |
---|---|
Юридическое лицо | legal |
Индивидуальный предприниматель | entrepreneur |
Физическое лицо | individual |
Если тип контрагента Юридическое лицо
, будут выведены следующие поля реквизитов:
legalTitle - Полное наименование Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
kpp - КПП
ogrn - ОГРН
okpo - ОКПО
Если тип контрагента Индивидуальный предприниматель
, будут выведены следующие поля реквизитов:
legalTitle - Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
legalLastName - Фамилия Контрагента
legalFirstName - Имя Контрагента
legalMiddleName - Отчество Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
okpo - ОКПО
ogrnip - ОГРНИП
certificateNumber - Номер свидетельства
certificateDate - Дата свидетельства
Если тип контрагента Физическое лицо
, будут выведены следующие поля реквизитов:
legalTitle - Полное наименование. Игнорируется, если передано одно из значений для ФИО. Формируется автоматически на основе получаемых ФИО Контрагента
legalLastName - Фамилия Контрагента
legalFirstName - Имя Контрагента
legalMiddleName - Отчество Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
О работе с доп. полями Контрагентов можно прочитать здесь
id - ID в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
syncId - ID синхронизации
version - Версия сущности
updated - Момент последнего обновления Контрагента
updatedBy - Автор последнего обновления сущности в формате uid
(admin@admin
)
name - Наименование Контрагента
description - Комментарий к Контрагенту
code - Код Контрагента
externalCode - Внешний код Контрагента
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса
actualAddress - Фактический адрес Контрагента
companyType - Тип Контрагента
discountCardNumber - номер дисконтной карты Контрагента
state - Статус Контрагента
legalTitle - Полное наименование Контрагента
legalAddress - Юридический адрес Контрагента
inn - ИНН
kpp - КПП
priceType - Тип цены Контрагента (строка или null)
id - ID в формате UUID
version - Версия сущности
updated - Момент последнего обновления Контрагента
updatedBy - Автор последнего обновления сущности в формате uid
(admin@admin
)
name - Наименование Контрагента
description - Комментарий к Контрагенту
externalCode - Внешний код Контрагента
archived - Добавлен ли Контрагент в архив
created - Дата создания
email - Адрес электронной почты
phone - Номер городского телефона
fax - Номер факса
Успешный запрос. Результат - JSON представление списка Контрагентов.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"size": 4,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12a8b923-692c-11e6-8a84-bae500000053",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 2,
"updated": "2016-08-23 15:21:09",
"name": "ООО \"Поставщик\"",
"externalCode": "aZBfWOKzj-lcq7c7IWZON3",
"archived": false,
"created": "2007-02-07 17:16:41",
"companyType": "legal",
"legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "7736570901",
"kpp": "773601001",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8b923-692c-11e6-8a84-bae500000053/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 0,
"priceType": "Цена летняя"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12a8e347-692c-11e6-8a84-bae500000055",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"created": "2007-02-07 17:16:41",
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 1,
"updated": "2016-08-23 15:21:09",
"name": "ООО \"Покупатель\"",
"externalCode": "DTItQRbDhyl472ZqC5OWw2",
"archived": false,
"companyType": "legal",
"legalTitle": "Общество с ограниченной ответственностью \"Покупатель\"",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "7736570902",
"kpp": "773601002",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12a8e347-692c-11e6-8a84-bae500000055/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"salesAmount": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "12c9ebcf-692c-11e6-8a84-bae50000005d",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 1,
"updated": "2016-08-23 15:21:09",
"name": "Розничный покупатель",
"externalCode": "lBvYwLWMiBsct7sVRrFnJ2",
"archived": false,
"created": "2007-02-07 17:16:41",
"companyType": "legal",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/12c9ebcf-692c-11e6-8a84-bae50000005d/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"salesAmount": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "df2fdd2d-6934-11e6-8a84-bae500000049",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-08-23 16:24:08",
"name": "rtr",
"externalCode": "rRlzrdZmjql9r9dveXPE43",
"archived": false,
"created": "2007-02-07 17:16:41",
"companyType": "legal",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/df2fdd2d-6934-11e6-8a84-bae500000049/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 0
}
]
}
/entity/counterparty
Получить список всех Контрагентов. Результат: Объект JSON, включающий в себя поля:
meta Метаданные о выдаче,
context - Метаданные о сотруднике, выполнившем запрос.
rows - Массив JSON объектов, представляющих собой Контрагентов.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Пример типичного запроса для создания Контрагента.
Content-Type: application/json
{
"name": "ООО Радуга",
"description": "Сеть стройматериалов Радуга ЭКСПО",
"code": "rainbowCode",
"externalCode": "extRainbw",
"email": "raduga@stroi.ru",
"phone": "+7 495 331 22 33",
"fax": "1257752",
"actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
"legalTitle": "Общество с ограниченой ответственностью \"Радуга\"",
"legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
"inn": "125152124152",
"kpp": "12155521",
"ogrn": "1251512",
"okpo": "201355",
"tags": [
"Строители",
"Радуга",
"Ремонт"
],
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
},
"priceType": "Цена летняя"
}
Успешный запрос. Результат - JSON представление созданного Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "b80ea81b-7058-11e6-8a84-bae500000000",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-09-01 18:28:22",
"name": "ООО Радуга",
"externalCode": "o7732zkki541HDkZZD1Yt3",
"archived": false,
"companyType": "legal",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
},
"priceType": "Цена летняя"
}
Пример запроса на создание Контрагента с указанием только лишь его имени
Content-Type: application/json
{
"name": "ООО Радуга"
}
Успешный запрос. Результат - JSON представление созданного Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "b80ea81b-7058-11e6-8a84-bae500000000",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-09-01 18:28:22",
"name": "ООО Радуга",
"externalCode": "o7732zkki541HDkZZD1Yt3",
"archived": false,
"created": "2007-02-07 17:16:41",
"companyType": "legal",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
}
}
Пример запроса на создание Контрагента с указанием юридических реквизитов для типа Индивидуальный Предприниматель.
Content-Type: application/json
{
"name": "ИП Иванов",
"code": "someCode",
"externalCode": "extCode",
"companyType": "entrepreneur",
"legalLastName": "Иванов",
"legalFirstName": "Иван",
"legalMiddleName": "Иванович",
"actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
"legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
"inn": "87654321",
"kpp": "15312532",
"ogrn": "12345",
"okpo": "12345",
"ogrnip": "58632598y21jk"
}
Успешный запрос. Результат - JSON представление созданного Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=45fd2f10-b0ae-11ea-0a80-163500000000"
},
"id": "45fd2f10-b0ae-11ea-0a80-163500000000",
"accountId": "02865f48-b0ae-11ea-0a80-203a00000002",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/02e06bea-b0ae-11ea-0a80-1d9c00000034",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=02e06bea-b0ae-11ea-0a80-1d9c00000034"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/02877fda-b0ae-11ea-0a80-203a00000003",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2020-06-17 18:21:53",
"name": "ИП Иванов",
"code": "someCode",
"externalCode": "extCode",
"archived": false,
"created": "2020-06-17 18:21:53",
"companyType": "entrepreneur",
"legalTitle": "Индивидуальный предприниматель Иванов Иван Иванович",
"legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
"legalAddressFull": {
"addInfo": "г.Москва ул Авиастроителей д 93 к 12"
},
"actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
"actualAddressFull": {
"addInfo": "г.Москва ул Академика Миля дом 15 к 21"
},
"inn": "87654321",
"okpo": "12345",
"ogrnip": "58632598y21jk",
"legalLastName": "Иванов",
"legalFirstName": "Иван",
"legalMiddleName": "Иванович",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/45fd2f10-b0ae-11ea-0a80-163500000000/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/03935900-b0ae-11ea-0a80-1d9c0000008c",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 0
}
Пример запроса для создания Контрагента с доп полями в теле запроса.
Content-Type: application/json
{
"name": "ООО Овощ Экспресс",
"description": "Сеть доставки овощей",
"code": "ovoshexpressCode",
"externalCode": "extVagetable",
"email": "ovosh@delivery.ru",
"phone": "+7 495 662 12 23",
"fax": "1052034",
"legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "1251521244152",
"kpp": "121555212",
"ogrn": "1251552",
"okpo": "201323",
"tags": [
"Овощи",
"Еда",
"Доставка"
],
"attributes": [
{
"id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"name": "Коэффициент скидки",
"type": "double",
"value": 0.75
},
{
"id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"name": "Последний заключённый договор",
"type": "time",
"value": "2016-06-07 12:52:33"
},
{
"id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"name": "Партнёрское юрлицо",
"type": "boolean",
"value": false
}
],
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
}
}
Успешный запрос. Результат - JSON представление созданного Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "88fc07ac-2c8d-11e6-8a84-bae500000050",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-06-07 11:55:08",
"name": "ООО Овощ Экспресс",
"description": "Сеть доставки овощей",
"code": "ovoshexpressCode",
"externalCode": "extVagetable",
"archived": false,
"created": "2007-02-07 17:16:41",
"legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "1251521244152",
"kpp": "121555212",
"ogrn": "1251552",
"okpo": "201323",
"email": "ovosh@delivery.ru",
"phone": "+7 495 662 12 23",
"fax": "1052034",
"attributes": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"type": "double",
"name": "Коэффициент скидки",
"value": 0.75
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"name": "Последний заключённый договор",
"type": "time",
"value": "2016-06-07 12:52:33"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"name": "Партнёрское юрлицо",
"type": "boolean",
"value": false
}
],
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [
"доставка",
"еда",
"овощи"
],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
}
}
/entity/counterparty
Создать нового Контрагента
Контрагент создаётся на основе переданного объекта JSON, который содержит представление нового Контрагента.
Успешное удаление Контрагента.
/entity/counterparty/{id}
Запрос на удаление Контрагента с указанным id.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента
Успешный запрос. Результат - JSON представление доп. полей Контрагентов.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"mediaType": "application/json"
},
"attributes": [
{
"id": "5290a290-0313-11e6-9464-e4de00000020",
"name": "attribute_name",
"type": "boolean",
"required": false
}
],
"states": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
},
"id": "fb56c504-2e58-11e6-8a84-bae500000069",
"accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
"name": "Новый",
"color": 15106326,
"stateType": "Regular",
"entityType": "counterparty"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56cae3-2e58-11e6-8a84-bae50000006a",
"type": "state",
"mediaType": "application/json"
},
"id": "fb56cae3-2e58-11e6-8a84-bae50000006a",
"accountId": "f976ed28-2e58-11e6-8a84-bae500000001",
"name": "Подтвержден",
"color": 40931,
"stateType": "Regular",
"entityType": "counterparty"
}
],
"createShared": false
}
/entity/counterparty/metadata
Запрос на получение метаданных Контрагентов. Результат - объект JSON, включающий в себя:
meta - Ссылка на метаданные Контрагентов
attributes - Массив объектов доп. полей Контрагентов в формате Метаданных
states - Массив статусов Контрагентов
createShared - создавать новых Контрагентов с меткой “Общий”
Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями.
Успешный запрос. Результат - JSON представление отдельного доп. поля.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "5290a290-0313-11e6-9464-e4de00000020",
"name": "attribute_name",
"type": "boolean",
"required": false
}
/entity/counterparty/metadata/attributes/{id}
Запрос на получение информации по отдельному дополнительному полю.
string
(required) Example: 5290a290-0313-11e6-9464-e4de00000020id Доп. поля
Контрагент, обращение к которому происходит по значению его id.
Успешный запрос. Результат - JSON представление Контрагента с указанным id.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "b80ea81b-7058-11e6-8a84-bae500000000",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/12747f9e-692c-11e6-8a84-bae50000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/11883c67-692c-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-09-01 18:28:22",
"name": "ООО Радуга",
"externalCode": "o7732zkki541HDkZZD1Yt3",
"archived": false,
"created": "2007-02-07 17:16:41",
"companyType": "legal",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 0,
"priceType": "Цена летняя",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
}
}
Успешный запрос. Результат - JSON представление Контрагента типа Индивидуальный Предприниматель с указанным id.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#company/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
},
"id": "7944ef04-f831-11e5-7a69-971500188b19",
"accountId": "02865f48-b0ae-11ea-0a80-203a00000002",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/02e06bea-b0ae-11ea-0a80-1d9c00000034",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json",
"uuidHref": "https://online.moysklad.ru/app/#employee/edit?id=02e06bea-b0ae-11ea-0a80-1d9c00000034"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/02877fda-b0ae-11ea-0a80-203a00000003",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2020-06-17 18:21:53",
"name": "ИП Иванов",
"code": "someCode",
"externalCode": "extCode",
"archived": false,
"created": "2020-06-17 18:21:53",
"companyType": "entrepreneur",
"legalTitle": "Индивидуальный предприниматель Иванов Иван Иванович",
"legalAddress": "г.Москва ул Авиастроителей д 93 к 12",
"legalAddressFull": {
"addInfo": "г.Москва ул Авиастроителей д 93 к 12"
},
"actualAddress": "г.Москва ул Академика Миля дом 15 к 21",
"actualAddressFull": {
"addInfo": "г.Москва ул Академика Миля дом 15 к 21"
},
"inn": "87654321",
"okpo": "12345",
"ogrnip": "58632598y21jk",
"legalLastName": "Иванов",
"legalFirstName": "Иван",
"legalMiddleName": "Иванович",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"state": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/states/03935900-b0ae-11ea-0a80-1d9c0000008c",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "state",
"mediaType": "application/json"
}
},
"salesAmount": 0
}
/entity/counterparty/{id}
Возвращает JSON представление Контрагента с указанным id.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
Content-Type: application/json
В теле запроса можно указать только те поля, которые необходимо изменить у Контрагента
Успешное обновление. Результат - JSON представление обновлённого Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "6a9c3857-2c8b-11e6-8a84-bae500000047",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 3,
"updated": "2016-06-07 12:13:31",
"name": "ООО Радуга ЭКСПО",
"description": "Сеть рынков стройматериалов Радуга ЭКСПО",
"code": "raduga",
"externalCode": "extRainbow",
"archived": false,
"created": "2007-02-07 17:16:41",
"legalTitle": "Общество с ограниченой ответственностью \"Радуга ЭКСПО\"",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "1251581244152",
"kpp": "121557212",
"ogrn": "1253552",
"okpo": "201313",
"email": "raduga@retail.ru",
"phone": "+7 495 162 32 23",
"fax": "1052054",
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts",
"type": "account",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"tags": [
"жжот",
"строители",
"бетон",
"ремонт",
"радуга"
],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
}
}
Пример запроса для обновления Контрагента с доп полями в теле запроса.
Content-Type: application/json
{
"name": "ООО Овощ Экспресс",
"description": "Сеть экспресс-доставки овощей",
"code": "ovoshexpresscode",
"externalCode": "externalVagetable",
"email": "ovoshi@delivery.ru",
"phone": "+7 495 162 12 23",
"fax": "1052014",
"legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
"inn": "1251581244152",
"kpp": "121557212",
"ogrn": "1253552",
"okpo": "201313",
"tags": [
"Овощи",
"Еда",
"Доставка",
"Экспресс",
"Едовозы"
],
"contactpersons": [
{
"name": "Вася",
"description": "Овощерез Вася",
"position": "Овощерез"
},
{
"name": "Петя",
"position": "Овощевоз"
}
],
"accounts": [
{
"isDefault": true,
"accountNumber": "12512568161257981",
"bankName": "ОАО Сбербанк",
"bankLocation": "г Москва Ул Вавилова 19",
"correspondentAccount": "375632785587",
"bic": "1234532"
},
{
"accountNumber": "12512568161257982",
"bankName": "ВТБ",
"bic": "7654352"
}
],
"attributes": [
{
"id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"name": "Коэффициент скидки",
"type": "double",
"value": 0.35
},
{
"id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"name": "Последний заключённый договор",
"type": "time",
"value": "2016-06-07 10:52:33"
},
{
"id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"name": "Партнёрскоё юрлицо",
"type": "boolean",
"value": true
}
]
}
Успешное обновление. Результат - JSON представление обновлённого Контрагента.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
},
"id": "88fc07ac-2c8d-11e6-8a84-bae500000050",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 3,
"updated": "2016-06-07 12:08:25",
"name": "ООО Овощ Экспресс",
"description": "Сеть экспресс-доставки овощей",
"code": "ovoshexpresscode",
"externalCode": "externalVagetable",
"archived": false,
"created": "2007-02-07 17:16:41",
"legalTitle": "Общество с ограниченой ответственностью \"Овощ Экспресс\"",
"legalAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 123, addInfo",
"legalAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "123",
"addInfo": "addinfo",
"comment": "some words about address"
},
"actualAddress": "125009, Россия, г Москва, Москва, ул Тверская, 1, 111, addInfo",
"actualAddressFull": {
"postalCode": "125009",
"country": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/country/9df7c2c3-7782-4c5c-a8ed-1102af611608",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/country/metadata",
"type": "country",
"mediaType": "application/json"
}
},
"region": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/region/00000000-0000-0000-0000-000000000077",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/region/metadata",
"type": "region",
"mediaType": "application/json"
}
},
"city": "Москва",
"street": "ул Тверская",
"house": "1",
"apartment": "111",
"addInfo": "addinfo",
"comment": "some words about address"
},
"inn": "1251581244152",
"kpp": "121557212",
"ogrn": "1253552",
"okpo": "201313",
"email": "ovoshi@delivery.ru",
"phone": "+7 495 162 12 23",
"fax": "1052014",
"attributes": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d129ff5-2c8c-11e6-8a84-bae5000000f3",
"name": "Коэффициент скидки",
"type": "double",
"value": 0.35
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d12a9a5-2c8c-11e6-8a84-bae5000000f4",
"name": "Последний заключённый договор",
"type": "time",
"value": "2016-06-07 10:52:33"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata/attributes/0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0d12b1e7-2c8c-11e6-8a84-bae5000000f5",
"name": "Партнёрское юрлицо",
"type": "boolean",
"value": true
}
],
"accounts": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/88fc07ac-2c8d-11e6-8a84-bae500000050/accounts",
"type": "account",
"mediaType": "application/json",
"size": 2,
"limit": 100,
"offset": 0
}
},
"tags": [
"овощи",
"доставка",
"еда",
"едовозы",
"экспресс"
],
"contactpersons": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 2,
"limit": 100,
"offset": 0
}
},
"notes": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/notes",
"type": "note",
"mediaType": "application/json",
"size": 0,
"limit": 100,
"offset": 0
}
}
}
/entity/counterparty/{id}
Обновляется представление Контрагента с указанным id.
В теле запроса можно указать только те поля, которые необходимо изменить у Контрагента, кроме тех, что
помечены Только для чтения
в описании атрибутов Контрагента.
Поля, которые не были указаны в JSON запроса, не изменяются.
Поля account и contactpersons обновляются как элементы вложенных коллекций. При обновлении,
переданные элементы данных коллекций обрабатываются как “Все элементы данной коллекции” и полностью заменяют
элементы, ранее присутствовавшие в ней.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
Список счетов Контрагента с указанным id.
Успешный запрос.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts",
"type": "account",
"mediaType": "application/json",
"size": 2,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts/04c5d0dc-2c92-11e6-8a84-bae5000000f6",
"type": "account",
"mediaType": "application/json"
},
"id": "04c5d0dc-2c92-11e6-8a84-bae5000000f6",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"version": 0,
"updated": "2016-06-07 12:27:13",
"isDefault": false,
"accountNumber": "125917666032321985647",
"bankName": "ВТБ",
"bankLocation": "ул Сахаровского д 153",
"correspondentAccount": "12512578256712",
"bic": "1258617"
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6a9c3857-2c8b-11e6-8a84-bae500000047/accounts/6a9c43ce-2c8b-11e6-8a84-bae500000048",
"type": "account",
"mediaType": "application/json"
},
"id": "6a9c43ce-2c8b-11e6-8a84-bae500000048",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"version": 1,
"updated": "2016-06-07 11:39:58",
"isDefault": true,
"accountNumber": "236174374372272747234743274",
"bankName": "ОАО Сбербанк",
"bankLocation": "ул Ваивлова д 19",
"correspondentAccount": "251632427568",
"bic": "125125125"
}
]
}
/entity/counterparty/{id}/accounts
Возвращает массив JSON представлений счетов Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Успешный запрос.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/accounts/a6aa5466-2ca2-11e6-8a84-bae500000017",
"type": "account",
"mediaType": "application/json"
},
"id": "a6aa5466-2ca2-11e6-8a84-bae500000017",
"accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
"version": 0,
"updated": "2016-06-07 14:26:17",
"isDefault": false,
"accountNumber": "12512568161257982",
"bankName": "ВТБ",
"bic": "7654352"
}
/entity/counterparty/{id}/accounts/{accountId}
Возвращает JSON представление счета Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Счёта.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Получить список контактных лиц Контрагента с указанным id.
Успешный запрос.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons",
"type": "contactperson",
"mediaType": "application/json",
"size": 3,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/43e39375-7059-11e6-8a84-bae5000000cb",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "43e39375-7059-11e6-8a84-bae5000000cb",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"version": 0,
"updated": "2016-09-01 18:32:17",
"name": "Адвокатов Петр Сергеевич",
"description": "Адвокат",
"externalCode": "asI0ncJch5jkgxxlCQKiH1",
"email": "advopetr@mail.ru",
"phone": "87127418",
"position": "Адвокат",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/308142fc-7059-11e6-8a84-bae5000000c6",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "308142fc-7059-11e6-8a84-bae5000000c6",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"version": 1,
"updated": "2016-09-01 18:31:44",
"name": "Travolta Jehn",
"description": "Траволта на связи",
"externalCode": "9QZNh3dbiLu1-V9bmmLKu0",
"email": "travolta@mail.ru",
"phone": "125815120",
"position": "Секретарь",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000/contactpersons/13af74bf-7059-11e6-8a84-bae5000000c3",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "13af74bf-7059-11e6-8a84-bae5000000c3",
"accountId": "1185513e-692c-11e6-8a84-bae500000001",
"version": 1,
"updated": "2016-09-01 18:30:56",
"name": "Панин Алексей Олегович",
"description": "Бухгалтерия",
"externalCode": "Gaizui5siLqoUbZ3jpE2I2",
"email": "mail@mail.rq",
"phone": "12412512512",
"position": "Бухгалтер",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/b80ea81b-7058-11e6-8a84-bae500000000",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
}
]
}
/entity/counterparty/{id}/contactpersons
Возвращает массив JSON представлений контактных лиц Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Пример запроса на создание контактного лица Контрагента.
Content-Type: application/json
{
"name": "Пётр",
"code": "Petya the deliverer",
"externalCode": "-odJxBw7i06O0GhSc28S90",
"email": "petr@ovoshy.com",
"phone": "+777 666 228",
"position": "овощедоставщик"
}
Успешное создание.
Content-Type: application/json
[
{
"meta": {
"href": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19/contactpersons/ceba215c-d5cb-11e7-0532-9eed00000005",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "ceba215c-d5cb-11e7-0532-9eed00000005",
"accountId": "eb9ac8c0-d511-11e7-0532-9eed00000001",
"version": 0,
"updated": "2017-11-30 15:41:38",
"name": "Пётр",
"code": "Petya the deliverer",
"externalCode": "-odJxBw7i06O0GhSc28S90",
"email": "petr@ovoshy.com",
"phone": "+777 666 228",
"position": "овощедоставщик",
"agent": {
"meta": {
"href": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/7944ef04-f831-11e5-7a69-971500188b19",
"metadataHref": "http://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json",
"uuidHref": "http://online.moysklad.ru/app/#company/edit?id=7944ef04-f831-11e5-7a69-971500188b19"
}
}
}
]
/entity/counterparty/{id}/contactpersons
Создать контактное лицо Контрагента с указанным id.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
Успешный запрос.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons/94433ed3-2c9f-11e6-8a84-bae500000010",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "94433ed3-2c9f-11e6-8a84-bae500000010",
"accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
"version": 2,
"updated": "2016-06-07 14:04:17",
"name": "Пётр",
"code": "Petya the deliverer",
"externalCode": "-odJxBw7i06O0GhSc28S90",
"email": "petr@ovoshy.com",
"phone": "+777 666 228",
"position": "овощедоставщик",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
}
/entity/counterparty/{id}/contactpersons/{contactpersonId}
Возвращает JSON представление отдельного контактного лица Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id контактного лица.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Пример запроса на обновление контактного лица Контрагента.
Content-Type: application/json
{
"name": "Пётр",
"code": "Petya the deliverer",
"email": "petr@ovoshy.com",
"phone": "+777 666 228",
"position": "овощедоставщик"
}
Успешное обновление.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003/contactpersons/94433ed3-2c9f-11e6-8a84-bae500000010",
"type": "contactperson",
"mediaType": "application/json"
},
"id": "94433ed3-2c9f-11e6-8a84-bae500000010",
"accountId": "da7d9bbe-2c97-11e6-8a84-bae500000001",
"version": 2,
"updated": "2016-06-07 14:04:17",
"name": "Пётр",
"code": "Petya the deliverer",
"externalCode": "-odJxBw7i06O0GhSc28S90",
"email": "petr@ovoshy.com",
"phone": "+777 666 228",
"position": "овощедоставщик",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/ee15550e-2c9e-11e6-8a84-bae500000003",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
}
/entity/counterparty/{id}/contactpersons/{contactpersonId}
Обновить контактное лицо Контрагента с указанным id.
Обновляются все поля, указанные в JSON объекте запроса, кроме
помеченных Только для чтения
в описании атрибутов контактных лиц Контрагента.
Поля, которые не были указаны в JSON запроса, не изменяются.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id контактного лица.
Получить список событий Контрагента с указанным id.
Успешный запрос.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes",
"type": "note",
"mediaType": "application/json",
"size": 2,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/7e391b16-3efd-11e7-8af5-581e0000009d",
"type": "note",
"mediaType": "application/json"
},
"id": "7e391b16-3efd-11e7-8af5-581e0000009d",
"accountId": "b127966a-3efa-11e7-8af5-581e00000001",
"version": 0,
"created": "2017-05-22 17:46:52",
"description": "второе событие",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"author": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/b1876a85-3efa-11e7-8af5-581e0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/7b919056-3efd-11e7-8af5-581e0000009a",
"type": "note",
"mediaType": "application/json"
},
"id": "7b919056-3efd-11e7-8af5-581e0000009a",
"accountId": "b127966a-3efa-11e7-8af5-581e00000001",
"version": 0,
"created": "2017-05-22 17:46:47",
"description": "первое событие",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"author": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/b1876a85-3efa-11e7-8af5-581e0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
}
]
}
/entity/counterparty/{id}/notes
Возвращает массив JSON представлений событий Контрагента.
string
(required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056id Контрагента.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Запрос на добавление нового события.
Content-Type: application/json
{
"description": "текст"
}
Успешный запрос. Результат - JSON представление добавленного события.
Content-Type: application/json
[
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
"type": "note",
"mediaType": "application/json"
},
"id": "50b318cb-3cb0-11e7-8af5-581e00000007",
"accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
"version": 0,
"created": "2017-05-19 19:29:22",
"description": "текст",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"author": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
}
]
/entity/counterparty/{id}/notes
string
(required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056id Контрагента.
Успешный запрос.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
"type": "note",
"mediaType": "application/json"
},
"id": "50b318cb-3cb0-11e7-8af5-581e00000007",
"accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
"version": 0,
"created": "2017-05-19 19:29:22",
"description": "текст",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"author": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
}
/entity/counterparty/{id}/notes/{noteId}
Возвращает JSON представление отдельного события Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id события.
Пример запроса на обновление события Контрагента.
Content-Type: application/json
{
"description": "измененный текст"
}
Успешное обновление.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056/notes/50b318cb-3cb0-11e7-8af5-581e00000007",
"type": "note",
"mediaType": "application/json"
},
"id": "50b318cb-3cb0-11e7-8af5-581e00000007",
"accountId": "674f0d4f-3c9c-11e7-8af5-581e00000001",
"version": 1,
"created": "2017-05-19 19:29:22",
"description": "измененный текст",
"agent": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/67e5a691-3c9c-11e7-8af5-581e00000056",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"author": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/67b86071-3c9c-11e7-8af5-581e0000002a",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
}
/entity/counterparty/{id}/notes/{noteId}
Обновить событие Контрагента с указанным id.
Обновляются все поля, указанные в JSON объекте запроса, кроме
помеченных Только для чтения
в описании атрибутов событий Контрагента.
Поля, которые не были указаны в JSON запроса, не изменяются.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Контрагента.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id события.
Успешное удаление События.
/entity/counterparty/{id}/notes/{noteId}
Запрос на удаление события с указанным id.
string
(required) Example: 67e5a691-3c9c-11e7-8af5-581e00000056id Контрагента.
string
(required) Example: 50b318cb-3cb0-11e7-8af5-581e00000007id события
Сущность assortment представляет собой список всех товаров, услуг, комплектов, серий и модификаций с полями stock
,
reserve
, inTransit
, quantity
, показывающими остаток, резерв, ожидание и доступно каждой из сущностей (для комплектов не выводятся поля остатков и резерва).
Данные поля могут быть рассчитаны в зависимости от даты и склада с использованием параметров запроса stockmoment
и stockstore
.
С помощью параметра filter=search=<значение>
можно произвести префиксный поиск по строковым полям, выводимым в ассортименте:
по наименованию элемента Ассортимента name
по имени модификации name
по коду code
по коду модификации code
по артикулу article
по штрихкоду barcode
по штрихкоду модификации barcode
по штрихкоду упаковок товаров barcode
Для этого необходимо использовать фильтр выборки по нескольким полям,
указав в качестве одного из полей поле search
и условие для этого поля - равенство поисковой строке.
filter=search=some_random_string
.Также можно осуществлять контекстный поиск с помощью специального параметра search
(используется без filter
). Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.
Поиск search=some_random_string
среди объектов ассортимента на соответствие поисковой строке будет осуществлен по следующим полям:
по наименованию элемента ассортимента name
по описанию description
Для фильтрации по полю productFolder необходимо использовать filter=productFolder=<href>
, где указать href группы товаров.
?filter=productFolder=https://online.moysklad.ru/api/remap/1.1/entity/productfolder/a3ff313d-a2f7-11e9-ac12-000d00000007
.id - ID в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
version - Версия сущности
updated - Момент последнего обновления сущности
updatedBy - Автор последнего обновления сущности в формате uid
(admin@admin
)
name - Наименование
description - Описание сущности
externalCode - Внешний код сущности
archived - Отметка о том, добавлена ли сущность в архив
code - Код сущности
productFolder - Группа товаров
article - Артикул товара или комплекта
supplier - Ссылка на контрагента-поставщика
name - Наименование
code - Код сущности
Успешный запрос. Результат - JSON представление списка всех товаров, услуг, модификация и серий.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/assortment",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/assortment/metadata",
"type": "assortment",
"mediaType": "application/json",
"size": 7,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "35427052-36e7-11e7-8a7f-40d0000000d1",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": true,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-05-12 10:47:11",
"name": "product",
"code": "00001",
"externalCode": "LsAGeHdbgyQ3oSlTzZUvH0",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"image": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/download/28ca8201-36e7-11e7-8a7f-40d0000000cd",
"mediaType": "application/octet-stream"
},
"title": "product_image",
"filename": "product_image.png",
"size": 64211,
"updated": "2017-05-12 10:46:50",
"miniature": {
"href": "https://online.moysklad.ru/api/remap/1.1/download/28ca8201-36e7-11e7-8a7f-40d0000000cd?miniature=true",
"mediaType": "image/png"
},
"tiny": {
"href": "https://online.moysklad.ru/app/download/28ca6fbb-36e7-11e7-8a7f-40d0000000cc.png",
"mediaType": "image/png"
}
},
"minPrice": 1000,
"salePrices": [
{
"value": 1500,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/1076cf8b-36e7-11e7-8a7f-40d000000093",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"buyPrice": {
"value": 500,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"article": "100000000",
"weight": 0,
"volume": 0,
"barcodes": [
"2000000000015"
],
"modificationsCount": 0,
"isSerialTrackable": false,
"trackingType": "NOT_TRACKED",
"stock": 0,
"reserve": 0,
"inTransit": 0,
"quantity": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/consignment/c66f4b17-36e7-11e7-8a7f-40d000000113",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/consignment/metadata",
"type": "consignment",
"mediaType": "application/json"
},
"id": "c66f4b17-36e7-11e7-8a7f-40d000000113",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"version": 0,
"updated": "2017-05-12 10:51:15",
"name": "product / consignment",
"code": "1012",
"externalCode": "g9BOLNRZglk9NMOHxcrVV0",
"label": "consignment",
"assortment": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
}
},
"stock": 0,
"reserve": 0,
"inTransit": 0,
"quantity": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/service/437f2d67-36e7-11e7-8a7f-40d0000000df",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/service/metadata",
"type": "service",
"mediaType": "application/json"
},
"id": "437f2d67-36e7-11e7-8a7f-40d0000000df",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": true,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-05-12 10:47:35",
"name": "service",
"code": "00002",
"externalCode": "DDBfxV4djLuOlbr80-I1A0",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 500,
"salePrices": [
{
"value": 1500,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"buyPrice": {
"value": 700,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/metadata",
"type": "bundle",
"mediaType": "application/json"
},
"id": "4f75d130-36e7-11e7-8a7f-40d0000000ef",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": true,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-05-12 10:47:55",
"name": "bundle",
"code": "00003",
"externalCode": "ndWrlXCZjm9uSyLk57KOD0",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 0,
"salePrices": [
{
"value": 0,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"article": "50000000",
"weight": 0,
"volume": 0,
"barcodes": [
"2000000000046"
],
"trackingType": "NOT_TRACKED",
"components": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef/components",
"type": "bundlecomponent",
"mediaType": "application/json",
"size": 1,
"limit": 100,
"offset": 0
}
}
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "6830a346-36e7-11e7-8a7f-40d0000000f8",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": true,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2017-05-12 10:48:37",
"name": "product2",
"code": "00004",
"externalCode": "bxviUUtwg4C6y4RdOc2GS3",
"archived": false,
"pathName": "",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 1000,
"salePrices": [
{
"value": 1800,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"buyPrice": {
"value": 700,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"article": "2000000000000",
"weight": 0,
"volume": 0,
"barcodes": [
"2000000000053"
],
"modificationsCount": 2,
"isSerialTrackable": false,
"trackingType": "SHOES",
"stock": 0,
"reserve": 0,
"inTransit": 0,
"quantity": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/68379863-36e7-11e7-8a7f-40d0000000fd",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"id": "68379863-36e7-11e7-8a7f-40d0000000fd",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"version": 0,
"updated": "2017-05-12 10:48:37",
"name": "product2 (blue)",
"code": "00002",
"externalCode": "BrmW28jLhRMI-jOPUdfWW0",
"archived": false,
"characteristics": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "682beecc-36e7-11e7-8a7f-40d0000000f5",
"name": "color",
"value": "blue"
}
],
"salePrices": [
{
"value": 1800,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"barcodes": [
"2000000000060"
],
"product": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"trackingType": "SHOES"
},
"stock": 0,
"reserve": 0,
"inTransit": 0,
"quantity": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/6839f0fa-36e7-11e7-8a7f-40d000000101",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata",
"type": "variant",
"mediaType": "application/json"
},
"id": "6839f0fa-36e7-11e7-8a7f-40d000000101",
"accountId": "103bff1b-36e7-11e7-8a7f-40d000000004",
"version": 0,
"updated": "2017-05-12 10:48:37",
"name": "product2 (red)",
"code": "00003",
"externalCode": "i0u4rktiiVX6BWL60IVkJ1",
"archived": false,
"characteristics": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "682beecc-36e7-11e7-8a7f-40d0000000f5",
"name": "color",
"value": "red"
}
],
"salePrices": [
{
"value": 1800,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
}
],
"barcodes": [
"2000000000077"
],
"product": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"trackingType": "SHOES"
},
"stock": 0,
"reserve": 0,
"inTransit": 0,
"quantity": 0
}
]
}
/entity/assortment
Запрос на получение всех товаров, услуг, комплектов, модификаций и серий в виде списка.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
string
(optional) Ссылка на склад, по которому нужно получить остатки. Формат - URI.
string
(optional) Момент времени, на который нужно вывести остатки. Формат строки:
YYYY-MM-DD HH:MM:SS
.string
(optional) Параметр фильтрации по типу объектов. Принимает одно из значений:
product - будут выведены только товары
variant - будут выведены товары и модификации
consignment - будут выведены все сущности (аналогично отсутствию параметра)
string
(optional) Вид Остатка. Параметр совместим только с параметрами: limit, offset, stockstore, stockmoment, quantitymode. Если указаны параметры отличные от совместимых в ответ вернется ошибка с кодом 1069.
Допустимые значения [all, positiveOnly, negativeOnly, empty, nonEmpty]
По умолчанию параметр stockmode
имеет значение all
. Если вы хотите увидеть объекты
с нулевым или отрицательным остатком, нужно указать соответствующее значение данного параметра
string
(optional) Фильтр по полю Доступно. Параметр совместим только с параметрами: limit, offset, stockstore, stockmoment, stockmode. Если указаны параметры отличные от совместимых в ответ вернется ошибка с кодом 1069.
Допустимые значения [all, positiveOnly, negativeOnly, empty, nonEmpty]
По умолчанию параметр quantitymode
имеет значение all
. Если вы хотите увидеть объекты
с нулевым или отрицательным значением поля Доступно, нужно указать соответствующее значение данного параметра.
Средствами JSON API можно запрашивать списки валют и сведения по отдельным валютам, а также создавать новые и обновлять сведения по уже существующим валютам. Кодом сущности для валют в составе JSON API является ключевое слово currency. Больше о валютах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по
этой ссылке.
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке. Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.
Поиск среди объектов валют на соответствие поисковой строке будет осуществлён по следующим полям:
meta - Метаданные объекта
name - Краткое наименование Валюты Необходимое
fullName - Полное наименование Валюты
code - Цифровой код Валюты Необходимое
isoCode - Буквенный код Валюты Необходимое
rate - Курс Валюты
multiplicity - Кратность курса Валюты
indirect - Признак обратного курса Валюты
rateUpdateType - Способ обновления курса Валюты Только для чтения
majorUnit - Формы единиц целой части Валюты
minorUnit - Формы единиц дробной части Валюты
archived - Добавлена ли Валюта в архив
system - Основана ли валюта на валюте из системного справочника Только для чтения
default - Является ли валюта валютой учета Только для чтения
name - Краткое наименование Валюты
fullName - Полное наименование Валюты
code - Цифровой код Валюты
isoCode - Буквенный код Валюты
multiplicity - Кратность курса Валюты
archived - Добавлена ли Валюта в архив
default - Является ли валюта валютой учета
id - ID в формате UUID
name - Краткое наименование Валюты
fullName - Полное наименование Валюты
code - Цифровой код Валюты
isoCode - Буквенный код Валюты
multiplicity - Кратность курса Валюты
archived - Добавлена ли Валюта в архив
default - Является ли валюта валютой учета
Поля majorUnit и minorUnit содержат в себе следующие атрибуты:
gender - Грамматический род единицы валюты (допустимые значения masculine
- мужской, feminine
- женский)
s1 - Форма единицы, используемая при числительном 1
s2 - Форма единицы, используемая при числительном 2
s5 - Форма единицы, используемая при числительном 5
В JSON API валюты в основном представлены в составе сущностей в формате Метаданные. Для того, чтобы раскрыть их в составе другого объекта нужно воспользоваться параметром expand
Успешный запрос. Результат - JSON представление списка Валют.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json",
"size": 2,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"system": false,
"name": "руб",
"fullName": "Рубль",
"rate": 1,
"multiplicity": 1,
"indirect": false,
"rateUpdateType": "manual",
"code": "643",
"isoCode": "RUB",
"majorUnit": {
"gender": "masculine",
"s1": "рубль",
"s2": "рубля",
"s5": "рублей"
},
"minorUnit": {
"gender": "feminine",
"s1": "копейка",
"s2": "копейки",
"s5": "копеек"
},
"archived": false,
"default": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"system": true,
"name": "доллар",
"fullName": "Доллар США",
"rate": 63,
"multiplicity": 1,
"indirect": false,
"rateUpdateType": "manual",
"code": "840",
"isoCode": "USD",
"majorUnit": {
"gender": "masculine",
"s1": "доллар",
"s2": "доллара",
"s5": "долларов"
},
"minorUnit": {
"gender": "masculine",
"s1": "цент",
"s2": "цента",
"s5": "центов"
},
"archived": false,
"default": false
}
]
}
/entity/currency/
Запрос на получение списка всех валют на данной учётной записи. Результат успешного запроса - JSON представление списка валют с перечисленными полями:
meta Метаданные о выдаче,
context - Метаданные о сотруднике, выполнившем запрос.
rows - Массив JSON объектов, представляющих собой валюты.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Пример запроса на создание новой валюты.
Content-Type: application/json
{
"name": "доллар",
"rate": 63,
"code": "840",
"isoCode": "USD"
}
Успешный запрос. Результат - JSON представление созданной Валюты.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"system": false,
"name": "доллар",
"rate": 63,
"multiplicity": 1,
"indirect": false,
"rateUpdateType": "manual",
"code": "840",
"isoCode": "USD",
"majorUnit": {
"gender": "masculine"
},
"minorUnit": {
"gender": "masculine"
},
"archived": false,
"default": false
}
/entity/currency/
Запрос на создание новой валюты. Обязательные поля для создание валюты - name, code и isoCode. В теле запроса нельзя указать курс валюты (rate) равным нулю.
Успешное удаление Валюты.
/entity/currency/{id}
Запрос на удаление Валюты с указанным id. Валюту учета удалить нельзя.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id Валюты
Работа с Валютой с указанным id.
Успешный запрос. Результат - JSON представление запрошенной Валюты.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"system": false,
"name": "руб",
"fullName": "Рубль",
"rate": 1,
"multiplicity": 1,
"indirect": false,
"rateUpdateType": "manual",
"code": "643",
"isoCode": "RUB",
"majorUnit": {
"gender": "masculine",
"s1": "рубль",
"s2": "рубля",
"s5": "рублей"
},
"minorUnit": {
"gender": "feminine",
"s1": "копейка",
"s2": "копейки",
"s5": "копеек"
},
"archived": false,
"default": true
}
/entity/currency/{id}
Запрос на получение Валюты с указанным id.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id валюты
Пример запроса на обновление валюты.
Content-Type: application/json
{
"name": "долл",
"rate": 66,
"code": "dollarusd",
"isoCode": "USD"
}
Успешный запрос. Результат - JSON представление обновлённой Валюты.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"system": false,
"name": "долл",
"rate": 66,
"multiplicity": 1,
"indirect": false,
"rateUpdateType": "manual",
"code": "dollarusd",
"isoCode": "USD",
"majorUnit": {
"gender": "masculine"
},
"minorUnit": {
"gender": "masculine"
},
"archived": false,
"default": false
}
/entity/currency/{id}
Запрос на обновление существующей валюты. В теле запроса нельзя указать курс валюты (rate) равным нулю, а также пустые поля name, code, isoCode. Нельзя изменять значения полей name, fullName, code, isoCode, majorUnit, minorUnit для валют, основанных на системном справочнике валют. Нельзя изменять курс валюты учета. Нельзя изменить курс валюты с автоматическим обновлением.
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19id валюты
Средствами JSON API можно создавать и обновлять сведения о Товарах, запрашивать списки Товаров и сведения по отдельным Товарам. Кодом сущности для Товара в составе JSON API является ключевое слово product. Больше о Товарах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки в разделе
Товары и склад.
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке.
Поиск среди объектов товаров на соответствие поисковой строке будет осуществлён по следующим полям:
по наименованию товара (name)
по коду товара (code)
по артикулу (article)
meta - Метаданные объекта
id - ID Товара в формате UUID Только для чтения
accountId - ID учетной записи Только для чтения
owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
shared - Общий доступ
group - Отдел сотрудника в формате Метаданных
syncId - ID синхронизации. После заполнения недоступен для изменения.
version - Версия сущности Только для чтения
updated - Момент последнего обновления сущности Только для чтения
name - Наименование Товара Необходимое
description - Описание Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар Только для чтения
vat - НДС %
effectiveVat - Реальный НДС % Только для чтения
productFolder - Ссылка на группу Товаров в формате Метаданных
uom - Ссылка на единицы измерения в формате Метаданных
image - Изображение Товара
minPrice - Минимальная цена
buyPrice - Закупочная цена
salePrices - Цены продажи
supplier - Ссылка на контрагента-поставщика в формате Метаданных
attributes - Коллекция доп. полей в формате Метаданных
country - Ссылка на страну в формате Метаданных
article - Артикул
weighed - Весовой товар
tobacco - Табачная продукция. Не может быть указан вместе с alcoholic, weighed и isSerialTrackable
weight - Вес
volume - Объём
packs - Упаковки Товара
barcodes - Массив штрихкодов товара
alcoholic - Объект, содержащий поля алкогольной продукции.
modificationsCount - Количество модификаций у данного товара Только для чтения
minimumBalance - Неснижаемый остаток
isSerialTrackable - Учет по серийным номерам. Не может быть указан вместе с alcoholic и weighed
things - Серийные номера Только для чтения
trackingType - Тип маркируемой продукции
tnved - Код ТН ВЭД
paymentItemType - Признак предмета расчета
discountProhibited - Признак запрета скидок.
taxSystem - Код системы налогообложения.
Система налогообложения | Значение поля 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 |
Атрибут pathName сам по себе является атрибутом только для чтения, однако его можно изменить с помощью обновления атрибута productFolder.
id - ID Товара в формате UUID
owner - Ссылка на Владельца (Сотрудника)
shared - Общий доступ
group - Отдел сотрудника
syncId - ID синхронизации
version - Версия сущности
updated - Момент последнего обновления сущности
updatedBy - Автор последнего обновления сущности в формате uid
(admin@admin
)
name - Наименование Товара
description - Описание Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар
vat - НДС %
supplier - Ссылка на контрагента-поставщика
article - Артикул
weighed - Весовой товар
weight - Вес
volume - Объём
minimumBalance - Неснижаемый остаток
isSerialTrackable - Учет по серийным номерам
id - ID Товара в формате UUID
version - Версия сущности
updated - Момент последнего обновления сущности
name - Наименование Товара
code - Код Товара
externalCode - Внешний код Товара
archived - Отметка о том, добавлен ли Товар в архив
pathName - Наименование группы, в которую входит Товар
weighed - Весовой товар
weight - Вес
volume - Объём
isSerialTrackable - Учет по серийным номерам
id - ID в формате UUID Только для чтения
uom - Ссылка на единицы измерения в формате Метаданных Необходимое
quantity - Количество Товаров в упаковке данного вида Необходимое
barcodes - Массив штрихкодов упаковок товаров. Данный массив может содержать не более одного штрихкода. Если штрихкод в массиве отсутствует, то данное поле не выводится. В версии API 1.1 был удалён отдельный ресурс для работы с упаковками товаров. Теперь упаковки - вложенная коллекция. Для того, чтобы создать новую упаковку для данного товара, нужно в запросе на обновление товара указать её как элемент поля packs, а в её составе указать ссылку в формате meta на единицу измерения и количество товаров в упаковке. Для упаковки товара нельзя указать ссылку на единицу измерения, совпадающую с единицей измерения товара, иначе возникнет ошибка. При обновлении штрихкодов упаковки в рамках обновления товара, переданная коллекция штрихкодов упаковки полностью заменяет имеющуюся до этого коллекцию. Для обновления списка упаковок товара, необходимо в рамках обновления товара передать новую коллекцию упаковок. Новая коллекия упаковок товара полностью заменит старую коллекцию.
Метаданные Товаров содержат информацию о дополнительных полях и типах цен Товаров.
Типы цен - поле priceType, вложенное в объекты коллекции salePrices. Его значение - наименование соответствующего типа цен.
Посмотреть все созданные в основном интерфейсе доп. поля Товаров, а также все типы цен можно с помощью запроса на получение метаданных Товаров. Ответ - объект, со следующей структурой:
meta - Метаданные
attributes - коллекция всех существующих доп. полей Товаров в формате Метаданных
priceTypes - коллекция всех существующих типов цен.
createShared - создавать новые товары с меткой “Общий”
Структуры объектов отдельных коллекций:
О работе с доп. полями Товаров можно прочитать здесь
value - Значение цены
currency - Ссылка на валюту в формате Метаданных
priceType - Тип цены
value - Значение цены
currency - Ссылка на валюту в формате Метаданных
Структура поля image, которое вы получите при запросе товара с изображением:
meta - Метаданные об изображении
title - Название изображения
filename - Имя файла
size - Размер файла в байтах
updated - Дата последнего изменения
miniature - Ссылка на миниатюру изображения в формате Метаданных
tiny - Ссылка на уменьшенное изображение в формате Метаданных
Для загрузки изображения нужно в теле запроса на создание или обновление товара указать поле image со следующими атрибутами:
filename - имя файла с расширением. Например - “банан.png”
content - Изображение, закодированное в формате Base64.
Если в запросе на обновление не будет полей filename и content, то весь объект image, если он присутствует в Body, будет проигнорирован, т.к. сервер посчитает, что его обновление не требуется.
Если одновременно осуществляется фильтрация по полям id и archived, то фильтрация по полю archived не учитывается.
Успешный запрос. Результат - JSON представление списка Товаров.
Content-Type: application/json
{
"context": {
"employee": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/context/employee",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
}
},
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json",
"size": 5,
"limit": 25,
"offset": 0
},
"rows": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/26b36824-2c83-11e6-8a84-bae50000001b",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "26b36824-2c83-11e6-8a84-bae50000001b",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-06-07 10:40:48",
"name": "Тыква",
"description": "Тыква, Германия",
"code": "pumpkin1",
"externalCode": "456pumpkin",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 53,
"salePrices": [
{
"value": 3353,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 3253,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6313d1e7-2c7f-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"attributes": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0c2e54cd-2c80-11e6-8a84-bae50000009c",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0c2e54cd-2c80-11e6-8a84-bae50000009c",
"name": "Экспорт",
"type": "boolean",
"value": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0c2e5dc5-2c80-11e6-8a84-bae50000009d",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0c2e5dc5-2c80-11e6-8a84-bae50000009d",
"name": "Изготовитель",
"type": "string",
"value": "фермерское хозяйство \"Петрович\""
}
],
"buyPrice": {
"value": 54,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"article": "Ar23",
"weight": 200,
"volume": 300,
"modificationsCount": 0
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/d950551c-2c7f-11e6-8a84-bae50000000b",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "d950551c-2c7f-11e6-8a84-bae50000000b",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 2,
"updated": "2016-06-07 10:45:16",
"name": "Бананы",
"description": "Бананы, Африка",
"code": "one1",
"externalCode": "456",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 532000,
"salePrices": [
{
"value": 346347237000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 100,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6313d1e7-2c7f-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"attributes": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0c2e54cd-2c80-11e6-8a84-bae50000009c",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0c2e54cd-2c80-11e6-8a84-bae50000009c",
"name": "Экспорт",
"type": "boolean",
"value": false
}
],
"buyPrice": {
"value": 23553000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"article": "Ar23",
"weight": 200,
"volume": 300,
"packs": [
{
"id": "c6bdee6f-2c83-11e6-8a84-bae5000000a4",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/c6b91d63-2c83-11e6-8a84-bae5000000a1",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"quantity": 35
},
{
"id": "c6bdf693-2c83-11e6-8a84-bae5000000a5",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/c6bc9273-2c83-11e6-8a84-bae5000000a3",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"quantity": 2000
}
],
"modificationsCount": 0,
"isSerialTrackable": true,
"things": [
"F564X056",
"F564X057"
],
"trackingType": "NOT_TRACKED"
}
]
}
/entity/product
Запрос на получение всех Товаров для данной учётной записи. Результат: Объект JSON, включающий в себя поля:
meta Метаданные о выдаче,
context - Метаданные о сотруднике, выполнившем запрос.
rows - Массив JSON объектов, представляющих собой Товары.
number
(optional) Default: 25 Example: 100Максимальное количество сущностей для извлечения.
Допустимые значения 1 - 100
number
(optional) Default: 0 Example: 40Отступ в выдаваемом списке сущностей
Пример наиболее полного по количеству полей запроса.
Content-Type: application/json
{
"name": "Бананы",
"code": "one1",
"externalCode": "456",
"description": "Бананы, Африка",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/2b5095a4-296b-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"minPrice": 532000,
"buyPrice": {
"value": 23553000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"salePrices": [
{
"value": 346347237000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 100,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"article": "Ar23",
"weight": 200,
"volume": 300,
"packs": [
{
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/2ec1170c-3f69-4409-87bb-c68e0011b275",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"quantity": 2
}
],
"isSerialTrackable": false,
"trackingType": "NOT_TRACKED"
}
Успешный запрос. Результат - JSON представление созданного Товара.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/a355f431-29a1-11e6-8a84-bae500000009",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "a355f431-29a1-11e6-8a84-bae500000009",
"accountId": "2aa3f5df-296b-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-06-03 18:41:28",
"name": "Бананы",
"description": "Бананы, Африка",
"code": "one1",
"externalCode": "456",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"discountProhibited": false,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 532000,
"salePrices": [
{
"value": 346347237000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 100,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/2b5095a4-296b-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"buyPrice": {
"value": 23553000,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/2b50da23-296b-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"article": "Ar23",
"weight": 200,
"volume": 300,
"packs": [
{
"id": "a97af44b-8b46-11e8-56c0-00080000000d",
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/2ec1170c-3f69-4409-87bb-c68e0011b275",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"quantity": 2
}
],
"isSerialTrackable": false,
"trackingType": "NOT_TRACKED"
}
Пример запроса на создание Товара с единственным необходимым полем.
Content-Type: application/json
{
"name": "Мандарины"
}
Успешный запрос. Результат - JSON представление созданного Товара.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/04996e84-29a1-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "04996e84-29a1-11e6-8a84-bae500000002",
"accountId": "2aa3f5df-296b-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-06-03 18:37:02",
"name": "Мандарины",
"code": "00003",
"externalCode": "Cf0ehavIglre6sMX-J2rR2",
"archived": false,
"pathName": "",
"weight": 0,
"volume": 0,
"isSerialTrackable": false,
"trackingType": "NOT_TRACKED"
}
Пример запроса на создание Товара с доп. полями.
Content-Type: application/json
{
"name": "Тыква",
"code": "pumpkin1",
"externalCode": "456pumpkin",
"description": "Тыква, Германия",
"vat": 18,
"effectiveVat": 18,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6313d1e7-2c7f-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"minPrice": 53,
"buyPrice": {
"value": 54,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"salePrices": [
{
"value": 3353,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 3253,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"article": "Ar23",
"weight": 200,
"volume": 300,
"attributes": [
{
"id": "0c2e54cd-2c80-11e6-8a84-bae50000009c",
"name": "Экспорт",
"value": true
},
{
"id": "0c2e5dc5-2c80-11e6-8a84-bae50000009d",
"name": "Изготовитель",
"value": "фермерское хозяйство \"Петрович\" "
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0f1e750e-e1b2-11e7-9464-e4de00000003",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0f1e750e-e1b2-11e7-9464-e4de00000003",
"name": "not strange attribute name",
"type": "file",
"file": {
"name": "filename",
"content": "5cYwMpOmNk5kSVr4YgZGKtXJb/7KpHVLDUawyZrD5Nf0WDhB7mS1I77VcAMqYQ8DkP/1wDLhb0X6b2JO4pdpKA=="
}
}
]
}
Успешный запрос. Результат - JSON представление созданного Товара.
Content-Type: application/json
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/26b36824-2c83-11e6-8a84-bae50000001b",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
},
"id": "26b36824-2c83-11e6-8a84-bae50000001b",
"accountId": "6270cd18-2c7f-11e6-8a84-bae500000001",
"owner": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/employee/metadata",
"type": "employee",
"mediaType": "application/json"
}
},
"shared": false,
"group": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/group/metadata",
"type": "group",
"mediaType": "application/json"
}
},
"version": 0,
"updated": "2016-06-07 10:40:48",
"name": "Тыква",
"description": "Тыква, Германия",
"code": "pumpkin1",
"externalCode": "456pumpkin",
"archived": false,
"pathName": "",
"vat": 18,
"effectiveVat": 18,
"discountProhibited": false,
"uom": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/uom/metadata",
"type": "uom",
"mediaType": "application/json"
}
},
"minPrice": 53,
"salePrices": [
{
"value": 3353,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена продажи"
},
{
"value": 3253,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
"priceType": "Цена для друзей"
}
],
"supplier": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/6313d1e7-2c7f-11e6-8a84-bae500000051",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"attributes": [
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0c2e54cd-2c80-11e6-8a84-bae50000009c",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0c2e54cd-2c80-11e6-8a84-bae50000009c",
"name": "Экспорт",
"type": "boolean",
"value": true
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0c2e5dc5-2c80-11e6-8a84-bae50000009d",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0c2e5dc5-2c80-11e6-8a84-bae50000009d",
"name": "Изготовитель",
"type": "string",
"value": "фермерское хозяйство \"Петрович\""
},
{
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/product/metadata/attributes/0f1e750e-e1b2-11e7-9464-e4de00000003",
"type": "attributemetadata",
"mediaType": "application/json"
},
"id": "0f1e750e-e1b2-11e7-9464-e4de00000003",
"name": "not strange attribute name",
"type": "file",
"value": "filename",
"download": {
"href": "https://online.moysklad.ru/api/remap/1.1/download/00664f3a-e3da-11e7-9464-e4de00000000",
"mediaType": "application/octet-stream"
}
}
],
"buyPrice": {
"value": 54,
"currency": {
"meta": {
"href": "https://online.moysklad.ru/api/remap/1.1/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055",
"metadataHref": "https://online.moysklad.ru/api/remap/1.1/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
},
"