Формирование квитанции к заказу
Метод используется для формирования квитанции в формате pdf к заказу/заказам.
Во избежание перегрузки платформы нельзя передавать более 100 номеров заказов в одном запросе.
Запрос на формирование квитанции к заказу
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/print/orders |
боевая | https://api.cdek.ru/v2/print/orders |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | orders | Список заказов | order[ ] | да |
1.1 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | да, если не передан cdek_number |
1.2 | cdek_number | Номер заказа СДЭК | long | да, если не передан order_uuid |
2 | copy_count | Число копий одной квитанции на листе. Рекомендовано указывать не менее 2, одна приклеивается на груз, вторая остается у отправителя По умолчанию 2 | integer | нет |
3 | type | Форма квитанции. Может принимать значения: По умолчанию будет выбрана форма на русском языке | string(255) | нет |
Ответ на формирование квитанции к заказу
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о квитанции к заказу | entity | нет |
1.1 | uuid | Идентификатор квитанции к заказу в ИС СДЭК | UUID | нет |
2 | requests | Информация о запросе над квитанцией к заказу | request[] | да |
2.1 | request_uuid | Идентификатор запроса в ИС СДЭК | UUID | нет |
2.2 | type | Тип запроса Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET | string() | да |
2.3 | date_time | Дата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
2.4 | state | Текущее состояние запроса ACCEPTED - пройдена предварительная валидация и запрос принят | string() | да |
2.5 | errors | Ошибки, возникшие в ходе выполнения запроса | error[] | нет |
2.5.1 | code | Код ошибки | string() | да |
2.5.2 | message | Описание ошибки | string() | да |
Полученный uuid необходимо использовать в методе "Получение квитанции к заказу" для получения ссылки на скачивание pdf-файла |
{ "orders": [ { "order_uuid": "72753034-bd61-45fc-be66-da4a03ed2ed8" } ], "copy_count": 2 } |
{ "entity": { "uuid": "72753034-4b28-40af-a89e-fc2e18935307" }, "requests": [ { "request_uuid": "72753034-c44c-49f3-8b07-4fb5af75bcfa", "type": "CREATE", "state": "ACCEPTED", "date_time": "2020-03-19T12:10:43+0700", "errors": [], "warnings": [] } ] } |
© 2000—2024, Курьерская компания СДЭК