Формирование квитанции к заказу


 

Метод используется для формирования квитанции в формате 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).

Поддерживаются следующие поля:

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

Описание

Тип поля

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

1ordersСписок заказовorder[ ]да
1.1order_uuidИдентификатор заказа в ИС СДЭКUUID

да, если не передан cdek_number

1.2cdek_numberНомер заказа СДЭКlong

да, если не передан order_uuid

2copy_count

Число копий одной квитанции на листе. Рекомендовано указывать не менее 2, одна приклеивается на груз, вторая остается у отправителя

По умолчанию 2

integerнет
3type

Форма квитанции. Может принимать значения:
tpl_china - квитанция на китайском
tpl_armenia - квитанция на армянском
tpl_russia - Русский
tpl_china - Китайский
tpl_armenia - Армянский
tpl_english - Английский
tpl_italian - Итальянский
tpl_korean - Корейский
tpl_latvian - Латышский
tpl_lithuanian - Литовский
tpl_german - Немецкий
tpl_turkish - Турецкий
tpl_czech - Чешский
tpl_thailand - Тайский
tpl_invoice - Инвойс

По умолчанию будет выбрана форма на русском языке

string(255)нет

Ответ на формирование квитанции к заказу

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

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

Описание

Тип поля

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

1entityИнформация о квитанции к заказуentityнет
1.1uuidИдентификатор квитанции к заказу в ИС СДЭКUUIDнет
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()да



Полученный 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—2022, Курьерская компания СДЭК