NAV Navbar
cURL

Документы

Общие сведения

Шаблоны документов

Шаблон - предзаполненный стандартными полями JSON-объект, который затем можно использовать для успешного создания документа. Средствами JSON API можно получать предзаполненные шаблоны документов. Они могут быть предзаполнены как на основе других документов, так и стандартными значениями без связей с другими документами. Для этого, во всех документах, по которым можно получить шаблон, существует специальный ресурс Шаблон документа, адрес которого формируется следующим образом:
https://online.moysklad.ru/api/remap/1.2/entity/<ключевое слово для документа>/new
В тело PUT запроса по данному ресурсу нужно передать метаданные документа, на основе которого будет создан шаблон нового документа, либо просто передать пустое тело запроса. Метаданные должны быть "обернуты" в объект, имя которого есть ключевое слово для документа-основания в JSON API. Для каждого из данных ресурсов есть примеры запросов и ответов.
На данный момент можно получить шаблоны следующих документы на основании других:

Документ Основание, на котором он может быть создан
Возврат покупателя (salesreturn) Отгрузка (demand),
Розничная продажа (retaildemand)
Возврат поставщику (purchasereturn) Приемка (supply)
Отгрузка (demand) Заказ покупателя (customerorder)
Счет поставщика (invoicein) Заказ поставщику (purchaseorder)
Cчет покупателю (invoiceout) Заказ покупателя (customerorder)
Списание (loss) Возврат покупателя (salesreturn),
инвентаризация(inventory)
Оприходование (enter) Инвентаризация(inventory)
Заказ поставщику (purchaseorder) Внутренний заказ (internalorder)
Перемещение (move) Внутренний заказ (internalorder)
Приходный ордер (cashin) Заказ покупателя (salesreturn),
Возврат поставщику (purchasereturn),
Отгрузка (demand),
Счет покупателю (invoiceout),
Полученный отчет комиссионера (commissionreportin)
Расходный ордер (cashout) Возврат покупателя (salesreturn),
Приемка (supply),
Счет поставщика (invoicein),
Заказ поставщику (purchaseorder),
Выданный отчет комиссионера (commissionreportout)
Входящий платеж (paymentin) Заказ покупателя (salesreturn),
Возврат поставщику (purchasereturn),
Отгрузка (demand),
Счет покупателю (invoiceout),
Полученный отчет комиссионера (commissionreportin)
Исходящий платеж (paymentout) Возврат покупателя (salesreturn),
Приемка (supply),
Счет поставщика (invoicein),
Заказ поставщику (purchaseorder),
Выданный отчет комиссионера (commissionreportout)
Тех. операция (processing) Заказ на производство (processingorder), Тех. карта (processingplan)
Заказ на производство (processingorder) Тех. карта (processingplan)
Розничная продажа (retaildemand) Розничная смена, Заказ покупателя

В результате PUT запроса по /entity/entityName/new НЕ будет создано нового документа.
Возвращаемый предзаполненный объект является лишь "болванкой" с некоторыми заполненными полями (поля заполняются по той же логике, что и в аналогичной ситуации в основном интерфейсе), облегчающей создание документа. Он не сохраняется в системе. Этот объект затем можно передать в теле запроса на создание соответствующего документа и тогда уже документ будет создан, и связан с документом-основанием.
Если послать на данный ресурс пустое тело запроса, то в итоговом шаблоне будут предзаполнены лишь стандартные поля в т.ч. указанные в настройках пользователя в учетной записи сервиса МойСклад.

С подробностями и примерами по каждому из документов можно ознакомиться в соответствующих разделах документации. Например, для шаблона отгрузки - смотреть в Шаблонах отгрузки

Контекстный поиск для документов

В JSON API можно осуществлять контекстный поиск среди списка сущностей определенного типа по их строковым полям. Для этого используется URI параметр фильтрации search.

Поиск среди документов на соответствие поисковой строке будет осуществлен по следующим полям: + по наименованию (name) + по описанию (description) + по входящему номеру (incomingNumber)

Удаление в корзину

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

Пример удаления Приемки в корзину

