Tracking: Отслеживание состояния груза
Функция позволяет узнать историю состояний и текущее состояние по номеру заказа или накладной.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| login | string | Логин пользователя | |
| password | string | Пароль | |
| documents | Element | Список документов, по которым мы получаем информацию | |
| parameters | Element | Список параметров |
Параметр parameters содержит один обязательный элемент:
- Key: значение parameters (Parameters).
Передается по строгой структуре
<ns1:parameters>
<ns1:Key>parameters</ns1:Key>
</ns1:parameters> | Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Передается значение Parameters согласно структуре выше |
Параметр documents используется для передачи списка номеров документов. Он должен содержать:
- Key: значение Documents (строго как указано);
- Properties: массив реквизитов, описывающих фильтры или параметры запроса (например, тип документа, флаг выбора);
- List: непустой массив элементов, каждый из которых — номер документа в виде структуры Element с полем Key.
Каждый элемент внутри List содержит только:
- Key: номер документа (строка, например, 888-0000111636).
Каждый элемент внутри Properties содержит:
- Key: имя реквизита (например, DocumentType);
- Value: значение реквизита (строка, булево и т.д.);
- ValueType: тип значения (string, boolean и т.п.).
Пример структуры:
<ns1:documents>
<ns1:Key>Documents</ns1:Key>
<ns1:Properties>
<ns1:Key>DocumentType</ns1:Key>
<ns1:Value>Order</ns1:Value>
<ns1:ValueType>string</ns1:ValueType>
</ns1:Properties>
<ns1:Properties>
<ns1:Key>OnlySelectedType</ns1:Key>
<ns1:Value>true</ns1:Value>
<ns1:ValueType>boolean</ns1:ValueType>
</ns1:Properties>
<ns1:List>
<ns1:Key>888-0000111636</ns1:Key>
</ns1:List>
</ns1:documents>Иерархия documents:
Key: Documents
Properties → (массив) → Key, Value, ValueType
List → (массив) → Key (номер документа)
List не может быть пустым — каждый документ должен быть указан отдельно.
Properties может содержать один или несколько реквизитов — они определяют условия фильтрации.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Передавать Documents | |
| Properties | string | Должен содержать параметры документа для отслеживания (перечислены ниже) | |
| List | string | Должен содержать Key с номером документа |
Список возможных сохраняемых свойств в Properties
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| DocumentType | string |
Тип отслеживаемых документов, может быть: «Order»/«Orders» (для заказов) «Waybill»/«Waybills» (для накладных) «ReturnWaybill»/«ReturnWaybills» (для возвратных накладных). |
|
| NumberType | string |
Позволяет указать, какой тип номера использовать для поиска документа. Если тип номера не указан, то используется внутренний номер. Допустимые значения: «ClientNumber» (номер клиента) «AgentNumber» (номер агента) «OrderNumber» (номер заказа, используется только для накладных) Так же можно передавать GUID доп номеров клиентов, полученных по методу GetRefernceData: numbertypes |
При успешном ответе возвращает состояние документов. Он содержит следующие параметры
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Название переданного метода, возвращается Tracking | |
| List | Element | Массив элементов, каждый из которых — сведения о документе или его событии в виде структуры Element. |
Каждый элемент в List имеет:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Идентификатор документа (например, `888-0000111636`) или текст события (например, `Заказ принят, идет обработка заказа.`); | |
| Value | string | Значение, связанное с Key — может быть пустым (как в примере с событием) | |
| ValueType | string | Тип значения (string, dateTime, boolean и т.д.); | |
| Properties | Element | Массив дополнительных реквизитов (необязательно, но присутствует в примере). |
Возвращаются данные в формате
- Key - название параметра
- Value - Значение параметра
- ValueType - тип данных Value
Возможные значения Key:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| DocumentType | string |
Вид документа: «Order» (для заказа), или «Waybill» (для накладной) |
|
| DocumentName | string | Внутреннее имя документа в системе «Карго» | |
| GUID | string |
GUID (Globally Unique Identifier) документа в базе «Карго» |
|
| Date | dateTime | Дата и время документа | |
| Number | string | Номер документа в системе «Карго» | |
| ClientNumber | string | Клиентский номер документа | |
| Posted | boolean | Признак, что документ проведён | |
| PlannedDeliveryPeriodMin | decimal | Минимальный срок доставки груза | |
| PlannedDeliveryPeriodMax | decimal | Максимальный срок доставки груза | |
| PlannedDeliveryDate | dateTime | Плановая дата доставки груза |
Возвращаются данные в формате
- Key - название параметра
- Value - Значение параметра
- ValueType - тип данных Value
Возможные значения Key:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| GUID | string | GUID (Globally Unique Identifier) записи о состоянии в системе «Карго» | |
| Comment | string | Примечание по состоянию | |
| RecorderGUID | string | GUID (Globally Unique Identifier) документа в системе «Карго», сделавшего запись о состоянии | |
| RecorderName | string | Внутреннее имя документа в системе «Карго», сделавшего запись о состоянии | |
| DateTime | dateTime | Время записи данного состояния | |
| DeliveryDateTime | dateTime | Время вручения груза получателю (только для состояния «груз доставлен») | |
| Recipient | string | Получатель груза (только для состояния «груз доставлен») |
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.cargo3.ru">
<SOAP-ENV:Body>
<ns1:Tracking>
<ns1:login>test</ns1:login>
<ns1:password>2016</ns1:password>
<ns1:documents>
<ns1:Key>Documents</ns1:Key>
<ns1:Properties>
<ns1:Key>DocumentType</ns1:Key>
<ns1:Value>Order</ns1:Value>
<ns1:ValueType>string</ns1:ValueType>
</ns1:Properties>
<ns1:Properties>
<ns1:Key>OnlySelectedType</ns1:Key>
<ns1:Value>true</ns1:Value>
<ns1:ValueType>boolean</ns1:ValueType>
</ns1:Properties>
<ns1:List>
<ns1:Key>888-0000111636</ns1:Key>
</ns1:List>
</ns1:documents>
<ns1:parameters>
<ns1:Key>Parameters</ns1:Key>
</ns1:parameters>
</ns1:Tracking>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> <soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<m:TrackingResponse
xmlns:m="http://www.cargo3.ru">
<m:return
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>Tracking</m:Key>
<m:List>
<m:Key>888-0000111636</m:Key>
<m:Value xsi:type="xs:string">Order</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>DocumentType</m:Key>
<m:Value xsi:type="xs:string">Order</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DocumentName</m:Key>
<m:Value xsi:type="xs:string">Заказ</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">9d2f9379-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Date</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:51:59</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Number</m:Key>
<m:Value xsi:type="xs:string">888-0000111636</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DeletionMark</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Posted</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryPeriodMin</m:Key>
<m:Value xsi:type="xs:decimal">1</m:Value>
<m:ValueType>float</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryPeriodMax</m:Key>
<m:Value xsi:type="xs:decimal">1</m:Value>
<m:ValueType>float</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryDate</m:Key>
<m:Value xsi:type="xs:dateTime">2019-02-02T00:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:List>
<m:Key>Заказ принят, идет обработка заказа.</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">0bcffda3-d0ca-4104-bc58-fbd374f325cd</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">9d2f9379-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">Заказ</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:51:59</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>На основании заказа оформлена накладная.</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">b7a84166-3233-4844-a0af-06761f65ffdd</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">b64822f9-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">Накладная</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:52:26</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>Груз забран</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">8c9ab389-4ef8-4d6c-99d4-c0bb2c62a623</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">fc6274c9-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">ЗаборГруза</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:54:30</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>Заказ выполнен.</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">052bdc4e-02b2-4209-b2ab-1e856d330ef5</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">19219e19-254f-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">ПодтверждениеОДоставкеГруза</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T15:10:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:Tables>
<m:Key>Waybills</m:Key>
<m:Properties>
<m:Key>ReturnWaybill</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Properties>
<m:List>
<m:Key>888-AA-0000000000236</m:Key>
<m:Value xsi:type="xs:string">Waybill</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>DocumentType</m:Key>
<m:Value xsi:type="xs:string">Waybill</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DocumentName</m:Key>
<m:Value xsi:type="xs:string">Накладная</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">b64822f9-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Date</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:52:26</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Number</m:Key>
<m:Value xsi:type="xs:string">888-AA-0000000000236</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DeletionMark</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Posted</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryPeriodMin</m:Key>
<m:Value xsi:type="xs:decimal">1</m:Value>
<m:ValueType>float</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryPeriodMax</m:Key>
<m:Value xsi:type="xs:decimal">1</m:Value>
<m:ValueType>float</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>PlannedDeliveryDate</m:Key>
<m:Value xsi:type="xs:dateTime">2019-02-02T00:00:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:List>
<m:Key>Груз получен на склад КС</m:Key>
<m:Value xsi:type="xs:string">Груз получен на склад КС</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">b7b5f799-94c7-4588-bae4-c14df35c9752</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string">Груз получен на склад КС</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">b456523d-1ee5-11e9-b9e9-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">УстановкаСтатусаСостоянияНакладной</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:40:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>Груз передан на доставку</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">b2af9ad9-22bd-4476-9393-7b51ffdab6f7</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string"/>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">daf66519-1ee5-11e9-b9e9-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">УстановкаСтатусаСостоянияНакладной</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:45:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>Зарегистрирована накладная</m:Key>
<m:Value xsi:type="xs:string">Заказ 888-0000111636 от 31.01.2019 14:51:59, зарегистрирована накладная:888-AA-0000000000236</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">ee9fc99e-53e5-4253-8b80-b582294ef526</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string">Заказ 888-0000111636 зарегистрирована накладная:888-AA-0000000000236</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">b64822f9-254e-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">Накладная</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T14:52:26</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
</m:List>
<m:List>
<m:Key>Отправление доставлено получателю</m:Key>
<m:Value xsi:type="xs:string">ООО Ромашка-2 (31.01.2019 15:10:00)</m:Value>
<m:ValueType>string</m:ValueType>
<m:Properties>
<m:Key>GUID</m:Key>
<m:Value xsi:type="xs:string">8e5ded66-a8f5-4fa8-b863-03e1e0406df5</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Comment</m:Key>
<m:Value xsi:type="xs:string">ООО Ромашка-2 (31.01.2019 15:10:00)</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderGUID</m:Key>
<m:Value xsi:type="xs:string">19219e19-254f-11e9-911f-005056b1a128</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>RecorderName</m:Key>
<m:Value xsi:type="xs:string">ПодтверждениеОДоставкеГруза</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T15:10:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>DeliveryDateTime</m:Key>
<m:Value xsi:type="xs:dateTime">2019-01-31T15:10:00</m:Value>
<m:ValueType>dateTime</m:ValueType>
</m:Properties>
<m:Properties>
<m:Key>Recipient</m:Key>
<m:Value xsi:type="xs:string">ООО Ромашка-2</m:Value>
<m:ValueType>string</m:ValueType>
</m:Properties>
</m:List>
</m:List>
</m:Tables>
</m:List>
</m:return>
</m:TrackingResponse>
</soap:Body>
</soap:Envelope> 