Page tree

Versions Compared

Key

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

...

No.

Field name

Description

Field type

Mandatory(yes/no)

1

type

Order type:

  1. “e-shop” (only for e-shop contracts)

  2. delivery (for any contract)

Default value: 1

integer

no

2

number

Order number in the Client IS (if it is not sent, the order number will be assigned in CDEK IS – uuid)

Only for orders of e-shop type
Сan contain only numbers, letters of the Latin alphabet or special characters (ASCII format).

string(40)

no

3

tariff_code

Tariff code (for more details, see Appendix 1)

integer

yes

4

comment

Comment for the order

string(255)

no

5developer_keyDeveloper keystring()no
6

shipment_point1

Code of the CDEK pickup point to which the client will deliver the shipment.

Cannot be used concurrently with from_location

string(255)

yes, if order with "from warehouse" tariff

7

delivery_point1

Code of the CDEK pickup point to which the parcel will be delivered

Cannot be used concurrently with to_location

string(255)

yes, if order with "to warehouse" or "to parcel terminal" tariff 

8

date_invoice

Date of invoice

Only for orders of e-shop type

date (yyyy-MM-dd)

yes, if the order is of international type

9

shipper_name

Consignor

Only for orders of e-shop type

string(255)

yes, if the order is of international type

10

shipper_address

Consignor's address

Only for orders of e-shop type

string(255)

yes, if the order is of international type

11

delivery_recipient_cost

Extra delivery charge collected by the e-shop from the receiver.

Only for orders of e-shop type

money

no

11.1

value

Amount of additional charge

float

yes

11.2

vat_sum

VAT amount

float

no

11.3

vat_rate

VAT rate (value – 0, 10, 18, 20, etc.; null – no VAT)

integer

no

12

delivery_recipient_cost_adv

Extra delivery charge collected by the e-shop from the receiver, depending on the order amount

Only for orders of e-shop type. It is possible to send several thresholds

threshold[]

no

12.1

threshold

Threshold price of product (defined as less than or equal to) in integer values of the currency

integer

yes

12.2

sum

Extra delivery charge, the total value of which is within the interval

float

yes

12.3

vat_sum

VAT amount included in the extra delivery charge

float

no

12.4

vat_rate

VAT rate (value – 0, 10, 18, 20, etc.; null – no VAT)

integer

no

13

sender

Sender

contact

no, if the order is of e- shop type

yes, if the order is of delivery type

13.1

company

Company’s name

string(255)

no, if the order is of e- shop type

yes, if the order is of delivery type

13.2

name

Contact person's full name

string(255)

no, if the order is of e- shop type

yes, if the order is of delivery type

13.3

email

Email

string(255)

no, if the order is of e- shop type

yes, if the order is of delivery type

13.4

phones

List of phones

No more than 10 numbers

phone[]

no, if the order is of e- shop type

yes, if the order is of delivery type

13.4.1

number2

Phone number

It should be transmitted in the international format: country code (for Russia +7) and phone number (10 or more) digits)

string(255)

no, if the order is of e-shop type

yes, if the order is of delivery type

13.4.2

additional

Additional information (additional number)

string(255)

no

14

seller

Details of a real seller

Only for orders of e-shop type

seller

yes, if the order is of international type

14.1

name

Name of a real seller

string(255)

yes, if inn is filled out

14.2

inn

INN (Taxpayer Identification Number) of a real seller

Can contain 10 or 12 characters

string(12)

no

14.3

phone

Phone of a real seller

string(255)

yes, if inn is filled out

14.4

ownership_form

Form of ownership code (for more details, see Appendix 3)

integer

yes, if inn is filled out

14.5

address

Address of a real seller. Used in printing the invoices to show the address of a real seller of the goods, or a brand name.

For international orders of e-shop type

string(255)

yes, if the order is of international type

15

recipient

Receiver

contact

yes

15.1

company

Company’s name

string(255)

no

15.2

name

Contact person's full name

string(255)

yes

15.3

passport_series

Passport series

string(4)

no

15.4

passport_number

Passport number

string(30)

no

15.5

passport_date_of_issue

Date of issue of a passport

date(yyyy-MM-dd)

no

15.6

passport_organization

Body which issued a passport

string(255)

no

15.7

tin

INN (Taxpayer Identification Number)

Can contain 10 or 12 characters

string(12)

no

15.8

passport_date_of_birth

Date of birth

date (yyyy-MM-dd)

no

15.9

email

Email

Must comply with RFC 2822

string(255)

no

15.10

phones

List of phones

No more than 10 numbers

phone[]

yes

15.10.1

number2

Phone number

It should be transmitted in the international format: country code (for Russia +7) and phone number (10 or more digits)

string(255)

yes

15.10.2

additional

Additional information (additional number)

string(255)

no

16

from_location1

Sender's address

Cannot be used concurrently with shipment_point

location

yes, if order with "from door" tariff

16.1

code

CDEK location code ("List of Cities" method)

integer

no

16.2

fias_guid

FIAS unique identifier

UUID

no

16.3

postal_code

Postal code

string(255)

no

16.4

longitude

Longitude

float

no