Параметры

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

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

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

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

Связи документов

Привязка документов к документам

Для того чтобы привязать к уже существующему документу другой документ нужно передать meta привязываемого документа в коллекцию связанных документов этого типа. Такие коллекции присутствуют среди аттрибутов документов. В описании сущностей они описаны в секции Связи с другими документами и каждое поле называется как ключевое слово для типов привязываемых документов во множественном числе. Например поле invoicesOut у отгрузок отвечает за связи с счетами покупателю. Если вы хотите привязать к отгрузке счет, в это поле, в составе коллекции, нужно положить meta счета покупателя который вы хотите привязать. Можно привязывать более 1 документа.

Пример привязки 1

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

Параметры

Параметр Описание
docname string (required) Example: move ключевое слово для документа со связями.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id документа.

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

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

Response 200 (application/json) Результат - перемещение с заполненным полем internalOrder.

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

Пример привязки 2

Второй пример запроса на привязку одного документа к другому.

Параметры

Параметр Описание
docname string (required) Example: move ключевое слово для документа со связями.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id документа.

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

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

Response 200 (application/json) Результат - отгрузка с новым элементом в коллекции invoicesOut.

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

Привязка платежей к документам

К некоторым документам в JSON API могут быть привязаны платежи. Платежи бывают 4-х типов: Входящий платеж, Приходный ордер, Исходящий платеж, Расходный ордер. Документы, к которым могут быть привязаны платежи содержат вложенную коллекцию payments среди атрибутов докуента. Платежи в свою очередь содержат коллекцию operations - операции, к которым привязан данный платеж. Для того, чтобы привязать платеж к документу, нужно в запросах на создание/обновление платежа в составе коллекции operations указать meta документа. Документы в этой коллекции могут иметь разный тип, однако это не значит, что к любому документу можно привязать все 4 типа платежей. Валидные типы платежей определяются самим документом, к которому происходит привязка. К примеру к полученному отчету комиссионера можно привязать только входящий платеж или приходный ордер.
В результате привзяки платежа, в составе коллекции operations платежа появится новый объект, указывающий на документ, а в составе коллекции payments у документа, к которому привязывается платеж, появится новый элемент ссылающийся на данный платеж.

Пример привязки платежа 1

Привязка входящего платежа к полученному отчету комиссионера.

Параметры

Параметр Описание
docname2 string (required) Example: commissionreportin ключевое слово для документа, к которому можно привязать платеж.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id документа.

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

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

Response 200 (application/json) Результат - входящий платеж с новым элементом в коллекции operations.

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

Пример привязки платежа 2

Привязка приходного ордера к заказу покупателя.

Параметры

Параметр Описание
docname2 string (required) Example: commissionreportin ключевое слово для документа, к которому можно привязать платеж.
id string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id документа.

Пример запроса на привязку приходного ордера к заказу покупателя.

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

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

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

Розничная смена

Розничные смены

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

Операции

С помощью данного ресурса вы не можете создавать или обновлять Розничные смены. Создание новой розничной смены происходит при выполнении запроса на Открытие смены через отдельный API подключения торговой точки к онлайн-сервису МойСклад POS API 1.0. Для совершения операции Открытие розничной смены необходимо аутентифицироваться с правами Кассира.

Атрибуты смены

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

Получить Розничные смены

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

Параметры

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

Получить Розничные смены

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

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

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

Удалить Розничную смену

Параметры

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

Запрос на удаление Розничной смены с указанным id.

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

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

Метаданные Розничных смен

Метаданные Розничных смен

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

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

Метаданные Розничных смен

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

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

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

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

Параметры

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

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

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

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

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

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

Розничная смена

Параметры

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

Получить Розничную смену

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

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

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

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

Оприходование

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

Оприходования

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

Позиции Оприходования

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

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

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

Получать Оприходования

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

Параметры

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

Получать Оприходования

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

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

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

Создать Оприходования

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

Пример создания нового Оприходования с телом запроса, содержащим только необходимые поля.

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

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

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

Массовое создание и обновление Оприходований

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

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

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

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

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

