Page tree

Versions Compared

Key

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

...

Version

Revision date

Revision description

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

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

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

A recommended phone number format has been described

1.5February 19, 2019Added description of the API calculator

Introduction

General Description

...

  • tariff code under which the order has been delivered;

  • price of CDEK services invoiced for the order (i.e. invoiced amount);

  • date of the last change in the order amount;

  • method of order delivery to the receiver (courier, pickup);

  • type of cash on delivery payment.

12. Calculator allows to calculate the delivery cost of one shipment for the defined input parameters.

1.1. Parcel Identifiers and Label Information

...

Code Block
languagexml
titleResponse
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Locations>
    <Location cityName="Sprockhövel" cityCode="34133" cityUuid="1d2ec7b1-f2f1-4190-bd60-44d336a615e7" country="Germany" countryCode="DE" region="North Rhine-Westphalia" regionCode="763" subRegion="Ennepe-Ruhr-Kreis" latitude="51.34669" longitude="7.24343"/>
    <Location cityName="Lüneburg" cityCode="8810" cityUuid="1f4a11a1-99c0-4d9e-999d-ae680e4c557d" country="Germany" countryCode="DE" region="Lower Saxony" regionCode="641" subRegion="Landkreis Lüneburg" latitude="53.2509" longitude="10.41409"/>
    <Location cityName="Westerstede" cityCode="53043" cityUuid="21df83e1-7ec7-49f8-a8b5-cbcf06365638" country="Germany" countryCode="DE" region="Lower Saxony" regionCode="641" subRegion="Landkreis Ammerland" latitude="53.25682" longitude="7.92737"/>
</Locations>

Appendices

Appendix 1. CDEK Tariffs and Delivery Modes

Tariffs for Online Stores

...

Code

...

Tariff name

...

Delivery mode

...

Service

...

Description

...

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

...

4.14
Anchor
Calculator
Calculator
Calculator

To get the rate and transit time you should send json-object to CDEK server to the following address:

4.14.1. Description of Data to be Transmitted

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

The version by used API, e.g. “1.0”.

stringyes
2authLogin1Client identifierstringno
3secure1Keystringno
4dateExecute2

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

dateno
5senderCityId3

Origin city code in accordance with city codes provided by CDEK (file City_XXX_YYYYMMDD.xls»)

integeryes
6senderCityPostCode3

Zip code of the origin city

integeryes
7receiverCityId3

Code of city of destination in accordance with city codes provided by CDEK (file «City_XXX_YYYYMMDD.xls»)

integeryes
8receiverCityPostCode3

City of destination zip code

integeryes
9tariffId4Code of chosen tariff (for more details, see Appendix No. 1)integeryes
10tariffList4List of tariffs
yes
10.1priority

The specified priority

integeryes
10.2id

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

integeryes
10.3modeId

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

integerno
11goodsLocation's dimension
yes
11.1weightWeight (in kilograms)floatyes
11.2lengthLength (in centimeters)integeryes
11.3widthWidth (in centimeters)integeryes
11.4heightHeight (in centimeters)integeryes
11.5volume5Shipment's volume (in cubic meters)floatyes
12servicesList of additional service (for more details, see Appendix No. 2)
no
12.1idNumber identifier of additional serviceintegeryes
12.2param6Parameter of additional service if necessaryintegerno


1 Authorization is not obligatory. Parameters: authLogin, secure might be not provided. Authorization allows taking into account individual rates and discounts, if the web shop has any.

2 The planning shipment date dateExecute is not obligatory (in this case the current date will be used). But if you work with the authorization the date must be transmitted mandatory because the date is taking into account while decoding the password.

3 A city can be identified in one of two ways at the user's discretion:

  • by unique city code from the CDEK database (city ID). Values are transferred in senderCityId and receiverCityId attributes;
  • by postal code of the city. Values are transferred in senderCityPostCode and receiverCityPostCode attributes; 
  • if putting both values then senderCityId/receiverCityId is taking, senderCityPostCode/receiverCityPostCode should be ignored.

It should be noted that the database of postal codes in the CDEK IS may contain incomplete and sometimes inaccurate information on postal codes. Therefore, the user should be able to adjust the postal code parameter, if necessary.

Note: At present, CDEK IS contains postcodes only for Russia. To identify cities of other countries, we recommend using a city code from the CDEK database.

4 While specifying the rates you should choose one tariff or the list of rates with priorities. If you specified tariffId, and tariffList – tariffId will be chosen, the list will be ignored.

The list of tariffs with the priorities used in the case, if the selected direction at CDEK may not be the most beneficial to you of any particular rate of delivery.

In the case of an assignment of price list this list is checked for the possibility of delivery in a given direction with a given weight of cargo sequentially (starting from the first with the least priority) and the verify process will continue until the rate will give the possibility. In this case the price will be calculated by this rate.  In server’s reply it would be returned tariffId from the specified list tariffList, according to which the price was calculated.

The mode of delivery can be specified by modeId and it makes sense only in specifying the list of tariffs. In this case the specified list is additionally filtered by delivery mode otherwise – ignored.

5 The locations in the list can be specified by the first option (using weight, length, width and height), the second (using weight and volume) and combining these options (one piece in first, another second, etc.). Shipping cost will be calculated based on the highest values of physical or volume weight.

