Поиск по сайту

API
Главная / API - Orders for shipping from the public

Orders for shipping from the public part

Обновлено 12.11.2020

General information

This service allows ordering/pre-ordering (see below) shipping without authorization (from the public part).

On creating orders with data of your personal account, see the relevant section.

Below is the description of all method parameters, for the requests and the responses examples see the relevant section

Pre-orderIf a client wants to bring the cargo to the company terminal, they may place an order online, print the paper and bring it to the terminal. Thus they will be able to save time since the clients who placed a pre-order are served out of turn. For more information see Delovye Linii company website.

Order for shipping

Method request

Request example

Method address: https://api.dellin.ru/v2/request.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "delivery":{  
      "deliveryType":{  
         "type":"avia",
         "payer":"sender"
      },
      "packages":[
         {  
            "uid":"0xA0A820F33B2F93FE44C8058B65C77D0F",
            "payer":"sender"
         },
         {  
            "uid":"0x947845D9BDC69EFA49630D8C080C4FBE",
            "payer":"sender",
            "count":3
         }
      ],
      "accompanyingDocuments":[  
         {  
            "action":"send",
            "payer":"sender"
         },
         {  
            "action":"return",
            "payer":"sender"
         }
      ],
      "derival":{  
         "produceDate":"2018-02-15",
         "pickupParams":{  
            "derivalDriverPass":24,
            "shipmentRegister":true,
            "paidEntry":{  
               "cost":100,
               "type":1
            },
            "shipmentDerival":"АБ1000222",
            "priorCall":true,
            "noNeedAgreement":true,
            "documentsForReceive":[  
               "0x90bc42c2d8cf7c1c47a40fc1ccfb54d5",
               "0x9c65f346435836584a8345ade132df00"
            ]
         },
         "variant":"terminal",
         "payer":"sender",
         "terminalID":"23",
         "address":{  
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а"
         },
         "additionalAddress":{  
            "address":{  
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"лит.А",
               "flat":"214а"
            },
            "payer":"sender"
         },
         "time":{  
            "worktimeStart":"09:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:30",
            "breakEnd":"13:30",
            "exactTime":true
         },
         "handling":{  
            "freightLift":true,
            "toFloor":10,
            "carry":50,
            "payer":"third"
         },
         "requirements":[  
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0xabb9c63c596b08f94c3664c930e77778"
         ]
      },
      "arrival":{  
         "variant":"terminal",
         "payer":"sender",
         "terminalID":"23",
         "address":{  
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"лит.А",
            "flat":"214а"
         },
         "city":"5500000100000000000000000",
         "time":{  
            "worktimeStart":"09:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:30",
            "breakEnd":"13:30",
            "exactTime":true
         },
         "handling":{  
            "freightLift":true,
            "toFloor":10,
            "carry":50,
            "payer":"third"
         },
         "requirements":[  
            "0x9951e0ff97188f6b4b1b153dfde3cfec",
            "0xabb9c63c596b08f94c3664c930e77778"
         ]
      },
      "smsback":"79213332211",
      "comment":"комментарий к отправке"
   },
   "members":{  
      "requester":{  
         "role":"sender",
         "email":"test@mail.ru"
      },
      "sender":{  
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{ 
               "search":"Омск, Ленина, 5",  
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            }
         },
         "contactPersons":[  
            {  
               "name":"Иван Иванович"
            }
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123"
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "receiver":{  
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "isAnonym":false,
            "phone":"79998887766",
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            }
         },
         "contactPersons":[  
            {  
               "name":"Иван Иванович"
            }
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123"
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "third":{  
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
              "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"3А",
               "flat":"Б-234"
            }
         },
         "contactPersons":[  
            {  
               "name":"Иван Иванович"
            }
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123"
            }
         ],
         "email":"test@mail.ru",
         "dataForReceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      }
   },
   "cargo":{  
      "quantity":1,
      "length":0.42,
      "width":0.18,
      "height":0.3,
      "weight":25.0,
      "totalVolume":0.02,
      "totalWeight":0.02,
      "oversizedWeight":25.0,
      "oversizedVolume":0.02,
      "hazardClass":2.1,
      "insurance":{  
         "statedValue":11220.50,
         "payer":"sender",
         "term":true
      },
      "freightUID":"0x9c2acaea110d75ba48fdc7a83c976269",
      "freightName":"Запчасти для трактора"
   },
   "payment":{  
      "type":"cash",
      "primaryPayer":"sender",
      "paymentCity":"5500000100000000000000000",
      "paymentCitySearch":{
         "search":"Омск"
            }
   },
   "cargoCode":"1234"
}

