List of Pickup Points
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:
Environment | URL |
---|---|
testing | https://api.edu.cdek.ru/v2/deliverypoints |
production | https://api.cdek.ru/v2/deliverypoints |
Request Parameters
The following parameters are supported:
No. | Tag / attribute | Description | Type of field | Mandatory (yes/no) |
1 | postal_code1 | Postal code of the city for which the list of pickup points is required | integer | no |
2 | city_code1 | CDEK location code ("List of Cities" method) | integer | no |
3 | type | Type of pickup point, possible values: | string(8) | no |
4 | country_code | Country code in the ISO_3166-1_alpha-2 format | string (2) | no |
5 | region_code | Region code from the CDEK base | integer | no |
6 | have_cashless | Availability of a payment terminal, possible values: | boolean | no |
7 | have_cash | Availability of a cash payment, possible values: | boolean | no |
8 | allowed_cod | Cash on delivery is permitted, possible values: | boolean | no |
9 | is_dressing_room | Availability of a fitting room, possible values: | boolean | no |
10 | weight_max | The maximum weight (kg) that can be accepted by a pickup point (values of more than 0 – load pickup points that accept this weight; 0 – pickup points with zero weight are not loaded; no value defined – load all pickup points). | integer | no |
11 | weight_min | The minimum weight (kg) that is accepted by a pickup point (pickup points with minimum weight up to the specified value will be transmitted) | integer | no |
12 | lang | Localization of pickup points. Default: “rus”. | string(3) | no |
13 | take_only | Whether the pickup point is only a pickup point, possible values: “1”, “true” – yes; “0”, “false” – no | boolean | no |
14 | is_handout | Availability of an issuing orders, possible values: “1”, “true” – yes; “0”, “false” – no. | boolean | no |
15 | is_reception | Availability of an taking orders, possible values: “1”, “true” – yes; “0”, “false” – no. | boolean | no |
16 | fias_guid | City code FIAS | UUID | no |
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 / attribute | Description | Type of field | Mandatory (yes/no) |
1 | code | Code | string(10) | yes |
2 | name | Name (deprecated field, it is recommended to use parameters from the "location" array) | string(50) | no |
3 | uuid | Office ID | UUID | yes |
4 | location | Address | yes | |
4.1 | country_code | Country code in the ISO_3166-1_alpha-2 format | string(2) | yes |
4.2 | region_code | Region code from the CDEK base | integer | yes |
4.3 | region | Region name | string(50) | yes |
4.4 | city_code | CDEK location code ("List of Cities" method) | integer | yes |
4.5 | city | City name | string(50) | yes |
4.6 | fias_guid | City code FIAS | UUID | no |
4.7 | postal_сode | Postcode | string(10) | yes |
4.8 | longitude | Coordinates of location (longitude) in degrees | float | yes |
4.9 | latitude | Coordinates of location (latitude) in degrees | float | yes |
4.10 | address | Address (street, house, office) in the specified city | string(255) | yes |
4.11 | address_full | Full address, including country, region, city, etc. | string(255) | yes |
5 | address_comment | Description of location | string(255) | no |
6 | nearest_station | Nearest station/public transport stop | string(50) | yes |
7 | nearest_metro_station | Nearest metro station | string(50) | no |
8 | work_time | Opening hours, string of the following type: Mon–Fri 9–18, Sat9–16” | string(100) | yes |
9 | phones | List of phones | phone[] | yes |
9.1 | number | Phone number | string(255) | yes |
9.2 | additional | Additional information (additional number) | string(255) | no |
10 | string(255) | yes | ||
11 | note | Pickup points note | string(255) | yes |
12 | type | Pickup point type: PVZ — CDEK warehouse, POSTAMAT — CDEK parcel terminals. | string(8) | yes |
13 | 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 |
14 | take_only | Whether the pickup point is only a pickup point | boolean | yes |
15 | is_handout | Availability of an issuing orders | boolean | yes |
16 | is_reception | Availability of an taking orders | boolean | yes |
17 | is_dressing_room | Availability of a fitting room | string(4) | yes |
18 | have_cashless | Availability of payment terminal | string(4) | yes |
19 | have_cash | Availability of cash payment | boolean | yes |
20 | allowed_cod | Cash on delivery is permitted in a pickup point | string(4) | yes |
21 | site | Pickup point's website on the CDEK page | string(255) | no |
22 | office_image_list | All photos of the office (except for a photo showing how to get to it) | yes | |
22.1 | url | All photos have a separate tag with url attribute. | string(255) | yes |
22.2 | number | Photo number | integer | yes |
23 | work_time_list | Opening hours for every day | yes | |
23.1 | day | Ordinal number of a day (Monday = 1, Sunday = 7) | integer | yes |
23.2 | time | Opening hours for these days. If the pickup point does not work on this day, no period is specified | string(20) | yes |
24 | work_time_exceptions | Office schedule exceptions | no | |
24.1 | date | Date | datetime | yes |
24.2 | time | The period of work on the specified date. If they don’t work on this day, it is not displayed | string(20) | no |
24.3 | is_working | Sign of a working / non-working day on a specified date | boolean | yes |
25 | weight_min | Minimum weight (in kg) accepted by a pickup point (> WeightMin) | float | no |
26 | weight_max | Maximum weight (in kg) accepted by a pickup point (<=WeightMax)floatyes | float | no |
27 | fulfillment | Availability of an order fulfillment zone | boolean | yes |
28 | dimensions | List of locker dimensions (only for type = POSTAMAT) | [ ] | no |
28.1 | width | Width (in centimeters) | float | yes |
28.2 | height | Height (in centimeters) | float | yes |
28.3 | depth | Depth (in centimeters) | float | yes |
29 | errors | Errors list | error[] | no |
29.1 | code | Error code | string() | yes |
29.2 | message | Error description | string() | yes |
http://api.cdek.ru/v2/deliverypoints?weight_max=50&city_code=270&allowed_cod=1 |
[ { "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, "address": "Гоголя ул., 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, "address": "ВИЛЮЙСКАЯ УЛ, 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:
Environment | URL |
---|---|
testing | https://api.edu.cdek.ru/v2/offices |
production | https://api.cdek.ru/v2/offices |
Request Parameters
The following parameters are supported:
No. | Tag / attribute | Description | Type of field | Mandatory (yes/no) |
1 | citypostcode1 | Postal code of the city for which the list of pickup points is required | integer | no |
2 | cityid1 | CDEK location code ("List of Cities" method) | integer | no |
3 | type | Type of pickup point, possible values: “PVZ” – display only CDEK warehouses; “POSTAMAT” – display only CDEK parcel terminals; “ALL” – display all pickup points, irrespective of their type. If no value is defined, “ALL” will be used as a default value. | string(8) | no |
4 | countryid | Country code from the CDEK base | integer | no |
5 | countryiso | Country code in the ISO_3166-1_alpha-2 format | string(2) | no |
6 | regionid | Region code from the CDEK base | integer | no |
7 | havecashless | Availability of a payment terminal, possible values: “1”, “true” – available; “0”, “false” – not available. | boolean | no |
8 | allowedcod | Cash on delivery is permitted, possible values: “1”, “true” – yes; “0”, “false” – no. | boolean | no |
9 | isdressingroom | Availability of a fitting room, possible values: “1”, “true” – available; “0”, “false” – not available. | boolean | no |
10 | weightmax | The maximum weight (kg) that can be accepted by a pickup point (values of more than 0 – load pickup points that accept this weight; 0 – pickup points with zero weight are not loaded; no value defined – load all pickup points). | integer | no |
11 | weightmin | The minimum weight (kg) that is accepted by a pickup point (pickup points with minimum weight up to the specified value will be transmitted) | integer | no |
12 | lang | Localization of pickup points. Default: “rus”. | string(3) | no |
13 | takeonly | Whether the pickup point is only a pickup point, possible values: “1”, “true” – yes; “0”, “false” – no. | boolean | no |
14 | ishandout | Availability of an issuing orders, possible values: “1”, “true” – yes; “0”, “false” – no. | boolean | no |
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 / attribute | Description | Type of field | Mandatory (yes/no) |
---|---|---|---|---|
1 | PvzList | Document title | yes | |
1.1 | Pvz | Pickup points | yes | |
1.1.1 | Code | Code | string(10) | yes |
1.1.2 | PostalCode | Postcode | string(10) | yes |
1.1.3 | Name | Name | string(50) | yes |
1.1.4 | CountryCode | Country code | integer | yes |
1.1.5 | countryCodeIso | Country code in the ISO_3166-1_alpha-2 format | string(2) | no |
1.1.6 | CountryName | Country name | string(50) | yes |
1.1.7 | RegionCode | Region code | integer | yes |
1.1.8 | RegionName | Region name | string(50) | yes |
1.1.9 | CityCode | CDEK location code ("List of Cities" method) | integer | yes |
1.1.10 | City | City name | string(50) | yes |
1.1.11 | WorkTime | Opening hours, string of the following type: Mon–Fri 9–18, Sat9–16” | string(100) | yes |
1.1.12 | Address | Address (street, house, office) in the specified city | string(255) | yes |
1.1.13 | FullAddress | Full address, including country, region, city, etc. | string(255) | yes |
1.1.14 | AddressComment | Description of location | string(255) | no |
1.1.15 | Phone | Phone | phone | yes |
1.1.16 | string(255) | yes | ||
1.1.17 | Note | Pickup points note | string(255) | yes |
1.1.18 | coordX | Coordinates of location (longitude) in degrees | float | yes |
1.1.19 | coordY | Coordinates of location (latitude) in degrees | float | yes |
1.1.20 | Type | Pickup point type: PVZ — CDEK warehouse, POSTAMAT — CDEK parcel terminals | 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.22 | IsDressingRoom | Availability of a fitting room | string(4) | yes |
1.1.23 | HaveCashless | Availability of payment terminal | string(4) | yes |
1.1.24 | AllowedCod | Cash on delivery is permitted in a pickup point | string(4) | yes |
1.1.25 | NearestStation | Nearest station/public transport stop | string(50) | yes |
1.1.26 | MetroStation | Nearest metro station | string(50) | yes |
1.1.27 | Site | Pickup point's website on the CDEK page | string(255) | no |
1.1.28 | OfficeImage | All 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. | string(255) | yes |
1.1.29 | WorkTimeY | Opening hours for every day | yes | |
1.1.29.1 | day | Ordinal number of a day (Monday = 1, Sunday = 7) | integer | yes |
1.1.29.2 | periods | Opening hours for these days. If the pickup point does not work on this day, no period is specified | string(20) | yes |
1.1.30 | WeightLimit | Weight limits for a pickup point(the tag is used only if limits are set) | yes | |
1.1.30.1 | WeightMin | Minimum weight (in kg) accepted by a pickup point (> WeightMin) | float | yes |
1.1.30.2 | WeightMax | Maximum weight (in kg) accepted by a pickup point (<=WeightMax) | float | yes |
1.1.31 | dimensions | List of locker dimensions (only for type = POSTAMAT) | [ ] | no |
1.1.31.1 | width | Width (in centimeters) | float | yes |
1.1.31.2 | height | Height (in centimeters) | float | yes |
1.1.31.3 | depth | Depth (in centimeters) | float | yes |
1.1.32 | ishandout | Availability of an issuing orders | boolean | yes |
https://api.cdek.ru/v2/offices?weightmax=50&cityid=270&allowedcode=1 |
{ "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" } ] } ] } |
© 2000—2024, Курьерская компания СДЭК