Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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;
“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
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 – pickup points with zero weight are not loaded; no value defined – load all pickup points).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
14is_handoutAvailability of an issuing orders, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno
15is_receptionAvailability of an taking orders, 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.

...

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)no
5nearest_stationNearest station/public transport stopstring(50)yes
6

nearest_metro_station

Nearest metro stationstring(50)no
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 — CDEK warehouse, POSTAMAT — CDEK parcel terminals.

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

14is_handoutAvailability of an issuing ordersbooleanyes
15is_receptionAvailability of an taking ordersbooleanyes
16

is_dressing_room

Availability of a fitting roomstring(4)yes
1617

have_cashless

Availability of payment terminal

string(4)yes
1718have_cashAvailability of cash paymentbooleanyes
1819allowed_codCash on delivery is permitted in a pickup pointstring(4)yes
1920

site

Pickup point's website on the CDEK pagestring(255)no
2021

office_image_list

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

2021.1

url

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

string(255)

yes

2021.2numberPhoto numberintegeryes

2122

work_time_list

Opening hours for every day
yes

2122.1

day

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

2122.2

time

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

string(20)

no

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

2324

weight_min

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

2425

weight_max

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

float

no

2526fulfillment

Availability of an order fulfillment zone

booleanyes
2627dimensionsList of locker dimensions (only for type = POSTAMAT)[ ]no
2627.1widthWidth (in centimeters)floatyes
2627.2heightHeight (in centimeters)floatyes
2627.3depthDepth (in centimeters)floatyes
2728errorsErrors listerror[]no
2728.1codeError codestring()yes
2728.2messageError descriptionstring()yes

...