Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The method is used to load the list of active pickup points, from which the client can pick up its order.

1. New method 

Request for List of Pickup Points

In order to use this process, a GET request should be sent to URL:

Request Parameters

The following parameters are supported:


No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1postal_code1Postal code of the city for which the list of pickup points is required

integer

no

2

city_code1

City code from the CDEK base

integer

no

3

type

Type of pickup point, possible values:
“PVZ” – display only CDEK warehouses;
“POSTOMAT” – display only partner's parcel terminals;
“ALL” – display all pickup points, irrespective of their type.
If no value is defined, “PVZ” will be used as a default value.


string(8)

no
4country_codeCountry code in the ISO_3166-1_alpha-2 formatstring (2)no

5

region_code

Region code from the CDEK baseintegerno

6

have_cashless

Availability of a payment terminal, possible values:
“1”, “true” – available;
“0”, “false” – not available.


booleanno
7have_cash

Availability of a cash payment, possible values:
“1”, “true” – available;
“0”, “false” – not available.


booleanno
8allowed_cod

Cash on delivery is permitted, possible values:
“1”, “true” – yes;
“0”, “false” – no.


booleanno
9is_dressing_room

Availability of a fitting room, possible values:
“1”, “true” – available;
“0”, “false” – not available.


booleanno
10weight_maxThe maximum weight that can be accepted by a pickup point (values of more than 0 – load pickup points that accept this weight; 0 – load all pickup points; no value defined – pickup points with zero weight are not loaded).integerno
11weight_minThe minimum weight that is accepted by a pickup point (pickup points with minimum weight up to the specified value will be transmitted)integerno
12langLocalization of pickup points. Default: “rus”.string(3)no
13take_onlyWhether the pickup point is only a pickup point, possible values:
“1”, “true” – yes;
“0”, “false” – no


booleanno

1 If both parameters city_code and postal_code are indicated, the system gives priority to city_code to determine a city among all countries in which CDEK is present.

Response to List of Regions request

The response is returned in JSON format:


No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1codeCodestring(10)yes
2

name

Namestring(50)yes
3locationAddress
yes
3.1country_codeCountry code in the ISO_3166-1_alpha-2 formatstring(2)yes
3.2

region_code

Region code from the CDEK baseintegeryes
3.3regionRegion namestring(50)yes
3.4city_codeCity code from the CDEK baseintegeryes
3.5cityCity namestring(50)yes
3.6postal_сodePostcodestring(10)yes
3.7longitudeCoordinates of location (longitude) in degreesfloatyes
3.8latitudeCoordinates of location (latitude) in degreesfloatyes
3.9addressAddress (street, house, office) in the specified citystring(255)yes
3.10address_fullFull address, including country, region, city, etc.string(255)yes
4address_commentDescription of locationstring(255)yes
5nearest_stationNearest station/public transport stopstring(50)yes
6

nearest_metro_station

Nearest metro stationstring(50)yes
7

work_time

Opening hours, string of the following type: Mon–Fri 9–18, Sat9–16”string(100)yes
8

phones

List of phones

phone[]

yes

8.1number

Phone number

string(255)yes
8.2additional

Additional information (additional number)

string(255)

no
9emailE-mailstring(255)yes
10

note

Pickup points note

string(255)

yes

11

type

Pickup point type: PVZ, deliveryOffice — CDEK warehouse, POSTOMAT — CDEK partner's postamat

string(8)

yes

12

owner_сode

Affiliation of the pickup points company: CDEK — pickup point is owned by CDEK, InPost — pickup point is owned by InPost.

string(6)

yes

13take_onlyWhether the pickup point is only a pickup point

boolean

yes

14

is_dressing_room

Availability of a fitting roomstring(4)yes
15

have_cashless

Availability of payment terminal

string(4)yes
16have_cashAvailability of cash paymentbooleanyes
17allowed_codCash on delivery is permitted in a pickup pointstring(4)yes
18

site

Pickup point's website on the CDEK pagestring(255)yes
19

office_image_list

All photos of the office (except for a photo showing how to get to it)
yes

19.1

url

All photos have a separate tag with url attribute.
A link to the image is displayed.

string(255)

yes

19.2numberPhoto numberintegeryes

