Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1

Метод используется для получения ШК места в формате pdf к заказу/заказам.

Ссылка на файл с ШК местом к заказу/заказам доступна в течение 1 часа. 

Запрос на получение ШК места к заказу

Для использования необходимо отправить GET-запрос на URL:

{uuid} - идентификатор ШК места, ссылку на который необходимо получить

Ответ на получение ШК места к заказу

Ответ возвращается в формате JSON:

Название поля

Описание

Тип поля

Обяз. для заполн.

1entityИнформация о ШК месте к заказуentityнет
1.1uuidИдентификатор файла ШК места к заказуUUIDда
1.2ordersСписок заказовorder[ ]да
1.2.1order_uuidИдентификатор заказа в ИС СДЭКUUIDнет
1.2.2cdek_numberНомер заказа СДЭКlongнет
1.1.3copy_countЧисло копий на листеintegerнет
1.1.4formatФормат печатиstring(2)нет
1.1.5langЯзык печатной формы в кодировке ISO - 639-3. По умолчанию - RUSstring(3)нет
1.1.6url1Ссылка на скачивание файла. Содержится в ответе только в статусе "Сформирован"
Формат: https://api.cdek.ru/v2/print/barcodes/{uuid}.pdf
string()нет
1.1.7statusesСтатус файлаstatus[ ]да
1.1.7.1codeКод статуса (подоробнее см. приложение 1)string()да
1.1.7.2nameНазвание статусаstring()да
1.1.7.3date_timeДата и время установки статуса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
1.2requestsИнформация о запросе над заказомrequest[]да
1.2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
1.2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
1.2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
1.2.4stateТекущее состояние запроса
Может принимать значения: ACCEPTED, WAITING, SUCCESSFUL, INVALID
string()да
1.2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
1.2.5.1codeКод ошибкиstring()да
1.2.5.2messageОписание ошибкиstring()да
1.2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
1.2.6.1codeКод предупрежденияstring()да
1.2.6.2messageОписание предупрежденияstring()да
2requestsИнформация о запросе над ШК местом к заказуrequest[]да
2.1request_uuidИдентификатор запроса в ИС СДЭКUUIDнет
2.2typeТип запроса
Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET
string()да
2.3date_timeДата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ)datetimeда
2.4state

Текущее состояние запроса
Может принимать значения: 

ACCEPTED - пройдена предварительная валидация и запрос принят
WAITING - запрос ожидает обработки (зависит от выполнения другого запроса)
SUCCESSFUL - запрос обработан успешно
INVALID - запрос обработался с ошибкой

string()да
2.5errorsОшибки, возникшие в ходе выполнения запросаerror[]нет
2.5.1codeКод ошибкиstring()да
2.5.2messageОписание ошибкиstring()да
2.6warningsПредупреждения, возникшие в ходе выполнения запросаwarning[]нет
2.6.1codeКод предупрежденияstring()да
2.6.2messageОписание предупреждения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Некорректный запросНекорректный запрос на формирование ШК места
  • No labels