Удалить Оприходование

Параметры

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

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

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

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

Массовое удаление Оприходований

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

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

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

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

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

Метаданные Оприходований

Метаданные Оприходований

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

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

Метаданные Оприходований

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

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

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

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

Параметры

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

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

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

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

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

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

Оприходование

Получить Оприходование

Параметры

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

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

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

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

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

Изменить Оприходование

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

Параметры

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

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

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

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

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

Позиции Оприходований

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

Получить позиции Оприходования

Запрос на получение списка всех позиций данного Оприходования.

Параметры

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

Получить позиции Оприходования

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

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

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

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

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

Параметры

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

Пример создания позиций в Оприходовании.

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

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

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

Позиция Оприходования

Получить позицию

Параметры

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

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

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

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

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

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

Запрос на обновление отдельной позиции Оприходования. Для обновления позиции нет каких-либо обязательных для указания в теле запроса полей. Только те, что вы желаете обновить.

Параметры

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

Пример запроса на обновление отдельной позиции в Оприходовании.

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

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

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

Удалить позицию

Параметры

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

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

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

Response 200 (application/json) Успешное удаление позиции Оприходования.

Заказ покупателя

Заказы покупателей

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

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

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

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/серий. Объект позиции Заказа содержит следующие поля:

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

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

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

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

Параметры

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

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

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

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

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

Создать Заказ покупателя

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

Пример создания нового Заказа с телом запроса, содержащим только необходимые поля.

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

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

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

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

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

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

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

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

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

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

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

Пример запроса на создание Заказа покупателя с позициями в теле запроса.

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

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

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

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

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

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

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

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

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

Удалить Заказ покупателя

Параметры

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

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

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

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

Метаданные Заказов покупателей

Метаданные Заказов покупателей

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

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

Массовое удаление Заказов покупателей

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

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

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

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

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

Метаданные Заказов покупателей

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

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

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

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

Параметры

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

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

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

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

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

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

Заказ покупателя

Получить Заказ покупателя

Параметры

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

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

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

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

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

Изменить Заказ покупателя

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

Параметры

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

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

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

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

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

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

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

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

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

Пример запроса на обновление Заказа покупателя с позициями в теле запроса.

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

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

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

Позиции Заказа покупателя

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

Получить позиции Заказа покупателя

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

Параметры

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

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

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

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

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

Создать позицию Заказа покупателя

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

Также можно указать поле с именем product, service, consignment, variant, bundle в соответствии с тем, чем является указанная позиция. Подробнее об этом поле можно прочитать в описании позиции Заказа

Параметры

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

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

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

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

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

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

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

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

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

Позиция Заказа

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

Получить позицию Заказа

Параметры

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

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

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

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

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

Изменить позицию Заказа

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

Параметры

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

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

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

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

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

Удалить позицию

Параметры

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

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

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

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

Заказ поставщику

Заказы Поставщикам

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

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

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

Позиции Заказа поставщику

Позиции Заказа - это список товаров/услуг/модификаций/серий. Объект позиции Заказа содержит следующие поля:

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

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

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

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

Параметры

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

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

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

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

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

Создать Заказ поставщику

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

Пример создания нового Заказа.

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

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

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

Пример запроса на создание Заказа поставщику с позициями в теле запроса.

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

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

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

Массовое создание и обновление Заказов поставщику

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

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

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

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

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

Удалить Заказ поставщику

Параметры

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

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

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

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

Массовое удаление Заказов Поставщикам

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

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

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

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

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

Метаданные Заказов Поставщикам

Метаданные Заказов Поставщикам

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

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

Метаданные Заказов Поставщикам

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

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

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

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

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

Параметры

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

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

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

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

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

Шаблон Заказа поставщику

Шаблон Заказа поставщику

Запрос на получение предзаполненого стандартными значениями шаблона заказа поставщику без связи с каким-либо документом.

Шаблон заказа поставщику

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

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

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

Шаблон Заказа поставщику на основе

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

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

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

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

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

Пример запроса на получение шаблона заказа поставщику на основе заказа покупателя.

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

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

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