Method address: https://api.dellin.ru/v2/request.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <delivery>
      <deliveryType>
         <type>avia</type>
         <payer>sender</payer>
      </deliveryType>
      <packages>
         <uid>0xA0A820F33B2F93FE44C8058B65C77D0F</uid>
         <payer>sender</payer>
      </packages>
      <packages>
         <uid>0x947845D9BDC69EFA49630D8C080C4FBE</uid>
         <payer>sender</payer>
         <count>3</count>
      </packages>
      <accompanyingDocuments>
         <action>send</action>
         <payer>sender</payer>
      </accompanyingDocuments>
      <accompanyingDocuments>
         <action>return</action>
         <payer>sender</payer>
      </accompanyingDocuments>
      <derival>
         <produceDate>2018-02-15</produceDate>
         <pickupParams>
            <derivalDriverPass>24</derivalDriverPass>
            <shipmentRegister>true</shipmentRegister>
            <paidEntry>
               <cost>100</cost>
               <type>1</type>
            </paidEntry>
            <shipmentDerival>АБ1000222</shipmentDerival>
            <priorCall>true</priorCall>
            <noNeedAgreement>true</noNeedAgreement>
            <documentsForReceive>0x90bc42c2d8cf7c1c47a40fc1ccfb54d5</documentsForReceive>
            <documentsForReceive>0x9c65f346435836584a8345ade132df00</documentsForReceive>
         </pickupParams>
         <variant>terminal</variant>
         <payer>sender</payer>
         <terminalID>23</terminalID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
         </address>
         <additionalAddress>
            <address>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>лит.А</structure>
               <flat>214а</flat>
            </address>
            <payer>sender</payer>
         </additionalAddress>
         <time>
            <worktimeStart>09:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:30</breakStart>
            <breakEnd>13:30</breakEnd>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>50</carry>
            <payer>third</payer>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
      </derival>
      <arrival>
         <variant>terminal</variant>
         <payer>sender</payer>
         <terminalID>23</terminalID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>лит.А</structure>
            <flat>214а</flat>
         </address>
         <city>5500000100000000000000000</city>
         <time>
            <worktimeStart>09:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:30</breakStart>
            <breakEnd>13:30</breakEnd>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>50</carry>
            <payer>third</payer>
         </handling>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
      </arrival>
      <smsback>79213332211</smsback>
      <comment>комментарий к отправке</comment>
   </delivery>
   <members>
      <requester>
         <role>sender</role>
         <email>test@mail.ru</email>
      </requester>
      <sender>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
         </counteragent>
         <contactPersons>
            <name>Иван Иванович</name>
         </contactPersons>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </sender>
      <receiver>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <isAnonym>false</isAnonym>
            <phone>79998887766</phone>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
         </counteragent>
         <contactPersons>
            <name>Иван Иванович</name>
         </contactPersons>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </receiver>
      <third>
         <counteragent>
            <form>0x8F51001438C4D49511DBD774581EDB80</form>
            <customForm>
               <formName>ОБРУГ</formName>
               <countryUID>0x00000000000000000000000000000000</countryUID>
               <juridical>true</juridical>
            </customForm>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>123456</number>
            </document>
            <name>Ромашка</name>
            <inn>1234567890</inn>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <house>5</house>
               <building>1</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
         </counteragent>
         <contactPersons>
            <name>Иван Иванович</name>
         </contactPersons>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataForReceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataForReceipt>
      </third>
   </members>
   <cargo>
      <quantity>1</quantity>
      <length>0.42</length>
      <width>0.18</width>
      <height>0.3</height>
      <weight>25</weight>
      <totalVolume>0.02</totalVolume>
      <totalWeight>0.02</totalWeight>
      <oversizedWeight>25</oversizedWeight>
      <oversizedVolume>0.02</oversizedVolume>
      <hazardClass>2.1</hazardClass>
      <insurance>
         <statedValue>11220.5</statedValue>
         <payer>sender</payer>
         <term>true</term>
      </insurance>
      <freightUID>0x9c2acaea110d75ba48fdc7a83c976269</freightUID>
      <freightName>Запчасти для трактора</freightName>
   </cargo>
   <payment>
      <type>cash</type>
      <primaryPayer>sender</primaryPayer>
      <paymentCity>5500000100000000000000000</paymentCity>
      <paymentCitySearch>
         <search>Омск</search>
      </paymentCitySearch>
   </payment>
   <cargoCode>1234</cargoCode>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringThe application key. To get the key, register
