Suspension and resumption of the cargo delivery
General information
This service allows suspending as well as resuming delivery. To suspend/resume the delivery full access to the sender is required (for more information on full access see "Available counterparties" method, the description of info.accessLevel parameter). To check the possibility of changing, use "Checking possibility to change the order" method. The changes do not come into effect immediately. To check the change request status use "Change history" method.
Delivery suspension
Method request
Request structure
Method address: https://api.dellin.ru/v3/orders/suspend.json
{
"appkey":"00000000-0000-0000-0000-000000000000",
"sessionID":"00000000-0000-0000-0000-000000000000",
"orderID":"345235",
"suspendDate":"2018-05-31"
}Method address: https://api.dellin.ru/v3/orders/suspend.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>345235</orderID> <suspendDate>2018-05-31</suspendDate> </request>
Description of parameters
Request
| Request | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
| appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | To get the session ID, use the User Authorization method |
orderID | Yes | string | ID of the order to be suspended |
| suspendDate | Yes | string | Suspension end date |
Method response
Response structure
{
"metadata":{
"status":200,
"generated_at":"2015-06-18 12:37:28"
},
"data":{
"state":"success"
}
}<response>
<metadata>
<status>200</status>
<generated_at>2015-06-18 12:37:28</generated_at>
</metadata>
<data>
<state>success</state>
</data>
</response>Description of parameters
Response
| Response | ||
|---|---|---|
| Parameter | Type | Description |
| metadata | object | System information |
| metadata.status | integer | Emulated status http-code. If successful, code 200 is returned |
| metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
| data | object | Success confirmation "Success" status indicates that the request was accepted. To check the change request status use "Change history" method |
| data.state | string | Request status. Possible value - "success" |
Error handling
Except for common API errors the method response may contain the following errors:
| Error number | http-code | Error title | |
|---|---|---|---|
| Title | Translation | ||
608001 | 400 | Заказ не найден | Order not found |
608002 | 400 | Операция недоступна | Operation unavailable |
608003 | 400 | Некорректная дата | Incorrect date |
Delivery resumption
Method request
Request structure
Method address: https://api.dellin.ru/v3/orders/resume.json
{
"appkey":"00000000-0000-0000-0000-000000000000",
"sessionID":"00000000-0000-0000-0000-000000000000",
"orderID":"345235",
"resumeDate":"2018-05-25"
}Method address: https://api.dellin.ru/v3/orders/resume.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>345235</orderID> <resumeDate>2018-05-25</resumeDate> </request>
Description of parameters
Request
| Request | |||
|---|---|---|---|
| Parameter | Required | Type | Description |
| appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | To get the session ID, use the User Authorization method |
orderID | Yes | string | ID of the order to be resumed |
| resumeDate | Yes | string | Delivery resumption date |
