Basic Data Types
The Data Exchange Protocol uses the following data types:
string(n) is the text string, where n is the maximum number of characters.
integer is an integer value in the interval from 0 to 1,000,000.
long is an integer value in the interval from 0 to 10,000,000,000.
float is a floating-point number, a period is used as a separator.
boolean is a boolean value (possible values: true or false).
dateTime is date and time in ISO 8601 format: YYYY-MM-DDThh:mm:ss±hhmm).
date is the date in ISO 8601 format: YYYY-MM-DD.
time is the time in the ISO 8601 format: hh:mm.
UUID is a 16-byte number. For example: 8dea00e3-9aab-4d8e-887c-ef2aaa546456.
money is the price of the service/product, including tax
Field name | Description | Field type | Mandatory (yes/no) |
value | Amount in currency | float | yes |
vat_sum | VAT amount | float | no |
vat_rate | VAT rate (value – 0, 10, 20, null – no VAT) | integer | no |
threshold is the extra delivery charge depending on the price of product
Field name | Description | Field type | Mandatory (yes/no) |
threshold | Threshold price of product (defined as less than or equal to) in integer values of the currency | integer | yes |
sum | Extra delivery charge, the total value of which is within the interval | float | yes |
vat_sum | VAT amount included in the extra delivery charge | float | no |
vat_rate | VAT rate (value – 0, 10, 20, null – no VAT) | integer | no |
contact is the details of a contractor (receiver, sender)
Field name | Description | Field type | Mandatory (yes/no)* |
company | Company | string(255) | no |
name | Full name of a contact person | string(255) | yes |
List of phones | phone[] | no | |
phones | string(255) | yes | |
passport_series | Passport series | string(255) | no |
passport_number | Passport number | string(255) | no |
passport_date_of_issue | Date of issue of a passport | date | no |
passport_organization | Body which issued a passport | string(255) | no |
passport_date_of_birth | Date of birth | date | no |
tin | INN (Taxpayer Identification Number) | string(255) | no |
passport_requirements_satisfied | Requirements for passport data are satisfied (actual for international orders): true - passport data is collected or not required false - passport data is required and not collected | boolean | no |
*Depends on the order type and contractor
phone is the phone number (mobile/landline)
Field name | Description | Field type | Mandatory (yes/no) |
number | Phone number To be transmitted in the international format: country code (for Russia +7) and phone number (10 or more digits) | string(255) | yes |
additional | Additional information (additional number) | string(255) | no |
seller is the details of a real seller
Field name | Description | Field type | Mandatory (yes/no) |
name | Name of a real seller | string(255) | no |
inn | INN (Taxpayer Identification Number) of a real seller | string(20) | no |
phone | Phone of a real seller | string(255) | no |
ownership_form | Form of ownership code | integer | no |
address | Address of a real seller. Used in printing the invoices to show the address of a real seller or a trade name | string(255) | no |
location is the address of a contractor (sender, receiver), including location-based data
Field name | Description | Field type | Mandatory (yes/no) |
code | CDEK location code ("List of Cities" method) | integer | no |
fias_guid | FIAS unique identifier | UUID | no |
postal_code | Postal code | string(255) | no |
longitude | Longitude | float | no |
latitude | Latitude | float | no |
country_code | Country code in the format: ISO_3166-1_alpha-2 | string(2) | no |
region | Region name | string(255) | no |
sub_region | Name of region's district | string(255) | no |
city | City name | string(255) | no |
kladr_code | KLADR (Russian Classifier of Addresses) code Deprecated field | string(255) | no |
address | Address string | string(255) | yes |
service is details of additional services
Field name | Description | Field type | Mandatory (yes/no) |
code | Additional service code | integer | yes |
parameter | Additional service parameter | string | no |
package is the details of order packages
Field name | Description | Field type | Mandatory (yes/no) |
number | The package number (can be used as sequence package number or order number), unique for this order. Order identifier in the Client's IS. | string(255) | yes |
weight | Total weight (in grams) | integer | yes |
length | Package dimensions. Length (in centimeters) | integer | no |
width | Package dimensions. Width (in centimeters) | integer | no |
height | Package dimensions. Height (in centimeters) | integer | no |
comment | Comments for the package | string(255) | no |
items | Items in the package | item[] | no |
item is details of items included in the order package (only for orders of e-shop type)
Field name | Description | Field type | Mandatory (yes/no) |
name | Product name (may also contain product description: size, color) | string(255) | yes |
ware_key | Identifier/item number of the goods | string(20) | yes |
payment | Cash on delivery (per unit in the specified currency, value >=0) – cash on delivery, value = 0 – prepayment | money | yes |
cost | Declared value of the goods (per unit in the specified currency, value >=0). This value is used to calculate the amount of insurance. | float | yes |
weight | Weight (per unit, in grams) | integer | yes |
weight_gross | Gross weight | integer | no |
amount | Number of units (pcs) | integer | yes |
name_i18n | Name in foreign language | string(255) | no |
brand | Brand in foreign language | string(255) | no |
country_code | Country code in the format: ISO_3166-1_alpha-2 | string(2) | no |
material | Material code | string(255) | no |
wifi_gsm | Contains wifi/gsm | boolean | no |
url | Link to the website of the e-shop with description of the goods | string(255) | no |
error is the details of a request processing error from the CDEK IS
Field name | Description | Field type | Mandatory (yes/no) |
code | Error code | string(255) | yes |
message | Error description | string(255) | yes |
status is the status of order or invitation
Field name | Description | Field type | Mandatory (yes/no) |
code | Status code | string(255) | yes |
name | Status name | string(255) | yes |
date_time | Date and time of status setting (format yyyy-MM- dd'T'HH:mm:ssZ) | datetime | yes |
reason_code | Additional status code | string(2) | no |
city | Place of origin of the status | string(255) | no |
© 2000—2022, Курьерская компания СДЭК