20

work_time_list

Opening hours for every day
yes

20.1

day

Ordinal number of a day (Monday = 1, Sunday = 7)integeryes

20.2

time

Opening hours for these days. If the pickup point does not work on this day, no period is specifiedstring(20)yes
21work_time_exceptionsOffice schedule exceptions
no
21.1dateDatedatetimeyes
21.2timeThe period of work on the specified date. If they don’t work on this day, it is not displayed

string(20)

no

21.3is_workingSign of a working / non-working day on a specified datebooleanyes

22

weight_min

Minimum weight (in kg) accepted by a pickup point (> WeightMin)floatyes

23

weight_max

Maximum weight (in kg) accepted by a pickup point (<=WeightMax)floatyes

float

no

24errorsErrors listerror[]no
24.1codeError codestring()yes
24.2messageError descriptionstring()yes


Sample request
http://api.cdek.ru/v2/deliverypoints?weight_max=50&city_code=270&allowed_cod=1


Sample Responce
[
    {
        "code": "NSK279",
        "name": "тест 43",
        "location": {
            "country_code": "RU",
            "region_code": 23,
            "region": "Новосибирская обл.",
            "city_code": 270,
            "city": "Новосибирск",
            "postal_code": "630126",
            "longitude": 34.0,
            "latitude": 43.0,
            "adress": "Гоголя ул., 1",
            "address_full": "Россия, Новосибирская обл., Новосибирск, Гоголя ул., 1"
        },
        "address_comment": "",
        "nearest_station": "нет",
        "nearest_metro_station": "",
        "work_time": "Пн-Пт 08:00-17:00",
        "phones": [
            {
                "number": "+79232478998"
            }
        ],
        "email": "test@test.ru",
        "note": "",
        "type": "PVZ",
        "owner_сode": "cdek",
        "take_only": false,
        "is_dressing_room": true,
        "have_cashless": true,
        "have_cash": true,
        "allowed_cod": true,
        "work_time_list": [
            {
                "day": 1,
                "time": "08:00/17:00"
            },
            {
                "day": 2,
                "time": "08:00/17:00"
            },
            {
                "day": 3,
                "time": "08:00/17:00"
            },
            {
                "day": 4,
                "time": "08:00/17:00"
            },
            {
                "day": 5,
                "time": "08:00/17:00"
            }
        ],
        "work_time_exceptions": [
            {}
        ]
    },
    {
        "code": "NSK197",
        "name": "Тестовый офис",
        "location": {
            "country_code": "RU",
            "region_code": 23,
            "region": "Новосибирская обл.",
            "city_code": 270,
            "city": "Новосибирск",
            "postal_code": "630126",
            "longitude": 34.0,
            "latitude": 43.0,
            "adress": "ВИЛЮЙСКАЯ УЛ, 1",
            "address_full": "Россия, Новосибирская обл., Новосибирск, ВИЛЮЙСКАЯ УЛ, 1"
        },
        "address_comment": "Тест",
        "nearest_station": "Тест",
        "nearest_metro_station": "Тест",
        "work_time": "Пн-Пт 00:00-23:59",
        "phones": [
            {
                "number": "+79232478998"
            }
        ],
        "email": "Test@test.ru",
        "note": "Тест",
        "type": "PVZ",
        "owner_сode": "cdek",
        "take_only": false,
        "is_dressing_room": true,
        "have_cashless": true,
        "have_cash": true,
        "allowed_cod": true,
        "work_time_list": [
            {
                "day": 1,
                "time": "00:00/23:59"
            },
            {
                "day": 2,
                "time": "00:00/23:59"
            },
            {
                "day": 3,
                "time": "00:00/23:59"
            },
            {
                "day": 4,
                "time": "00:00/23:59"
            },
            {
                "day": 5,
                "time": "00:00/23:59"
            }
        ],
        "work_time_exceptions": [
            {}
        ],
        "weight_min": 0.0,
        "weight_max": 50.0
    }
]


2. Deprecated method

Request for List of Pickup Points

In order to use this process, a GET request should be sent to URL:

Request Parameters

