Try it — Report - ReturnOfGoods
SOAP Request

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

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

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

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

Параметры запроса
Параметр Тип Обязательно Описание
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 Серийный номер товара, если ведется учет
Примеры запроса/ответа 
<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>
<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>