Order limitations
General information
The method allows to get information on limitations and possible parameter values depending on order conditions.
Below is the description of all method parameters, for the requests and the responses examples see the relevant section.
Order limitations
Method request
Request structure
Method address: https://api.dellin.ru/v1/public/request_conditions.json
{
"appkey":"00000000-0000-0000-0000-000000000000",
"blocks":[
"day_to_day",
"packages",
"loadings",
"insurance"
],
"derivalPoint":"1000000100000000000000000",
"arrivalPoint":"7700000000000000000000000",
"volume":3,
"weight":1,
"derivalTerminalID":122,
"arrivalTerminalID":325,
"deliveryType":1,
"derivalDoor":true,
"arrivalDoor":true
}Method address: https://api.dellin.ru/v1/public/request_conditions.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <blocks>day_to_day</blocks> <blocks>packages</blocks> <blocks>loadings</blocks> <blocks>insurance</blocks> <derivalpoint>1000000100000000000000000</derivalpoint> <arrivalpoint>7700000000000000000000000</arrivalpoint> <volume>3</volume> <weight>1</weight> <derivalTerminalID>122</derivalTerminalID> <arrivalTerminalID>325</arrivalTerminalID> <deliveryType>1</deliveryType> <derivalDoor>true</derivalDoor> <arrivalDoor>true</arrivalDoor> </request>
Description of parameters
| Request | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
| appkey | Yes | string | Application key. To get the key, register |
blocks | Yes | array of strings | The list of additional services (that can be limited due to the order conditions) for which information is needed Possible values:
If the parameter is not passed in the request or the array is empty, then the response will contain information on all the services |
| derivalPoint | Yes | string | CLADR* code of the point of cargo dispatch. Either code of the city or code of the street can be used. To get CLADR code use the services listed on "CLADR search" page *CLADR - Classifier of Addresses of the Russian Federation |
| arrivalPoint | Yes | string | CLADR* code of the point of cargo arrival. Either code of the city or code of the street can be used. To get CLADR code use the services listed on "CLADR search" page |
| volume | Yes | float | Cargo volume, m3 |
| weight | Yes | float | Cargo weight, kg |
| derivalTerminalID | No | integer | ID of the terminal of cargo dispatch, see "Terminals directory" |
| arrivalTerminalID | No | integer | ID of the terminal of cargo arrival, see "Terminals directory" |
deliveryType | Yes | integer | ID of the shipping type, see "Directory of shipping types" |
derivalDoor | No | boolean | Flag indicating that delivery from the sender address is ordered. Default value - "false" |
arrivalDoor | No | boolean | Flag indicating that delivery from the receiver address is ordered. Default value - "false" |
Method response
Response structure
{
"day_to_day":{
"same_day_pickup_ends_at":"16:00:00",
"minimal_pickup_period":4,
"same_day_pickup_allowed":true,
"terminal_id":58,
"minimal_same_day_pickup_period":4
},
"packages":[
{
"incompatible_uids":[
"0x8783b183e825d40d4eb5c21ef63fbbfb",
"0xb9f594d27a2d31b440a647d19547543c"
],
"uid":"0x838fc70baeb49b564426b45b1d216c15"
},
{
"incompatible_uids":[
],
"uid":"0x951783203a254a05473c43733c20fe72"
},
{
"incompatible_uids":[
"0x84f7578779ae4a444e3dfc8b96d80e08"
],
"uid":"0x9a7f11408f4957d7494570820fcf4549"
},
{
"incompatible_uids":[
],
"uid":"0xa8b42ac5ec921a4d43c0b702c3f1c109"
},
{
"incompatible_uids":[
],
"uid":"0xad22189d098fb9b84eec0043196370d6"
},
{
"incompatible_uids":[
"0x9195b45e731fd4bd44c3157f2e23b33f"
],
"uid":"0xbaa65b894f477a964d70a4d97ec280be"
}
],
"loadings":{
"recipient":[
"0xb83b7589658a3851440a853325d1bf69",
"0xabb9c63c596b08f94c3664c930e77778",
"0x92fce2284f000b0241dad7c2e88b1655",
"0x88f93a2c37f106d94ff9f7ada8efe886",
"0x9951e0ff97188f6b4b1b153dfde3cfec",
"0x818e8ff1eda1abc349318a478659af08"
],
"sender":[
"0xb83b7589658a3851440a853325d1bf69",
"0xabb9c63c596b08f94c3664c930e77778",
"0x92fce2284f000b0241dad7c2e88b1655",
"0x88f93a2c37f106d94ff9f7ada8efe886",
"0x9951e0ff97188f6b4b1b153dfde3cfec",
"0x818e8ff1eda1abc349318a478659af08"
]
},
"insurance":{
"term_insurance_available":1
}
}<response>
<day_to_day>
<same_day_pickup_ends_at>16:00:00</same_day_pickup_ends_at>
<minimal_pickup_period>4</minimal_pickup_period>
<same_day_pickup_allowed>true</same_day_pickup_allowed>
<terminal_id>58</terminal_id>
<minimal_same_day_pickup_period>4</minimal_same_day_pickup_period>
</day_to_day>
<packages>
<incompatible_uids>0x8783b183e825d40d4eb5c21ef63fbbfb</incompatible_uids>
<incompatible_uids>0xb9f594d27a2d31b440a647d19547543c</incompatible_uids>
<uid>0x838fc70baeb49b564426b45b1d216c15</uid>
</packages>
<packages>
<uid>0x951783203a254a05473c43733c20fe72</uid>
</packages>
<packages>
<incompatible_uids>0x84f7578779ae4a444e3dfc8b96d80e08</incompatible_uids>
<uid>0x9a7f11408f4957d7494570820fcf4549</uid>
</packages>
<packages>
<uid>0xa8b42ac5ec921a4d43c0b702c3f1c109</uid>
</packages>
<packages>
<uid>0xad22189d098fb9b84eec0043196370d6</uid>
</packages>
<packages>
<incompatible_uids>0x9195b45e731fd4bd44c3157f2e23b33f</incompatible_uids>
<uid>0xbaa65b894f477a964d70a4d97ec280be</uid>
</packages>
<loadings>
<recipient>0xb83b7589658a3851440a853325d1bf69</recipient>
<recipient>0xabb9c63c596b08f94c3664c930e77778</recipient>
<recipient>0x92fce2284f000b0241dad7c2e88b1655</recipient>
<recipient>0x88f93a2c37f106d94ff9f7ada8efe886</recipient>
<recipient>0x9951e0ff97188f6b4b1b153dfde3cfec</recipient>
<recipient>0x818e8ff1eda1abc349318a478659af08</recipient>
<sender>0xb83b7589658a3851440a853325d1bf69</sender>
<sender>0xabb9c63c596b08f94c3664c930e77778</sender>
<sender>0x92fce2284f000b0241dad7c2e88b1655</sender>
<sender>0x88f93a2c37f106d94ff9f7ada8efe886</sender>
<sender>0x9951e0ff97188f6b4b1b153dfde3cfec</sender>
<sender>0x818e8ff1eda1abc349318a478659af08</sender>
</loadings>
<insurance>
<term_insurance_available>1</term_insurance_available>
</insurance>
</response>Description of parameters
| Response | ||
|---|---|---|
| Parameter | Type | Description |
| day_to_day | object | Information on possibility to hand over the cargo to the forwarding driver at the sender's address on the day of order |
| day_to_day.same_day_pickup_ends_at | string | Time until which it is possible to arrange to hand over the the cargo to the forwarding driver on the day of order, HH:MM:SS |
| day_to_day.minimal_pickup_period | integer | Minimal duration of the forwarding driver arrival interval, h (The client can indicate at what time the driver should arrive, the interval should not be less then parameter value) |
| day_to_day.same_day_pickup_allowed | boolean | Flag indicating that it is possible to hand over the cargo to the forwarding driver on the day of order |
| day_to_day.terminal_id | integer | Dispatch terminal ID (see "Terminals directory") |
| day_to_day.minimal_same_day_pickup_period | integer | Minimal duration of the forwarding driver arrival interval in case the cargo is handed over to the driver on the day of order, h (The client can indicate at what time the driver should arrive, in case the cargo is handed over to the driver on the day of order, the interval should not be less then parameter value) |
| packages | array of Response.Packages | Packages available subject to the indicated conditions |
| loadings | object | Available types of loading/additional arrangements for loading |
| loadings.recipient | array of strings | UIDs of types of loading/additional arrangements for loading available to receiver Possible values:
|
| loadings.sender | array of strings | UIDs of types of loading/additional arrangements for loading available to sender For possible values see the description of response.loadings.recipien parameter |
insurance | object | Information on delivery date insurance |
insurance.term_insurance_available | integer | Options for delivery date insurance. Possible values:
|
| Response.Packages | ||
|---|---|---|
| Parameter | Type | Description |
| incompatible_uids | array of strings | Array of UIDs of packages incompatible with the type which UID is passed in response.packages.uid parameter (see "Directory of packages") |
| uid | string | Packaging UID (see "Directory of packages") |
