Функция WaybillInfoList возвращает список накладных за указанный период с поддержкой фильтров по плательщику, агентам, статусу доставки и наличию скана.
Получение списка накладных за период
ОПИСАНИЕ ПАРАМЕТРОВ ЗАПРОСА
| Параметр | Описание в WSDL | Описание |
|---|---|---|
| beginDate | type="dateTime" | Начальная дата периода |
| endDate | type="dateTime" | Конечная дата периода |
| whoWillPay | type="unsignedByte" | Код стороны оплаты |
| shipperAgentCode | type="short" | Код агента отправителя |
| consigneeAgentCode | type="short" | Код агента получателя |
| isDelivered | type="boolean" | Признак доставки накладной |
| isNeedScan | type="boolean" | Признак необходимости скана |
| agentCodeClientHolder | type="short" | Код агента — держателя клиента |
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/WaybillInfoList"
<?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>
<WaybillInfoList xmlns="http://tempuri.org/">
<beginDate>dateTime</beginDate>
<endDate>dateTime</endDate>
<whoWillPay>unsignedByte</whoWillPay>
<shipperAgentCode>short</shipperAgentCode>
<consigneeAgentCode>short</consigneeAgentCode>
<isDelivered>boolean</isDelivered>
<isNeedScan>boolean</isNeedScan>
<agentCodeClientHolder>short</agentCodeClientHolder>
</WaybillInfoList>
</soap:Body>
</soap:Envelope>
ОПИСАНИЕ ПАРАМЕТРОВ ОТВЕТА
| Параметр | Описание в WSDL | Описание |
|---|---|---|
| ResCode | type="int" | Код результата выполнения запроса |
| ResText | type="string" | Текст результата выполнения запроса |
| Items | object | Список накладных |
Ответ содержит коллекцию Items, внутри которой возвращаются объекты WaybillInfo.
Items — список накладных
| Параметр | Описание в WSDL | Описание |
|---|---|---|
| WaybillInfo | object | Информация о накладной |
Каждый объект WaybillInfo содержит следующие блоки:
| Параметр | Описание в WSDL | Описание |
|---|---|---|
| Header | object | Основные данные накладной |
| Route | object | Информация о маршруте |
| CargoInfo | object | Параметры груза |
| PaymentInfo | object | Информация об оплате |
| SpecialDeliveryConditions | object | Специальные условия доставки |
| Places | object | Информация о грузовых местах |
Эти блоки присутствуют непосредственно внутри каждого элемента WaybillInfo в ответе метода.
SOAP-ответ
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?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:Body>
<WaybillInfoListResponse xmlns="http://tempuri.org/">
<WaybillInfoListResult>
<ResCode>int</ResCode>
<ResText>string</ResText>
<Items>
<WaybillInfo>
<Header xsi:nil="true" />
<Route xsi:nil="true" />
<CargoInfo xsi:nil="true" />
<PaymentInfo xsi:nil="true" />
<SpecialDeliveryConditions xsi:nil="true" />
<Places xsi:nil="true" />
</WaybillInfo>
<WaybillInfo>
<Header xsi:nil="true" />
<Route xsi:nil="true" />
<CargoInfo xsi:nil="true" />
<PaymentInfo xsi:nil="true" />
<SpecialDeliveryConditions xsi:nil="true" />
<Places xsi:nil="true" />
</WaybillInfo>
</Items>
</WaybillInfoListResult>
</WaybillInfoListResponse>
</soap:Body>
</soap:Envelope>
