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

API
Главная / API - Orders from the personal account

Orders for shipping from the personal account

Обновлено 16.07.2019
242 кб

General information

This service allows you to create orders for shipping using data of your personal account. It is possible to use this method without creating entries in the address book and save in the address book data entered when creating an order.

It's possible to create orders without authorization (from the public part). See description in the relevant section.

Order for shipping

Method request

Request example

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "inOrder":true,
   "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",
         "addressID":"457824578",
         "address":{  
            "street":"7800000000004380000000000",
            "house":"4",
            "building":"3",
            "structure":"лит. А",
            "flat":"214а",
            "save":true
         },
         "additionalAddress":{  
            "addressID":"",
            "address":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"3",
               "structure":"лит. А",
               "flat":"214а",
               "save":true
            },
            "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",
         "addressID":"457824578",
         "city":"7700000000000000000000000",
         "address":{  
            "street":"7800000000004380000000000",
            "house":"4",
            "building":"3",
            "structure":"лит. А",
            "flat":"214а",
            "save":true
         },
         "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":"payer",
         "uid":"f969722a-cca3-49ed-85ff-b6be9e904b94",
         "email":"test@mail.ru"
      },
      "sender":{  
         "counteragentID":"456783515",
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            "12345678",
            "78456123"
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            "98765412",
            "65478921"
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "email":"test@mail.ru",
         "dataforreceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "receiver":{  
         "counteragentID":"456783515",
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "isAnonym":false,
            "phone":"79998887766",
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            "12345678",
            "78456123"
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            "98765412",
            "65478921"
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "email":"test@mail.ru",
         "dataforreceipt":{
            "send":true,
            "phone":"+79999999999",
            "email":"test@mail.ru"
         }
      },
      "third":{  
         "counteragentID":"456783515",
         "counteragent":{  
            "form":"0x8F51001438C4D49511DBD774581EDB80",
            "customForm":{  
               "formName":"ОБРУГ",
               "countryUID":"0x00000000000000000000000000000000",
               "juridical":true
            },
            "document":{  
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"Ромашка",
            "inn":"1234567890",
            "juridicalAddress":{  
               "street":"7800000000004380000000000",
               "house":"4",
               "building":"2",
               "structure":"3А",
               "flat":"Б-234"
            },
            "save":true
         },
         "contactIDs":[  
            "12345678",
            "78456123"
         ],
         "contactPersons":[  
            {  
               "name":"Иван Иванович",
               "save":true
            },
            {  
               "name":"Петр Петрович",
               "save":false
            }
         ],
         "phoneIDs":[  
            "98765412",
            "65478921"
         ],
         "phoneNumbers":[  
            {  
               "number":"79213332211",
               "ext":"0123",
               "save":true
            }
         ],
         "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":{  
      "cashOnDelivery":[  
         {  
            "orderNumber":"123456",
            "orderDate":"2018-04-09",
            "paymentType":"cash",
            "products":[  
               {  
                  "productName":"Кофеварка BRAUN",
                  "productCode":"K-2300",
                  "productAmount":"1",
                  "costWithVAT":"17800",
                  "VATRate":18
               }
            ]
         }
      ],
      "type":"cash",
      "primaryPayer":"sender",
      "paymentCity":"7800000000000000000000000"
   }
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <inOrder>true</inOrder>
   <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>
         <addressID>457824578</addressID>
         <address>
            <street>7800000000004380000000000</street>
            <house>4</house>
            <building>3</building>
            <structure>лит. А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <additionalAddress>
            <addressID></addressID>
            <address>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>3</building>
               <structure>лит. А</structure>
               <flat>214а</flat>
               <save>true</save>
            </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>
         <addressID>457824578</addressID>
         <city>7700000000000000000000000</city>
         <address>
            <street>7800000000004380000000000</street>
            <house>4</house>
            <building>3</building>
            <structure>лит. А</structure>
            <flat>214а</flat>
            <save>true</save>
         </address>
         <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>payer</role>
         <uid>f969722a-cca3-49ed-85ff-b6be9e904b94</uid>
         <email>test@mail.ru</email>
      </requester>
      <sender>
         <counteragentID>456783515</counteragentID>
         <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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataforreceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataforreceipt>
      </sender>
      <receiver>
         <counteragentID>456783515</counteragentID>
         <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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </phoneNumbers>
         <email>test@mail.ru</email>
         <dataforreceipt>
            <send>true</send>
            <phone>+79999999999</phone>
            <email>test@mail.ru</email>
         </dataforreceipt>
      </receiver>
      <third>
         <counteragentID>456783515</counteragentID>
         <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>
               <street>7800000000004380000000000</street>
               <house>4</house>
               <building>2</building>
               <structure>3А</structure>
               <flat>Б-234</flat>
            </juridicalAddress>
            <save>true</save>
         </counteragent>
         <contactIDs>12345678</contactIDs>
         <contactIDs>78456123</contactIDs>
         <contactPersons>
            <name>Иван Иванович</name>
            <save>true</save>
         </contactPersons>
         <contactPersons>
            <name>Петр Петрович</name>
            <save>false</save>
         </contactPersons>
         <phoneIDs>98765412</phoneIDs>
         <phoneIDs>65478921</phoneIDs>
         <phoneNumbers>
            <number>79213332211</number>
            <ext>0123</ext>
            <save>true</save>
         </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>
      <cashOnDelivery>
         <orderNumber>123456</orderNumber>
         <orderDate>2018-04-09</orderDate>
         <paymentType>cash</paymentType>
         <products>
            <productName>Кофеварка BRAUN</productName>
            <productCode>K-2300</productCode>
            <productAmount>1</productAmount>
            <costWithVAT>17800</costWithVAT>
            <VATRate>18</VATRate>
         </products>
      </cashOnDelivery>
      <type>cash</type>
      <primaryPayer>sender</primaryPayer>
      <paymentCity>7800000000000000000000000</paymentCity>
   </payment>
</request>

Description of parameters

Request
Request
ParameterR*TypeDescription
Root parameters
appkeyYesstringThe application key. To get the key, register
sessionIDYesstring

To get the session ID, use the User Authorization method

inOrderNo
boolean

If the value is "false", then the order is saved, but not transferred to further processing.

Default value: "true"

deliveryYes
objectDelivery parameters
delivery.deliveryTypeYesDeliveryType

Delivery type for terminal-to-terminal shipping

delivery.packagesNoarray of Package

List of required packages

delivery.accompanyingDocumentsNoarray of AcDocAccompanying documents
delivery.derivalYesDerivalDelivery from the address
delivery.arrivalYesArrivalDelivery 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
object
Payment parameters
payment.typeYesstring

Payment type.

Available values:

  • "cash"
  • "noncash"
payment.primaryPayerYesstring

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

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

payment.cashOnDeliveryNoarray of CashOnDelivery

Cash on delivery

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

DeliveryType
DeliveryType
ParameterR*TypeDescription
typeYes
string

Delivery type.

Available values:

  • "auto" (by truck)
  • "express"
  • "small" (small-size cargo)
  • "letter"
  • "avia"
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"

Package
Package
ParameterR*TypeDescription
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

AcDoc
AcDoc
ParameterR*TypeDescription
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"

Derival
Derival
ParameterR*TypeDescription
produceDateYesstring

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

Format: YYY-MM-DD

pickupParamsNo
PickupParams

Additional parameters of cargo delivery from the address

variantYes
string

Shipping method.

Available values:

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

terminalIDYes*integer

Terminal ID from the "Terminals" directory.

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

addressIDYes*integer

Address ID from the "Address book".

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

addressYes*Address

Address as a set of parameters.

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

additionalAddressNo
object
Picking up the cargo at an additional address
additionalAddress.addressIDNo*integer

Address ID from the "Address book".

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

additionalAddress.addressNo*Address

Address as a set of parameters.

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

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"

timeYes*object

Time of cargo picking up.

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

time.worktimeStartYesstring

Beginning of period of cargo picking up.

Format: HH:MM

time.worktimeEndYesstring

End of period of cargo picking up.

Format: HH:MM

time.breakStartNostring

Beginning of the break.

Format: HH:MM

time.breakEndNostring

End of the break.

Format: HH:MM

time.exactTimeNoboolean

Delivery at the exact time.

Default value: "false"

handlingNoobjectLoading and unloading works at the address
handling.freightLiftNoboolean

There is a freight elevator.

Default value: "false"

handling.toFloorNointeger

Number of the floor.

Maximum number of characters - 5

handling.carryNointeger

The distance of carrying the load manually.

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 string

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
ParameterR*TypeDescription
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 string

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
ParameterR*TypeDescription
streetYesstring

CLADR code of the street from the "Streets" directory

houseYesstring

House.

Maximum number of characters - 5

buildingNo
string

Building.

Maximum number of characters - 5

structureNo
string

Structure.

Maximum number of characters - 5

flatNo
string

Apartmetn/office.

Maximum number of characters - 5

saveNo
boolean

Indicator of saving the object in the address book.

Default value: "false".

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

Arrival
Arrival
ParameterR*TypeDescription
variantYesstring

Shipping method.

Available values:

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

terminalIDYes*integer

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", "addressID", "address", "city"

addressIDYes*integer

Address ID from the "Address book".

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

addressYes*Address

Address as a set of parameters.

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

cityYes*string

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

*It's possible to pass only one of parameters: "terminalID", "addressID", "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

timeYes*object

Time of cargo delivery.

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

time.worktimeStartYesstring

Beginning of period of cargo delivery.

Format: HH:MM

time.worktimeEndYesstring

End of period of cargo delivery.

Format: HH:MM

time.breakStartNostring

Beginning of the break.

Format: HH:MM

time.breakEndNostring

End of the break.

Format: HH:MM

time.exactTimeNoboolean

Delivery at the exact time.

Default value: "false"

handlingNoobject

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

handling.freightLiftNoboolean

There is a freight elevator.

Default value: "false"

handling.toFloorNointeger

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

Maximum number of characters - 5

handling.carryNointeger

The distance of carrying the load manually.

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 string

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.

Requester
Requester
ParameterR*TypeDescription
roleYesstring

Role in shipping.

Available values:

  • "sender"
  • "receiver"
  • "payer"
  • "third" (third party)
uidYes*string

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

emailNostring

E-mail of the order requester.

Maximum number of characters - 128

Member
Member
ParameterR*TypeDescription
counteragentIDYes*integer

Counterparty ID from the "Address book".

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

counteragentYes*Counteragent

Counterparty as a set of parameters.

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

contactIDsYes*array of integer

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

contactPersonsYes*array of ContactPerson

List of contact persons.

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

phoneIDsYes*array of integer

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

phoneNumbersYes*array of PhoneNumber

List of phone numbers.

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

emailNostring

E-mail of the order requester.

Maximum number of characters - 128

dataforreceiptYes*DataForReceipt

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

Counteragent
Counteragent
ParameterR*TypeDescription
formYes*integer

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"

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

phoneYes*string

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

nameYesstring

Name of counterparty

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

juridicalAddressYes*Address

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

saveNoboolean

Indicator of saving the object in the address book.

Default value: "false"

ContactPerson
ContactPerson
ParameterR*TypeDescription
nameYesstring

Name of contact person

saveNoboolean

Indicator of saving the object in the address book.

Default value: "false".

Parameter is ignored for the third party

PhoneNumber
PhoneNumber
ParameterR*TypeDescription
numberYesstring

Phone number.

Maximum number of characters - 15

extNostring

Extension.

Maximum number of characters - 5

saveNo
boolean

Indicator of saving the object in the address book.

Default value: "false".

Parameter is ignored for the third party

DataForReceipt
DataForReceipt
ПараметрR*ТипОписание
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
phoneYes*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

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

Cargo
Cargo
ParameterR*TypeDescription
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"

oversizedVolumeNo*float

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

oversizedWeightNo*float

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

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"

freightNameYes*string

Nature of cargo (textual value).

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

freightUIDYes*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.

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

CashOnDelivery
CashOnDelivery
ParameterR*TypeDescription
orderNumberNostring

Online store order number

orderDateNo
date

Order date.

Format: "YYYY-MM-DD"

paymentTypeNo
string

Payment type.

Available values:

  • "cash"
  • "card"
productsNo
array of Product

List of products

Product
Product
ParameterR*TypeDescription
productNameYes
string

Product name

productCodeNostring

Product code

productAmountYes
integer

Quantity

costWithVATYesfloat

Cost with VAT, rub.

VATRateNo
integer

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

Method response

Response example

{  
   "metadata":{  
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{  
      "state":"success",
      "requestID":"3954004",
      "barcode":"41508460D0905400400000014",
      "addressBook":{  
         "sender":{  
            "counteragent":{  
               "id":2132424,
               "state":"existed"
            },
            "address":{  
               "id":89985444,
               "state":"new"
            },
            "contactPersons":[  
               {  
                  "id":78436784,
                  "state":"existed",
                  "value":"Иван Иванович"
               },
               {  
                  "id":3778489,
                  "state":"new",
                  "value":"Петр Петрович"
               }
            ],
            "phoneNumbers":[  
               {  
                  "id":6543687564,
                  "state":"existed",
                  "value":"795545785587"
               },
               {  
                  "id":4574583767,
                  "state":"new",
                  "value":"0127588848887588"
               }
            ]
         }
      }
   }
}
<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>
      <addressBook>
         <sender>
            <counteragent>
               <id>2132424</id>
               <state>existed</state>
            </counteragent>
            <address>
               <id>89985444</id>
               <state>new</state>
            </address>
            <contactPersons>
               <id>78436784</id>
               <state>existed</state>
               <value>Иван Иванович</value>
            </contactPersons>
            <contactPersons>
               <id>3778489</id>
               <state>new</state>
               <value>Петр Петрович</value>
            </contactPersons>
            <phoneNumbers>
               <id>6543687564</id>
               <state>existed</state>
               <value>795545785587</value>
            </phoneNumbers>
            <phoneNumbers>
               <id>4574583767</id>
               <state>new</state>
               <value>0127588848887588</value>
            </phoneNumbers>
         </sender>
      </addressBook>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information about the order
metadata.statusstring

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

metadata.generated_atstring

Date and time of the server respone generation.

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

dataData

Information about the order

Data
Data
ParameterTypeDescription
statestringRequest processing status
requestIDstring

Number of created order or pre-order

barcodestring

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

addressBookAddressBook

Information about saving data in the address book

AddressBook
AddressBook
ParameterTypeDescription
senderMember

Sender

receiverMemberReceiver
thirdMemberThird party

Member
Member
ParameterTypeDescription
counteragentobjectInformation about counteragent
counteragent.idintegerCounteragent ID
counteragent.statestring

Counteragent status.

Possible values:

  • "existed"
  • "new"
addressobjectInformation about address
address.idintegerAddress ID
address.statestring

Address status.

Possible values:

  • "existed"
  • "new"
contactPersonsarray of ContactPerson

List of contact persons

phoneNumbersarray of PhoneNumber

List of phone numbers

ContactPerson
ContactPerson
ParameterTypeDescription
idintegerContact person ID
statestring

Contact person status.

Possible values:

  • "existed"
  • "new"
valuestringFull name of the contact person

PhoneNumber
PhoneNumber
ParameterTypeDescription
idintegerPhone number ID
statestring

Phone number status.

Possible values:

  • "existed"
  • "new"
valuestringPhone number

Error handling

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation

609001

400Указан некорректный документ, удостоверяющий личностьInvalid personal identification document specifiedПроверьте правильность переданных значенийCheck if the passed values are correct

609002

400Указан некорректный адресInvalid address specifiedУказан некорректный адресInvalid address specified

609003

400Выбран недопустимый терминалInvalid terminal selectedВыбран недопустимый терминалInvalid terminal selected

609004

400Услуга недоступнаService unavailableВыбранная услуга недоступна для указанных параметров перевозкиSpecified service is unavailable for selected parameters of the shipment

609005

400Значение превышает допустимоеValue exceeds the allowableГабариты превышают допустимые размерыDimensions exceed allowable sizes

609006

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

609007

400Недопустимое значение параметраInvalid parameter valueДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609008

400Ошибка упрощенной отправкиError of simplified shipmentДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609009

400Ошибка оформления услуги Доставка в день заказаError of ordering service of cargo delivery on the same dayДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609010

400Ошибка оформления услуги Доставка в точное времяError of ordering service of cargo delivery at the exact timeДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609011

400Указан некорректный период работыInvalid work period specifiedДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609012

400Выбранная дата недоступнаSpecified date is not availableДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609013

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

609014

400Ошибка наложенного платежаCash on delivery errorДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609015

400Ошибка оформления услугиService issue errorДетальное описание ошибки см. в поле "detail" ответаDetailed error description see in the field "detail" of the response

609016

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