Page tree

Versions Compared

Key

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

...

3.2. List of API Methods

No.

Method

Link (production)

Link (test)

1

Loading the list of pickup points

https://integration.cdek.ru/pvzlist/v1/xml

https://integration.edu.cdek.ru/pvzlist/v1/xml

2

Order registration


2.1

Order from the online store

https://integration.cdek.ru/new_orders.php

https://integration.edu.cdek.ru/new_orders.php

2.2

Delivery order

https://integration.cdek.ru/addDelivery

https://integration.cdek.ru/addDeliveryRaw (for transferring the content in the request body)

https://integration.edu.cdek.ru/addDelivery

https://integration.edu.cdek.ru/addDeliveryRaw (for transferring the content in the request body)

3

Order change

http://integration.cdek.ru/update

http://integration.cdek.ru/updateRaw (for transferring the content in the request body)

http://integration.edu.cdek.ru/update

http://integration.edu.cdek.ru/updateRaw (for transferring the content in the request body)

4

Order deletion

https://integration.cdek.ru/delete_orders.php

https://integration.edu.cdek.ru/delete_orders.php

5

Printing an order receipt

https://integration.cdek.ru/orders_print.php

https://integration.edu.cdek.ru/orders_print.php

6

Registration of a courier invitation

https://integration.cdek.ru/call_courier.php

https://integration.edu.cdek.ru/call_courier.php

7

Recording of notification call results

https://integration.cdek.ru/new_schedule.php

https://integration.edu.cdek.ru/new_schedule.php

8

Printing a package barcode

https://integration.cdek.ru/ordersPackagesPrint

https://integration.cdek.ru/ordersPackagesPrintRaw (for transferring the content in the request body)

https://integration.edu.cdek.ru/ordersPackagesPrint

https://integration.edu.cdek.ru/ordersPackagesPrintRaw (for transferring the content in the request body)

9

Order Status Report

https://integration.cdek.ru/ status_report_h.php

https://integration.edu.cdek.ru/status_report_h.php

10

Order Information Report

https://integration.cdek.ru/info_report.php

https://integration.edu.cdek.ru/info_report.php

11

List of Regions

https://integration.cdek.ru/v1/location/regions?

https://integration.edu.cdek.ru/v1/location/regions?

12

List of Cities

https://integration.cdek.ru/v1/location/cities?

https://integration.edu.cdek.ru/v1/location/cities?
13Cost calculation on tarrifs with priorityhttp://api.cdek.ru/calculator/calculate_price_by_json.phphttp://api.edu.cdek.ru/calculator/calculate_price_by_json.php
14Cost calculation on tariffs without priorityhttp://api.cdek.ru/calculator/calculate_tarifflist.phphttp://api.edu.cdek.ru/calculator/calculate_tarifflist.php

3.3. Translation of integration errors

...

The CDEK server will return a result in the form of XML:

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.9CityCodeCDEK city codeintegeryes
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

...

Registration of a Request from the Online Store

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 CDEK city codeintegeryes
1.6.3RecCityCode1Receiver's CDEK city codeintegeryes
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.19TariffTypeCode7Code 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), and for orders with the "to the parcel terminal" mode".
If the specified pickup point is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point. If the specified parcel terminal is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point or parcel terminal. 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, if the mode of delivery "to the warehouse" or "to a parcel terminal"
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.3Weight7Total 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
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 
1.6.26.5SizeB4Package dimensions. Width (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 
1.6.26.6SizeC4Package dimensions. Height (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 
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.3Marking8

Marking of item.
If marking is indicated for Item, the Amount parametr can't be greater than 1.

For the correct display of the marking of the goods in the receipt, it is required to transfer the DISASSEMBLED type of marking, which may look like this:

1) Array of bytes encoded in base64 format

Example: RE0DSU3xvJVMTFdHY3FUbVdSQkZI

2) Array as a string, with or without spaces:

Example 1: 44 4D 04 3D 02 64 1E D1 3E 69 55 72 54 54 4E 2B 65 54 4D 63 74

Example 2: 444D043D02641ED13E69557254544E2B65544D6374

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
It is possible to send several thresholds


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 services with 24, 54-58, 61-73, 76 codesintegerno
1.6.28.3LengthLength of package. It is used and is mandatory only for the additional services with 74, 75 codesfloatno
1.6.29Schedule5

Schedule for delivery /pickup (deprecated, it is recommended to use a separate new_schedule method)


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 CDEK city code

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


