Page tree

Versions Compared

Key

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

...

Version

Revision date

Revision description

1.5January 29, 2019Creation of the documentation
1.5February 4, 2019

New tags for international order registration have been added to the method "Order registration" for online store

New tags for the method "Order Change" have been added: RecipientName tag, Phone tag, Address block, DeliveryRecipientCostAdv block

A recommended phone number format has been described

1.5February 19, 2019Added description of the API calculator
1.5March 20, 2019

Additional service "Insurance" is allowed for delivery order.

Added test accounts, test method links.

1.5March 26, 2019

Added ability to identify:

  • order in the methods of changing and deleting an order by the CDEK order number;
  • city by a city name and/or an address string

Added ability to update international order fields in the changing order method.

1.5March 27, 2019Additional service "Package 1" is available.
1.5April 8, 2019

Added description of the calculator method "Calculating on tariffs without priority"

The country code in the ISO_3166-1_alpha-2 format has been added to the method "Loading the list of pickup points"

1.5April 24, 2019cityName, postcode и regionFiasGuid were added to the method "List of Cities"
1.5May 13, 2019

In the method "Registration of a Request from the Online Store" added the ability to specify the requisites of a real seller in the Seller block for further printing of requisites on checks: Name, Address, Phone, INN, OwnershipForm

Removed individual elements SellerName and SellerAddress

1.5June 17, 2019The opportunity to transfer goods marking will appear soon. In the documentation described the pass format of goods marking in the methods "Registration of a Request from the Online Store", "Order Update" and output format of goods marking in the methods "Order Status Report", "Order Information Report".
1.5August 26, 2019Mandatory fields of the Sender block have been changed in the methods "Registration of a Delivery Order"
1.5September 17, 2019New tag RecipientEmail has been added in the method "Order Change"
1.5September 29, 2019New tag timezone has been added in the "List of cities" method response
1.5October 28, 2019

New filter weightmin has been added in the method "Loading the List of Pickup Points"

New fileds have been added in the calculator methods for identify cities (senderCountryCode, receiverCountryCode, senderCity, receiverCity, senderLongitude, receiverLongitude, senderLatitude, receiverLatitude fields)

1.5January 19, 2020Comment attribute has become mandatory in the method "Registration of a courier invitation"
1.5March 23, 2020

New filter havecash and HaveCash, TakeOnly, WorkTimeExceptions fields have been added to the method "Loading the list of pickup points"

1.5March 27, 2020

The "package volume (in m³)" field is excluded from the calculator API

1.5April 17, 2020Added "Sent to the sender city" and "Received in the sending city" statuses
1.5June 8, 2020Keys of online-shop test account were changed
1.5July 10, 2020Updated reasons for Late Delivery
1.5July 13, 2020Fields were removed from the "Description of Input Parameters" method:
"DeliveryRecipientCost" - Additional delivery charge collected by the online store from the receiver (in the recipient country currency)
"DeliveryRecipientVATRate" - VAT rate included in the extra delivery charge (for more details, see Appendix No. 4)
"DeliveryRecipientVATSum" - VAT amount included in the extra delivery charge
1.5July 14, 2020The "ClientSide" field was removed from the "order Registration for delivery" method"
1.5July 23, 2020
  1. Loading the List of Pickup Points
    1. Changed the "default" value in the Type field from PVZ to ALL
    2. Added Dimensions, width, height, depth fields in response to the request
  2. Added new tariffs for the terminals (361,363, 366, 368, 376, 378)
  3. Added new modes of orders: door-post terminal and warehouse-post terminal
  4. A method of creating order and a method of changing the order:

    1. Updated conditions for the SizeA, SizeB, and SizeC fields
    2. Updated the condition for the PvzCode field
  5. Updated permissions for additional services (Appendix 2)
1.5September 3, 2020178, 179, 180, 181, 182, 183, 231, 232,376 tariff codes are no longer available
1.5September 24, 2020Removed the "Creation of a Pre-Alert Document" method
1.5October 5, 2020For the "Create order" and "Changing the order" methods, the "Length", "Width", and "Height" fields are required.
1.5November 11, 2020Field "isHandout" was added in the "Loading the List of Pickup Points" method
1.5December 15, 2020Field "IsReception" was added in the "Loading the List of Pickup Points" method

Introduction

General Description

