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

API
Главная / API - Suspension and resumption

Suspension and resumption of the cargo delivery

Обновлено 26.03.2020
84 кб

General information

This service allows suspending as well as resuming delivery.

Delivery suspension

Method request

Request example

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
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register

sessionID

YesstringTo get the session ID, use the User Authorization method

orderID

YesstringID of the order to be suspended
suspendDateYes
string

Suspension end date

Method response

Response example

{  
   "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
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated status http-code. If successful, code 200 is returned
metadata.generated_atstring

Server response date and time.

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

dataobject

Success confirmation

data.statestringRequest status. Possible value - "success"

Error handling

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

Error numberhttp-codeError title
TitleTranslation

608001

400Заказ не найденOrder not found

608002

400Операция недоступнаOperation unavailable

608003

400Некорректная датаIncorrect date

Delivery resumption

Method request

Request example

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
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register

sessionID

YesstringTo get the session ID, use the User Authorization method

orderID

YesstringID of the order to be resumed
resumeDateYesstring

Delivery resumption date

Method response

Response of the method "Delivery resumption" is similar to the response of the method "Delivery suspension".

Error handling

Errors of the method "Delivery resumption" are similar to the errors of the method "Delivery suspension".