6 For additional services 2, 24, 25 and 32, the parameter value is mandatory and must be passed in the request. For service 2 - insurance in param it is necessary to transfer the amount from which the insurance will be calculated (must be transferred in the currency of mutual settlements). Service 30 is only available for an on-line store contract, so the request must be passed the values of authLogin and secure. For services 24, 25 and 32, a quantity value is transmitted to param.

4.14.2. Response Format

The CDEK server will return a result:


No.Tag / attributeDescriptionType of field
1error

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


2codeError codeinteger
3textError textstring
4price

Price for delivery in RUB

double
5deliveryPeriodMin

Minimum delivery time in days

integer
6deliveryPeriodMaxMaximumdelivery time in daysinteger
7deliveryDateMinMinimum delivery date, 'YYYY-ММ-DD', eg “2018-07-29”string
8eliveryDateMax

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

string
9tariffId

Tariff code, regarding to which the delivery cost was calculated

integer
10cashOnDelivery

Cash payment limits will appear if there is any

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

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

string
13percentVATThe 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
14servicesList of transmitted additional services (for more details, see Appendix 9)
14.1idService IDinteger
14.2titleService titlestring
14.3priceAdditional service cost without VAT in RUBfloat
14.4rateThe percentage to calculate the additional servicesfloat


Пример. Расчет стоимости доставки

Code Block
languagexml
firstline1
titleRequest
{ 
	"version":"1.0",
	"dateExecute":"2018-07-27", 
	"senderCityId":"270", 
	"receiverCityId":"44", 
	"tariffId":"137", 
	"goods": 
		[ 
			{ 
				"weight":"0.3", 
				"length":"10", 
				"width":"7", 
				"height":"5" 
			}, 
			{ 
				"weight":"0.1", 
				"volume":"0.1" 
			} 
		],
	"services": [
		{	
			"id": 2,	
			"param": 2000	
		},
		{	
			"id": 30
		}
	]
} 	
Code Block
languagexml
firstline1
titleResponse
{
	"result": {
		"price": "2555",
		"deliveryPeriodMin": 2,
		"deliveryPeriodMax": 3,
		"deliveryDateMin": "2018-07-28",
		"deliveryDateMax": "2018-07-29",
		"tariffId": "137",
		"cashOnDelivery": "30000.00",
		"percentVAT": 18,
		"priceByCurrency": 2555,
		"currency": "RUB",
		"services": [
			{
				"id": 2,
				"title": "Insurance",
				"price": 15
			},
			{
				"id": 30,
				"title": "Home fitting",
				"price": 0
			}
		]
	}
}



Appendices

Appendix 1. CDEK Tariffs and Delivery Modes

Tariffs for Online Stores

Code

Tariff name

Delivery mode

Weightlimit

Service

Description

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

warehouse–door (W-D)

139

Door–door parcel

door–door (D-D)

233

Economy warehouse–door parcel

warehouse–door (W-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.

234

Economy warehouse–warehouse parcel

warehouse–warehouse (W-W)

291

CDEK Express warehouse-warehouse

warehouse–warehouse (W-W)


CDEK Express

Delivery of goods from abroad to Russia, including customs clearance.

Three 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. The order is executed as, e.g., “Beijing-“Novosibirsk”

2) The client imports a cargo to Russia on its own. We clear it through Russian customs and deliver it to the client. The order is executed, e.g., as Moscow–Novosibirsk.

3) The client imports a cargo to Russia and clears it to the Russian customs. We only deliver it to the client. The order is executed, e.g., as Moscow–Novosibirsk.

293

CDEK Express door–door

door–door (D-D)

294

CDEK Express warehouse–door

warehouse–door (W-D)

295

CDEK Express door–warehouse

warehouse–door (W-D)

...

You can get more detailed information about services for the Help Desk by phone 8-800-250-04-05 (toll free) or from CDEK managers in office of your city.


Appendix 3. Currencies

CodeParameterReceiver's country
RUBRussian rubleRussia
USDUS dollarUnited States
EUREuroCountries of Europe
KZTTengeKazakhstan
GBPPound sterlingUnited Kingdom
CNYYuanChina
BYNBelarusian rubleBelarus
UAHGrzywnaUkraine
AMDArmenian dramArmenia
KGSKyrgyzstani somKyrgyzstan
TLTurkish liraTurkey
THBThai
bahtThailand
bahtThailand
KRWSouth korean wonSouth Korea
AEDUAE dirhamUnited Arab Emirates
UZSUzbek sumUzbekistan
MNTMongolian tugrikMongolia


Appendix 4. VAT Rates

IdentifierType of VAT rate
VATXFREE OF VAT
VAT00%
VAT1010%
VAT1818%
VAT2020%

...

CodeReason
1Phone is busy
2The subscriber does not answer
3Subscriber unavailable
4Wrong Number
5Phone unknown
6Silence
7Reset
8Hung up

...

Appendix 9. Possible calculator errors

CodeError text

0

Internal server mistake. Please consult to CDEK IT team for correction.

1

The API that you provided is not supported

2

Authorization mistake

3

Impossible to deliver to this area under given conditions

4

Error when specifying the parameters

5

No pieces are specified for sending

6

No tariff or tariffs list

7

No city of origin

8

No city of destination

9

No date of shipping is specified while authorization

10

Mode of delivery mistake

11

Incorrectly specified data format

12

Decoding data mistake. Awaiting <json или jsop>

13

No zip code for city of origin in CDEK database

14

Impossible to uniquely identify the city of origin by zip code

15

No zip code for city of destination in CDEK database

16

Impossible to identify the city of destination by zip code