Orders for shipping from the personal account

To get the session ID, use the User Authorization method

If the value is "false", then the order is saved, but is not processed (is necessary in case the order will be included into a multi-request).

Default value: "true"

Delivery type for terminal-to-terminal shipping

List of required packages

Phone number for SMS-notifications.

Format: "7XXXXXXXXXX" (11 figures, starts with 7)

Comment to the order.

Maximum field length: 500 characters

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

The payer for the service must not differ from the default payer, that is, the value of the parameter must match the value of the "request.payment.primaryPayer" parameter. If the parameter is not passed or a value other than the value of the "request.payment.primaryPayer" parameter is passed, then the parameter takes the value of the "request.payment.primaryPayer" parameter

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Number of bags or boxes.

Parameter is required if the package "bag" ("Упаковка мешок") or "carton box" ("Картонная коробка") is selected

Action over accompanying documents.

Available values:

• "send";
• "return"

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Address ID from the "Address book".

*One of the excluding parameters is required: "terminalID", "addressID", "address", "city"

Address.

*One of the excluding parameters is required: "terminalID", "addressID", "address", "city"

Address ID from the "Address book".

Only one of the following parameters is allowed: "addressID" or "address"

Address as a set of parameters.

Only one of the following parameters is allowed: "addressID" or"address"

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Time of cargo hand over at the address.

*If "variant" parameter value is "address", then parameter is required

Period start.

Format: HH:MM

Period end.

Format: HH:MM

Break start.

Format: HH:MM

Break end.

Format: HH:MM

Delivery at the exact time.

Default value: "false"

Flag indicating that there is a service lift.

Default value: "false"

Number of the floor to which the cargo is to be lifted/from which the cargo is to be carried downstairs.

Maximum number of characters - 5

Distance to which the cargo is to be carried, m.

Maximum number of characters - 5

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Array of UID's of special requirements for transport from the Directory of Special Requirements for Transport.

Special requirements include type of truck loading (side, rear, etc.) and other requirements: manipulator, tenting removal, etc.

Parameter determining the need to order a pass by the driver of DL to enter the territory of the sender and time that it takes.

Available values:

• "1" - an hour before enter the territory of the sender;
• "24" - one day before enter the territory of the sender

Parameter determining the need to make an appointment by the driver of DL to pick-up the cargo at the sender's address.

Default value: "false"

Reimbursement method.

Available values:

• "1" - by the check at the address;
• "2" - include in the bill

Parameter determining the need to provide the pick-up number by the driver of DL in order to pick-up the cargo at the sender's territory. Parameter should contain the pick-up number.

Maximum number of characters - 30

Parameter determining the need of advance call from the driver of DL to the sender before the picking-up of the cargo.

Default value: "false"

Parameter determining the need to agree the order for shipment with the sender.

Available values:

• "true" - not need to agree;
• "false" - need to agree (default value)

List of the documents that the driver of DL has to have in order to pick-up the cargo at the sender's territory. Should be specified using the "Documents for receipt of cargo" directory

CLADR code of the street. It's possible to get CLADR code using the services presented on the page "Using CLADR codes" (2)

House (2).

Maximum number of characters - 7

Building (2).

Maximum number of characters - 5

Structure (2).

Maximum number of characters - 7

Apartment/office (2).

Maximum number of characters - 5

Indicator of saving the object in the address book.

Default value: "false".

Parameter is not used in blocks "juridicalAddress" of class "Counteragent"

Notes:

1. Address information must be passed in the request therefore either "search" parameter is required or "street" and "house" parameters are required.
2. If "search" parameter is passed in the request, then "street", "house", "building", "structure" or "flat" parameters must not be passed in the request

Role in shipping.

Available values:

• "sender";
• "receiver";
• "payer";
• "third" (third party).

Counterparty UID from the "List of available counterparties".

*Parameter is not required and ignored in case of absence of the full access to the counterparties

E-mail of the order requester

Counterparty ID from the "Address book".

*It's possible to pass only one of parameters: "counteragentID", "counteragent"

Counterparty as a set of parameters.

*It's possible to pass only one of parameters: "counteragentID", "counteragent"

List of ID's of contact persons from the "Address book".

Maximum number of items in array - 3.

