API | Заказы на эмиссию кодов маркировки

Создание заказа#

URL : /bp/processes/order/

Method : POST

Content type : application/json

Тело запроса :

Параметр	Обязательный	Тип	Комментарий
`data`	Да	`OrderData`	Основная информация о заказе
`extra`	Нет	`DocumentExtra`	Дополнительная информация

Структура OrderData :

Параметр	Обязательный	Тип	Комментарий
`contact_person`	Да	string	Контактное лицо
`release_method_type`	Да	String	Метод выпуска товаров Возможные варианты: «IMPORT» - Импорт в РФ «PRODUCTION» - Производство в РФ «REMAINS» - Маркировка остатков
`create_method_type`	Да	String	Способ изготовления СИ Возможные варианты: «SELF_MADE» - Самостоятельно «CEM» - ЦЭМ
`production_order_id`	Нет	String	Идентификатор производственного заказа
`remains_import`	Нет	Bool	Товар был импортирован до даты запрета оборота немаркированных товаров
`remains_available`	Нет	Bool	Товар был произведен до даты запрета оборота немаркированных товаров
`contract_date`	Нет	Date	Дата договора с оператором (не используется)
`contract_number`	Нет	String	Номер договора с оператором (не используется)

Структура DocumentExtra :

Параметр	Обязательный	Тип	Комментарий
`name`	Нет	String	Произвольное имя документа

Пример запроса (JSON) :

{
  "data": {
    "remains_available": false,
    "remains_import": false,
    "production_order_id": null,
    "contract_number": null,
    "contract_date": null,
    "print_status": "Available",
    "contact_person": " Иванов Иван Иванович",
    "release_method_type": "IMPORT",
    "create_method_type": "SELF_MADE"
  },
  "extra": {
    "name": "Test"
  }
}

Параметры ответа :

Параметр	Тип	Комментарий
`document_id`	String	Уникальный ID Документа
`status`	String	Статус документа
`created`	String	Дата создания
`data`	Объект `OrderData`	Основная информация о заказе
`extra`	Объект `DocumentExtra`	Дополнительная информация
`external_id`	String	ID заказа в СУЗ

Пример ответа (JSON) :

{
    "document_id": "6306149a-c846-4d73-85ca-8063c2022673",
    "doctype": "order__request",
    "status": "draft",
    "created": "2020-04-24T14:11:44.822409",
    "company": "11",
    "parent": null,
    "data": {
        "remains_available": false,
        "remains_import": false,
        "print_status": "Available",
        "contact_person": "Иванов Иван Иванович",
        "release_method_type": "IMPORT",
        "create_method_type": "SELF_MADE",
        "production_order_id": null,
        "contract_number": null,
        "contract_date": null
    },
    "extra": {
        "name": "Test"
    },
    "direction": "Out",
    "external_id": null,
    "external_status": null,
    "last_es_update": null,
    "product_group": "shoes"
}

Получение одного заказа по ID#

URL : /bp/processes/order/{id}/

Method : GET

Ответ на запрос аналогичен ответу на запрос создания заказа

Редактирование заказа#

URL : /bp/processes/order/{id}/

Method : PATCH

Content type : application/json

Тело запроса и ответ аналогичны созданию заказа

Удаления заказа#

URL : /bp/processes/order/{id}/

Method : DELETE

Создание позиций заказа#

URL : /bp/processes/order/{id}/children/create/

Method : POST

Content type : application/json

Тело запроса :

Параметр	Обязательный	Тип	Комментарий
`data`	Да	Объект `OrderChildData`	Основная информация о заказе

Структура OrderChildData :

Параметр	Обязательный	Тип	Комментарий
`gtin`	Да	string	GTIN товара
`quantity`	Да	Number	Кол-во довом маркировки
`serial_number_type`	Да	String	Тип генерации серийного номера Возможные варианты: «OPERATOR» - Оператором ИС МП «SELF_MADE» - Самостоятельно
`serial_numbers`	Да, если serial_number_type = «SELF_MADE»	Array	Массив серийных номеров
`template_id`	Да	Number	Номер шаблона кода маркировки Возможные варианты: «1» - Лёгкая промышленность, обувь

Пример запроса (JSON) :

{
  "data": {
    "serial_numbers": null,
    "gtin": "000000000000",
    "quantity": 10,
    "serial_number_type": "OPERATOR",
    "template_id": 1
  }
}

Параметры ответа :

Параметр	Тип	Комментарий
`document_id`	String	Уникальный ID Позиции заказа
`created`	String	Дата создания
`data`	Объект `OrderChildData`	Основная информация о позиции заказе

Получение одного позиции заказа по ID#

URL : /bp/document/document/{id}/

Method : GET

Ответ на запрос аналогичен ответу на запрос создания позиции заказа

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

URL : /bp/document/document/{id}/

Method : PATCH

Content type : application/json

Тело запроса и ответ аналогичны созданию позиции заказа

Удаления заказа#

URL : /bp/document/document/{id}/

Method : DELETE

Отправка заказа#

Отправка заказа на обработку в СУЗ

URL : /bp/processes/order/{id}/execute/

Method : POST

Отслеживание статуса заказа#

Для получения статуса заказа, можно использовать запрос GET /bp/processes/order/{id}/

Возможные статусы заказа :

Статус	Значение
`draft`	Черновик
`request_created`	Заказ в обработке
`completed`	Завершен (коды маркировки получены)
`failed`	Отклонен