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)

1entityData of the order over which request is sent
no

1.1

uuidOrder identifier in the CDEK ISUUIDyes
1.2is_return

Sign of a return order:
true - return
false - direct

booleanyes
1.3is_reverseSign of a reverse order:
true - reverse
false - direct
booleanyes

1.4

typeOrder type:
“e-shop”(only for e-shop contracts)
“delivery” (for any contract)
integeryes

1.5

cdek_numberCDEK order numberlongno

1.6

number

Order number in the Client IS
When requesting information on this field, the following options are possible:
- if it is not sent, the order number will be assigned in the CDEK IS – uuid;
if more than 1 is found, the one created with the most recent date is selected.

Can contain only numbers, letters of the Latin alphabet or special characters (ASCII format)

string(40)no
1.7delivery_mode
True ordering mode:
1 - door - door
2 - door - warehouse 
3 - warehouse - door
4 - warehouse - warehouse
6 - door - postamat
7 -warehouse - postamat
string()no

1.8

tariff_codeTariff codeintegeryes

1.9

commentComment for the orderstring(255)no
1.10developer_keyDeveloper keystring()no

1.11

shipment_pointCode of the CDEK pickup point to which the client will deliver the shipmentstring()no

1.12

delivery_pointCode of the CDEK pickup point to which the parcel will be deliveredstring()no

1.13

date_invoiceDate of invoicedate(yyyy-MM-dd)no

1.14

shipper_nameConsignorstring(255)no

1.15

shipper_addressConsignor's addressstring(255)no

1.16

delivery_recipient_costExtra delivery charge collected by the e-shop from the receiver.moneyno

1.16.1

valueAmount of additional chargefloatyes

1.16.2

vat_sumVAT amountfloatno

1.16.3

vat_rateVAT rate (value – 0, 10, 18, 20; null – no VAT)integerno

1.17

delivery_recipient_cost_advExtra delivery charge collected by the e-shop from the receiver, depending on the order amountthreshold[]no

1.17.1

thresholdThreshold price of product (defined as less than or equal to) in integer values of currencyintegeryes

1.17.2

sumExtra delivery charge, the total value of which is within the intervalfloatyes

1.17.3

vat_sumVAT amount included in the extra delivery chargefloatno

1.17.4

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

1.18

senderSendercontactyes

1.18.1

companyCompany’s namestring(255)no

1.18.2

nameContact person's full namestring(255)yes
1.18.3passport_requirements_satisfiedRequirements 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
booleanno

1.18.4

email

Email

Must comply with RFC 2822
string(255)no

1.18.5

phones

List of phones

No more than 10 numbers

phone[]no

1.18.5.1

numberPhone numberstring()no

1.18.5.2

additionalAdditional information (additional number)string()no

1.19

sellerDetails of a real sellersellerno

1.19.1

nameName of a real sellerstring(255)no

1.19.2

innINN (Taxpayer Identification Number) of a real sellerstring(12)no

1.19.3

phonePhone of a real sellerphoneno

1.19.4

ownership_formForm of ownership codeintegerno

1.19.5

addressAddress of a real seller. Used in printing the invoices to show the address of a real seller or a trade name. Only for international ordersstringno

1.20

recipientReceivercontactyes

1.20.1

companyCompany’s namestring()no

1.20.2

nameContact person's full namestring(255)yes

1.20.3

passport_seriesPassport seriesstring(4)no

1.20.4

passport_numberPassport numberstring(30)no

1.20.5

passport_date_of_issueDate of issue of a passportdate(yyyy-MM- dd)no

1.20.6

passport_organizationBody which issued a passportstring(255)no

1.20.7

tin

TIN (Taxpayer Identification Number)

Can contain 10 or 12 characters
string(12)no

1.20.8

passport_date_of_birthDate of birthdate(yyyy-MM- dd)no
1.20.9passport_requirements_satisfiedRequirements 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
booleanno

1.20.10

email

Email

Must comply with RFC 2822
string(255)no

1.20.11

phonesList of phonesphone[]yes

1.20.11.1

numberPhone numberstring()yes

1.20.11.2

additionalAdditional information (additional number)string()no

1.21

from_locationSender's addresslocationyes

1.21.1

codeCDEK location code ("List of Cities" method)integeryes

1.21.2

fias_guidFIAS unique identifierUUIDno

1.21.3

postal_codePostal codestring()no

1.21.4

longitudeLongitudefloatno

1.21.5

latitudeLatitudefloatno

1.21.6

country_codeCountry code in the format: ISO_3166-1_alpha-2string()yes

1.21.7

regionRegion namestring()no

1.21.8

sub_regionName of region's districtstring()no

1.21.9

cityCity namestring()yes

1.21.10

kladr_code

KLADR (Russian Classifier of Addresses) code

Deprecated field

string()no

1.21.11

addressAddress stringstring(255)no

1.22

to_locationReceiver's addressstring()yes

1.22.1

codeCDEK location code ("List of Cities" method)integeryes

1.22.2

fias_guidFIAS unique identifierUUIDno

1.22.3

postal_codePostal codestring()no

1.22.4

longitudeLongitudefloatno

1.22.5

latitudeLatitudefloatno

1.22.6

country_codeCountry code in the format: ISO_3166-1_alpha-2string()yes

1.22.7

regionRegion namestring()no