deliveryYes
objectDelivery parameters
delivery.deliveryTypeYesDeliveryType

Delivery type for terminal-to-terminal shipping

delivery.packagesNoarray of Packages

List of required packages

delivery.accompanyingDocumentsNoarray of AcDocsAccompanying documents

delivery.derival

YesDerivalArrivalDelivery from the address

delivery.arrival

YesDerivalArrivalDelivery to the address
delivery.smsbackNostring

Phone number for SMS-notifications.

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

delivery.commentNostring

Comment to the order.

Maximum field length: 500 characters

membersYes
object
Shipping members
members.requesterYesRequesterOrder requester
members.senderYesMemberSender
members.receiverYesMemberReceiver
members.thirdNoMemberThird party
cargoYes
CargoCargo characteristics
paymentYes
PaymentPayment parameters
cargoCodeNostring

Client waybill number. Maximum string length - 100 characters

Client waybill number is used for batch orders

DeliveryType
DeliveryType
ParameterRequiredTypeDescription

type

Yes
string

Delivery type.

Available values:

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

Small size cargo is the cargo with parameters that do not exceed the following values:
  • weight is less than or equal to 10 kg;
  • LWH is less than or equal to 0.54*0.39*0.39 m;
  • volume is less than or equal to 0.1 cubic meters.
It is only possible to order Small Cargo Delivery service if there are Delovye Linii company terminals in the city of departure and city of arrival. For more information see company website.
payerNo
string

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

Packages
Packages
ParameterRequiredTypeDescription
uidYesstringPackage UID from "Directory of Additional Services"
payerNo
string

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"

countNo*integer

Number of bags or boxes.

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

AcDocs
AcDocs
ParameterRequiredTypeDescription
actionYesstring

Action over accompanying documents.

Available values:

  • "send";
  • "return"
payerYes
string

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"

DerivalArrival
DerivalArrival
ParameterRequiredTypeDescription
produceDateYesstring

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

Format: YYYY-MM-DD

Only for "request.delivery.derival" object
pickupParamsNo
PickupParams

Additional parameters of cargo delivery from the address

Only for "request.delivery.derival" object

variant

Yes
string

Shipping method.

Available values:

  • "terminal" - delivery from/to the terminal.
  • Note: If small-size cargo delivery is ordered ("delivery.deliverуType.type" request parameter value is "small"), then delivery from/to the terminal is not available;
  • "address" - delivery from/to the address;
  • "airport" - delivery to the airport.
    Note: The variant is used only for "request.delivery.arrival" object and only if air transportation is ordered ("delivery.deliverуType.type" request parameter value is "avia").  If delivery to the airport is ordered, then the request must contain "city" parameter and must not contain "terminalID" or "address" parameters
