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

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

SOAP Endpoint: Report Обновлено: 2026-05-25
  • Endpoint: Report
  • SOAP-метод: Report - PartialRedemptionOfGoods
  • Группа: Report
  • Создано: 25.05.2026 · Обновлено: 25.05.2026

Описание

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

«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, если ведется серийный учет

Пример запроса (XML Request)

XML 
<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>

Пример ответа (XML Response)

XML 
<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>