Page tree

Versions Compared

Key

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

...

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”https://cdek.ru/storage/source/document/1/CDEK_city.zip)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

...

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 (see the file“City_XXX_YYYYMMDD.xls”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 — 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

...

No.

Tag / attributeDescriptionTypeof fieldMandatory (yes/no)
1Delivery RequestDocument title
yes
1.1NumberID number of the acceptance certificate/waybill (accompanying document attached upon the transfer of the cargo to CDEK, generated in the online store's system). Identifier of the list of cargoes in the IS of the CDEK client. By default, you can use 1.string(30)yes
1.2DateDate of document (date of order)Datetime/dateyes
1.3AccountOnline store identifier (login)string(255)yes
1.4SecureKeystring(255)yes
1.5OrderCountThe total number of orders in a documentintegeryes
1.6OrderShipment (order)
yes
1.6.1NumberClient shipment number (unique for orders of a particular client). Order identifier in the Client's IS.string(40)yes
1.6.2SendCityCode1Sender's city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
1.6.3RecCityCode1Receiver's city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
1.6.4SendCityPostCode1Postal code of the sender's citystring(6)yes
1.6.5RecCityPostCoDe1Postal code of the receiver's citystring(6)yes
1.6.6SendCountryCode1Sender's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.7RecCountryCode1Receiver's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.8SendCityName1Name of sender's citystring(255)no
1.6.9RecCityName1Name of receiver's citystring(255)no
1.6.10RecipientINN

TIN of the receiver. Only for international orders.

string(12)no
1.6.11DateInvoice

Invoice date. Only for international orders.

Date time/dateyes, if order is international
1.6.12ShipperName

Shipper. Used to print waybills. Only for international orders.

string (255)yes, if order is international
1.6.13ShipperAddress

Shipper’s address. Used to print waybills. Only for international orders.

string (255)yes, if order is international
1.6.14Passport

Details of the receiver’s passport. Used to print waybills. Only for international orders.


no
1.6.14.1Series

Series of the receiver’s passport.

string (255)no
1.6.14.2Number

Number of the receiver’s passport.

string (255)no
1.6.14.3IssueDate

Date of issue of the receiver’s passport.

Date time/dateno
1.6.14.4IssuedBy

Issuing authority of the receiver’s passport.

string (255)no
1.6.14.5DateBirth

The receiver’s birthdate

Date time/dateno
1.6.15SenderSender. Must be defined if it is different from the online store client. If the online store is a sender, the Sender tag is not available.
no
1.6.15.1CompanyName of sender's companystring(128)no
1.6.15.2NameSender's contact personstring(128)no
1.6.15.3Address1Sender address (address of pickup)
no
1.6.15.3.1StreetStreetstring(50)yes
1.6.15.3.2HouseHousestring(30)no
1.6.15.3.3FlatFlat/officestring(10)no
1.6.15.4PhoneSender's phonephoneno
1.6.16RecipientNameReceiver (full name). At least 3 characters.string(128)yes
1.6.17RecipientEmailReceiver's email for sending order status notifications and contacting in case of failed callsemailno
1.6.18PhoneReceiver's phonephoneyes
1.6.19TariffTypeCodeCode of tariff type (for more details, see Appendix No. 1)integeryes
1.6.20DeliveryRecipientCost2Extra delivery charge collected by the online store from the receiver (the recipient country currency)floatno
1.6.21DeliveryRecipientVATRateVAT rate included in the extra delivery charge (for more details, see Appendix No. 4)string(10)no
1.6.22DeliveryRecipientVATSumVAT amount included in the extra delivery chargefloatno
1.6.23SellerRequisites of the real seller
no
1.6.23.1AddressReal seller’s address. Used to print invoices to display the address of the true seller or trade name. Only for international orders.string (255)yes, if order is international
1.6.23.2NameReal sellerstring (255)yes, if ITN is indicated
1.6.23.3INNITN (Individual Taxpayer Number) of the real sellerstring (20)no
1.6.23.4PhoneTelephone of the real sellerphoneyes, if ITN is indicated
1.6.23.5OwnershipFormCode of type ownership (for more details, see Appendix No. 10)integeryes, if ITN is indicated
1.6.24Comment3Comments (special notes on the order)string(255)no
1.6.25Address1Delivery address. Depending on a delivery mode, it is necessary to specify either Street, House, Flat attributes (delivery to the receiver's address) or PvzCode (pickup)
yes
1.6.25.1StreetReceiver's street. If possible, do not specify prefixes of values, such as “st.”string(50)yes
1.6.25.2HouseReceiver's house, building, block. If possible, do not specify prefixes of values, such as “house”.string(30)no
1.6.25.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat”.string(10)no
1.6.25.4PvzCodePickup code. The attribute is required only for orders with the delivery mode “to warehouse”, provided that no additional service “Delivery in the receiver's city” is ordered (AddService="17", for more details, see Appendix 2).
If the specified pickup point is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point. The receiver will be notified about change of the pickup point via SMS. If all pickup points in the city that can provide the selected service are closed, order registration will be impossible. The relevant error message will be sent.
string(10)yes
1.6.26PackagePackage (all packages are sent with different Package tags)
yes
1.6.26.1NumberPackage number (ordinal package number or order number can be used), unique for this order. Order identifier in the Client's IS.string(20)no
1.6.26.2BarCodePackage barcode, package identifier (if any); otherwise, transmit a value of the package number: Packege.Number). The parameter is used to handle the cargo at CDEK warehouses), unique for this order. Package identifier in the Client's IS.string(20)yes
1.6.26.3WeightTotal weight (in grams)integeryes
1.6.26.4SizeA4Package dimensions. Length (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.26.5SizeB4Package dimensions. Width (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.26.6SizeC4Package dimensions. Height (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.26.7ItemItems (goods)
yes
1.6.26.7.1AmountQuantity of goods of the same type (pcs).
The maximum number is 999.
Integeryes
1.6.26.7.2WareKeyIdentifier/item number of the goods.string(50)yes
1.6.26.7.3MarkingMarking of item.
If marking is indicated for Item, the Amount parametr can't be greater than 1.
stringno
1.6.26.7.4CostDeclared value of the goods (per item in the contract currency, value >=0). This value is used to calculate the amount of insurance.floatyes
1.6.26.7.5PaymentCash on delivery (per item in the recipient country currency, value >=0) — cash on delivery; in case of prepayment, value = 0.floatyes
1.6.26.7.6PaymentVATRateVAT rate included in the value of the goods (for more details, see the Appendix 4)string(10)no
1.6.26.7.7PaymentVATSumVAT amount included in the value (payment) of the goods.floatno
1.6.26.7.8WeightWeight (per item, in grams)integeryes
1.6.26.7.9CommentName of the goods (may contain description of the goods: size, color)string(255)yes
1.6.26.7.10WeightBrutto

Gross weight (for one unit of goods, in grams). Only for international orders.

integeryes, if order is international
1.6.26.7.11CommentEx

Name of the goods, in English (also can contain description of the goods, such as size and color). Only for international orders.

string(255)no
1.6.26.7.12Link

Link to the e-shop’s website with the goods’ description. Only for international orders.

string(255)no
1.6.27DeliveryRecipientCostAdv

Additional charge for delivery (E-shop charges the receiver), depending on the order’s sum


no
1.6.27.1Threshold

Goods price threshold (valid by condition less than or equal to), in even monetary units

integeryes
1.6.27.2Sum

Additional charge for delivery with total amount that falls within the interval

floatyes
1.6.27.3VATRate

VAT rate included in the additional charge for delivery (for more details, see Appendix No. 4). If the value is unknown, then default value “No VAT” is applied

string(10)no
1.6.27.4VATSum

VAT sum included in the additional charge for delivery

floatno
1.6.28AddServiceAdditional services
no
1.6.28.1ServiceCodeType of additional service (for more details, see Appendix No. 2)integeryes
1.6.28.2CountNumber of packages. It is used and is mandatory only for the additional service "Package 1".integerno
1.6.29Schedule5

Schedule for delivery /pickup


no
1.6.29.1Attempt

Time of delivery (one time interval not less than 3 hours is permitted for one day)


yes
1.6.29.1.1ID

ID number of a schedule from the online store's database. You may use 1 as a default value

integeryes
1.6.291.1.2Date

Date of delivery (only date, in the format “YYYY-MM-DD”, no time) as agreed by the receiver

dateyes
1.6.29.1.3CommentCommentstring(255)no
1.6.29.1.4TimeBeg

Start of a delivery time range (receiver's time)

timeyes
1.6.29.1.5TimeEnd

End of a delivery time range (receiver's time)

timeyes
1.6.29.1.6Address

New delivery address (if change is required). Depending on a delivery mode, Street or House attributes should be specified. Flat – delivery to the receiver's address, or PvzCode – pickup


no
1.6.29.1.6.1Street

Receiver's street. If possible, do not specify prefixesof values, such as “str”

string(50)yes
1.6.29.1.6.2House

Receiver's house, building, block. If possible, do not specify prefixes of values, such as “house”

string(30)yes
1.6.29.1.6.3Flat

Receiver's flat/office. If possible, do not specify prefixes of values, such as “flat.”

string(10)no
1.6.29.1.6.4PvzCode

Pickup code, required only for orders with a delivery mode “to warehouse” and provided that no additional service “Delivery in the receiver's city” has been ordered.

string(10)yes
1.7CallCourier6Call courier
no
1.7.1Call

Waiting for a courier


yes
1.7.1.1Date

Date of courier waiting

dateyes
1.7.1.2TimeBeg

Start time of courier waiting

timeyes
1.7.1.3TimeEnd

End time of courier waiting

timeyes
1.7.1.4LunchBeg

Start time of a lunch break, if it is within a time range [TimeBeg; TimeEnd]

timeno
1.7.1.5LunchEnd

End time of a lunch break, if it is within a time range [TimeBeg; TimeEnd]

timeno
1.7.1.6SendCityCode1

Sender's city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)

integeryes
1.7.1.7SendCityPostCode1

Postal code of the sender's city

string(6)yes
1.7.1.8SendCountryCode1

Sender's country code to identify a country by postal code

string(2)no
1.7.1.9SendCityName1

Name of sender's city

string(255)no
1.7.1.10SendPhone

Sender's contact phone

phoneyes
1.7.1.11SenderName

Sender (full name)

string(255)yes
1.7.1.12CommentComment for courierstring(255)no
1.7.1.13SendAddressSender's address
yes
1.7.1.13.1Street

Sender's street. If possible, do not specify prefixes of values, such as “st.”

string(50)yes
1.7.1.13.2House

Sender's house, building, block. If possible, do not specify prefixes of values, such as “house”.

string(30)yes
1.7.1.13.3Flat

Sender's flat/office. If possible, do not specify prefixes of values, such as “flat”.

string(10)yes

...

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1Delivery RequestDocument title
yes
1.1NumberNumber of an acceptance certificate/waybill. Identifier of the list of cargoes in the IS of the CDEK client. 1 can be used a default value.string(30)yes
1.2DateDate of document (date of order)datetime/dateyes
1.3AccountClient identifier (login)string(255)yes
1.4SecureKeystring(255)yes
1.5OrderCountThe total number of orders in a documentintegeryes
1.6OrderShipment (order)
yes
1.6.1ClientSideClient type: sender, receiver, third person. Possible values: “sender”, “receiver”, “other” (third party)string(10)yes
1.6.2NumberClient shipment number (unique for orders of a particular client). Order identifier in the Client's IS.string(40)yes
1.6.3SendCityCode1Sender's city code from the CDEK base (see the file“City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)Integeryes
1.6.4RecCityCode1Receiver's city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)Integeryes
1.6.5SendCityPostCode1Postal code of the sender's citystring(6)yes
1.6.6RecCityPostCode1Postal code of the receiver's citystring(6)yes
1.6.7SendCountryCode1Sender's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.8RecCountryCode1Receiver's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.9SendCityName1Name of sender's citystring(255)no
1.6.10RecCityName1Name of receiver's citystring(255)no
1.6.11SenderSender
no
1.6.11.1CompanyName of sender's companystring(128)no
1.6.11.2NameSender's contact personstring(128)yes
1.6.11.3Address1Address of pickup
no
1.6.11.3.1StreetStreetstring(50)yes
1.6.11.3.2HouseHousestring(30)no
1.6.11.3.3FlatFlat/officestring(10)no
1.6.11.4PhoneSender's phonephoneyes
1.6.12RecipientCompanyName of receiver's companystring(128)yes
1.6.13RecipientNameReceiver (full name). At least 3 characters.string(128)yes
1.6.14RecipientEmailEmail for sending order status notifications and contacting in case of failed callsеmailno
1.6.15PhoneReceiver's phonephoneyes
1.6.16TariffTypeCodeCode of tariff type (for more details, see Appendix No. 1)Integeryes
1.6.17Comment3Comments (special notes on the order)string(255)no
1.6.18Address1Delivery address. Depending on a delivery mode, it is necessary to specify either Street, House, Flat attributes (delivery to the receiver's address) or PvzCode (pickup)
yes
1.6.18.1StreetReceiver's street. If possible, do not specify prefixes of values, such as “st.”string(50)yes
1.6.18.2HouseReceiver's house, building, block. If possible, do not specify prefixes of values, such as “house”string(30)no
1.6.18.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat”string(10)no
1.6.18.4PvzCodePickup code. The attribute is required only for orders with the delivery mode “to warehouse”, provided that no additional service “Delivery in the receiver's city” is ordered (AddService="17", for more details, see Appendix 2).
If the specified pickup point is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point.
The receiver will be notified about change of the pickup point via SMS. If all pickup points in the city that can provide the selected service are closed, order registration will be impossible. The relevant error message will be sent.
string(10)yes
1.6.19PackagePackage (all packages are sent with different Package tags)
yes
1.6.19.1NumberPackage number (ordinal package number or order number can be used), unique for this order. Order identifier in the Client's IS.string(20)no
1.6.19.2BarCodePackage barcode, package identifier (if any); otherwise, transmit a value of the package number: Packege.Number). The parameter is used to handle the cargo at CDEK warehouses, uniquefor this order. Package identifier in the Client's IS.string(20)yes
1.6.19.3WeightTotal weight (in grams)integeryes
1.6.19.4SizeA4Package dimensions. Length (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.19.5SizeB4Package dimensions. Width (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.19.6SizeC4Package dimensions. Height (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
1.6.20AddServiceAdditional services
no
1.6.20.1ServiceCodeType of additional service (for more details, see Appendix No. 2)integeryes
1.6.20.2CostDeclared value of the package. It is used and is mandatory only for the additional service "Insurance".floatno
1.6.20.3CountNumber of packages. It is used and is mandatory only for the additional service "Package 1".integerno

...

  • By unique city code (City ID) in CDEK’s database. City IDs in CDEK’s database can be found in lists of cities in the documents package (see «City_XXX_YYYYMMDD.xls» filehttps://cdek.ru/storage/source/document/1/CDEK_city.zip). The values are represented in SendCityCode, RecCityCode attributes.

  • By the city’s postcode. The values are represented in SendCityPostCode, RecCityPostCode attributes. Along with the postcode, the country code (attributes SendCountryCode, RecCountryCode) and/or the city’s name (attributes SendCityName, RecCityName) can be used for specifying: the country code of the sought city should match with that described in the related attribute, and the transferred name of the city should be included in the name of the sought one. The city’s name can be in the client’s language (all localizations will be searched).

  • By address string which is formed by concatenating the following fields: SendCityName/RecCityName + Address.Street + Address.House.

...

  • By unique city code (City ID) in CDEK’s database. City IDs in CDEK’s database can be found in lists of cities in the documents package (see «City_XXX_YYYYMMDD.xls» filehttps://cdek.ru/storage/source/document/1/CDEK_city.zip). The values are represented in RecCityCode attribute.
  • By pickup code (PvzCode attribute).

  • By the city’s postcode. The value is represented in RecCityPostCode attribute. Along with the postcode, the country code (attribute RecCountryCode) and/or the city’s name (attribute RecCityName) can be used for specifying: the country code of the sought city should match with that described in the related attribute, and the transferred name of the city should be included in the name of the sought one. The city’s name can be in the client’s language (all localizations will be searched).

...

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1CallCourierDocument title
yes
1.2DateDate of document (date of invitation)datetime/dateyes
1.3AccountOnline store identifier (login)string(255)yes
1.4SecureKeystring(255)yes
1.5CallCountThe total number of courier invitations in the documentintegeryes
1.6CallWaiting for a courier
yes
1.6.1DateDate of courier waitingdateyes
1.6.2TimeBegStart time of courier waitingtimeyes
1.6.3TimeEndEnd time of courier waitingtimeyes
1.6.4LunchBegStart time of a lunch break, if it is within a time range [TimeBeg; TimeEnd]timeno
1.6.5LunchEndEnd time of a lunch break, if it is within a time range [TimeBeg; TimeEnd]timeno
1.6.6SendCityCode1Sender's city code from the CDEK base (see the file
“City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)
integeryes, if DispatchNumber is not defined
1.6.7SendCityPostCode1

Postal code of the sender's city

string(6)yes
1.6.8SendCountryCode1

Sender's country code to identify a country by postal code.

string(2)no
1.6.9SendCityName1

Name of sender's city

string(255)no
1.6.10SendPhoneSender's contact phonephoneyes, if
1. DispatchNumber is not defined
2. DispatchNumber is defined, but phone number is not defined in an order
1.6.11SenderNameSender (full name)string(255)yes, if
1. DispatchNumber is not defined
2. DispatchNumber is defined, but full name is not defined in an order
1.6.12WeightTotal weight (in grams) The document contain an integral number, but clients may transmit number with a decimal point. In this case, it will be rounded. If no number is transmitted, a default value (0.5 kg) will be written in the order.stringyes, if DispatchNumber is not defined
1.6.13CommentCargo descriptionstring(255)yes, if DispatchNumber is not defined
1.6.14DispatchNumber2Number of an assigned orderstring(10)no
1.6.15IgnoreTime

If “true” is selected, parameters of courier arrival will not be checked

boolean

no, default value: “false”

1.6.16Address1Receiver's address
yes
1.6.16.1StreetReceiver's street. If possible, do not specify prefixes of values, such as
“st.”.
string(50)yes
1.6.16.2HouseReceiver's house, building, block. If possible, do not specify prefixes of values, such as “house”string(30)yes
1.6.16.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat”.string(10)yes

...

  • By unique city code (City ID) in CDEK’s database. City IDs in CDEK’s database can be found in lists of cities in the documents package (see «City_XXX_YYYYMMDD.xls» filehttps://cdek.ru/storage/source/document/1/CDEK_city.zip). The values are represented in SendCityCode, RecCityCode attributes.

  • By the city’s postcode. The values are represented in SendCityPostCode, RecCityPostCode attributes. Along with the postcode, the country code (attributes SendCountryCode, RecCountryCode) and/or the city’s name (attributes SendCityName, RecCityName) can be used for specifying: the country code of the sought city should match with that described in the related attribute, and the transferred name of the city should be included in the name of the sought one. The city’s name can be in the client’s language (all localizations will be searched);

  • By address string which is formed by concatenating the following fields: SendCityName/RecCityName + Address.Street + Address.House.

...

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1StatusReportDocument title
yes
1.1DateFirstStart date and time of the period during which order statuses have changeddatetime/dateyes
1.2DateLastEnd date and time of the period during which order statuses have changeddatetime/dateyes
2OrderShipment (order)
yes
2.1ActNumberAcceptance certificate numberstring(30)yes
2.2NumberClient's shipment number. Order identifier in the IS of a CDEK client.string(30)yes
2.3DispatchNumberCDEK shipment number (assigned when orders are imported). Order identifier in the CDEK IS.integeryes
2.4DeliveryDateDelivery date:datetimeno
2.5RecipientNameRecipient at the time of delivery (filled only in the order status "Delivered")string(50)no
2.6ReturnDispatchNumberNumber of return shipment (order number under which the goods are returned to the online store in case of statuses “Not delivered”, “Delivered” – “Partial delivery”)integerno
2.7StatusCurrent order status
yes
2.7.1DateStatus date. Greenwich mean time indicateddatetimeyes
2.7.2CodeStatus code (for more details, see Appendix No. 5)integeryes
2.7.3DescriptionStatus namestring(100)yes
2.7.4CityCodeStatus change city, city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
2.7.5CityNameName of the status change citystring(100)yes
2.7.6State1Status change history
yes
2.7.6.1DateStatus datedatetimeyes
2.7.6.2CodeStatus code (for more details, see Appendix No. 5)integeryes
2.7.6.3DescriptionStatus namestring(100)yes
2.7.6.4CityCodeStatus change city, city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
2.7.6.5CityNameName of the status change citystring(100)yes
2.8ReasonCurrent additional status
yes
2.8.1DateAdditional status datedatetimeyes
2.8.2CodeAdditional status code (for more details, see Appendix No. 6)integerno
2.8.3DescriptionAdditional status namestring(100)no
2.9DelayReasonCurrent delay reason
yes
2.9.1DateDelay reason datedatetimeyes
2.9.2CodeDelay reason code (for more details, see Appendix No. 7)integerno
2.9.3DescriptionDelay reasonstring(50)no
2.9.4State1Delay reason history
yes
2.9.4.1DateDelay reason datedatetimeyes
2.9.4.2CodeDelay reason code (for more details, see Appendix No. 7)integerno
2.9.4.3DescriptionDelay reasonstring(50)no
2.10Package2Package
no
2.10.1NumberPackage number. Order identifier in the IS of еру CDEK client.string(20)yes
2.10.2Item2Items
yes
2.10.2.1WareKeyIdentifier/item number of the goods.string(20)yes
2.10.2.2MarkingMarking of itemstringno
2.10.2.3DelivAmountNumber of delivered items. Default value is equal to the number of items transferred for delivery.integeryes
2.10.2.4AmountQuantity of goods of the same type (pcs). The maximum number is 999.integeryes
2.11Attempt3Delivery time taken from the delivery schedule
no
2.11.1IDID number of a schedule from the online store's databaseintegeryes
2.11.2ScheduleCodeDelay reason code (for more details, see Appendix No. 7)integeryes
2.11.3ScheduleDescriptionDelay reasonstring(50)yes
2.12CallHistory of notification calls to the receiver
no
2.12.1.1CallGoodHistory of successful calls
no
2.12.1.1GoodSuccessful call
yes
2.12.1.1.1DateDate of a successful calldateyes
2.12.1.1.2DateDelivAgreed date of delivery/ pickupdateyes
2.12.2CallFailHistory of failed calls
no
2.12.2.1FailFailed call
yes
2.12.2.1.1DateDate of calldateyes
2.12.2.1.2ReasonCodeFailed call reason code (for more details, see Appendix No. 8)integeryes
2.12.2.1.3ReasonDescriptionReason for a failed callstring(255)yes
2.12.3CallDelayHistory of call reschedules
no
2.12.3.1DelayCall reschedule
yes
2.12.3.1.1DateDate of calldateyes
2.12.3.1.2DateNextDate to which call is rescheduleddateyes
3ReturnOrderReturn shipment
no
3.1ActNumberAcceptance certificate numberstring(30)yes
3.2NumberClient's shipment number. Order identifier in the IS of the CDEK client.string(30)yes
3.3DispatchNumberCDEK number of return order (assigned when the return order is agreed). Order identifier in the CDEK IS.integeryes
3.4DeliveryDateDelivery datedatetimeno
3.5RecipientNameRecipient at the time of deliverystring(50)no
3.6StatusCurrent order status
yes
3.6.1DateStatus datedatetimeyes
3.6.2CodeStatus code (for more details, see Appendix No. 5)integeryes
3.6.3DescriptionStatus namestring(100)yes
3.6.4CityCodeStatus change city, city code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
3.6.5CityNameName of the status change citystring(100)yes
3.6.6State1Status change history
yes
3.6.6.1DateStatus datedatetimeyes
3.6.6.2CodeStatus code (for more details, see Appendix No. 5)integeryes
3.6.6.3DescriptionStatus namestring(100)yes
3.6.6.4CityCodeStatus change cityintegeryes
3.6.6.5CityNameName of the status change citystring(100)yes
3.7ReasonCurrent additional status
yes
3.7.1DateAdditional status datedatetimeyes
3.7.2CodeAdditional status code (for more details, see Appendix No. 6)integerno
3.7.3DescriptionAdditional status namestring(100)no
3.8DelayReasonCurrent delay reason
yes
3.8.1DateDelay reason datedatetimeyes
3.8.2CodeDelay reason code (for more details, see Appendix No. 7)integerno
3.8.3DescriptionDelay reasonstring(50)no

...

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1InfoReportDocument title
yes
1.1OrderShipment (order)
yes
1.1.1NumberClient's shipment number. Order identifier in the IS of the CDEK client.string(30)yes
1.1.2DateDate on which the order has been transferred to the CDEK databasedateyes
1.1.3DispatchNumberCDEK shipment number (assigned when orders are imported). Order identifier in the CDEK IS.integeryes
1.1.4TariffTypeCodeTariff code (for more details, see Appendix No. 1)integeryes
1.1.5WeightEstimated weight (in kilograms)floatyes
1.1.6DeliverySumCost of delivery, in the settlement currency. Default: rubles.floatyes
1.1.7DateLastChangeLast change date for cost of deliverydateno
1.1.8CashOnDelivCash-on-delivery amount to be collected from the receiver in the currency of the receiver's country. Default: rubles.floatno
1.1.9CashOnDelivFactCash-on-delivery amount collected from the receiver in the currency of the receiver's country (default: rubles), subject to possible partial delivery. Available only for orders with the status “Delivered”floatno
1.1.10CashOnDelivTypePayment type of cash-on-delivery. Possible values: cash, cashless. Tag missing if payment information has not gotstrong(10)no
1.1.11DeliveryModeDelivery mode code (for more details, see Appendix No. 1)integeryes
1.1.12PvzCodePickup code specified in order at the time of request, for the delivery mode “to warehouse”string(10)yes
1.1.13DeliveryVariantDelivery option: (COURIER – courier, PVZCDEK – CDEK pickup point, PVZCLIENT – partner’s pickup point)string(10)yes
2.13SendCitySender's city
yes
2.13.1CodeCity code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
2.13.2PostCodePostal code of the citystring(6)yes
2.13.3NameCity namestring(50)yes
2.14RecCityReceiver's city
yes
2.14.1CodeCity code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
2.14.2PostCodePostal code of the citystring(6)yes
2.14.3NameCity namestring(50)yes
2.15AddedServiceAdditional services for orders
no
2.15.1ServiceCodeAdditional service code (for more details, see Appendix No. 2)integeryes
2.15.2SumValue of service in the settlement currency, default: rubles.floatyes
2.16PackagePackage (all packages are sent with different Package tags)
yes
2.16.1NumberPackage numberstring(20)yes
2.16.2BarCodePackage barcode, package identifierstring(20)yes
2.16.3WeightTotal weight (in kilograms)integeryes
2.16.4VolumeWeightVolumetric weight (in kilograms), calculated by formula: SizeA*SizeB*SizeC/5,000integeryes
2.16.5SizeAPackage dimensions. Length (in centimeters)integeryes
2.16.6SizeBPackage dimensions. Width (in centimeters)integeryes
2.16.7SizeCPackage dimensions. Height (in centimeters)integeryes
2.16.8ItemItems (goods)
yes
2.16.8.1WareKeyIdentifier/item number of the goodsstring(50)yes
2.16.8.2MarkingMarking of itemstringno
2.16.8.3CommentName of the goods (may contain description of the goods: size, color)string(255)yes
2.16.8.4AmountQuantity of the goods transferred for deliveryintegeryes
2.16.8.5DelivAmountQuantity of items of the same type delivered (pcs)integeryes
2.16.8.6CostDeclared value of the goods (per item in the specified the contract currency)floatyes
2.16.8.7PaymentCash on delivery (per item in the recipient country currency)floatyes
2.16.8.8VATRateVAT rate included in the value of the goods (for more details, see Appendix No. 4)string(10)no
2.16.8.9VATSumVAT amount included in the value (payment) of the goods.floatno
2.16.8.10WeightWeight (per item, in kilograms)integeryes

...

No.Tag/ attributeDescriptionType of fieldMandatory (yes/no)
1regionCodeExtRegion codeintegerno
2regionCodeRegion code in the CDEK ISintegerno
3regionFiasGuidRegion code according to the Federal Information Address SystemUUIDno
4pageNumber of the results page. Default value: 0integerno
5sizeLimitation on the number of results displayed. Default value: 1,000integeryes, if page is specified
6countryCodeCountry code in the format ISO 3166-1 alpha-2string(2)no
7cityNameCity namestringno
8cityCodeCity code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integerno
9postcodePostal codestringno
10langLocalization. Default: “rus”.string(3)no

...

No.Tag/ attributeDescriptionType of fieldMandatory (yes/no)
1cityUuidEntity identifier in the CDEK ISUUIDyes
2cityNameCity namestring(255)yes
3cityCodeCity code from the CDEK base (see the file “City_XXX_YYYYMMDD.xls”https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
4regionRegion namestring(255)yes
6regionCodeExtRF region codeintegerno
7regionCodeRegion code in the CDEK ISintegerno
8subRegionName of region's districtstring(255)no
9countryCountry namestring(255)yes
10countryCodeCountry code in the format ISO 3166-1 alpha-2integeryes
11latitudeLatitudefloatno
12longitudeLongitudefloatno
13kladrCity code according to the Russian Classifier of Addressesstring(20)no
14fiasGuid Code of an address object according to the Russian Classifier of AddressesUUIDno
15regionFiasGuidRegion code according to the Federal Information Address SystemUUIDno
16paymentLimitCash-on-delivery amount limit, possible values:
1 – no limit;
0 – cash on delivery is not accepted;
positive value – the cash-on-delivery amount does not exceed this value.
floatyes
17timezoneCity timezonestringno

...

4.14.1.1. Description of Data to be Transmitted

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

The version by used API - “1.0”.

stringyes
2authLogin1Client identifier (login)stringno
3secure1Keystringno
4dateExecute2

Planning date of shipment in the format “YYYY-ММ-DD”

dateno
5langLocalization of city name. Default: “rus”.string(3)no
6senderCountryCode3Sender country code in the ISO_3166-1_alpha-2 formatstring(2)no
7receiverCountryCode3Receiver country code in the ISO_3166-1_alpha-2 formatstring(2)no
8senderCityId3

Origin city code in accordance with city codes provided by CDEK (

file City_XXX_YYYYMMDD.xls»

https://cdek.ru/storage/source/document/1/CDEK_city.zip)

integeryes
9senderCity3Sender city namestringno
10senderCityPostCode3

Zip code of the origin city

integeryes
11receiverCityId3

Code of city of destination in accordance with city codes provided by CDEK (

file «City_XXX_YYYYMMDD.xls»

https://cdek.ru/storage/source/document/1/CDEK_city.zip)

integeryes
12receiverCityPostCode3

City of destination zip code

integeryes
13receiverCity3Receiver city namestringno
14senderLongitude3Sender city longitudefloatno
15receiverLongitude3Receiver city longitudefloatno
16senderLatitude3Sender city latitudefloatno
17receiverLatitude3Receiver city latitudefloatno
18tariffId4Code of chosen tariff (for more details, see Appendix No. 1)integeryes
19tariffList4List of tariffs
yes
19.1priority

The specified priority

integeryes
19.2id

Tariff code (for more details, see Appendix No. 1)

integeryes
19.3modeId

Chosen delivery mode (for more details, see Appendix No. 1)

integerno
20goodsPackage dimensions
yes
20.1weightWeight (in kilograms)floatyes
20.2lengthLength (in centimeters)integeryes
20.3widthWidth (in centimeters)integeryes
20.4heightHeight (in centimeters)integeryes
20.5volume5Package volume (in cubic meters)floatyes
21servicesList of additional service (for more details, see Appendix No. 2)
no
21.1idNumber identifier of additional serviceintegeryes
21.2param6Parameter of additional service if necessaryintegerno


1 Authorization is not obligatory for regular delivery tariffs and authLoginsecure parametrs might be not provided.

...

No.Tag / attribute
DescriptionType of fieldMandatory (yes/no)
1version

The version by used API - “1.0”.

stringyes
2authLogin1Client identifier (login)stringno
3secure1Keystringno
4dateExecute2

Planning date of shipment in the format “YYYY-ММ-DD”

dateno
5langLocalization of city name. Default: “rus”.string(3)no
6senderCountryCode3Sender country code in the ISO_3166-1_alpha-2 formatstring(2)no
7receiverCountryCode3Receiver country code in the ISO_3166-1_alpha-2 formatstring(2)no
8senderCityId3

Origin city code in accordance with city codes provided by CDEK (file City_XXX_YYYYMMDD.xls»https://cdek.ru/storage/source/document/1/CDEK_city.zip)

integeryes
9senderCityPostCode3

Zip code of the origin city

integeryes
10senderCity3Sender city namestringno
11receiverCityId3

Code of city of destination in accordance with city codes provided by CDEK (file «City_XXX_YYYYMMDD.xls»https://cdek.ru/storage/source/document/1/CDEK_city.zip)

integeryes
12receiverCityPostCode3

City of destination zip code

integeryes
13receiverCity3Receiver city namestringno
14senderLongitude3Sender city longitudefloatno
15receiverLongitude3Receiver city longitudefloatno
16senderLatitude3Sender city latitudefloatno
17receiverLatitude3Receiver city latitudefloatno
18currencyThe currency in which you need to calculate shipping cost. Default - RUBstringno
19tariffId4Code of chosen tariff (for more details, see Appendix No. 1)integeryes
20tariffList4List of tariffs
yes
20.1id

Tariff code (for more details, see Appendix No. 1)

integeryes
21goodsPackage dimensions
yes
21.1weightWeight (in kilograms)floatyes
21.2lengthLength (in centimeters)integeryes
21.3widthWidth (in centimeters)integeryes
21.4heightHeight (in centimeters)integeryes
22servicesList of additional service (for more details, see Appendix No. 2)
no
22.1idNumber identifier of additional serviceintegeryes
22.2param5Parameter of additional service if necessaryintegerno

...