...

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 (https://cdek.ru/storage/source/document/1/CDEK_city.zip)integerno
3typeType of pickup point, possible values:
“PVZ” – display only CDEK warehouses;
“POSTAMAT” – display only partner's 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
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
8havecash

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

booleanno
9allowedcodCash on delivery is permitted, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno
10isdressingroomAvailability of a fitting room, possible values:
“1”, “true” – available;
“0”, “false” – not available.
booleanno
11weightmaxThe 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
12weightminThe minimum weight that is accepted by a pickup point (pickup points with minimum weight up to the specified value will be transmitted)integerno
13langLocalization of pickup points. Default: “rus”.string(3)no
14takeonlyWhether the pickup point is only a pickup point, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno
15isHandoutAvailability of an issuing orders, possible values:
“1”, “true” – yes;
“0”, “false” – no.
booleanno
16IsReceptionAvailability of a receiving orders, 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.

...

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.3NameParameterstring(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 (https://cdek.ru/storage/source/document/1/CDEK_city.zip)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, POSTAMAT - 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.24HaveCash
Availability of payment in cash
string(4)yes
1.1.25AllowedCodCash on delivery is permitted in a pickup pointstring(4)yes
1.1.26TakeOnly
Whether the pickup point is only a pickup point
string(4)yes
1.1.27NearestStationNearest station/public transport stopstring(50)yes
1.1.28MetroStationNearest metro stationstring(50)yes
1.1.29SitePickup point's website on the CDEK pagestring(255)no
1.1.30OfficeImageAll photos of the office (except for a photo showing how to get to it)
yes

1.1.30.1

url

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

string(255)

yes

1.1.31

WorkTimeYOpening hours for every day
yes

1.1.31.1

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

1.1.31.2

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

yes
1.1.32.1DateDatedatetimeyes
1.1.32.2Time
The period of work on the specified date. If they don’t work on this day, it is not displayed
string(20)yes
1.1.32.3IsWorkingSign of a working / non-working day on a specified datestring(4)yes

1.1.33

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

1.1.33.1

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

1.1.33.2

WeightMaxMaximum weight (in kg) accepted by a pickup point (<=WeightMax)floatyes
1.1.34DimensionsDimensions of cells for parcel terminal

1.1.34.1widthWidth (cm)floatYes, if Type= POSTAMAT or ALL
1.1.34.2heightHeight (cm)floatYes, if Type= POSTAMAT or ALL
1.1.34.3depthDepth (cm)floatYes, if Type= POSTAMAT or ALL
1.1.35isHandoutAvailability of an issuing orders    boolean   yes
1.1.36IsReceptionAvailability of a receiving ordersbooleanno


Example. List of pickup points

...

Code Block
languagexml
titleResponse
<PvzList>
    <Pvz Code="NSK71" PostalCode="630001" Name="Na Kholodilnoy" CountryCode="1" countryCodeIso="RU" CountryName="Russia" RegionCode="23" RegionName="Novosibirsk Oblast" CityCode="270" City="Novosibirsk" WorkTime="Mon-Fri 10:00-20:00, Sat-Sun 10:00-16:00" Address="ul. Kholodilnaya, 13" FullAddress="Russia, Novosibirsk Oblast, Novosibirsk, ul. Kholodilnaya, 13" AddressComment="Ryadom s ostanovkoy Kholodilnaya ( po storone nechetnykh domov Dusi Kovalchuk) stoit dom , ot dorogi vtoroye ofisnoye pomeshcheniye." Phone="+79913770310" Email="Bibikova.m@cdek.ru" qqId="" Note="" coordX="82.885359" coordY="55.049586" Type="PVZ" ownerCode="cdek" IsDressingRoom="true" IsHandout="true" IsReception="true" HaveCashless="true" AllowedCod="true" NearestStation="Kholodilnaya" MetroStation="Zayeltsovskaya" Site="">
        <PhoneDetail number="+79913770310"/>
        <WorkTimeY day="1" periods="10:00/20:00"/>
        <WorkTimeY day="2" periods="10:00/20:00"/>
        <WorkTimeY day="3" periods="10:00/20:00"/>
        <WorkTimeY day="4" periods="10:00/20:00"/>
        <WorkTimeY day="5" periods="10:00/20:00"/>
        <WorkTimeY day="6" periods="10:00/16:00"/>
        <WorkTimeY day="7" periods="10:00/16:00"/>
    </Pvz>
</PvzList>

...