Page Comparison

...

Для получения данных по изменению статусов заказов в приложении API использует структуру application/xml и HTTP-метод POST.

Входные данные запроса getOrdersLog

#	Field name	Data type	Length	Mandatory	DescriptionНаименование поля	Тип данных	Длина	Обязательность	Описание
1	sessionID	Текст		Да	Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут
2	filter
2.1	limit	Целое число		Нет	Максимальное количество статусов, которое должна вернуть система
2.2	date				Если данный блок заполнен, то блок Данный блок может использоваться как вместе с блоком "ref" игнорируется, так и отдельно от него.
2.2.1	begin			Нет	Начало временного интервала для выбора изменений. Формат – “ГГГГ-ММ-ДДTЧЧ:ММ:СС.00Z”
2.2.2	end			Нет	Окончания временного интервала для выбора изменений. Формат – “ГГГГ-ММ-ДДTЧЧ:ММ:СС.00Z”
2.3	refs				Блок содержит список заказов. Может использоваться как отдельно с блоком "date" (тогда будут выведены выбранные заказы в указанном промежутке), так и без него.
2.3.1	reference	Текст	255		Имя заказа.

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

...

Структура: application/xml

XML:

1)

Code Block

language	xml

<?xml version=

...

"1.0" encoding=

...

"UTF-8"?>

...

...


<apiRequest>
   <sessionID>38a0e5953a744ff8be3a928453d735a6</sessionID>
   <filter>
      <limit>5000</limit>
      <date>
         <begin>2014-12-26T00:00:10.

...

00Z</begin>
         <end>2014-12-26T23:54:10.

...

00Z</end>

...


      </date>

...


   </filter>

...


</apiRequest>

2)

Code Block

language

...

xml

...

<?xml version="1.0" encoding="UTF-8"?>
<apiRequest>
   <sessionID>8057758B67649106D9AB0E46EC943265</sessionID>
   <filter>
      <limit>50</limit>
      <date>
         <begin>2015-06-07T00:00:10.

...

00Z</begin>
         <end>2015-06-082T23:54:10.

...

00Z</end>

...


      </date>

...


      <refs>
         <reference>Order_API_1955952_

...

6</reference>

...


      </refs>

...


   </filter>

...


</apiRequest>

3)

...

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<apiRequest>
   <sessionID>8057758B67649106D9AB0E46EC943265</sessionID>
   <filter>
      <refs>
         <reference>Order_API_1955952_

...

6</reference>
      </refs>
   </filter>
</apiRequest>

Ответ getOrdersLog

Для получения данных по изменению статусов заказов API использует структуру application/xml в качестве структуры ответа.

...

*если в ответе пришел статус "removed", это значит, что заказ был удален.

#	Field nameНаименование поля	DescriptionОписание
1	Orders
1.1	Order
	Атрибут “referenceNumber”	Название/Идентификатор заказа
	Атрибут “status”	Статус заказа. Возможные значения представлены в Приложении 3.
	Атрибут “type”	Тип заказа. DO – Доставка PU – Сбор
	Атрибут “date”	Дата и время изменения статуса
	Атрибут “author”	Имя пользователя, от имени которого совершено действие
	Атрибут “shortNotes”	Название действия
	Атрибут “fullNotes”	Расшифровка действия
	Атрибут “fullNotes”	Причина недоставки если таковая имеется и комментарий введенный водителем. Возможные причины: адресат выбыл адресат заберет отправление временное отсутствие адресата доставка отложена по просьбе адресата иная нет адресата неточный адрес обстоятельства непреодолимой силы отказ от получения по техническим причинам не хватило времени поменялись приоритеты

...

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

1)

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">

...


   <apiResponse>
      <orders>
         <order referenceNumber="TEST-00088570301214" status="FAILED" type="DO" date="2014-12-29T16:50:06.000Z" author="Alexander" shortNotes="created_from_import" fullNotes="Обстоятельства непреодолимой силы: Комментарий водителя " />

...


      </orders>

...


   </apiResponse>

...


</apiResponse>

2)

Code Block

language	xml

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">

...


   <apiResponse>
      <orders>
         <order referenceNumber="Order_API_1955952_6" status="NEW" type="PU" date="2015-06-08T05:30:15.000Z" author="&lt;external_

...

system&gt;" shortNotes="&lt;created_from_external_

...

system&gt;" fullNotes="" />

...


         <order referenceNumber="Order_API_1955952_6" status="UPDATED" type="PU" date="2015-06-08T11:41:11.000Z" author="&lt;external_

...

system&gt;" shortNotes="&lt;updated_from_external_

...

system&gt;" fullNotes="" />

...


      </orders>

...


   </apiResponse>

...


</apiResponse>

Возможные ошибки:

	ошибка
1	1134 - "No logs found for the order"
2	1108 - "Job with the provided reference number was not found"

...

Versions Compared

Old Version 5

New Version 6

Key

Ответ getOrdersLog