For "request.delivery.derival" only: If delivery from the address is ordered, then the order is placed, if delivery from the terminal - then pre-order
payerNo
string

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"

terminalIDNo*string

Terminal ID from the "Terminals" directory.

In case of express delivery ("delivery.deliverуType.type" request parameter value is "express") the terminal should accept/give out express cargoes: in Terminals directory the selected terminal should have "Worktables.Worktable.department" parameter with "Приём груза к экспресс-перевозке" value (in case of "request.delivery.derival" object)/"Выдача грузов экспресс-перевозки" (in case of "request.delivery.arrival" object).

For "request.delivery.arrival" only: it is only possible to choose a pick-up point or a default terminal in this case (in Terminals directory "city.terminals.terminal.isPVZ" or "city.terminals.terminal.default" parameter value should be "true" )

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

addressNo*Address

Address.

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

cityNo*string

CLADR code of the city. It's possible to get CLADR code using the services presented on the page "Using CLADR codes". The parameter is not allowed if "variant" parameter value is "address". If the parameter is passed the arrival terminal is determined automatically

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

Only for "request.delivery.arrival" object
additionalAddressNo
object

Picking up the cargo at an additional address

Only for "request.delivery.derival" object
additionalAddress.addressNoAddress

Address as a set of parameters

additionalAddress.payerNostring

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"

timeNo*object

Time of cargo hand over at the address.

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

time.worktimeStartYesstring

Period start.

Format: HH:MM

time.worktimeEndYesstring

Period end.

Format: HH:MM

time.breakStartNostring

Break start.

Format: HH:MM

time.breakEndNostring

Break end.

Format: HH:MM

time.exactTimeNoboolean

Delivery at the exact time.

Default value: "false"

handlingNoobjectLoading and unloading works at the address
handling.freightLiftNoboolean

Flag indicating that there is a service lift.

Default value: "false"

handling.toFloorNointeger

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

handling.carryNointeger

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

Maximum number of characters - 5

handling.payerNostring

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"

requirementsNoarray of strings

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.

PickupParams
PickupParams
ParameterRequiredTypeDescription
derivalDriverPassNo
integer

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
shipmentRegisterNoboolean

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"

paidEntryNoobjectParameter determining the need to pay the entry fee by the driver of DL when entering the territory of the sender to pick-up the cargo
paidEntry.costNo
floatAmount, rub.
paidEntry.typeNo
integer

Reimbursement method.

Available values:

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

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

priorCallNo
boolean

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"

noNeedAgreementNo
boolean

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)
documentsForReceiveNo
array of strings

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

Address
Address
ParameterRequiredTypeDescription

search

No (1)stringAddress as a string. Minimum 2 symbols, maximum 1024 (2)
streetNo (1)string

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

houseNo (1)string

House (2).

Maximum number of characters - 7

buildingNo
string

Building (2).

Maximum number of characters - 5

structureNo
string

Structure (2).

Maximum number of characters - 7

flatNo
string

Apartment/office (2).

Maximum number of characters - 5

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

Requester
Requester
ParameterRequiredTypeDescription
roleYesstring

Role in shipping.

Available values:

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

E-mail of the order requester

Member
Member
ParameterRequiredTypeDescription
counteragentYesCounteragent

Counterparty as a set of parameters

contactPersonsNo*array of ContactPersons

Contact person.

When the order is created from the public part, only one item in the "contactPersons" array can be passed.

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

contactPersons.nameYesstring

Name of contact person

phoneNumbersNo*array of PhoneNumbers

Phone number.

When the order is created from the public part, only one item in the "phoneNumbers" array can be passed.

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

phoneNumbers.numberYesstring

Phone number.

Maximum 15 digits

