Orders for shipping from the public part

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

Payment type.

Available values:

• "cash"
• "noncash"

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 from the "Places" directory

(CLADR - Classifier of Addresses of Russian Federation)

*Parameter is required if one of payers is the third party

Delivery type.

Available values:

• "auto" (by truck)
• "express"
• "small" (small-size cargo)
• "letter"
• "avia"

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"

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"

Date of cargo transfer to the terminal of departure or date of truck arrival to the sender.

Format: YYY-MM-DD

Additional parameters of cargo delivery from the address

Shipping method.

Available values:

• "terminal" - delivery from the terminal
• "address" - delivery from the 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"

Terminal ID from the "Terminals" directory.

*It's possible to pass only one of parameters: "terminalID", "address"

Address as a set of parameters.

*It's possible to pass only one of parameters: "terminalID", "address"

Address as a set of parameters

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 picking up.

*Parameter is required only if specified shipping method is "address"

Beginning of period of cargo picking up.

Format: HH:MM

End of period of cargo picking up.

Format: HH:MM

Beginning of the break.

Format: HH:MM

End of the break.

Format: HH:MM

Picking up at the exact time.

Default value: "false"

There is a freight elevator.

Default value: "false"

Number of the floor.

Maximum number of characters - 5

The distance of carrying the load manually.

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 from the "Streets" directory

House.

Maximum number of characters - 5

Building.

Maximum number of characters - 5

Structure.

Maximum number of characters - 5

Apartmetn/office.

Maximum number of characters - 5

Shipping method.

Available values:

• "terminal" - delivery to the terminal
• "address" - delivery to the 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"

Terminal ID from the "Terminals" directory.

*It's possible to pass this parameter only in case of express delivery or if selected terminal is one of the pick-up points. Otherwise, this option is unavailable.

*It's possible to pass only one of parameters: "terminalID", "address", "city"

Address as a set of parameters.

*It's possible to pass only one of parameters: "terminalID", "address", "city"

CLADR code of the city from the "Places" directory.

*It's possible to pass only one of parameters: "terminalID", "address", "city"

*This parameter is allowed to be passed if parameter "variant" has the value "terminal".

When this parameter is passed the arrival terminal is determined automatically

Time of cargo delivery.

*Parameter is required only if specified shipping method is "address"

Beginning of period of cargo delivery.

Format: HH:MM

End of period of cargo delivery.

Format: HH:MM

Beginning of the break.

Format: HH:MM

End of the break.

Format: HH:MM

Delivery at the exact time.

Default value: "false"

Loading and unloading works at the address.

Such works may be ordered in case of delivery to the address (parameter "variant" has the value "address")

There is a freight elevator.

Default value: "false"

Number of the floor to which the cargo is to be lifted.

Maximum number of characters - 5

The distance of carrying the load manually.

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.

Role in shipping.

Available values:

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

E-mail of the order requester.

Maximum number of characters - 128

Counterparty as a set of parameters

E-mail of the order requester.

Maximum number of characters - 128

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

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

*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 meaning that counterparty is an anomymous receiver. If the value "true" is passed then the simplified shipment is being created.

It's possible to pass this parameter with value "true" only for shipping member wih role "Receiver".

Default value: "false"

Phone number of counteragent that is an anomymous receiver.

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

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

Name of counterparty

Counterparty TIN.

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 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")

Name of contact person

Phone number.

Maximum number of characters - 15

Extension.

Maximum number of characters - 5

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

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"

Volume of oversized part of cargo, cub. m

*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

Weight of oversized part of cargo, cub. m

*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"

Nature of cargo (textual value).

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

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.

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

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

Date and time of the server respone generation.

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

Information about the order

Number of created order or pre-order

Barcode according to algorithm Code 128 (for pre-order)