*It's possible to pass only one of parameters: "contactIDs", "contactPersons".

*Parameter is not required and ignored for counterparty that is an "anonymous" receiver (1)

Indicator of saving the object in the address book.

Default value: "false".

Parameter is ignored for the third party

List of ID's of phone numbers from the "Address book".

Maximum number of items in array - 3.

*It's possible to pass only one of parameters: "phoneIDs", "phoneNumbers".

*Parameter is not required and ignored for counterparty that is an "anonymous" receiver (1)

Phone number.

Maximum 15 digits

Extension.

Maximum 5 digits

Indicator of saving the object in the address book.

Default value: "false".

Parameter is ignored for the third party

E-mail of the order requester

Contact information for sending an electronic payment receipt to the payer that is a physical party

*Parameter is required for the counterparty, that is a physical party and is not an "anonymous" receiver. Otherwise, parameter is not required and ignored (1)

Consent to receive an electronic payment receipt. Available values:

• "true" - user passed "phone" and/or "email" to send payment receipt;
• "false" - user refused to provide contact information to send payment receipt

Phone number to send payment receipt.

Format: "+79XXXXXXXXX" (12 figures, starts with "+79" and then 9 digits)

*If "send" = "true", than at least one of the parameters is required: "phone" or "email"

*If "send" = "false", than parameter is ignored

E-mail to send payment receipt

*If "send" = "true", than at least one of the parameters is required: "phone" or "email"

*If "send" = "false", than parameter is ignored

Notes:

1. "Anonymous" receiver - a receiver on whom minimum info was provided.

   Delovye Linii company allows providing minimum information on the receiver - only name and phone number. In this case SMS with a code is sent to the phone number. The code is used to receive the goods. For more information see the description of Simplified Shipping service on Delovye Linii company website.

UID of legal form of organization. Value from the "Directory of legal forms of organization".

When passing data about the "anonymous" (1) receiver ("isAnonym" parameter value is "true") it is necessary to pass UID of individual in Russian Federation ("0xAB91FEEA04F6D4AD48DF42161B6C2E7A").

*It's possible to pass only one of parameters: "form", "customForm"

Legal form of organization as a set of parameters.

*It's possible to pass only one of parameters: "form", "customForm"

Name of legal form of organization.

Maximum number of characters - 35

Personal identification document

*Parameter is required only if both of parameters "customForm.juridical" and "isAnonym" are passed with the value "false"

Document type.

Available values:

• "passport";
• "drivingLicence";
• "foreignPassport".

The value "foreignPassport" is unavailable for some countries

Serial of the document.

*Parameter is not required and ignored for some countries

Document number.

Format depends on the country

Flag indicating that counterparty is an "anonymous" receiver, that is minimal information about the receiver is provided, this service is called simplified shipment (1).

It's possible to pass this parameter with value "true" only for the receiver.

Default value: "false"

Phone number of counterparty that is an "anonymous" receiver (1).

Format: "7ХХХХХХХХХХ" (11 digits, starts with "7").

*Parameter is required only for counterparty that is an "anonymous" receiver

Name of counterparty

Counterparty TIN (taxpayer identification number).

Maximum number of characters depends on the country and legal form of organization

*Parameter is required only for juridical party (parameter "form" has value that is an UID of legal form or organization of juridical party or "customForm.juridical" = "true")

Juridical address.

Parameter is used only for juridical party (parameter "form" has value that is an UID of legal form or organization of juridical party or "customForm.juridical" = "true")

Indicator of saving the object in the address book.

Default value: "false"

Notes:

1. "Anonymous" receiver - a receiver on whom minimum info was provided.

   Delovye Linii company allows providing minimum information on the receiver - only name and phone number. In this case SMS with a code is sent to the phone number. The code is used to receive the goods. For more information see the description of Simplified Shipping service on Delovye Linii company website.

Quantity of cargo pieces, pcs.

Default value: "1".

If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then the passed value is ignored, parameter takes the default value ("1")

Length of the longest cargo piece, m.

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.3"

Width of the widest cargo piece, m.

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.21"

Height of the highest cargo piece, m.

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.01"

Weight of the heaviest cargo piece, kg.

