Orders for shipping from the public part
General information
This service allows you to create orders for shipping without authorization (from the public part).
On creating orders with data of your personal account, see the relevant section.
Order for shipping
Method request
Request example
Method address: https://api.dellin.ru/v2/request.json
{ "appkey":"00000000-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":{ "street":"7800000000004380000000000", "house":"4", "building":"3", "structure":"лит. А", "flat":"214а" }, "additionalAddress":{ "address":{ "street":"7800000000004380000000000", "house":"4", "building":"3", "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", "city":"7700000000000000000000000", "address":{ "street":"7800000000004380000000000", "house":"4", "building":"3", "structure":"лит. А", "flat":"214а" }, "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":{ "street":"7800000000004380000000000", "house":"4", "building":"2", "structure":"3А", "flat":"Б-234" } }, "contactPersons":[ { "name":"Иван Иванович" } ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ], "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":{ "street":"7800000000004380000000000", "house":"4", "building":"2", "structure":"3А", "flat":"Б-234" } }, "contactPersons":[ { "name":"Иван Иванович" } ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ], "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":{ "street":"7800000000004380000000000", "house":"4", "building":"2", "structure":"3А", "flat":"Б-234" } }, "contactPersons":[ { "name":"Иван Иванович" } ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ], "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":"7800000000000000000000000" } }
Method address: https://api.dellin.ru/v2/request.xml
<request> <appkey>00000000-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> <street>7800000000004380000000000</street> <house>4</house> <building>3</building> <structure>лит. А</structure> <flat>214а</flat> </address> <additionalAddress> <address> <street>7800000000004380000000000</street> <house>4</house> <building>3</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> <city>7700000000000000000000000</city> <address> <street>7800000000004380000000000</street> <house>4</house> <building>3</building> <structure>лит. А</structure> <flat>214а</flat> </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>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> <street>7800000000004380000000000</street> <house>4</house> <building>2</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> </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> <street>7800000000004380000000000</street> <house>4</house> <building>2</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> </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> <street>7800000000004380000000000</street> <house>4</house> <building>2</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> </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>7800000000000000000000000</paymentCity> </payment> </request>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | R* | Type | Description |
Root parameters | |||
appkey | Yes | string | The application key. To get the key, register |
delivery | Yes | object | Delivery parameters |
delivery.deliveryType | Yes | DeliveryType | Delivery type for terminal-to-terminal shipping |
delivery.packages | No | array of Package | List of required packages |
delivery.accompanyingDocuments | No | array of AcDoc | Accompanying documents |
delivery.derival | Yes | Derival | Delivery from the address |
delivery.arrival | Yes | Arrival | Delivery to the address |
delivery.smsback | No | string | Phone number for SMS-notifications. Format: "7XXXXXXXXXX" (11 figures, starts with 7) |
delivery.comment | No | string | Comment to the order. Maximum field length: 500 characters |
members | Yes | object | Shipping members |
members.requester | Yes | Requester | Order requester |
members.sender | Yes | Member | Sender |
members.receiver | Yes | Member | Receiver |
members.third | No | Member | Third party |
cargo | Yes | Cargo | Cargo characteristics |
payment | Yes | object | Payment parameters |
payment.type | Yes | string | Payment type. Available values:
|
payment.primaryPayer | Yes | string | 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:
|
payment.paymentCity | No* | 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 |
DeliveryType
DeliveryType | |||
---|---|---|---|
Parameter | R* | Type | Description |
type | Yes | string | Delivery type. Available values:
|
payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
Package
Package | |||
---|---|---|---|
Parameter | R* | Type | Description |
uid | Yes | string | Package UID from "Directory of Additional Services" |
payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
count | No* | integer | Number of bags or boxes. Parameter is required if the package "bag" ("Упаковка мешок") or "carton box" ("Картонная коробка") is selected |
AcDoc
AcDoc | |||
---|---|---|---|
Parameter | R* | Type | Description |
action | Yes | string | Action over accompanying documents. Available values:
|
payer | Yes | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
Derival
Derival | |||
---|---|---|---|
Parameter | R* | Type | Description |
produceDate | Yes | string | Date of cargo transfer to the terminal of departure or date of truck arrival to the sender. Format: YYY-MM-DD |
pickupParams | No | PickupParams | Additional parameters of cargo delivery from the address |
variant | Yes | string | Shipping method. Available values:
|
payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
terminalID | Yes* | integer | Terminal ID from the "Terminals" directory. *It's possible to pass only one of parameters: "terminalID", "address" |
address | Yes* | Address | Address as a set of parameters. *It's possible to pass only one of parameters: "terminalID", "address" |
additionalAddress | No | object | Picking up the cargo at an additional address |
additionalAddress.address | No | Address | Address as a set of parameters |
additionalAddress.payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
time | Yes* | object | Time of cargo picking up. *Parameter is required only if specified shipping method is "address" |
time.worktimeStart | Yes | string | Beginning of period of cargo picking up. Format: HH:MM |
time.worktimeEnd | Yes | string | End of period of cargo picking up. Format: HH:MM |
time.breakStart | No | string | Beginning of the break. Format: HH:MM |
time.breakEnd | No | string | End of the break. Format: HH:MM |
time.exactTime | No | boolean | Picking up at the exact time. Default value: "false" |
handling | No | object | Loading and unloading works at the address |
handling.freightLift | No | boolean | There is a freight elevator. Default value: "false" |
handling.toFloor | No | integer | Number of the floor. Maximum number of characters - 5 |
handling.carry | No | integer | The distance of carrying the load manually. Maximum number of characters - 5 |
handling.payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
requirements | No | array 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 | |||
---|---|---|---|
Parameter | R* | Type | Description |
derivalDriverPass | No | 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:
|
shipmentRegister | No | boolean | 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" |
paidEntry | No | object | Parameter 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.Cost | No | float | Amount, rub. |
paidEntry.Type | No | integer | Reimbursement method. Available values:
|
shipmentDerival | No | 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 |
priorCall | No | 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" |
noNeedAgreement | No | boolean | Parameter determining the need to agree the order for shipment with the sender. Available values:
|
documentsForReceive | No | 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 | |||
---|---|---|---|
Parameter | R* | Type | Description |
street | Yes | string | CLADR code of the street from the "Streets" directory |
house | Yes | string | House. Maximum number of characters - 5 |
building | No | string | Building. Maximum number of characters - 5 |
structure | No | string | Structure. Maximum number of characters - 5 |
flat | No | string | Apartmetn/office. Maximum number of characters - 5 |
Arrival
Arrival | |||
---|---|---|---|
Parameter | R* | Type | Description |
variant | Yes | string | Shipping method. Available values:
|
payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
terminalID | Yes* | 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", "address", "city" |
address | Yes* | Address | Address as a set of parameters. *It's possible to pass only one of parameters: "terminalID", "address", "city" |
city | Yes* | string | 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 | Yes* | object | Time of cargo delivery. *Parameter is required only if specified shipping method is "address" |
time.worktimeStart | Yes | string | Beginning of period of cargo delivery. Format: HH:MM |
time.worktimeEnd | Yes | string | End of period of cargo delivery. Format: HH:MM |
time.breakStart | No | string | Beginning of the break. Format: HH:MM |
time.breakEnd | No | string | End of the break. Format: HH:MM |
time.exactTime | No | boolean | Delivery at the exact time. Default value: "false" |
handling | No | object | 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.freightLift | No | boolean | There is a freight elevator. Default value: "false" |
handling.toFloor | No | integer | Number of the floor to which the cargo is to be lifted. Maximum number of characters - 5 |
handling.carry | No | integer | The distance of carrying the load manually. Maximum number of characters - 5 |
handling.payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
requirements | No | array 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 | |||
---|---|---|---|
Parameter | R* | Type | Description |
role | Yes | string | Role in shipping. Available values:
|
Yes | string | E-mail of the order requester. Maximum number of characters - 128 |
Member
Member | |||
---|---|---|---|
Parameter | R* | Type | Description |
counteragent | Yes | Counteragent | Counterparty as a set of parameters |
contactPersons | Yes* | array of ContactPerson | 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 counteragent that is an anonymous receiver |
phoneNumbers | Yes* | array of PhoneNumber | 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 |
No | string | E-mail of the order requester. Maximum number of characters - 128 |
Counteragent
Counteragent | |||
---|---|---|---|
Parameter | R* | Type | Description |
form | Yes* | 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" |
customForm | Yes* | object | Legal form of organization as a set of parameters. *It's possible to pass only one of parameters: "form", "customForm" |
customForm.formName | Yes | string | Name of legal form of organization. Maximum number of characters - 35 |
customForm.countryUID | Yes | string | Country UID from the "Countries" directory |
customForm.juridical | Yes | boolean | Indicator of juridical party |
document | Yes* | object | Personal identification document *Parameter is required only if both of parameters "customForm.juridical" and "isAnonym" are passed with the value "false" |
document.type | Yes | string | Document type. Available values:
The value "foreignPassport" is unavailable for some countries |
document.serial | Yes* | string | Serial of the document. *Parameter is not required and ignored for some countries |
document.number | Yes | string | Document number. Format depends on the country |
isAnonym | No | boolean | 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 | Yes* | 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 |
name | Yes | string | Name of counterparty |
inn | Yes* | 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") |
juridicalAddress | Yes* | 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") |
ContactPerson
ContactPerson | |||
---|---|---|---|
Parameter | R* | Type | Description |
name | Yes | string | Name of contact person |
PhoneNumber
PhoneNumber | |||
---|---|---|---|
Parameter | R* | Type | Description |
number | Yes | string | Phone number. Maximum number of characters - 15 |
ext | No | string | Extension. Maximum number of characters - 5 |
Cargo
Cargo | |||
---|---|---|---|
Parameter | R* | Type | Description |
quantity | No | integer | 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 | Yes* | 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" |
width | Yes* | 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" |
height | Yes* | 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" |
weight | No* | 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" |
totalVolume | Yes* | 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" |
totalWeight | Yes* | 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" |
oversizedVolume | No* | 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 |
oversizedWeight | No* | 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 |
hazardClass | No | float | Hazard class of cargo. Default value: "0" |
insurance | No | object | Information about cargo insurance |
insurance.statedValue | No | float | Declared value of the cargo, rub. Maximum number of characters - 12 |
insurance.payer | No | string | Payer for the service. Available values:
If parameter is not passed, then it takes the value of the parameter "Request.Payment.primaryPayer" |
insurance.term | No | boolean | Flag of insurance of delivery time. Default value: "true" |
freightName | Yes* | string | Nature of cargo (textual value). *It's possible to pass only one of parameters: "freightName", "freightUID" |
freightUID | Yes* | 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" |
Method response
Response example
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":{ "state":"success", "requestID":"3954004", "barcode":"41508460D0905400400000014" } }
<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> </data> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information about the order |
metadata.status | string | Emulated http-code of status. In case of success the code "200" returns |
metadata.generated_at | string | Date and time of the server respone generation. Format: "YYYY-MM-DD HH:MM:SS" |
data | Data | Information about the order |
Data
Data | ||
---|---|---|
Parameter | Type | Description |
state | string | Request processing status |
requestID | string | Number of created order or pre-order |
barcode | string | Barcode according to algorithm Code 128 (for pre-order) |
Error handling
Error number | http-code | Error title | Error description | ||
---|---|---|---|---|---|
Title | Translation | Description | Translation | ||
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 |