ЭПД

XML-черновик поручения экспедитору (ПЭ)

Сервис позволяет получить XML-черновик поручения экспедитору (ПЭ)

Адреса метода

Метод относится к основному B2B API и использует стандартную авторизацию по заголовкам X-User и X-Token.

Тестовая среда:GET https://b2b-test.otr-it.ru/api/b2b/order/{orderId}/logistics-forwarding-order-draft

Производственная среда:GET https://b2b.otr-it.ru/api/b2b/order/{orderId}/logistics-forwarding-order-draft

Процесс работы (Workflow)

Для отправки электронного документа через вашу систему ЭДО необходимо выполнить следующие шаги:

Создание заявки: Клиент создаёт заявку на грузоперевозку через метод POST /api/b2b/order. Заказчик (Customer) в заявке обязательно должен быть юридическим лицом.
Получение идентификатора: В успешном ответе клиент получает идентификатор созданной заявки (Id).
Запрос черновика: Клиент вызывает метод получения черновика документа GET /api/b2b/order/{orderId}/logistics-forwarding-order-draft, передав полученный идентификатор.
Получение XML: API возвращает HTTP 200 и формирует XML-черновик титула Т1 поручения экспедитору. Имя файла будет передано в заголовке ответа Content-Disposition.
Загрузка в ЭДО: Клиент загружает полученный XML-файл в используемую систему электронного документооборота (ЭДО).
Подписание документа: Документ подписывается усиленной квалифицированной электронной подписью (УКЭП) со стороны клиента.
Отправка документа: Клиент продолжает отправку подписанного документа по маршруту через свою систему ЭДО.

Особенности формирования документа

Повторные вызовы (Идемпотентность): Метод можно вызывать повторно. При каждом вызове черновик документа формируется заново на основе текущих данных заявки.
Ограничение по типу лица: Для использования метода получения черновика Customer заявки должен быть юридическим лицом.

Возможные ошибки (404 Not Found)

Метод возвращает статус 404 Not Found, если заявка не найдена либо по её текущим данным невозможно сформировать XML-черновик поручения экспедитору (например, отсутствуют необходимые данные заказчика или данные о грузовых местах).

Причина ошибки передаётся в поле message. Важно: API возвращает в поле message строку (string), внутри которой находится сериализованный JSON с диагностической информацией backend.

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

Page updated

Google Sites

Report abuse