PrintEntity: CDEK waybills and barcodes in Joomla

PrintEntity generates shipment barcodes and waybills and retrieves print-task statuses and ready-document endpoints.

Access the entity through the Cdek facade:

$print = $cdek->print();

barcodePrint()

Signature

public function barcodePrint(array $request_options = []): array

REST API

• POST /v2/print/barcodes

Purpose

Starts barcode PDF generation.

Parameters

Nonempty request options, usually containing an orders array.

Returns

Asynchronous response with print-task UUID.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->barcodePrint([
    'orders' => [
        ['order_uuid' => '11111111-1111-1111-1111-111111111111'],
    ],
]);

barcodeGet()

Signature

public function barcodeGet(string $uuid): array

REST API

• GET /v2/print/barcodes/{uuid}

Purpose

Retrieves barcode generation status and a PDF link when ready.

Parameters

$uuid: print-task UUID.

Returns

Statuses such as ACCEPTED, PROCESSING, READY, INVALID or REMOVED, and associated data.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->barcodeGet('11111111-1111-1111-1111-111111111111');

barcodeDownload()

Signature

public function barcodeDownload(string $uuid): array

REST API

• GET /v2/print/barcodes/{uuid}.pdf

Purpose

Requests the ready barcode PDF endpoint.

Parameters

$uuid: print-task UUID.

Returns

The library's response for the ready-document endpoint.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->barcodeDownload('11111111-1111-1111-1111-111111111111');

waybillPrint()

Signature

public function waybillPrint(array $request_options = []): array

REST API

• POST /v2/print/orders

Purpose

Starts waybill PDF generation for one or more orders.

Parameters

Nonempty request options array.

Returns

Asynchronous response with print-task UUID.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->waybillPrint([
    'orders' => [
        ['order_uuid' => '11111111-1111-1111-1111-111111111111'],
    ],
]);

waybillGet()

Signature

public function waybillGet(string $uuid): array

REST API

• GET /v2/print/orders/{uuid}

Purpose

Retrieves waybill generation status and a ready PDF link.

Parameters

$uuid: print-task UUID.

Returns

Print-document status data.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->waybillGet('11111111-1111-1111-1111-111111111111');

waybillDownload()

Signature

public function waybillDownload(string $uuid): array

REST API

• GET /v2/print/orders/{uuid}.pdf

Purpose

Requests the ready waybill PDF endpoint.

Parameters

$uuid: print-task UUID.

Returns

The library's response for the ready-document endpoint.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->print()->waybillDownload('11111111-1111-1111-1111-111111111111');

Overview and getting started

WT CDEK 1.4.0 source code on GitHub