The following parameters are supported:

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1citypostcode1Postal code of the city for which the list of pickup points is requiredintegerno
2cityid1City code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”)integerno
3typeType of pickup point, possible values:
“PVZ” – display only CDEK warehouses;
“POSTOMAT” – display only partner's parcel terminals;
“ALL” – display all pickup points, irrespective of their type.
If no value is defined, “PVZ” will be used as a default value.
string(8)no
4countryidCountry code from the CDEK baseintegerno
5countryisoCountry code in the ISO_3166-1_alpha-2 formatstring(2)no
6regionidRegion code from the CDEK baseintegerno
7havecashlessAvailability of a payment terminal, possible values:
“1”, “true” – available;
“0”, “false” – not available.
booleanno
8allowedcodCash on delivery is permitted, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno
9isdressingroomAvailability of a fitting room, possible values:
“1”, “true” – available;
“0”, “false” – not available.
booleanno
10weightmaxThe maximum weight that can be accepted by a pickup point (values of more than 0 – load pickup points that accept this weight; 0 – load all pickup points; no value defined – pickup points with zero weight are not loaded).integerno
11weightminThe minimum weight that is accepted by a pickup point (pickup points with minimum weight up to the specified value will be transmitted)integerno
12langLocalization of pickup points. Default: “rus”.string(3)no
13takeonlyWhether the pickup point is only a pickup point, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno

1 If both parameters cityid and citypostcode are indicated, the system gives priority to cityid to determine a city among all countries in which CDEK is present.

Response to List of Regions request

The response is returned in JSON format:

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)

1

PvzList

Document title
yes

1.1

Pvz

Pickup points
yes
1.1.1CodeCodestring(10)yes
1.1.2PostalCodePostcodestring(10)yes
1.1.3NameNamestring(50)yes
1.1.4CountryCodeCountry codeintegeryes
1.1.5countryCodeIsoCountry code in the ISO_3166-1_alpha-2 formatstring(2)no
1.1.6CountryNameCountry namestring(50)yes
1.1.7RegionCodeRegion codeintegeryes
1.1.8RegionNameRegion namestring(50)yes
1.1.9CityCodeCity code from the CDEK base (see the file“City_XXX_YYYYMMDD.xls”)integeryes
1.1.10CityCity namestring(50)yes
1.1.11WorkTimeOpening hours, string of the following type: Mon–Fri 9–18, Sat9–16”string(100)yes
1.1.12AddressAddress (street, house, office) in the specified citystring(255)yes
1.1.13FullAddressFull address, including country, region, city, etc.string(255)yes
1.1.14AddressCommentDescription of locationstring(255)yes
1.1.15PhonePhonephoneyes
1.1.16EmailE-mailstring(255)yes
1.1.17

Note

Pickup points note

string(255)

yes

1.1.18coordXCoordinates of location (longitude) in degreesfloatyes
1.1.19coordYCoordinates of location (latitude) in degreesfloatyes
1.1.20

Type

Pickup point type: PVZ, deliveryOffice — CDEK warehouse, POSTOMAT — CDEK partner's postamat

string(8)

yes

1.1.21

ownerCode

Affiliation of the pickup points company: CDEK — pickup point is owned by CDEK, InPost — pickup point is owned by InPost.

string(6)

yes

1.1.22IsDressingRoomAvailability of a fitting roomstring(4)yes
1.1.23

HaveCashless

Availability of payment terminal

string(4)yes
1.1.24AllowedCodCash on delivery is permitted in a pickup pointstring(4)yes
1.1.25NearestStationNearest station/public transport stopstring(50)yes
1.1.26MetroStationNearest metro stationstring(50)yes
1.1.27SitePickup point's website on the CDEK pagestring(255)yes
1.1.28OfficeImageAll photos of the office (except for a photo showing how to get to it)
yes

1.1.28.1

url

All photos have a separate tag with url attribute.
A link to the image is displayed.

string(255)

yes

1.1.29

WorkTimeYOpening hours for every day
yes

1.1.29.1

dayOrdinal number of a day (Monday = 1, Sunday = 7)integeryes

1.1.29.2

periodsOpening hours for these days. If the pickup point does not work on this day, no period is specifiedstring(20)yes

1.1.30

WeightLimitWeight limits for a pickup point(the tag is used only if limits are set)
yes

