DeliverypointsEntity: CDEK pickup-point API for Joomla

WT CDEK library - Documentation
Category: Libraries

DeliverypointsEntity in WT CDEK for Joomla covers API lookup of pickup offices and lockers. This reference explains its purpose, parameters and PHP examples for Joomla extensions.

DeliverypointsEntity searches CDEK pickup offices and parcel lockers for maps, checkout selectors and server-side lookup.

Access the entity through the Cdek facade:

$deliverypoints = $cdek->deliverypoints();

getDeliveryPoints()

Signature

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

REST API

  • GET /v2/deliverypoints

Purpose

Returns matching CDEK offices and caches the response. Empty options use defaults including type = ALL and lang = rus.

Parameters

Common filters: city_code, type (PVZ/POSTAMAT/ALL), postal_code, country_code, region_code, have_cashless, have_cash, allowed_cod, is_dressing_room, weight_min, weight_max, take_only, is_handout, is_reception, fias_guid, lang. fias_guid is a FIAS settlement UUID, not CDEK city_uuid. For handout-only offices, use string 'false' for is_reception and string 'true' for is_handout so empty-value filtering retains false.

Returns

An array of offices with codes, addresses, opening hours, services and restrictions.

Example

<?php

declare(strict_types=1);

use Webtolk\Cdekapi\Cdek;

defined('_JEXEC') or die;

$cdek = new Cdek();

$points = $cdek->deliverypoints()->getDeliveryPoints([
    'city_code' => 270,
    'type'      => 'PVZ',
]);

Overview and getting started

WT CDEK 1.4.0 source code on GitHub

WebTolk Joomla Extensions

113 Extensions
12 Categories
587 Versions released
920737 Downloads