Получение ШК места к заказу
Метод используется для получения ШК места в формате pdf к заказу/заказам.
Ссылка на файл с ШК местом к заказу/заказам доступна в течение 1 часа. |
Для загрузки файла печатной формы заказа необходимо отправить GET-запрос к URL из ответа метода. Способ аутентификации: Bearer token
Запрос на получение ШК места к заказу
Для использования необходимо отправить GET-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/print/barcodes/{uuid} |
боевая | https://api.cdek.ru/v2/print/barcodes/{uuid} |
{uuid} - идентификатор ШК места, ссылку на который необходимо получить
Ответ на получение ШК места к заказу
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о ШК месте к заказу | entity | нет |
1.1 | uuid | Идентификатор файла ШК места к заказу | UUID | да |
1.2 | orders | Список заказов | order[ ] | да |
1.2.1 | order_uuid | Идентификатор заказа в ИС СДЭК | UUID | нет |
1.2.2 | cdek_number | Номер заказа СДЭК | long | нет |
1.3 | copy_count | Число копий на листе | integer | нет |
1.4 | format | Формат печати | string(2) | нет |
1.5 | lang | Язык печатной формы в кодировке ISO - 639-3. По умолчанию - RUS | string(3) | нет |
1.6 | url1 | Ссылка на скачивание файла. Содержится в ответе только в статусе "Сформирован" Формат: https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf | string() | нет |
1.7 | statuses | Статус файла | status[ ] | да |
1.7.1 | code | Код статуса (подробнее см. приложение 1) | string() | да |
1.7.2 | name | Название статуса | string() | да |
1.7.3 | date_time | Дата и время установки статуса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
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() | да |
2.6 | warnings | Предупреждения, возникшие в ходе выполнения запроса | warning[] | нет |
2.6.1 | code | Код предупреждения | string() | да |
2.6.2 | message | Описание предупреждения | string() | да |
1 Для получения файла с ШК местом к заказу/заказам необходимо выполнить GET-запрос на полученный URL с указанием в заголовке токена для авторизации
https://api.cdek.ru/v2/print/barcodes/72753034-c617-46ef-b70a-8f5f520b6be4 |
{ "entity": { "uuid": "72753034-c617-46ef-b70a-8f5f520b6be4", "orders": [ { "order_uuid": "72753034-bd61-45fc-be66-da4a03ed2ed8" } ], "copy_count": 1, "type": "barcode", "format": "A4", "url": "http://api.cdek.ru/v2/print/barcodes/72753034-c617-46ef-b70a-8f5f520b6be4.pdf", "statuses": [ { "code": "ACCEPTED", "name": "Принят", "date_time": "2020-03-19T11:25:53+0700" }, { "code": "PROCESSING", "name": "Формируется", "date_time": "2020-03-19T11:25:53+0700" }, { "code": "READY", "name": "Сформирован", "date_time": "2020-03-19T11:25:54+0700" } ] }, "requests": [ { "request_uuid": "72753034-e836-499d-bee7-e02053498521", "type": "CREATE", "date_time": "2020-03-19T11:25:54+0700", "state": "SUCCESSFUL" } ] } |
Приложение 1. Статусы ШК места
Код | Название статуса | Комментарий |
---|---|---|
ACCEPTED | Принят | Запрос на формирование ШК места принят |
PROCESSING | Формируется | Файл с ШК места формируется |
READY | Сформирован | Файл с ШК места и ссылка на скачивание файла сформированы |
REMOVED | Удален | Истекло время жизни ссылки на скачивание файла с ШК места |
INVALID | Некорректный запрос | Некорректный запрос на формирование ШК места |
© 2000—2023, Курьерская компания СДЭК