1.22.8

sub_regionName of region's districtstring()no

1.22.9

cityCity namestring()yes

1.22.10

kladr_code

KLADR (Russian Classifier of Addresses) code

Deprecated field

string()no

1.22.11

addressAddress stringstring(255)no

1.23

servicesAdditional servicesservice[ ]no

1.23.1

codeType of additional service, code from the additional service directory (for more details, see Appendix 3)string()yes

1.23.2

parameterAdditional service parameterstring()no
1.23.3sumAdditional service cost (in the contract currency)floatno

1.24

packagesList of details for cargo packagespackage[]yes
1.24.1package_idCDEK information system’s package identifier stringyes

1.24.2

numberThe 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

1.24.3

weightTotal weight (in grams)integeryes
1.24.4weight_volumeVolume weight (in grams)integerno
1.24.5weight_calcCalculated weight (in grams)integerno

1.24.6

lengthPackage dimensions. Length (in centimeters)integerno

1.24.7

widthPackage dimensions. Width (in centimeters)integerno

1.24.8

heightPackage dimensions. Height (in centimeters)integerno

1.24.9

commentComments for the packagestring(255)no

1.24.10

itemsItems in the packageitem[]no

1.24.10.1

nameProduct name (may also contain product description: size, color)string(255)yes

1.24.10.2

ware_key

Identifier/item number of the goods

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

1.24.10.3

paymentCash on delivery (per unit in the recipient country currency, value >=0) – cash on delivery, value = 0 – prepaymentmoneyyes

1.24.10.3.1

valueCash on delivery amount (prepayment = 0)floatyes

1.24.10.3.2

vat_sumVAT amountfloatno

1.24.10.3.3

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

1.24.10.4

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

1.24.10.5

weightWeight (per unit, in grams)integeryes

1.24.10.6

weight_grossGross weightintegerno

1.24.10.7

amountNumber of units (pcs)integeryes
1.24.10.8delivery_amountNumber of delivered units (pcs)integerno

1.24.10.9

name_i18nName in foreign languagestring(255)no

1.24.10.10

brandBrand in foreign languagestring(255)no

1.24.10.11

country_codeCountry code in the format: ISO_3166-1_alpha-2string(2)no

1.24.10.12

materialMaterial codestring(255)no

1.24.10.13

wifi_gsmContains wifi/gsmbooleanno

1.24.10.14

urlLink to the website of the e-shop with description of the goodsstring()no
1.25delivery_problem
Delivery problems
[ ]no
1.25.1code
Problem code
string()no
1.25.2create_date
Date the problem was created
datetimeno
1.26delivery_detailInformation about delivery
no
1.26.1dateDelivery datedatetimedateyes
1.26.2recipient_nameRecipient namestring()yes
1.26.3payment_sumCash on delivery amount collected from the receiver in the currency of the receiver's country, subject to possible partial deliveryfloatno
1.26.4payment_infoCash on delivery type by recipient[ ]no
1.26.4.1typeType of payment:
CARD - card
CASH - cash
string(4)yes
1.26.4.2sumSum in the currency of the recipient countryfloatyes
1.26.5delivery_sumCost of delivery, in the contract currencyfloatyes
1.26.6total_sumTotal order costfloatyes
1.27transacted_paymentAn indication that the order has received information about the transfer of cash on delivery to the online storebooleanno

1.28

statusesList of order statuses sorted by date and timestatus[]yes

1.28.1

codeStatus code (for more details, see Appendix 1)string()yes

1.28.2

nameStatus namestring()yes

1.28.3

date_timeDate and time of status setting (format yyyy-MM-dd'T'HH:mm:ssZ)datetimeyes

1.28.4

reason_codeAdditional status code (for more details, see Appendix 2)string()no

1.28.5

cityPlace of origin of the statusstring()yes
2requestsData on the request/requests over the orderrequest[]yes
2.1request_uuidRequest identifier in CDEK information systemUUIDno
2.2typeRequest type
May take on values: CREATE, UPDATE, DELETE, AUTH, GET
string()yes
2.3state

Current status of the request
May take on values: 

ACCEPTED - pre-validation passed and request accepted
WAITING - the request is awaiting processing (depends on the execution of another request)
SUCCESSFUL - the request was processed successfully
INVALID - the request was processed with an error

string()yes
2.4date_timeDate and time of setting current status of the request (format yyyy-MM-dd'T'HH:mm:ssZ)datetimeyes
2.5errorsRequest processing errorserror[]no
2.5.1codeError codestring()yes
2.5.2messageError descriptionstring()yes
2.6warningsRequest processing warningswarning[]no
2.6.1codeWarning codestring()yes
2.6.2messageWarning descriptionstring()yes
3related_entitiesEntities related with the order
no
3.1type

Entity type related with order
May take the following values:
return_order - a return order (returned for direct if the order has not been handed over and a return order has already been formed on it)
direct_order - direct order (returned for return and revers order)
barcode - barcode CP for the order
waybill - order receipt
reverse_order - a reverse order (returned for direct order which have reverse service)

string()yes
3.2uuidEntity identifier related to orderUUIDyes
3.3urlLink to download the file with print form. Contained in the answer only for waybill and barcode in the “Formed” print form statusstring()no
3.4cdek_numberCDEK order number (for return_order, direct_order, reverse_order)string()no

...