Report : Отчет по возвратным отправлениям клиента

Позволяет получить информацию по возвратным накладным

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

Описание

Позволяет получить информацию по возвратным накладным

Параметры запроса

Параметры запроса

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

Описание параметра 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

Параметр
Тип
Обязательно
Описание
FromDate
dateTime
Нет
Дата, с которой формируется отчёт. Если не указана, то отчёт формируется с начала предыдущего месяца
ToDate
dateTime
Нет
Дата, по которую формируется отчёт. Если не указана, то отчёт формируется до конца предыдущего месяца
OrderNumber
string
Нет
Номер заказа, если мы хотим сформировать отчёт только по данным одного заказа
WaybillNumber
string
Нет
Номер накладной, если мы хотим сформировать отчёт только по данным одной накладной
Indetail
boolean
Нет
Выводить информацию по товарам (для PartialRedemptionOfGoods и ReturnOfGoods)
Divergence
string
Нет
Количество единиц расхождения (для GoodsOrderDiscrepancy)

Возвращаемый тип

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

Информация об ошибке, при её наличии заносится в свойство Properties (см. раздел Errors).

Параметр
Тип
Обязательно
Описание
Нет

Ответ по отчету

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

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

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

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

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

Варианты Key для отчета:

Параметр
Тип
Обязательно
Описание
Nom
int
Нет
Порядковый номер
ReturnNmber
string
Нет
Номер возвратной накладной
ReturnDate
dateTime
Нет
Дата возвратной накладной
ClientNumber
string
Нет
Номер клиента
ReturnSum
decimal
Нет
Сумма за услуги возврата
ReturnSumOfGoods
decimal
Нет
Общая стоимость товаров для возврата
WaibillSum
decimal
Нет
Сумма за услуги и доставки
WaybillSumCOD
decimal
Нет
Сумма наложенного платежа при доставке
ListOfReturnGoods
Element
Нет
Список товаров для возврата

Возвращаемые параметры List

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

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

Список сохраняемых свойств в Properties общая информация по документу

Параметр
Тип
Обязательно
Описание
Number
string
Да
Номер общего документа
Date
dateTime
Да
Дата общего документа
Client
string
Да
Контрагент
Contract
string
Нет
Договор контрагента
ALLSumCOD
float
Нет
Сумма наложенного платежа по доставочным накладным
ALLSumReturn
float
Нет
Сумма стоимости услуг по возвратным накладным
ALLSumDelivery
float
Нет
Сумма стоимости услуг по доставочным накладным
ALLSumOfProduct
float
Нет
Общая стоимость товаров по возвратным накладным

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

Параметр
Тип
Обязательно
Описание
Article
string
Да
Номер артикула товара
Units
string
Да
Единица измерения товара
Party
string
Нет
Партия товара, если ведется учет
Qty
float
Да
Количество
Price
float
Да
Цена
AssessedValue
string
Нет
Оценочная стоимость товара
Comment
string
Нет
Комментарий
SerialNumber
string
Нет
Серийный номер товара, если ведется учет

Пример запроса (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>ReturnOfGoods</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
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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>ReturnNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ReturnData</m:Key>
          <m:Value xsi:type="xs:string">dateTime</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>ReturnSum</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ReturnSumOfGoods</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WaybillSum</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WaybillSumCOD</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:List>
          <m:Key>ReturnOfGoods</m:Key>
          <m:Properties>
            <m:Key>Number</m:Key>
            <m:Value xsi:type="xs:string">888-AA-0000000000219</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Date</m:Key>
            <m:Value xsi:type="xs:string">28 декабря 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:Properties>
            <m:Key>ALLSumCOD</m:Key>
            <m:Value xsi:type="xs:string">30706</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumReturn</m:Key>
            <m:Value xsi:type="xs:string">1383</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumDelivery</m:Key>
            <m:Value xsi:type="xs:string">71259</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumOfProduct</m:Key>
            <m:Value xsi:type="xs:string">1500</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-AA-0000000000215</m:Cells>
            <m:Cells xsi:type="xs:string">21 декабря 2018 г.</m:Cells>
            <m:Cells xsi:type="xs:string">603908</m:Cells>
            <m:Cells xsi:type="xs:string">840</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">59322</m:Cells>
            <m:Cells xsi:type="xs:string">15353</m:Cells>
          </m:Rows>
          <m:Rows>
            <m:Cells xsi:type="xs:decimal">2</m:Cells>
            <m:Cells xsi:type="xs:string">888-AA-0000000000218</m:Cells>
            <m:Cells xsi:type="xs:string">21 декабря 2018 г.</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">543</m:Cells>
            <m:Cells xsi:type="xs:string">1500</m:Cells>
            <m:Cells xsi:type="xs:string">11937</m:Cells>
            <m:Cells xsi:type="xs:string">15353</m:Cells>
          </m:Rows>
        </m:List>
      </m:return>
    </m:ReportResponse>
  </soap:Body>
</soap:Envelope>