phoneNumbers.extNostring

Extension.

Maximum 5 digits

emailNostring

E-mail of the order requester

dataForReceiptNo*object

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)

dataForReceipt.sendYesboolean

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
dataForReceipt.phoneNo*string

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

dataForReceipt.emailNo*string

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

Counteragent
Counteragent
ParameterRequiredTypeDescription
formNostring

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"

customFormNo*object

Legal form of organization as a set of parameters.

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

customForm.formNameYesstring

Name of legal form of organization.

Maximum number of characters - 35

customForm.countryUIDYesstringCountry UID from the "Countries" directory
customForm.juridicalYesbooleanIndicator of juridical party
documentNo*object

Personal identification document

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

document.typeYesstring

Document type.

Available values:

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

The value "foreignPassport" is unavailable for some countries

document.serialYes*string

Serial of the document.

*Parameter is not required and ignored for some countries

document.numberYesstring

Document number.

Format depends on the country

isAnonymNoboolean

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"

phoneNo*string

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

nameYesstring

Name of counterparty

innNo*string

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

juridicalAddressNoAddress

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

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

Cargo
Cargo
ParameterRequiredTypeDescription
quantityNointeger

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

lengthYes*float

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"

widthYes*float

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"

heightYes*float

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"

weightNo*float

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"

totalVolumeYes*float

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"

totalWeightYes*float

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

No*float

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

oversizedVolumeNo*float

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

hazardClassNofloat

Hazard class of cargo.

Default value: "0"

insuranceNoobjectInformation about cargo insurance
insurance.statedValueNofloat

Declared value of the cargo, rub.

Maximum number of characters - 12

insurance.payerNostring

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"

insurance.termNoboolean

Flag of insurance of delivery time.

Default value: "true"

freightUIDNo*string

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"

freightNameNo*string

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

Payment

ParameterRequiredTypeDescription

type

Yesstring

Payment type.

Available values:

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

primaryPayer

Yesstring

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

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

paymentCitySearchNo*object

City of payment as a string.

*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

paymentCitySearch.search

YesstringCity 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

Method response

Response example

{  
   "metadata":{  
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{  
      "state":"success",
      "requestID":3954004,
      "barcode":"41508460D0905400400000014",
      "foundAddresses": [
         {
            "field": "delivery.derival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.derival.additionalAddress.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.arrival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.sender.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.receiver.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.third.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "payment.paymentCitySearch",
            "source": "Омск",
            "result": "Россия, Омская обл, г Омск"
         }
      ]
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>success</state>
      <requestID>3954004</requestID>
      <barcode>41508460D0905400400000014</barcode>
      <foundAddresses>
         <field>delivery.derival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.derival.additionalAddress.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.arrival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.sender.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.receiver.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.third.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>payment.paymentCitySearch</field>
         <source>Омск</source>
         <result>Россия, Омская обл, г Омск</result>
      </foundAddresses>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information about the order
metadata.statusinteger

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

metadata.generated_atstring

Date and time of the server response generation.

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

dataData

Information about the order

data.statestringRequest processing status
data.requestIDintegerNumber of created order or pre-order
data.barcodestringBarcode according to algorithm Code 128 (for pre-order, that is in case "delivery.derival.variant" request parameter value is "terminal")
data.foundAddressesarray of FoundAddressesData on found addresses/cities. The parameter is present in the response if "search" parameter of the "Address" class or "payment.paymentCitySearch.search" parameter was passed in the request

FoundAddresses

FoundAddresses

ParameterTypeDescription
fieldstringThe parent object that was used to pass the "search" parameter
sourcestring

Entered value

resultstring

Address/city found

Error handling

Except for common API errors the method response may contain the following errors:

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation

609013

400Ошибка параметров оплатыPayment parameters errorДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609016

400Ошибка при сохранении заявкиSaving order errorНевозможно сохранить заявкуUnable to save order