16.5

latitude

Latitude

float

no

16.6

country_code

Country code in the format: ISO_3166-1_alpha-2

string(2)

no

16.7

region

Region name

string(255)

no

16.8

sub_region

Name of region's district

string(255)

no

16.9

city

City name

string(255)

no

16.10

kladr_code

KLADR (Russian Classifier of Addresses) code

Deprecated field

string(255)

no

16.11

address

Address string

string(255)

yes

17

to_location1

Receiver's address

Cannot be used concurrently with delivery_point

location

yes, if order with "to door" tariff

17.1

code

CDEK location code ("List of Cities" method)

integer

no

17.2

fias_guid

FIAS unique identifier

UUID

no

17.3

postal_code

Postal code

string(255)

no

17.4

longitude

Longitude

float

no

17.5

latitude

Latitude

float

no

17.6

country_code

Country code in the format: ISO_3166-1_alpha-2

string(2)

no

17.7

region

Region name

string(255)

no

17.8

sub_region

Name of region's district

string(255)

no

17.9

city

City name

string(255)

no

17.10

kladr_code

KLADR (Russian Classifier of Addresses) code

Deprecated field

string(255)

no

17.11

address

Address string

string(255)

no

18

services

Additional services

service[]

no

18.1

code

Type of additional service (for more details, see Appendix 4)

integer(16)

yes

18.2

parameter

Additional service parameter:

  • Number of packages. It is used and is mandatory only for PACKAGE_1, COURIER_PACKAGE_A2, SECURE_PACKAGE_A2, SECURE_PACKAGE_A3, SECURE_PACKAGE_A4, SECURE_PACKAGE_A5, CARTON_BOX_XS, CARTON_BOX_S, CARTON_BOX_M, CARTON_BOX_L, CARTON_BOX_500GR, CARTON_BOX_1KG, Фото документовCARTON_BOX_2KG, CARTON_BOX_3KG, CARTON_BOX_5KG, CARTON_BOX_10KG, CARTON_BOX_15KG, CARTON_BOX_20KG, CARTON_BOX_30KG, CARTON_FILLER (for all orders types).

  • Declared value of the package. It is used and is mandatory only for INSURANCE (only for orders of delivery type).

  • Length of package. It is used and is mandatory only for BUBBLE_WRAP, WASTE_PAPER (for all orders types).

string()

no

19

packages

List of details of cargo packages

The number of places in the order can be from 1 to 255.

package[]

yes

19.1

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(20)

yes

19.2

weight

Total weight (in grams)

integer

yes

19.3

length

Package dimensions. Length (in centimeters)

integer

yes, if other dimensions are specified
yes, if the "to parcel terminal" order 
yes, if total weight >= 100 

19.4

width

Package dimensions. Width (in centimeters)

integer

yes, if other dimensions are specified
yes, if the "to parcel terminal" order
yes, if total weight >= 100 

19.5

height

Package dimensions. Height (in centimeters)

integer

yes, if other dimensions are specified
yes, if the "to parcel terminal" order
yes, if total weight >= 100 

19.6

comment

Comments for the package
Mandatory and only for delivery type orders

string(255)

no

19.7

items

Items in the package

Only for orders of e-shop type
Maximum 126 unique positions in one order.
The total number of items in an order can be from 1 to 10,000.

item[]

yes

19.7.1

name

Product name (may also contain product description: size, color)

string(255)

yes

19.7.2

ware_key

Identifier/item number of the goods

Identifier/item number can only contain characters: [A-z A-z 0-9! @ "# # $;% ^: &? * () _ - + =? <>,. {} [] \ /, Space]

string(50)

yes

19.7.3marking3

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

string()no
19.7.4

payment

Cash on delivery (per unit in the recipient country currency, value >=0) — cash on delivery, value = 0 – prepayment

money

yes

19.7.4.1

value

Cash on delivery amount (prepayment = 0)

float

yes

19.7.4.2

vat_sum

VAT amount

float

no

19.7.4.3

vat_rate

VAT rate (value – 0, 10, 18, 20, etc.; null – no VAT)

integer

no

19.7.5

cost

Declared value of the goods (per unit in the contract currency, value >=0). This value is used to calculate the amount of insurance.

float

yes

19.7.6

weight

Weight (per unit, in grams)

integer

yes

19.7.7

weight_gross

Gross weight

integer

yes, if the order is of international type

19.7.8

amount

Number of units (pcs)

The number of one product in an opportunity can be from 1 to 999

integer

yes

19.7.9

name_i18n

Name in foreign language

string(255)

no

19.7.10

brand

Brand in foreign language

string(255)

no

19.7.11

country_code

Country code in the format: ISO_3166-1_alpha-2

string(2)

no

19.7.12

material

Material code (for more details, see Appendix 5)

string(255)

no

19.7.13

wifi_gsm

Contains wifi/gsm

boolean

no

19.7.14

url

Link to the website of the e-shop with description of the goods

string(255)

no

20  print  The need to create a printed form on order
  Possible values:
  barcode - barcode CP for the order (copy count - 1)
  waybill - order receipt (copy count - 2)
  string(7)  no

...