Функция WaybillInfoWithHistory возвращает информацию о накладной по её номеру с полной историей событий.
Полный портрет накладной включает:
- основные данные накладной;
- информацию о маршруте;
- параметры груза;
- информацию об оплате;
- специальные условия доставки;
- информацию о грузовых местах;
- полную историю изменения состояния накладной.
Получение данных о накладной с историей событий
ОПИСАНИЕ ПАРАМЕТРОВ ЗАПРОСА
| Параметр | Описание в WSDL | Описание |
|---|
| waybillNumber | minOccurs="1" maxOccurs="1" type="string" | Номер накладной МЭ |
SOAP-запрос
POST /ShipmentService.asmx HTTP/1.1
Host: agents.major-express.ru
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/WaybillInfoWithHistory"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<TicketHeader xmlns="http://tempuri.org/">
<Ticket>string</Ticket>
<UserName>string</UserName>
<CheckSum>int</CheckSum>
<inRole>boolean</inRole>
</TicketHeader>
</soap:Header>
<soap:Body>
<WaybillInfoWithHistory xmlns="http://tempuri.org/">
<waybillNumber>string</waybillNumber>
</WaybillInfoWithHistory>
</soap:Body>
</soap:Envelope>
ОПИСАНИЕ ПАРАМЕТРОВ ОТВЕТА
Основные параметры ответа
| Параметр | Описание в WSDL | Описание |
|---|
| ResCode | minOccurs="1" maxOccurs="1" type="int" | Код результата выполнения запроса |
| ResText | minOccurs="0" maxOccurs="1" type="string" | Текст результата выполнения запроса |
| WBInfo | minOccurs="0" maxOccurs="1" | Информация о накладной с историей событий |
WBInfo — данные накладной и история
Объект содержит два основных блока:
- Info — основная информация по накладной;
- History — история событий по накладной.
Info — основная информация по накладной
| Параметр | Описание в WSDL | Описание |
|---|
| Header | type="object" | Основные данные накладной |
| Route | type="object" | Информация о маршруте перевозки |
| CargoInfo | type="object" | Параметры груза |
| PaymentInfo | type="object" | Информация об оплате |
| SpecialDeliveryConditions | type="object" | Специальные условия доставки |
| Places | type="object" | Информация о грузовых местах |
Header — основные данные накладной
| Параметр | Описание в WSDL | Описание |
|---|
| WBNumber | type="string" | Номер накладной МЭ |
| ExternalReference | type="string" | Внешняя ссылка / клиентский номер |
| Status | type="object" | Статус накладной |
| DeliveryRequirements | type="object" | Требования доставки |
| WaybillMetaData | type="object" | Дополнительные данные накладной |
| WBOpenDate | type="dateTime" | Дата и время создания накладной |
| ExpectedDeliveryDate | type="dateTime" | Расчётная дата доставки |
| WBCloseDate | type="dateTime" | Дата закрытия накладной |
Route — маршрут перевозки
| Параметр | Описание в WSDL | Описание |
|---|
| Shipper | object | Информация об отправителе |
| Consignee | object | Информация о получателе |
| RouteConfig | object | Конфигурация маршрута |
CargoInfo — параметры груза
| Параметр | Описание в WSDL | Описание |
|---|
| Description | type="string" | Описание вложения |
| PlaceCount | type="short" | Количество грузовых мест |
| Weight | type="double" | Вес груза (кг) |
| Length | type="double" | Длина груза |
| Width | type="double" | Ширина груза |
| Height | type="double" | Высота груза |
| Volume | type="double" | Объём груза |
| Cost_RUR | type="decimal" | Объявленная стоимость (руб.) |
| PackageType | type="unsignedByte" | Код типа упаковки |
PaymentInfo — информация об оплате
| Параметр | Описание в WSDL | Описание |
|---|
| Payer | object | Информация о плательщике |
| WhoWillPay | type="unsignedByte" | Код стороны оплаты |
| | 1 — отправитель |
| | 2 — получатель |
| | 3 — третья сторона |
| PaymentType | type="unsignedByte" | Код типа оплаты |
| CalcWeightAgent | type="double" | Расчётный вес по данным агента |
| CalcWeightClient | type="double" | Расчётный вес по данным клиента |
| Insurance_USD | type="double" | Стоимость страховки (USD) |
| Insurance_RUR | type="double" | Стоимость страховки (руб.) |
| Freight_USD | type="double" | Стоимость перевозки (USD) |
| Freight_RUR | type="double" | Стоимость перевозки (руб.) |
| AddService_RUR | type="double" | Стоимость дополнительных услуг (руб.) |
SpecialDeliveryConditions — специальные условия доставки
| Параметр | Описание в WSDL | Описание |
|---|
| DeliveryFeatures | object | Перечень специальных условий доставки |
Places — грузовые места
| Параметр | Описание в WSDL | Описание |
|---|
| PlaceModel | object | Детальная информация о грузовом месте |
History — история событий
| Параметр | Описание в WSDL | Описание |
|---|
| HistoryEvents | object | Список событий истории накладной |
HistoryEvents — события истории
| Параметр | Описание в WSDL | Описание |
|---|
| Event | object | Информация о событии изменения состояния накладной |
SOAP-ответ
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<WaybillInfoWithHistoryResponse xmlns="http://tempuri.org/">
<WaybillInfoWithHistoryResult>
<ResCode>int</ResCode>
<ResText>string</ResText>
<WBInfo>
<Info>
<Header />
<Route />
<CargoInfo />
<PaymentInfo />
<SpecialDeliveryConditions />
<Places />
</Info>
<History>
<HistoryEvents />
</History>
</WBInfo>
</WaybillInfoWithHistoryResult>
</WaybillInfoWithHistoryResponse>