Try it — Report - PartialRedemptionOfGoods
SOAP Request

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

Report: Отчет по частичному выкупу товаров

  • Создано 25.05.2026
  • Обновлено 25.05.2026
  • Endpoint: Report
  • Soap-method: Report - PartialRedemptionOfGoods
Описание

Функция позволяет получить отчёт по названию, в котором содержится подробная информация. 

«PartialRedemptionOfGoods». Отчет по частичному выкупу товаров. В отчет попадает информация по проверенным накладным за указанный период

Параметры запроса
Параметр Тип Обязательно Описание
login string Логин пользователя
password string Пароль
parameters Element Список параметров
name string Наименование отчёта = PartialRedemptionOfGoods для отчета по частичному выкупу товаров
Описание параметра parameters

Параметр parameters должен содержать:

- Key: значение parameters(строго как указано);

- List: непустой массив элементов, каждый из которых — отдельный параметр в виде структуры с тремя полями:


- Key: имя параметра (например, FromDate, ToDate);

- Value: значение параметра (строка, дата и т.д.);

- ValueType: тип значения (string, dateTime и т.п.).


Пример структуры:

<p><m:parameters xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>parameters</m:Key>
<m:List>
    <m:Key>FromDate</m:Key>
    <m:Value xsi:type="xs:dateTime">2014-09-01T00:00:00</m:Value>
    <m:ValueType>dateTime</m:ValueType>
</m:List>
<m:List>
    <m:Key>ToDate</m:Key>
    <m:Value xsi:type="xs:dateTime">2014-09-30T00:00:00</m:Value>
    <m:ValueType>dateTime</m:ValueType>
</m:List>
</m:parameters></p>

List не может быть пустым — каждый параметр должен быть описан как отдельный элемент.

Иерархия parameters:

Key: parameters

List(массив) → каждый элемент → Key, Value, ValueType

Параметр Тип Обязательно Описание
Возвращаемый тип

Возвращаемые данные зависят от того отчета который запрашивается.

Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок). 

Параметр Тип Обязательно Описание
Ответ по отчету частичный выкуп

 Корневой контейнер ответа метода Report содержит return с Key = Report, Fields (повторяются), содержащие описание колонок и List с данными отчёта.

Данные отчета возвращаются в Rows - Строки отчёта, каждая из которых соответствует конкретной накладной, попавшей в группу накладных. Они представлены в виде структуры Row. В структуре Row конкретные данные по накладной находятся в списке Cells.

Содержимое и порядок данных в Cells соответствует списку колонок, описанному ниже.

Описание колонок отчёта (название и тип данных). Каждый параметр представлен отдельным блоком Fields, содержащим:

  • Key — название колонки (варианты в таблице ниже зависят от типа отчёта)
  • Value — тип данных колонки (string, int, decimal, dateTime и т.д.)
  • ValueType — тип значения (всегда string)

Варианты Key для отчета Частичный выкуп:

Параметр Тип Обязательно Описание
Nom int Порядковый номер
WaybillNumber string Номер накладной
ClientNumber string Номер клиента
LastStateDate dateTime Дата последнего статуса
LastState string Последний статус
DeliveryDate dateTime Дата доставки
Delivery string Доставка
LastTraceDate dateTime Дата последнего трейса
LastStateOfTrace string Последний трейс
SateOfCheck string Статус чека ККМ
ReturnWaybill string Возвратная накладная
PrimaryProducts Element Список первоначальных товаров в накладной
PaidProducts Element Список оплаченных товаров
ReturnProducts Element Список возвращенных товаров
Возвращаемые параметры List

Каждый раздел в списке List представляет собой информацию по накладным за период в виде структуры Element и заполнен следующим образом: 

Параметр Тип Обязательно Описание
Key string «PartialRedemptionOfGoods»
Properties Element Дополнительные свойства отчета (период, клиент)
Rows Element Строки отчёта, каждая из которых соответствует конкретной накладной, попавшей в период
Возвращаемые параметры PrimaryProducts, PaidProducts, ReturnProducts

