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

API
Главная / API - Checking possibility to change the

Checking possibility to change the order

Обновлено 14.05.2020
97 кб

General information 

The service allows checking possibility of

  • changing the receiver;
  • changing the payer;
  • changing the payment method;
  • changing the order contact info;
  • changing the shipping or the delivery addresses;
  • suspending or resuming the cargo delivery;
  • cancelling the shipping from the sender's address;
  • cancelling the delivery to the receiver's address (the receiver will pick up the cargo from Delovye Linii company terminal).

Changing the order receiver data

Method request

Request example

Method address: https://api.dellin.ru/v3/orders/change_available.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":00000000
}

Method address: https://api.dellin.ru/v3/orders/change_available.xml

<request>
	<appkey>00000000-0000-0000-0000-000000000000</appkey>
	<sessionID>00000000-0000-0000-0000-000000000000</sessionID>
	<orderID>00000000</orderID>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription

appkey

YesstringApplication key. To get the key, register
sessionIDYesstringSession ID. To get the session ID, use User authorization service

orderID

YesintegerThe number of the order for which it is necessary to check the possibility of changing the data

Method response

Response example

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "receiver":{
         "available":true,
         "displayName":"Изменение получателя по заказу"
      },
      "payer":{
         "available":true,
         "displayName":"Изменение плательщика по заказу"
      },
      "contactInfo":{
         "changeSender":{
            "available":true,
            "displayName":"Изменение контактной информации об отправителе"
         },
         "changeReceiver":{
            "available":true,
            "displayName":"Изменение контактной информации о получателе"
         }
      },
      "pickupInfo":{
         "available":true,
         "displayName":"Изменение информации об адресе и времени забора"
      },
      "deliveryInfo":{
         "available":true,
         "displayName":"Изменение информации об адресе и времени доставки"
      },
      "suspend":{
         "available":true,
         "displayName":"Приостановка выдачи груза",
         "info":{
            "terminalInfo":"Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б",
            "availableTill":"2018-06-10",
            "warning":"Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.",
            "terminalId":53,
            "stateInfo":"Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу."
         }
      },
      "resume":{
         "available":false,
         "displayName":"Возобновление выдачи груза",
         "info":{
            "terminalInfo":"Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б",
            "availableTill":"2018-06-10",
            "warning":"Снятие ограничения в день запроса не гарантировано при подаче запроса вечером. Информация о том, что ограничение на выдачу груза снято, появится в карточке заказа",
            "terminalId":53,
            "stateInfo":"Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу."
         }
      },
      "cancelPickup":{
         "available":true,
         "displayName":"Отмена забора груза от адреса"
      },
      "cancelDelivery":{
         "available":true,
         "displayName":"Отмена доставки груза до адреса"
      }
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <receiver>
         <available>true</available>
         <displayName>Изменение получателя по заказу</displayName>
      </receiver>
      <payer>
         <available>true</available>
         <displayName>Изменение плательщика по заказу</displayName>
      </payer>
      <contactInfo>
         <changeSender>
            <available>true</available>
            <displayName>Изменение контактной информации об отправителе</displayName>
         </changeSender>
         <changeReceiver>
            <available>true</available>
            <displayName>Изменение контактной информации о получателе</displayName>
         </changeReceiver>
      </contactInfo>
      <pickupInfo>
         <available>true</available>
         <displayName>Изменение информации об адресе и времени забора</displayName>
      </pickupInfo>
      <deliveryInfo>
         <available>true</available>
         <displayName>Изменение информации об адресе и времени доставки</displayName>
      </deliveryInfo>
      <suspend>
         <available>true</available>
         <displayName>Приостановка выдачи груза</displayName>
         <info>
            <terminalInfo>Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б</terminalInfo>
            <availableTill>2018-06-10</availableTill>
            <warning>Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.</warning>
            <terminalId>53</terminalId>
            <stateInfo>Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу.</stateInfo>
         </info>
      </suspend>
      <resume>
         <available>false</available>
         <displayName>Возобновление выдачи груза</displayName>
         <info>
            <terminalInfo>Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б</terminalInfo>
            <availableTill>2018-06-10</availableTill>
            <warning>Снятие ограничения в день запроса не гарантировано при подаче запроса вечером. Информация о том, что ограничение на выдачу груза снято, появится в карточке заказа</warning>
            <terminalId>53</terminalId>
            <stateInfo>Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу.</stateInfo>
         </info>
      </resume>
      <cancelPickup>
         <available>true</available>
         <displayName>Отмена забора груза от адреса</displayName>
      </cancelPickup>
      <cancelDelivery>
         <available>true</available>
         <displayName>Отмена доставки груза до адреса</displayName>
      </cancelDelivery>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusinteger

Emulated status http-code. If successful, code 200 is returned. In case of error - 400

metadata.generated_atstring

Server response date and time.

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

dataobjectInformation on possibility of changing order data

Data

Data

ParameterTypeDescription
receiverChangeInfoInfo on possibility of changing the receiver
payerChangeInfo

Info on possibility of changing the payer

contactInfoobject

Info on possibility of changing the contact info

contactInfo.changeSenderChangeInfoInfo on possibility of changing the sender contact info
contactInfo.changeReceiverChangeInfoInfo on possibility of changing the receiver contact info
pickupInfoChangeInfo

Info on possibility of changing the sender's address as well as the time when the forwarding driver should pick up the cargo from the sender

deliveryInfoChangeInfo

Info on possibility of changing the receiver's address as well as the time when the forwarding driver should hand over the cargo to the receiver

suspend

ChangeInfoInfo on possibility of suspending the delivery

resume

ChangeInfoInfo on possibility of resuming the delivery
cancelPickupChangeInfo

Info on possibility of cancelling the shipping from the sender's address

cancelDeliveryChangeInfo

Info on possibility of cancelling the shipping to the receiver's address (the receiver will pick up the cargo from Delovye Linii company terminal)

ChangeInfo
ChangeInfo
ParameterTypeDescription
availableboolean

Flag indicating that it is possible to change the data

Possible values:

  • "true" - the data can be changed;
  • "false" - the data can not be changed
displayNamestring

Info to be changed

infoobject

Additional info on possibility of changing the data

info.terminalInfostringInfo on the terminal where the cargo will be delivered

info.availableTill

string

Date up to which (inclusive) it is possible to suspend/resume the cargo delivery

info.warningstring

Additional information relevant if the date received in the parameter "info.availableTill" is passed in the request of cargo delivery suspension/resumption method (as a value of "suspendDate"/"resumeDate" parameter) 

info.terminalIdintegerID of the terminal where the cargo will be delivered
info.stateInfostring

Additional info

Error handling

The common API errors are used with the method, for errors format description and errors list see Errors of API methods.