Page tree

Versions Compared

Key

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

...

Answers to frequently asked questions can be found at https://www.cdek.ru/faq_integrator.html.Please send your requests for account generation, questions and proposals to our email: integrator@cdek

We accept questions and wishes of clients by e-mail: integrationtor@cdek.ru.

Symbols

Note
titleNote

Information marked with this symbol is important and must be read and/or followed.

...

  • If you have selected a ready-made partner module and need advice on configuration, please refer to the developer or support service of this module.

  • If you want to implement your own solution, you should try all preliminary settings under your test account.

Step 5: After you have tried everything and settled all issues, request a live everything has been verified (tested, all problems are resolved), you should receive an access key to the "combat" account (Account and Secure password) for integration by sending an email to integrator@cdek.ru. Please do not forget to specify the ID of your contract with CDEK. . The keys can be obtained in your CDEK personal account at the link: https://lk.cdek.ru/integration/index. To do this, in your personal account in the "Integration" section, click the "Create a key" button, after which the account ID and password will appear in this section.

Step 6: You can switch over to the live account and work in the normal mode.

...

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 (https://cdek.ru/storage/source/document/1/CDEK_city.zip)integeryes
1.6.3RecCityCode1Receiver's city code from the CDEK base (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.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


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 (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 city code from the CDEK base (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

...