...
No. | Tag / attribute | Description | Typeof field | Mandatory (yes/no) |
1 | Delivery Request | Document title | yes | |
1.1 | Number | ID 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.2 | Date | Date of document (date of order) | Datetime/date | yes |
1.3 | Account | Online store identifier (login) | string(255) | yes |
1.4 | Secure | Key | string(255) | yes |
1.5 | OrderCount | The total number of orders in a document | integer | yes |
1.6 | Order | Shipment (order) | yes | |
1.6.1 | Number | Client shipment number (unique for orders of a particular client). Order identifier in the Client's IS. | string(40) | yes |
1.6.2 | SendCityCode1 | Sender's city code from the CDEK base (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | yes |
1.6.3 | RecCityCode1 | Receiver's city code from the CDEK base (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | yes |
1.6.4 | SendCityPostCode1 | Postal code of the sender's city | string(6) | yes |
1.6.5 | RecCityPostCoDe1 | Postal code of the receiver's city | string(6) | yes |
1.6.6 | SendCountryCode1 | Sender's country code to identify a country by postal code. Default value: RU | string(2) | no |
1.6.7 | RecCountryCode1 | Receiver's country code to identify a country by postal code. Default value: RU | string(2) | no |
1.6.8 | SendCityName1 | Name of sender's city | string(255) | no |
1.6.9 | RecCityName1 | Name of receiver's city | string(255) | no |
1.6.10 | RecipientINN | TIN of the receiver. Only for international orders. | string(12) | no |
1.6.11 | DateInvoice | Invoice date. Only for international orders. | Date time/date | yes, if order is international |
1.6.12 | ShipperName | Shipper. Used to print waybills. Only for international orders. | string (255) | yes, if order is international |
1.6.13 | ShipperAddress | Shipper’s address. Used to print waybills. Only for international orders. | string (255) | yes, if order is international |
1.6.14 | Passport | Details of the receiver’s passport. Used to print waybills. Only for international orders. | no | |
1.6.14.1 | Series | Series of the receiver’s passport. | string (255) | no |
1.6.14.2 | Number | Number of the receiver’s passport. | string (255) | no |
1.6.14.3 | IssueDate | Date of issue of the receiver’s passport. | Date time/date | no |
1.6.14.4 | IssuedBy | Issuing authority of the receiver’s passport. | string (255) | no |
1.6.14.5 | DateBirth | The receiver’s birthdate | Date time/date | no |
1.6.15 | Sender | Sender. 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.1 | Company | Name of sender's company | string(128) | no |
1.6.15.2 | Name | Sender's contact person | string(128) | no |
1.6.15.3 | Address1 | Sender address (address of pickup) | no | |
1.6.15.3.1 | Street | Street | string(50) | yes |
1.6.15.3.2 | House | House | string(30) | no |
1.6.15.3.3 | Flat | Flat/office | string(10) | no |
1.6.15.4 | Phone | Sender's phone | phone | no |
1.6.16 | RecipientName | Receiver (full name). At least 3 characters. | string(128) | yes |
1.6.17 | RecipientEmail | Receiver's email for sending order status notifications and contacting in case of failed calls | no | |
1.6.18 | Phone | Receiver's phone | phone | yes |
1.6.19 | TariffTypeCode7 | Code of tariff type (for more details, see Appendix No. 1) | integer | yes |
1.6.20 | DeliveryRecipientCost2 | Extra delivery charge collected by the online store from the receiver (the recipient country currency) | float | no |
1.6.21 | DeliveryRecipientVATRate | VAT rate included in the extra delivery charge (for more details, see Appendix No. 4) | string(10) | no |
1.6.22 | DeliveryRecipientVATSum | VAT amount included in the extra delivery charge | float | no |
1.6.23 | Seller | Requisites of the real seller | no | |
1.6.23.1 | Address | Real 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.2 | Name | Real seller | string (255) | yes, if ITN is indicated |
1.6.23.3 | INN | ITN (Individual Taxpayer Number) of the real seller | string (20) | no |
1.6.23.4 | Phone | Telephone of the real seller | phone | yes, if ITN is indicated |
1.6.23.5 | OwnershipForm | Code of type ownership (for more details, see Appendix No. 10) | integer | yes, if ITN is indicated |
1.6.24 | Comment3 | Comments (special notes on the order) | string(255) | no |
1.6.25 | Address1 | Delivery 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.1 | Street | Receiver's street. If possible, do not specify prefixes of values, such as “st.” | string(50) | yes |
1.6.25.2 | House | Receiver's house, building, block. If possible, do not specify prefixes of values, such as “house”. | string(30) | no |
1.6.25.3 | Flat | Receiver's flat/office. If possible, do not specify prefixes of values, such as “flat”. | string(10) | no |
1.6.25.4 | PvzCode | Pickup 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.26 | Package | Package (all packages are sent with different Package tags) | yes | |
1.6.26.1 | Number | Package 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.2 | BarCode | Package 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.3 | Weight7 | Total weight (in grams) | integer | yes |
1.6.26.4 | SizeA4 | Package dimensions. Length (in centimeters) | integer | yes, 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.5 | SizeB4 | Package dimensions. Width (in centimeters) | integer | yes, 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.6 | SizeC4 | Package dimensions. Height (in centimeters) | integer | yes, 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.7 | Item | Items (goods) | yes | |
1.6.26.7.1 | Amount | Quantity of goods of the same type (pcs). The maximum number is 126999. | Integer | yes |
1.6.26.7.2 | WareKey | Identifier/item number of the goods. | string(50) | yes |
1.6.26.7.3 | Marking8 | Marking of item. If marking is indicated for Item, the Amount parametr can't be greater than 1. | string | no |
1.6.26.7.4 | Cost | Declared value of the goods (per item in the contract currency, value >=0). This value is used to calculate the amount of insurance. | float | yes |
1.6.26.7.5 | Payment | Cash on delivery (per item in the recipient country currency, value >=0) — cash on delivery; in case of prepayment, value = 0. | float | yes |
1.6.26.7.6 | PaymentVATRate | VAT rate included in the value of the goods (for more details, see the Appendix 4) | string(10) | no |
1.6.26.7.7 | PaymentVATSum | VAT amount included in the value (payment) of the goods. | float | no |
1.6.26.7.8 | Weight | Weight (per item, in grams) | integer | yes |
1.6.26.7.9 | Comment | Name of the goods (may contain description of the goods: size, color) | string(255) | yes |
1.6.26.7.10 | WeightBrutto | Gross weight (for one unit of goods, in grams). Only for international orders. | integer | yes, if order is international |
1.6.26.7.11 | CommentEx | 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.12 | Link | Link to the e-shop’s website with the goods’ description. Only for international orders. | string(255) | no |
1.6.27 | DeliveryRecipientCostAdv | Additional charge for delivery (E-shop charges the receiver), depending on the order’s sum | no | |
1.6.27.1 | Threshold | Goods price threshold (valid by condition less than or equal to), in even monetary units | integer | yes |
1.6.27.2 | Sum | Additional charge for delivery with total amount that falls within the interval | float | yes |
1.6.27.3 | VATRate | 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.4 | VATSum | VAT sum included in the additional charge for delivery | float | no |
1.6.28 | AddService | Additional services | no | |
1.6.28.1 | ServiceCode | Type of additional service (for more details, see Appendix No. 2) | integer | yes |
1.6.28.2 | Count | Number of packages. It is used and is mandatory only for the additional service "Package 1". | integer | no |
1.6.29 | Schedule5 | Schedule for delivery /pickup (deprecated, it is recommended to use a separate new_schedule method) | no | |
1.6.29.1 | Attempt | Time of delivery (one time interval not less than 3 hours is permitted for one day) | yes | |
1.6.29.1.1 | ID | ID number of a schedule from the online store's database. You may use 1 as a default value | integer | yes |
1.6.291.1.2 | Date | Date of delivery (only date, in the format “YYYY-MM-DD”, no time) as agreed by the receiver | date | yes |
1.6.29.1.3 | Comment | Comment | string(255) | no |
1.6.29.1.4 | TimeBeg | Start of a delivery time range (receiver's time) | time | yes |
1.6.29.1.5 | TimeEnd | End of a delivery time range (receiver's time) | time | yes |
1.6.29.1.6 | Address | 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.1 | Street | Receiver's street. If possible, do not specify prefixesof values, such as “str” | string(50) | yes |
1.6.29.1.6.2 | House | Receiver's house, building, block. If possible, do not specify prefixes of values, such as “house” | string(30) | yes |
1.6.29.1.6.3 | Flat | Receiver's flat/office. If possible, do not specify prefixes of values, such as “flat.” | string(10) | no |
1.6.29.1.6.4 | PvzCode | 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.7 | CallCourier6 | Call courier | no | |
1.7.1 | Call | Waiting for a courier | yes | |
1.7.1.1 | Date | Date of courier waiting | date | yes |
1.7.1.2 | TimeBeg | Start time of courier waiting | time | yes |
1.7.1.3 | TimeEnd | End time of courier waiting | time | yes |
1.7.1.4 | LunchBeg | Start time of a lunch break, if it is within a time range [TimeBeg; TimeEnd] | time | no |
1.7.1.5 | LunchEnd | End time of a lunch break, if it is within a time range [TimeBeg; TimeEnd] | time | no |
1.7.1.6 | SendCityCode1 | Sender's city code from the CDEK base (https://cdek.ru/storage/source/document/1/CDEK_city.zip) | integer | yes |
1.7.1.7 | SendCityPostCode1 | Postal code of the sender's city | string(6) | yes |
1.7.1.8 | SendCountryCode1 | Sender's country code to identify a country by postal code | string(2) | no |
1.7.1.9 | SendCityName1 | Name of sender's city | string(255) | no |
1.7.1.10 | SendPhone | Sender's contact phone | phone | yes |
1.7.1.11 | SenderName | Sender (full name) | string(255) | yes |
1.7.1.12 | Comment | Comment for courier | string(255) | no |
1.7.1.13 | SendAddress | Sender's address | yes | |
1.7.1.13.1 | Street | Sender's street. If possible, do not specify prefixes of values, such as “st.” | string(50) | yes |
1.7.1.13.2 | House | Sender's house, building, block. If possible, do not specify prefixes of values, such as “house”. | string(30) | yes |
1.7.1.13.3 | Flat | Sender's flat/office. If possible, do not specify prefixes of values, such as “flat”. | string(10) | yes |
...