Списки PrimaryProducts, PaidProducts, ReturnProducts приходят в виде структуры Element и заполнен следующим образом:

Параметр Тип Обязательно Описание
Article string Номер артикула товара
Units string Единица измерения товара
Party string Партия товара, если ведется учет
Qty float Количество
Price float Цена
AssessedValue string Оценочная стоимость товар
Comment string Комментарий
SerialNumber string Серийный номер товара, если ведется учет
SerialNumberGuid string Наименование серийного номера, если ведется учет
NumberGTD string Номер GTD, если ведется серийный учет
NumberGTIN string Номер GTIN, если ведется серийный учет
Примеры запроса/ответа 
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header/>
  <soap:Body>
    <m:Report
      xmlns:m="http://www.cargo3.ru">
      <m:login>LOGIN</m:login>
      <m:password>PASSWORD</m:password>
      <m:name>PartialRedemptionOfGoods</m:name>
      <m:parameters>
        <m:Key>Parameters</m:Key>
        <m:List>
          <m:Key>FromDate</m:Key>
          <m:Value xsi:type="xs:dateTime">2014-09-01T00:00:00</m:Value>
          <m:ValueType>dateTime</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>ToDate</m:Key>
          <m:Value xsi:type="xs:dateTime">2014-09-30T00:00:00</m:Value>
          <m:ValueType>dateTime</m:ValueType>
        </m:List>
      </m:parameters>
    </m:Report>
  </soap:Body>
</soap:Envelope>

<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <m:ReportResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return>
        <m:Key>Report</m:Key>
        <m:Fields>
          <m:Key>Nom</m:Key>
          <m:Value xsi:type="xs:string">int</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WaybillNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ClientNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>LastStateDate</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>LastState</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>DeliveryDate</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Delivery</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>LastTraceDate</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>LastStateOfTrace</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>SateOfCheck</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ReturnWaybill</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:List>
          <m:Key>PartialRedemptionOfGoods</m:Key>
          <m:Properties>
            <m:Key>Period</m:Key>
            <m:Value xsi:type="xs:string">с 10.06.2018 по 11.09.2018</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Client</m:Key>
            <m:Value xsi:type="xs:string">ТЕСТ_&amp;_ТРЕСТ</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Contract</m:Key>
            <m:Value xsi:type="xs:string">Договор № 134 от 02.08.2010</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Rows>
            <m:Cells xsi:type="xs:decimal">1</m:Cells>
            <m:Cells xsi:type="xs:string">888-0000110077</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">27.08.2018</m:Cells>
            <m:Cells xsi:type="xs:string">Оформлена добавочная накладная</m:Cells>
            <m:Cells xsi:type="xs:string">27.08.2018</m:Cells>
            <m:Cells xsi:type="xs:string">Подтверждение о доставке груза получателю 888-00000000225 от 27.08.2018 17:04:15</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">888-AA-0000000000205</m:Cells>
          </m:Rows>
          <m:Rows>
            <m:Cells xsi:type="xs:decimal">2</m:Cells>
            <m:Cells xsi:type="xs:string">888-3226983-00000105</m:Cells>
            <m:Cells xsi:type="xs:string">T923776789</m:Cells>
            <m:Cells xsi:type="xs:string">25.07.2018</m:Cells>
            <m:Cells xsi:type="xs:string">Оформлена добавочная накладная</m:Cells>
            <m:Cells xsi:type="xs:string">11.07.2018</m:Cells>
            <m:Cells xsi:type="xs:string">Подтверждение о доставке груза получателю 888-00000000222 от 11.07.2018 16:48:37</m:Cells>
            <m:Cells xsi:type="xs:string">20.07.2018</m:Cells>
            <m:Cells xsi:type="xs:string">некоррек данные получател</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string"/>
          </m:Rows>
        </m:List>
      </m:return>
    </m:ReportResponse>
  </soap:Body>
</soap:Envelope>