Получение данных о накладной по её номеру с полной историей событий

Функция WaybillInfoWithHistory возвращает информацию о накладной по её номеру с полной историей событий.

Полный портрет накладной включает:

  • основные данные накладной;
  • информацию о маршруте;
  • параметры груза;
  • информацию об оплате;
  • специальные условия доставки;
  • информацию о грузовых местах;
  • полную историю изменения состояния накладной.

Получение данных о накладной с историей событий


ОПИСАНИЕ ПАРАМЕТРОВ ЗАПРОСА

ПараметрОписание в WSDLОписание
waybillNumberminOccurs="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Описание
ResCodeminOccurs="1"
maxOccurs="1"
type="int"
Код результата выполнения запроса
ResTextminOccurs="0"
maxOccurs="1"
type="string"
Текст результата выполнения запроса
WBInfominOccurs="0"
maxOccurs="1"
Информация о накладной с историей событий

WBInfo — данные накладной и история

Объект содержит два основных блока:

  • Info — основная информация по накладной;
  • History — история событий по накладной.

Info — основная информация по накладной

ПараметрОписание в WSDLОписание
Headertype="object"Основные данные накладной
Routetype="object"Информация о маршруте перевозки
CargoInfotype="object"Параметры груза
PaymentInfotype="object"Информация об оплате
SpecialDeliveryConditionstype="object"Специальные условия доставки
Placestype="object"Информация о грузовых местах

Header — основные данные накладной

ПараметрОписание в WSDLОписание
WBNumbertype="string"Номер накладной МЭ
ExternalReferencetype="string"Внешняя ссылка / клиентский номер
Statustype="object"Статус накладной
DeliveryRequirementstype="object"Требования доставки
WaybillMetaDatatype="object"Дополнительные данные накладной
WBOpenDatetype="dateTime"Дата и время создания накладной
ExpectedDeliveryDatetype="dateTime"Расчётная дата доставки
WBCloseDatetype="dateTime"Дата закрытия накладной

Route — маршрут перевозки

ПараметрОписание в WSDLОписание
ShipperobjectИнформация об отправителе
ConsigneeobjectИнформация о получателе
RouteConfigobjectКонфигурация маршрута

CargoInfo — параметры груза

ПараметрОписание в WSDLОписание
Descriptiontype="string"Описание вложения
PlaceCounttype="short"Количество грузовых мест
Weighttype="double"Вес груза (кг)
Lengthtype="double"Длина груза
Widthtype="double"Ширина груза
Heighttype="double"Высота груза
Volumetype="double"Объём груза
Cost_RURtype="decimal"Объявленная стоимость (руб.)
PackageTypetype="unsignedByte"Код типа упаковки

PaymentInfo — информация об оплате

ПараметрОписание в WSDLОписание
PayerobjectИнформация о плательщике
WhoWillPaytype="unsignedByte"Код стороны оплаты
1 — отправитель
2 — получатель
3 — третья сторона
PaymentTypetype="unsignedByte"Код типа оплаты
CalcWeightAgenttype="double"Расчётный вес по данным агента
CalcWeightClienttype="double"Расчётный вес по данным клиента
Insurance_USDtype="double"Стоимость страховки (USD)
Insurance_RURtype="double"Стоимость страховки (руб.)
Freight_USDtype="double"Стоимость перевозки (USD)
Freight_RURtype="double"Стоимость перевозки (руб.)
AddService_RURtype="double"Стоимость дополнительных услуг (руб.)

SpecialDeliveryConditions — специальные условия доставки

ПараметрОписание в WSDLОписание
DeliveryFeaturesobjectПеречень специальных условий доставки

Places — грузовые места

ПараметрОписание в WSDLОписание
PlaceModelobjectДетальная информация о грузовом месте

History — история событий

ПараметрОписание в WSDLОписание
HistoryEventsobjectСписок событий истории накладной

HistoryEvents — события истории

ПараметрОписание в WSDLОписание
EventobjectИнформация о событии изменения состояния накладной

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>