*If quantity of cargo pieces > 1 ("request.cargo.quantity" > 1), then this parameter is required. Otherwise, this parameter takes the value of the parameter "totalWeight".

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.5"

Total cargo volume, cub. m.

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.001"

Total cargo weight, kg.

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is not required, passed value is ignored, parameter takes the value "0.5"

oversizedWeight

Weight of oversized cargo places, kg (1).

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is ignored.

*If according to the weight-dimensional characteristics it is determined that the cargo is oversized, then this parameter is required

Volume of oversized cargo places, cub. m (1).

*If delivery type is "letter" ("request.delivery.deliveryType.type" = "letter"), then this parameter is ignored.

*If according to the weight-dimensional characteristics it is determined that the cargo is oversized, then this parameter is required

Hazard class of cargo.

Default value: "0"

Declared value of the cargo, rub.

Maximum number of characters - 12

Payer for the service.

Available values:

• "sender";
• "receiver";
• "third" (third party).

If parameter is not passed, then it takes the value of the parameter "request.payment.primaryPayer"

Flag of insurance of delivery time.

Default value: "true"

UID of nature of cargo from the "Nature of cargo" directory. To search for UID by the name of cargo use the Cargo Type by an Input String method (2).

*It's possible to pass only one of parameters: "freightName", "freightUID"

Nature of cargo (textual value) (2).

*It's possible to pass only one of parameters: "freightName", "freightUID"

Notes:

1. An oversized cargo place is a cargo place with weight greater than or equal to 100 kg (80 kg in case of air transportation) or with at least one of the dimensions (LWH) greater than or equal to 3 m (80 сm in case of air transportation).
2. If "request.delivery.deliveryType.type" parameter values is "letter", then the passed value is ignored, the nature of cargo is considered to be "Документы" (documents)

Payment type.

Available values:

• "cash" - by cash or credit card;
• "noncash" - by bank transfer

Default payer. Specified party pays for the main service (terminal-to-terminal shipping) and all other services, unless other payers are specified for them.

Available values:

• "sender";
• "receiver";
• "third"

CLADR code of the city of payment. It's possible to get CLADR code using the services presented on the page "Using CLADR codes". 

(CLADR - Classifier of Addresses of Russian Federation).

*If one of the payers is the third party and "request.payment.type" parameter value is "cash" then one of the excluding parameters - "paymentCity" or "paymentCitySearch" is required, in other cases the parameter is ignored

City as a string. Minimum 2 symbols, maximum 1024. Along with the name of the city it is possible to pass the name of the country, region or district - this will allow refining the search and eliminating errors that may occur since the cities can have the identical names

Cash on delivery.

Cash on delivery is only possible if the following requirements are met:

1. The requester is a legal entity, "Cash on delivery" service is available to the requester (to make the service available, please contact Delovye Linii company manager).
2. The requester is the sender ("members.requester.role" parameter value is "sender").
3. The receiver is an individual.
4. "cashOnDelivery.products" parameter is passed in the request. If the parameter is not passed, the shipment will not be made on cash on delivery basis, however the object may be used to pass the client internal order number. See the description of "cashOnDelivery.orderNumber" parameter.

In case of cash on delivery it is not possible to order the delivery to the receiver's address/to the airport ("delivery.arrival.variant" parameter value should be "terminal").

It's possible to pass only one item of array currently. Other passed elements are ignored

Order date.

Format: "YYYY-MM-DD" 

Payment type.

Available values:

• "cash" - by cash;
• "card" - by card

List of products

Product name

Product code

Quantity

Cost with VAT, rub.

VAT rate, %.

Available values:

• "0";
• "10";
• "20".

If the goods are not subject to VAT, then you should not transfer a zero value, but simply do not pass the parameter

Notes:

1. In case of cash on delivery the total amount must be an integer (that is the sum of the products of "costWithVAT" and "productAmount" parameters values of all the "CashOnDelivery.products" array elements should be an integer)

Emulated http-code of status. In case of success the code "200" returns

Date and time of the server response generation.

Format: "YYYY-MM-DD HH:MM:SS"

Information about the order

id

state

Object status. Possible Values:

• "existing" - the existing object has been edited;
• "new" - a new object has been created

value

Entered value

Address/city found