1.1.30.1

WeightMinMinimum weight (in kg) accepted by a pickup point (> WeightMin)floatyes

1.1.30.2

WeightMaxMaximum weight (in kg) accepted by a pickup point (<=WeightMax)floatyes
Sample Request
https://api.cdek.ru/v2/offices?weightmax=50&cityid=270&allowedcode=1
Sample Response
{
    "pvz": [
        {
            "code": "NSK39",
            "postalCode": "630091",
            "name": "На Крылова",
            "countryCode": "1",
            "countryCodeIso": "RU",
            "countryName": "Россия",
            "regionCode": "23",
            "regionName": "Новосибирская обл.",
            "cityCode": "270",
            "city": "Новосибирск",
            "workTime": "Сб-Вс 10:00-18:00, Пн-Пт 10:00-20:00",
            "address": "ул. Крылова, 7/1, 2",
            "fullAddress": "Россия, Новосибирская обл., Новосибирск, ул. Крылова, 7/1, 2",
            "phone": "+79529304062",
            "note": "",
            "coordX": "82.918786",
            "coordY": "55.041049",
            "type": "PVZ",
            "ownerCode": "cdek",
            "isDressingRoom": true,
            "haveCashless": true,
            "allowedCod": true,
            "nearestStation": "«Метро Красный проспект»",
            "metroStation": "Красный проспект",
            "site": "",
            "email": "a.matyunina@cdek.ru",
            "addressComment": "",
            "officeImageList": [
                {
                    "number": 1,
                    "url": "https://pvzimage.cdek.ru/images/1625/1062_1_NSK39"
                }
            ],
            "workTimeYList": [
                {
                    "day": "1",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "2",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "3",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "4",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "5",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "6",
                    "periods": "10:00/18:00"
                },
                {
                    "day": "7",
                    "periods": "10:00/18:00"
                }
            ],
            "phoneDetailList": [
                {
                    "number": "+79529304062"
                }
            ]
        },
        {
            "code": "NSK82",
            "postalCode": "630005",
            "name": "На Фрунзе",
            "countryCode": "1",
            "countryCodeIso": "RU",
            "countryName": "Россия",
            "regionCode": "23",
            "regionName": "Новосибирская обл.",
            "cityCode": "270",
            "city": "Новосибирск",
            "workTime": "Сб-Вс 10:00-18:00, Пн-Пт 10:00-20:00",
            "address": "ул. Журинская, 80/2",
            "fullAddress": "Россия, Новосибирская обл., Новосибирск, ул. Журинская, 80/2",
            "phone": "+73833751065",
            "note": "",
            "coordX": "82.940139",
            "coordY": "55.037283",
            "type": "PVZ",
            "ownerCode": "cdek",
            "isDressingRoom": true,
            "haveCashless": true,
            "allowedCod": true,
            "nearestStation": "Университет Экономики",
            "metroStation": "Маршала Покрышкина",
            "site": "",
            "email": "v.mihajlovskij@cdek.ru",
            "addressComment": "По ул.Фрунзе от ул.Красный пр., перед  ул.Ипподромской направо   вдоль заправки Газпромнефть, далее налево до бетонной стены, далее по указателям.",
            "officeImageList": [
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4673_IMG_2207-24-04-19-06-41.jpeg"
                },
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4671_IMG_2204-24-04-19-06-35.jpeg"
                },
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4669_IMG_2102-24-04-19-06-35.jpeg"
                },
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4665_IMG_2085-24-04-19-06-35.jpeg"
                },
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4667_IMG_2097-24-04-19-06-35.jpeg"
                },
                {
                    "number": 0,
                    "url": "https://pvzimage.cdek.ru/images/3589/4663_IMG_2083-24-04-19-06-35.jpeg"
                }
            ],
            "workTimeYList": [
                {
                    "day": "1",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "2",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "3",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "4",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "5",
                    "periods": "10:00/20:00"
                },
                {
                    "day": "6",
                    "periods": "10:00/18:00"
                },
                {
                    "day": "7",
                    "periods": "10:00/18:00"
                }
            ],
            "phoneDetailList": [
                {
                    "number": "+73833751065"
                }
            ]
        }
    ]
}


  • No labels