IntakesEntity: CDEK courier collection in Joomla

IntakesEntity manages courier collection requests: creation, available dates, details, status changes and deletion.

Access the entity through the Cdek facade:

$intakes = $cdek->intakes();

changeStatus()

Signature

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

REST API

• PATCH /v2/intakes

Purpose

Changes an existing courier request's status.

Parameters

The library requires a nonempty array. Its contents must follow the CDEK schema for the requested status change.

Returns

API response array.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->intakes()->changeStatus([
    'intake_uuid' => '11111111-1111-1111-1111-111111111111',
    'status'      => 'REQUIRE_PROCESSING',
]);

create()

Signature

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

REST API

• POST /v2/intakes

Purpose

Creates a courier collection request.

Parameters

The library checks for a nonempty array. Provide the sender address, contact, collection date/time and packages required by CDEK for your scenario. The example illustrates the call, not a complete payload for every contract.

Returns

Asynchronous response with request UUID and processing status.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->intakes()->create([
    'intake_date' => '2026-04-20',
    'intake_time_from' => '10:00',
    'intake_time_to'   => '14:00',
    'name' => 'Склад интернет-магазина',
    'phones' => [
        ['number' => '+79990000000'],
    ],
    'packages' => [
        ['weight' => 2000],
    ],
]);

getAvailableDays()

Signature

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

REST API

• POST /v2/intakes/availableDays

Purpose

Retrieves available courier collection dates for a location.

Parameters

Nonempty options array matching the CDEK API schema.

Returns

Available collection dates.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->intakes()->getAvailableDays([
    'city' => 'Москва',
]);

deleteByUuid()

Signature

public function deleteByUuid(string $uuid): array

REST API

• DELETE /v2/intakes/{uuid}

Purpose

Deletes a courier collection request.

Parameters

$uuid: request UUID.

Returns

API response array.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->intakes()->deleteByUuid('11111111-1111-1111-1111-111111111111');

getByUuid()

Signature

public function getByUuid(string $uuid): array

REST API

• GET /v2/intakes/{uuid}

Purpose

Retrieves one courier collection request.

Parameters

$uuid: request UUID.

Returns

Request details and current status.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$result = $cdek->intakes()->getByUuid('11111111-1111-1111-1111-111111111111');

Overview and getting started

WT CDEK 1.4.0 source code on GitHub