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

API
Главная / API - История изменений заказа

История изменений заказа

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

Общие сведения

Сервис позволяет получать историю изменений заказов. Сервис доступен только авторизованным пользователям.

История изменений заказа

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v3/orders/history.json

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

Адрес метода: https://api.dellin.ru/v3/orders/history.xml

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

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

orderID

ДаstringНомер заказа, по которому необходимо получить данные

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2020-03-27 09:21:26"
   },
   "data":[
      {
         "typeCode":"receiver_change",
         "typeName":"Изменение получателя",
         "createdAt":"2020-03-26 07:25:25",
         "status":"success",
         "detailedInfo":"\n            <html>\n            <head>\n                <style>body {\n\tmargin: 0;\n    padding: 18px 24px 18px;\n}\n\nh1 {\n\tcolor: #202020;\n    font-size: 20px;\n    font-weight: normal;\n    margin-top: 0;\n    margin-bottom: 6px;\n    line-height: 28px;\n}\n\np {\n\tcolor: #848484;\n    margin: 0;\n    font-size: 14px;\n    line-height: 20px;\n}\n\nb {\n\tfont-weight: bold;\n\tcolor: #3c3c3c;\n}\n\np.date {\n\tmargin-bottom: 20px;\n}\n\np.phone-list {\n    padding-left: 40px;\n    margin-bottom: 8px;\n    background-repeat: no-repeat;\n    background-position: 2px 4px;\n    background-size: 14px 14px;\n}\n\np.contact-list {\n    padding-left: 40px;\n    background-repeat: no-repeat;\n    background-position: 3px 5px;\n    background-size: 12px 12px;\n}\n\np.status {\n\tcolor: #737373;\n    margin-top: 20px;\n    padding-left: 40px;\n    background-repeat: no-repeat;\n    background-size: 17px 17px;\n    background-position: 0px 2px;\n}\n\n.section-name {\n    margin-bottom: 4px;\n}\n\n.contact-info-section {\n    margin-bottom: 20px;\n}\n.status.success {background-image: url(\"https://api.dellin.test/static/img/ic_ok.svg\");}.status.inprogress {background-image: url(\"https://api.dellin.test/static/img/ic_time.svg\");}.status.fail {background-image: url(\"https://api.dellin.test/static/img/ic_block.svg\");}.phone-icon {background-image: url(\"https://api.dellin.test/static/img/phone_icon.svg\");}.contact-icon {background-image: url(\"https://api.dellin.test/static/img/person_icon.svg\");}</style>\n                <meta charset=\"UTF-8\">\n            </head>\n            <body>\n                <h1>Изменение получателя</h1>\n                <p class=\"date\">от 26.03.2020</p>\n                <p>на получателя <b>РОМАШКИН</b><br>новый получатель будет отображаться в документах после выдачи накладной</p>\n                <p class=\"status success\">Запрос согласован</p>\n            </body>\n            </html>",
         "document":""
      }
   ]
} 
<response>
   <metadata>
      <status>200</status>
      <generated_at>2020-03-27 09:21:26</generated_at>
   </metadata>
   <data>
      <typeCode>receiver_change</typeCode>
      <typeName>Изменение получателя</typeName>
      <createdAt>2020-03-26 07:25:25</createdAt>
      <status>success</status>
      <detailedInfo>
         <html>
            <head>
               <style>body {
   margin: 0;
    padding: 18px 24px 18px;
}

h1 {
   color: #202020;
    font-size: 20px;
    font-weight: normal;
    margin-top: 0;
    margin-bottom: 6px;
    line-height: 28px;
}

p {
   color: #848484;
    margin: 0;
    font-size: 14px;
    line-height: 20px;
}

b {
   font-weight: bold;
   color: #3c3c3c;
}

p.date {
   margin-bottom: 20px;
}

p.phone-list {
    padding-left: 40px;
    margin-bottom: 8px;
    background-repeat: no-repeat;
    background-position: 2px 4px;
    background-size: 14px 14px;
}

p.contact-list {
    padding-left: 40px;
    background-repeat: no-repeat;
    background-position: 3px 5px;
    background-size: 12px 12px;
}

p.status {
   color: #737373;
    margin-top: 20px;
    padding-left: 40px;
    background-repeat: no-repeat;
    background-size: 17px 17px;
    background-position: 0px 2px;
}

.section-name {
    margin-bottom: 4px;
}

.contact-info-section {
    margin-bottom: 20px;
}
.status.success {background-image: url("https://api.dellin.test/static/img/ic_ok.svg");}.status.inprogress {background-image: url("https://api.dellin.test/static/img/ic_time.svg");}.status.fail {background-image: url("https://api.dellin.test/static/img/ic_block.svg");}.phone-icon {background-image: url("https://api.dellin.test/static/img/phone_icon.svg");}.contact-icon {background-image: url("https://api.dellin.test/static/img/person_icon.svg");}</style>
               <meta charset="UTF-8">
               </head>
               <body>
                  <h1>Изменение получателя</h1>
                  <p class="date">от 26.03.2020</p>
                  <p>на получателя 
                     <b>РОМАШКИН</b>
                     <br>новый получатель будет отображаться в документах после выдачи накладной
                     </p>
                     <p class="status success">Запрос согласован</p>
                  </body>
               </html>
            </detailedInfo>
            <document></document>
         </data>

</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataМассив с информацией по каждому изменению
data.typeCodestring

Тип изменённой информации.

Возможные значения параметра см. в таблице ниже

data.typeNamestring

Наименование типа изменённой информации на русском языке.

Возможные значения параметра см. в таблице ниже

data.createdAtstringДата изменения
data.statusstring

Статус изменения.

Возможные значения:

  • "success" - успешно;
  • "in_progress" - в процессе;
  • "failed" - не успешно
data.detailedInfostringСвёрстанная html-страница с подробной информацией о запросе на изменение заказа
data.documentstringСсылка на печатную форму с данными заказа. Если была изменена контактная информация (значение параметра "typeCode" - "contact_info_changes"), то параметр отсутствует в ответе

Значения параметров "response.data.typeCode" и "response.data.typeName"
В нижеследующей таблице приведены значения параметра "response.data.typeCode" и соответствующие значения параметра "response.data.typeName"

 typeCode

 typeName

receiver_change

Изменение получателя

payer_change

Изменение плательщика

payment_order_change

Разрешить выдачу груза по платежному поручению

contact_info_change

Изменение контактной информации

giveout_suspension_change

Приостановка выдачи груза

giveout_resumption_change

Возобновление выдачи груза

delivery_cancel_change

Отмена доставки до адреса

pickup_cancel_change

Отмена доставки от адреса

delivery_info_change

Смена адреса и времени доставки до адреса
pickup_info_changeСмена адреса и времени доставки от адреса

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".