Вход   Регистрация

Получение печатных форм этикеток / ТТН

Получение печатной формы этикеток/ТТН

/delivery/order

Метод получает файл (pdf или изображение) с печатной формой этикеток или ТТН.

Параметр Тип Описание
key string Ключ доступа
action string Значение: print
order_id string Идентификатор заказа в системе транспортной компании
format string

Для СДЭК, Халва, DPD

Формат печати.
Возможные значения:

  • СДЭК: A4, A5, A6; по умолчанию A4
  • DPD: A5, A6; по умолчанию A5
  • Халва: 58x60, 76x51, 70x28_a4; по умолчанию 58x60
mode string

Тип формы документа

Для Деловые Линии
По умолчанию: order
Возможные значения:

  • bill: счёт
  • order: накладная
  • invoice: счёт-фактура
  • label: этикетки

Для СДЭКа
По умолчанию: barcodes
Возможные значения:

  • barcodes: штрихкоды
  • order: накладная

Для DPD и ПЭК
По умолчанию: label
Возможные значения:

  • label: наклейки
  • order: накладная

Для Яндекс Доставка
По умолчанию: label
Возможные значения:

  • label: наклейки
  • act: акт приема-передачи
count integer

Для СДЭК, DPD.
Количество копий, по умолчанию - 1
batch string

Для Почта России

Название партии.
Рекомендуется указывать, если известно. Можно получить с помощью запроса «Получение заказа на доставку»
place integer

Для Байкал Сервис

Номер места, для которого формируется стикер.

Параметры, отмеченные , - обязательны.

curl --request POST 'https://api.esplc.ru/delivery/order' \
--header 'Content-Type: application/json' \
--data-raw '{ "key": "a2275ee6a7f268682fb553db39ff16d6", "action": "print" }'

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.esplc.ru/delivery/order',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => ['key' => 'a22752e6a73238684fb753db39ff16b6', 'action' => 'print'],
]);

$response = curl_exec($curl);

curl_close($curl);

print_r(json_decode($response,1));

При успешном запросе значение http_status будет равно 200.

В ответе будет ссылка на файл url и массив с данными по статусу запроса.

Внимание! Ссылка действиетльна в течении часа.

Возможен случай, когда печатная форма не отдаётся сразу и необходимо сделать повторный запрос. В этом случае в ответе не будет ссылки и status.code будет равен processing.

В случае неудачи, код ответа будет 4XX (например - 422); в ответе будет массив errors, содержащий описание ошибок.

{
    "http_status": 200,
    "http_status_message": "OK",
    "data": {
        "status": {
            "code": "success",
            "description": "Печатная форма успешно получена"
        },
        "url": "https://site.ru/print/636d275f22bfb.pdf"
    }
}