Registration of a Delivery Order

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.1SendCityCode1Sender's CDEK city codeIntegeryes
1.6.2RecCityCode1Receiver's CDEK city codeIntegeryes
1.6.3SendCityPostCode1Postal code of the sender's citystring(6)yes
1.6.4RecCityPostCode1Postal code of the receiver's citystring(6)yes
1.6.5SendCountryCode1Sender's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.6RecCountryCode1Receiver's country code to identify a country by postal code. Default value: RUstring(2)no
1.6.7SendCityName1Name of sender's citystring(255)no
1.6.8RecCityName1Name of receiver's citystring(255)no
1.6.9SenderSender
no
1.6.9.1CompanyName of sender's companystring(128)no
1.6.9.2NameSender's contact personstring(128)yes
1.6.9.3Address1Address of pickup
no
1.6.9.3.1StreetStreetstring(50)yes
1.6.9.3.2HouseHousestring(30)no
1.6.9.3.3FlatFlat/officestring(10)no
1.6.9.3.4PhoneSender's phonephoneyes
1.6.10RecipientCompanyName of receiver's companystring(128)yes
1.6.11RecipientNameReceiver (full name). At least 3 characters.string(128)yes
1.6.12RecipientEmailEmail for sending order status notifications and contacting in case of failed callsеmailno
1.6.13PhoneReceiver's phonephoneyes
1.6.14TariffTypeCode7Code of tariff type (for more details, see Appendix No. 1)Integeryes
1.6.15Comment3Comments (special notes on the order)string(255)no
1.6.16Address1Delivery 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.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)no
1.6.16.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat”string(10)no
1.6.16.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), and for orders with the "to the parcel terminal" mode".
If the specified pickup point is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point. If the specified parcel terminal is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point or parcel terminal. 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, if the mode of delivery "to the warehouse" or "to a parcel terminal"
1.6.17PackagePackage (all packages are sent with different Package tags)
yes
1.6.17.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.17.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.17.3Weight7Total weight (in grams)integerno
1.6.17.4SizeA4Package dimensions. Length (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 g
1.6.17.5SizeB4Package dimensions. Width (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 g
1.6.17.6SizeC4Package dimensions. Height (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
or
Total weight >= 100 g
1.6.18AddServiceAdditional services
no
1.6.18.1ServiceCodeType of additional service (for more details, see Appendix No. 2)integeryes
1.6.18.2CostDeclared value of the package. It is used and is mandatory only for the additional service "Insurance".floatno
1.6.28.3CountNumber of packages. It is used and is mandatory only for the additional services with 24, 54-58, 61-73, 76 codesintegerno
1.6.28.4LengthLength of package. It is used and is mandatory only for the additional services with 74, 75 codesfloatno

1Identification of sender city and receiver city (in the case of “to the door” mode) uses the following algorithm by order of priority:

...

The CDEK server will return a result in the form of XML:

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1ResponseDocument title
yes
1.1OrderOrder
yes
1.1.1DispatchNumber

CDEK order number

It is returned if the order is created successfully or if an error ErrorCode = "ERR_ORDER_DUBL_EXISTS" occurs

integerno
1.1.2NumberOrder number of the online storestring(40)yes
1.1.3ErrorCodeError codestring(255)no
1.1.4MsgFixed text “Orders added”
Description of error (if any)
string(255)yes
1.2CallCall courier
no
1.2.1Number

Invitation number

string(30)yes
1.2.2ErrorCodeError codestring(255)no
1.2.3Msg

Fixed text “Orders added”

Description of error (if any)

string(255)yes


Example 1. Registration of an “online store” order

...

4.3.1. Description of Request Fields to be Transmitted

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1UpdateRequestDocument title
yes
1.1NumberAcceptance certificate number Order identifier in the IS of the CDEK client.string(30)yes
1.2DateDate of document (date of order)Date time/ 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.1Number1Client shipment number (unique for orders of a particular client). Order identifier in the Client's IS.string(40)yes
1.6.2DispatchNumber1CDEK order numberintegeryes
1.6.3Delivery Recipient CostAdditional delivery charge collected by the online store from the receiver (in the recipient country currency)floatno
1.6.4Delivery RecipientVATRateVAT rate included in the extra delivery charge
(for more details, see Appendix No. 4)
string(10)no
1.6.5DeliveryRecipientVATSumVAT amount included in the extra. delivery chargefloatno
1.6.6RecipientNameReceiver (full name). At least 3 characters.string(128)no
1.6.7RecipientEmailReceiver's email for sending order status notifications and contacting in case of failed callsemailno
1.6.8PhoneReceiver's phonephoneno
1.6.9RecipientINNTIN of the receiver. Only for international orders.string(12)no
1.6.10DateInvoiceInvoice date. Only for international orders.Date time/dateno
1.6.11PassportDetails of the receiver’s passport. Used to print waybills. Only for international orders.
no
1.6.11.1SeriesSeries of the receiver’s passport.string(255)no
1.6.11.2NumberNumber of the receiver’s passport.string(255)no
1.6.11.3IssueDateDate of issue of the receiver’s passport.Date time/dateno
1.6.11.4IssuedByIssuing authority of the receiver’s passport.string(255)no
1.6.11.5DateBirth

The receiver’s birthdate

Date time/dateno
1.6.12AddressDelivery 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)
no
1.6.12.1StreetReceiver's street. If possible, do not specify prefixes of values, such as “st.”string(50)yes
1.6.12.2HouseReceiver's house, building, block. If possible, do not specify prefixes of values, such as “house”.string(30)yes
1.6.12.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat”.string(10)no
1.6.12.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), and for orders with the "to a parcel terminal" mode.
If the specified pickup point is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point. If the specified parcel terminal is closed at the time of order creation, the order will be accepted for the nearest functioning pickup point or parcel terminal. 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, if the mode of delivery "to the warehouse" or "to a parcel terminal"
1.6.13DeliveryRecipientCostAdvAdditional charge for delivery (E-shop charges the receiver), depending on the order’s sum
It is possible to send several thresholds

no
1.6.13.1Threshold

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

integeryes
1.6.13.2Sum

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

floatyes
1.6.13.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.13.4VATSum

VAT sum included in the additional charge for delivery

floatno
1.6.14PackagePackage (all packages are sent with different Package tags)
no
1.6.14.1NumberPackage number (ordinal package number or order number can be used), unique for this order. Order identifier in the Client's IS.string(20)yes
1.6.14.2BarCodePackage barcode, package identifier (if any); otherwise, transmit a value of the package number Package.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.14.3WeightTotal weight (in grams)integeryes
1.6.14.4SizeAPackage dimensions. Length (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
1.6.14.5SizeBPackage dimensions. Width (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
1.6.14.6SizeCPackage dimensions. Height (in centimeters)integeryes, if other dimensions are indicated, in a range of 1 to 1,500
or
if the orders with the delivery mode “to parcel terminal”
1.6.14.7ItemItems (goods)
yes
1.6.14.7.1Amount

Quantity of goods of the same type (pcs). The maximum number is 999.

integeryes
1.6.14.7.2WareKeyIdentifier/item number of the goods.string(50)yes
1.6.14.7.3MarkingMarking of item.
If marking is indicated for Item, the Amount parametr can't be greater than 1.
stringno
1.6.14.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.14.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.14.7.6PaymentVATRateVAT rate included in the value of the goods (for more details, see Appendix No. 4)string(10)yes
1.6.14.7.7PaymentVATSumVAT amount included in the value (payment) of the goods.floatyes
1.6.14.7.8Weight

Weight (per item, in grams)

integeryes
1.6.14.7.9Comment

Name of the goods (may contain description of the goods: size, color)

string(255)yes
1.6.14.7.10WeightBruttoGross weight (for one unit of goods, in grams). Only for international orders.integerno
1.6.14.7.11CommentExName 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.14.7.12LinkLink to the e-shop’s website with the goods’ description. Only for international orders.string(255)no

1 The order is identified either by “DispatchNumber” or by "Number".

...

The CDEK server will return a result in the form of XML:

No.

Tag/ attribute

Description

Type of field

Mandatory (yes/no)

1

ResponseDocument title
yes

1.1

OrderOrder
yes

1.1.1

DispatchNumberCDEK order numberIntegeryes

1.1.2

NumberOrder number of the online storestring(40)yes

1.1.3

ErrorCodeError codestring(255)no

1.1.4

MsgFixed text “Orders changed”
Description of error (if any)
string(255)yes


Example. Order change

Code Block
languagexml
titleUpdateRequest
<?xml version="1.0" encoding="UTF-8"?>
<updaterequest account="0278f9e8004f6b08f37497001e804007"
    date="2019-01-23 11:20:45" number="soOEl" ordercount="1" secure="3e10b5b7d1da1dfa42cb70c329964ec2">
    <order deliveryrecipientcost="10.02" deliveryrecipientvatrate="VATX" deliveryrecipientvatsum="0.0" number="number-s785558445">    
        <package barcode="barcode-soOEl00" number="soOEl00" sizea="2.0" sizeb="3.0" sizec="4.0" weight="100.0">
            <item amount="2" comment="comment-soOEl000" cost="8.0" payment="10.0" paymentvatrate="VATX" paymentvatsum="0.0" warekey="warekey-soOEl000" weight="1.0"/>
        </package>
    </order>
</updaterequest>

...

No.

Tag/ attributeDescriptionType of fieldMandatory (yes/no)

1

DeleteRequestDocument title
yes

1.1

NumberAcceptance certificate number.
Order identifier in the IS of the CDEK client.
string(30)yes

1.2

DateDate of document (date of order)datetime/dateyes

1.3

AccountOnline store identifier (login)string(255)yes

1.4

SecureKeystring(255)yes

1.5

OrderCountThe total number of orders to be deleted in the documentintegeryes

2

OrderShipment (order)
yes

2.1

Number1Client's shipment number.
Order identifier in the IS of the CDEK client.
string(40)yes
2.2DispatchNumber1CDEK order numberintegeryes

...

The CDEK server will return a result in the form of XML:

No.

Tag / attributeDescriptionType of fieldMandatory (yes/no)

1

ResponseDocument title
yes

1.1

DeleteRequestOrders to be deleted
yes

1.1.1

MsgInformation messagestring(255)yes

1.1.2

OrderOrderintegeryes

1.1.2.1

NumberAcceptance certificate number. Order identifier in the IS of the CDEK client.string(40)yes

1.1.2.2

ErrorCodeError codestring(255)no

1.1.2.3

MsgFixed text “Order deleted”
Description of error (if any)
string(255)yes


Example. Order deletion

Code Block
languagexml
titleDeleteRequest
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deleterequest number="soOEl" ordercount="1" account="0278f9e8004f6b08f37497001e804007" date="2019-01-23 18:41:51" secure="3e10b5b7d1da1dfa42cb70c329964ec2">
	<order number="number-s785558445"/>
</deleterequest>

...

4.5.1. Description of Request Fields to be Transmitted

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1OrdersPrintDocument title
yes
1.1DateDate of document (date of invitation)datetime/dateyes
1.2AccountOnline store identifier (login)string(255)yes
1.3SecureKeystring(255)yes
1.4OrderCountTotal number of orders transmitted in a documentintegeryes
1.5CopyCountNumber of copies of a receipt per sheet. We recommend specifying at least 2: one will be attached to a cargo; another will be retained by the sender.integerno
1.6LangIdentifier of language in which the request is sent and the response is expectedstring(3)no
1.7OrderShipment (order)
yes
1.7.1DispatchNumber1CDEK shipment number (assigned when orders are imported). Order identifier in the IS of the CDEK client.integeryes
1.7.2Number1Client's shipment number. Order identifier in the IS of the CDEK client.string(30)yes
1.7.3Date1Date of an acceptance certificate, based on which the order has been transferred.dateyes

1 The order is identified either by “DispatchNumber” or by two parameters — Number and Date. If the request has a value of the “DispatchNumber” attribute, “Number” and “Date” attributes will be ignored.

...

No.

Tag / attributeDescriptionType of fieldMandatory (yes/no)

1

ResponseDocument title
yes

1.1

OrderOrder
yes

1.1.1

ErrorCodeError codestring(255)no

1.1.2

MsgError descriptionstring(255)yes

...

4.6.1. Description of Data to be Transmitted

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 CDEK city codeintegeryes, 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.49 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.16Address1Sender 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

Identification of sender city and receiver city (in the case of “to the door” mode) uses the following algorithm by order of priority:

...

No.

Tag / attributeDescriptionType of fieldMandatory (yes/no)

1

ResponseDocument title
yes

1.1

CallWaiting for a courier
yes

1.1.1

NumberInvitation numberstring(30)yes

1.1.2

ErrorCodeError codestring(255)no

1.1.3

MsgFixed text “Orders added”
Description of error (if any)
string(255)yes

...

4.7.1. Description of Input Parameters

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1ScheduleRequestDocument title.
yes
1.1DateDate of document (date of invitation)datetime/dateyes
1.2AccountOnline store identifier (login)string(255)yes
1.3NumberNumber of an acceptance certificate/waybill. Identifier of the list of cargoes in the IS of the CDEK client. You can use 1 as a default value.string(30)yes
1.4SecureKeystring(255)yes
1.5Order CountTotal number of requests for notification calls. Default value: 1.Integeryes
1.6OrderShipment (order)
yes
1.6.1DispatchNumber1CDEK shipment number (assigned when orders are imported).
Order identifier in the IS of a CDEK client.
integeryes
1.6.2Number1Client shipment number (unique for orders of a particular client). Order identifier in the Client's IS.string(40)yes
1.6.3Date1Date of document (date of order)datetime/dateyes
1.6.4AttemptTime of delivery.
yes
1.6.4.1IDID number of a schedule from the online store's database. You may use 1 as a default value.integeryes
1.6.4.2DateDate of delivery (only date, in the format “YYYY-MM-DD”, no time) as agreed by the receiverdateyes
1.6.4.3CommentCommentstring(255)no
1.6.4.4TimeBegStart of a delivery time range (receiver's time)timeyes
1.6.4.5TimeEndEnd of a delivery time range (receiver's time)еimeyes
1.6.4.6AddressNew 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.4.6.1StreetReceiver's street. If possible, do not specify prefixes of values, such as “str”string(50)yes
1.6.4.6.2HouseReceiver's house, building, block. If possible, do not specify prefixes of values, such as “house”string(30)yes
1.6.4.6.3FlatReceiver's flat/office. If possible, do not specify prefixes of values, such as “flat.”string(10)no
1.6.4.6.4PvzCodePickup 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 The order is identified either by “DispatchNumber” or by two parameters — Number and Date. If the request has a value of the “DispatchNumber” attribute, “Number” and “Date” attributes will be ignored.

...

The CDEK server will return a result in the form of XML:

No.

Tag / attributeDescriptionType of fieldMandatory (yes/no)

1

ResponseDocument title
yes

1.1

ScheduleResuestWaiting for a courier
yes

1.1.1

NumberInvitation numberstring(40)no

1.1.2

DispatchNumberCDEK order numberintegeryes

1.1.3

ErrorCodeError codestring(255)no

1.1.4

MsgFixed text or Description of error (if any)string(255)yes


Example. Recording of Notification Call Results

...

4.8.1. Description of Data to be Transmitted

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1OrdersPackagesPrintDocument title
yes
1.1DateDate of documentdatetime/dateyes
1.2AccountOnline store identifier (login)string(255)yes
1.3SecureKeystring(255)yes
1.4OrderCountTotal number of orders transmitted in a documentintegeryes
1.5CopyCountNumber of copies. Default value: 1integerno
1.6PrintFormatPrint format, acceptable values: A4, A5, A6 (A – Latin letter). Default value: A4string(2)no
1.7OrderShipment (order)
yes
1.7.1DispatchNumber1CDEK shipment number (assigned when orders are imported). Order identifier in the IS of the CDEK client.integeryes
1.7.2Number1Client's shipment number. Order identifier in the IS of the CDEK client.string(40)yes
1.7.3Date1Date of an acceptance certificate, based on which the order has been transferreddateyes

1 The order is identified either by “DispatchNumber” or by Number. If the request has a value of the “DispatchNumber” attribute, “Number” attribute will be ignored.

...

No.Tag/ attributeDescriptionType of fieldMandatory (yes/no)
1ResponseDocument title
yes
1.1OrderOrder
yes
1.1.1ErrorCodeError codestring(255)no
1.1.2MsgError descriptionstring(255)yes

...

4.9.1. Description of Data to be Transmitted

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1StatusReportDocument title
yes
1.1DateDate of requestdatetime/dateyes
1.2AccountClient identifier (login)string(255)yes
1.3SecureKeystring(255)yes
1.4ShowHistoryThe attribute indicating that the order history must be loaded (1 – yes, 0 – no)booleanno
1.5ShowReturnOrderThe attribute indicating that the list of return orders must be loaded (1 – yes, 0 – no)booleanno
1.6ShowReturnOrderHistoryThe attribute indicating that the history of return orders must be loaded (1 – yes, 0 – no)booleanno
1.7LangIdentifier of language in which the request is sent and the response is expectedstring(3)no
1.7ChangePeriod1The period during which the order status has changed.
no
1.7.1DateFirst3Start date of requested perioddatetime/dateyes
1.7.2DateLast3End date of requested perioddatetime/dateno
1.8Order1Shipment (order)
no
1.8.1DispatchNumber2CDEK shipment number (assigned when orders are imported). Order identifier in the CDEK IS.integeryes
1.8.2Number2Client's shipment number. Order identifier in the IS of the CDEK client.string(40)yes
1.8.3Date2Date of an acceptance certificate, based on which the order has been transferreddateyes

1 The request must contain at least one of two tags: ChangePeriod or Order:

...

The CDEK server will return a result in the form of XML:

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.7ReverseDispatchNumberReverse waybill number (number of the waybill in which the cargo is returned if there is an additional service #48 " REVERSE")integerno
2.8StatusCurrent order status
yes
2.8.1DateStatus date. Greenwich mean time indicateddatetimeyes
2.8.2CodeStatus code (for more details, see Appendix No. 5)integeryes
2.8.3DescriptionStatus namestring(100)yes
2.8.4CityCodeStatus change city, CDEK city codeintegeryes
2.8.5CityNameName of the status change citystring(100)yes
2.8.6State1Status change history
yes
2.8.6.1DateStatus datedatetimeyes
2.8.6.2CodeStatus code (for more details, see Appendix No. 5)integeryes
2.8.6.3DescriptionStatus namestring(100)yes
2.8.6.4CityCodeStatus change city, CDEK city codeintegeryes
2.8.6.5CityNameName of the status change citystring(100)yes
2.9ReasonCurrent additional status
yes
2.9.1DateAdditional status datedatetimeyes
2.9.2CodeAdditional status code (for more details, see Appendix No. 6)integerno
2.9.3DescriptionAdditional status namestring(100)no
2.10DelayReasonCurrent delay reason
yes
2.10.1DateDelay reason datedatetimeyes
2.10.2CodeDelay reason code (for more details, see Appendix No. 7)integerno
2.10.3DescriptionDelay reasonstring(50)no
2.10.4State1Delay reason history
yes
2.10.4.1DateDelay reason datedatetimeyes
2.10.4.2CodeDelay reason code (for more details, see Appendix No. 7)integerno
2.10.4.3DescriptionDelay reasonstring(50)no
2.11Package2Package
no
2.11.1NumberPackage number. Order identifier in the IS of еру CDEK client.string(20)yes
2.11.2

BarCode

Package barcode, package identifier

string(20)

yes

2.11.3Item2Items
yes
2.11.3.1WareKeyIdentifier/item number of the goods.string(20)yes
2.11.3.2MarkingMarking of itemstringno
2.11.3.3DelivAmountNumber of delivered items. Default value is equal to the number of items transferred for delivery.integeryes
2.11.3.4AmountQuantity of goods of the same type (pcs). The maximum number is 999.integeryes
2.12Attempt3Delivery time taken from the delivery schedule
no
2.12.1IDID number of a schedule from the online store's databaseintegeryes
2.12.2ScheduleCodeDelay reason code (for more details, see Appendix No. 7)integeryes
2.12.3ScheduleDescriptionDelay reasonstring(50)yes
2.13CallHistory of notification calls to the receiver
no
2.13.1.1CallGoodHistory of successful calls
no
2.13.1.1GoodSuccessful call
yes
2.13.1.1.1DateDate of a successful calldateyes
2.13.1.1.2DateDelivAgreed date of delivery/ pickupdateyes
2.13.2CallFailHistory of failed calls
no
2.13.2.1FailFailed call
yes
2.13.2.1.1DateDate of calldateyes
2.13.2.1.2ReasonCodeFailed call reason code (for more details, see Appendix No. 8)integeryes
2.13.2.1.3ReasonDescriptionReason for a failed callstring(255)yes
2.13.3CallDelayHistory of call reschedules
no
2.13.3.1DelayCall reschedule
yes
2.13.3.1.1DateDate of calldateyes
2.13.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, CDEK city codeintegeryes
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

1 The State tag is used only if ShowHistory = 1 (see the Description of Data to be Transmitted).

...

4.10.1. Description of Data to be Transmitted

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1InfoRequestDocument title
yes
1.1DateDate of requestdatetime/dateyes
1.2AccountClient identifier (login)string(255)yes
1.3SecureKeystring(255)yes
1.4ChangePeriodThe period during which the tariff has changed.
no
1.4.1DateBegStart date of requested perioddateno
1.4.2DateEndEnd date of requested perioddateno
1.5OrderShipment (order)
no
1.5.1DispatchNumber1CDEK shipment number (assigned when orders are imported). Order identifier in the CDEK IS.integeryes
1.5.2Number1Client's shipment number. Order identifier in the IS of a CDEK client.string(30)yes
1.5.3Date1Date of an acceptance certificate, based on which the order has been transferreddateyes

The order is identified either by “DispatchNumber” or by two parameters — Number and Date. If the request has a value of the “DispatchNumber” attribute, “Number” and “Date” attributes will be ignored.

...

The CDEK server will return a result in the form of XML:

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.1CodeCDEK city codeintegeryes
2.13.2PostCodePostal code of the citystring(6)yes
2.13.3NameCity namestring(50)yes
2.14RecCityReceiver's city
yes
2.14.1CodeCDEK city codeintegeryes
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


Info
titleInformation

The order information report method and order registration method refer to different modules of system, synchronization between which can take from several seconds to several minutes. We recommend to call order information report method after some time after creating an order.

...

In order to load the list of regions, it is necessary to send a GET request with the following parameters:

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1regionCodeExtRegion codestring(10)no
2regionCodeRegion code in the CDEK ISintegerno
3regionFiasGuidRegion code according to the Federal Information Address SystemUUIDno
4countryCodeCountry code in the format ISO 3166-1 alpha-2string(2)no
5countryCode ExtCode according to the Russian Classifier of Countries of the Worldintegerno
6pageNumber of the results page. Default value: 0integerno
7sizeLimitation on the number of results displayed. Default value: 1,000integeryes, if page is specified
8langLocalization. Default: “rus”.string(3)no


4.11.2. Response Format

The CDEK server returns a result with the following fields:

No.Tag / attributeDescriptionType of fieldMandatory (yes/no)
1regionUuidEntity identifier in the CDEK ISUUIDyes
2regionNameRegion namestring(255)yes
3prefixPrefix (possible values: region, territory, republic, autonomous okrug, region, city)string(20)no
4regionCodeExRegion codeString( 10)no
5regionCodeRegion code in the CDEK ISString( 10)no
6regionFiasGuidRegion code according to the Federal Information Address SystemUUIDno
7countryNameCountry namestring(255)yes
8countryCodeCountry code in the format ISO 3166-1 alpha-2Stringno
9countryCodeExtCode according to the Russian Classifier of Countries of the WorldStringno


Example 1. List of Regions in JSON

...

In order to load the list of cities, it is necessary to send a GET request with the following parameters:

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
8cityCodeCDEK city codeintegerno
9postcodePostal codestringno
10langLocalization. Default: “rus”.string(3)no

4.12.2. Response Format

The CDEK server returns a result with the following fields:

No.Tag/ attributeDescriptionType of fieldMandatory (yes/no)
1cityUuidEntity identifier in the CDEK ISUUIDyes
2cityNameCity namestring(255)yes
3cityCodeCDEK city codeintegeryes
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


Example 1.List of cities in JSON

...

4.13.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 CDEK city code

integeryes
9senderCity3Sender city namestringno
10senderCityPostCode3

Zip code of the origin city

integeryes
11receiverCityId3

Code of city of destination in accordance with CDEK city code

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
20modeId

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

integerno
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


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

...

The CDEK server will return a result:

No.Tag / attributeDescriptionType of field
1error

Array errors (for more details, see Appendix No. 9)


1.1codeError codeinteger
1.2textError textstring
2price

Price for delivery in RUB

double
3deliveryPeriodMin

Minimum delivery time in days

integer
4deliveryPeriodMaxMaximum delivery time in daysinteger
5deliveryDateMinMinimum delivery date, 'YYYY-ММ-DD', eg “2018-07-29”string
6deliveryDateMax

Maximum delivery date , 'YYYY-ММ-DD', eg “2018-07-30”

string
7tariffId

Tariff code, regarding to which the delivery cost was calculated

integer
8cashOnDelivery

Cash payment limits will appear if there is any

float
9priceByCurrencyThe price is in the currency at which the on-line store operates with the CDEK. Currency is determined by authLogin and secure.float
10currency

Price in currency, in which the web shop works with CDEK (for more details, see Appendix No. 3)

string
11percentVATThe rate of VAT for this client. It appears if authLogin and secure are transferred, and the rate of on-line store is determined from them. If the VAT rate is not stipulated by the terms of the contract, this parameter will not be displayed.integer
12servicesList of transmitted additional services (for more details, see Appendix 2)
12.1idService IDinteger
12.2titleService titlestring
12.3priceAdditional service cost without VAT in RUBfloat
12.4rateThe percentage to calculate the additional servicesfloat


Example. Calculate shipping cost

...

4.13.2.1. Description of Data to be Transmitted

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 CDEK city code

integeryes
9senderCityPostCode3

Zip code of the origin city

integeryes
10senderCity3Sender city namestringno
11receiverCityId3

Code of city of destination in accordance with CDEK city code

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

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

...

No.Tag / attributeDescriptionType of field
1tariffId

Tariff code, regarding to which the delivery cost was calculated

integer
2statusResponse status (true - successful, false - unsuccessful)string
3resultCost and delivery time of tariff
3.1error

Array errors (for more details, see Appendix No. 9)


3.1.1codeError codeinteger
3.1.2textError textstring
3.2price

Price for delivery in RUB

double
3.3deliveryPeriodMin

Minimum delivery time in days

integer
3.4deliveryPeriodMaxMaximum delivery time in daysinteger
3.5cashOnDeliveryCash payment limits will appear if there is anyfloat
3.6priceByCurrencyThe price is in the currency that was transfered in the requestfloat
3.7currencyPrice in currency that was thransfered in the requeststring
3.8percentVATThe rate of VAT for this client. It appears if authLogin and secure are transferred, and the rate of on-line store is determined from them. If the VAT rate is not stipulated by the terms of the contract, this parameter will not be displayedinteger
3.9servicesList of transmitted additional services (for more details, see Appendix 2)
3.9.1idService IDinteger
3.9.2titleService titlestring
3.9.3priceAdditional service cost without VAT in RUBfloat
3.9.4rateThe percentage to calculate the additional servicesfloat

...

Code

Tariff name

Delivery mode

Weightlimit

Service

Description

7International express documents door–doordoor–door (D-D)up to 5 kgInternational expressExpress delivery for / from abroad of documents and letters.
8International express freight door–door door–door (D-D)up to 30 kgInternational expressExpress delivery to / from abroad of goods and parcels up to 30 kg.

136

Warehouse–warehouse parcel

warehouse–warehouse (W-W)

up to 30 kg




Parcel

Economy delivery of goods across Russia for e-commerce companies.

137

Warehouse–door parcel

warehouse–door (W-D)

138

Door–warehouse parcel

Door–warehouse (D-W)

139

Door–door parcel

door–door (D-D)

366

Parcel door-parcel terminal

door-parcel terminal (D-T)
368Parcel warehouse-parcel terminalwarehouse-parcel terminal (W-T)
178International express freight warehouse–warehousewarehouse–warehouse (W-W)up to 30 kgInternational expressExpress delivery to / from abroad of goods and parcels up to 30 kg.
179International express freight warehouse–doorwarehouse–door (W-D)
180International express freight door–warehousedoor–warehouse (D-W)
181International express documents warehouse–warehousewarehouse–warehouse (W-W)up to 5 kgInternational expressExpress delivery for / from abroad of documents and letters.
182International express documents warehouse–doorwarehouse–door (W-D)
183International express documents door–warehousedoor–warehouse (D-W)
231Economy door–door parceldoor–door (D-D)

up to 50 kg


Economy parcel


Economy delivery of goods by road/rail across Russia for e-commerce companies.

This tariff is applicable to directions from Moscow to CDEK offices located east of the Urals and in Crimea.


232Economy door–warehouse parceldoor–warehouse (D-W)

233

Economy warehouse–door parcel

warehouse–door (W-D)

234

Economy warehouse–warehouse parcel

warehouse–warehouse (W-W)

376Economic parcel door-parcel terminaldoor-parcel terminal (W-T)
378Economic parcel warehouse-parcel terminalwarehouse-parcel terminal (W-T)

291

CDEK Express warehouse-warehouse

warehouse–warehouse (W-W)


CDEK Express

Delivery of goods from abroad to Russia, Ukraine, Kazakhstan, Kyrgyzstan, Uzbekistan including customs clearance.

Two options of the service:

1) We pick up a cargo in a foreign country, import it to the RF, clear it through customs, and deliver it to the client

2) The client imports a cargo to Russia on its own. We clear it through Russian customs and deliver it to the client

293

CDEK Express door–door

door–door (D-D)

294

CDEK Express warehouse–door

warehouse–door (W-D)

295

CDEK Express door–warehouse

door–warehouse (D-W)

Chinese Express Tariffs

Code

Tariff name

Delivery mode

Weightlimit

Service

Description

243

Chinese Express

warehouse–warehouse (W-W)


Chinese Express

Delivery from China to Russia, Belarus and Kazakhstan. Cost of delivery is divided into intervals:

  • up to 200 g;

  • every additional 100 g up to 1 kg;

  • every additional kilogram in excess of 1 kg;

245

Chinese Express

door–door (D-D)


246

Chinese Express

warehouse–door (W-D)


247

Chinese Express

door–warehouse (D-W)

Regular Delivery Tariffs

CodeTariff nameDelivery modeWeight limitServiceDescription
1Express light door–doordoor–door (D-D)up to 30 kgExpressClassical express delivery of documents and cargoes up to 30 kg.
361Express lite door-parcel terminaldoor-parcel terminal (D-T)
363Express lite warehouse-parcel terminalwarehouse-parcel terminal (W-T)
3Super express up to 18 kgdoor–door (D-D)
Express deliveryExpress delivery of documents and cargoes “from hand to hand” across Russia by a certain hour.
5Economy express warehouse–warehousewarehouse–warehouse (W-W)
Economy deliveryCheap delivery of goods across Russia by rail and by road (longer delivery period).
10Express light warehouse-warehousewarehouse–warehouse (W-W)up to 30 kgExpressClassic Express delivery of documents and cargo within the Russian Federation, Belarus, Kazakhstan, Armenia, Kyrgyzstan and between these countries.
11Express light warehouse–doorwarehouse–door (W-D)up to 30 kgExpress
12Express light door–warehousedoor–warehouse (D-W)up to 30 kgExpress
15Express heavy warehouse-warehousewarehouse–warehouse (W-W)from 30 kgExpressClassic Express delivery within Russia, Belarus, Kazakhstan, Armenia, Kyrgyzstan and between these countries.
16Express heavy warehouse–doorwarehouse–door (W-D)from 30 kgExpress
17Express heavy door–warehousedoor–warehouse (D-W)from 30 kgExpress
18Express heavy door–doordoor–door (D-D)from 30 kgExpress
57Super express up to 9 a.m.door–door (D-D)up to 30 kgExpress deliveryExpress delivery of documents and cargoes “from hand to hand” across Russia by a certain hour (delivery within 1–2 days).
58Super express up to 10 a.m.door–door (D-D)up to 30 kgExpress deliveryExpress delivery of documents and cargoes
“from hand to hand” across Russia by a certain hour (delivery within 1–2 days).
59Super express up to 12 p.m.door–door (D-D)up to 30 kgExpress deliveryExpress delivery of documents and cargoes “from hand to hand” across Russia by a certain hour (delivery within 1–2 days).
60Super express up to 14 p.m.door–door (D-D)up to 30 kgExpress deliveryExpress delivery of documents and cargoes “from hand to hand” across Russia by a certain hour (delivery within 1–2 days).
61Super express up to 16 p.m.door–door (D-D)up to 30 kgExpress deliveryExpress delivery of documents and cargoes “from hand to hand” across Russia by a certain hour (delivery within 1–2 days).
62Long-distance express warehouse–warehousewarehouse–warehouse (W-W)
Economy deliveryFast economy delivery of cargoes across Russia
63Long-distance super express warehouse-warehousewarehouse–warehouse (W-W)
Economy deliveryFast economy delivery of cargoes by a certain hour
118Economy express door–door door–door (D-D)
Economy deliveryLow-cost delivery of goods within the Russian Federation, Belarus, Kazakhstan, Armenia, Kyrgyzstan and between these countries, railway and road transport (delivery of goods with an increase in time).
119Economy express warehouse–doorwarehouse–door (W-D)
120Economy express door–warehousedoor–warehouse (D-W)
121Main express door–doordoor–door (D-D)
Economy deliveryFast economical cargo delivery in Russia.
122Main express warehouse–doorwarehouse–door (W-D)
123Main express door–warehousedoor–warehouse (D-W)
124Main super express door–doordoor–door (D-D)
Economy deliveryFast economical cargo delivery by a specific hour.
125Main super express warehouse–door warehouse–door (W-D)

126Main super express door–warehousedoor–warehouse (D-W)

480Express door-doordoor–door (D-D)
ExpressClassic express delivery of documents and cargoes according to standard delivery times within the country (Russia, Belarus, Armenia, Kyrgyzstan, Kazakhstan). It also operates in directions between the countries of the customs community (Russia, Belarus, Armenia, Kyrgyzstan, Kazakhstan).
No weight limits
481Express door-warehousedoor–warehouse (D-W)
482Express warehouse-doorwarehouse–door (W-D)
483Express warehouse-warehousewarehouse–warehouse (W-W)
485Express door-parcel terminaldoor-parcel teminal (D-PT)
486Express warehouse-parcel terminalwarehouse-parcel terminal (W-PT)
361Express lite door-parcel terminaldoor-parcel teminal (D-PT)up to 30 kgExpressClassical express delivery of documents and cargoes across Russia.
363

Express lite warehouse-parcel terminal

warehouse-parcel terminal (W-PT)

...