GetReferenceData: TypeOfProduct — Признак расчета товара

Функция позволяет получить возможные признаки расчета товара (для интернет-магазинов), используемые в других функциях...

SOAP Endpoint: GetReferenceData Обновлено: 2026-05-19

Endpoint: GetReferenceData
SOAP-метод: TypeOfProduct
Группа: GetReferenceData
Создано: 16.04.2026 · Обновлено: 19.05.2026

Описание

Функция позволяет получить возможные признаки расчета товара (для интернет-магазинов), используемые в других функциях при вызове web-сервиса.

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

Параметр	Тип	Обязательно	Описание
login	string	да	логин
password	string	да	пароль
parameters	Element	да	список параметров

Описание параметра parameters

Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.

Он должен включать:

Key: строка со значением parameters (обязательное);

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

Key: имя параметра (например, Reference);
Value: значение параметра указывающая на то какой parameters описывается;
ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).

Пример одного элемента из List:

xml

<car:List>
 <car:Key>Reference</car:Key>
 <car:Value>TypeOfProduct</car:Value>
 <car:ValueType>string</car:ValueType>
</car:List>

Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.

Иерархия структуры parameters:

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

Параметр	Тип	Обязательно	Описание
Reference	string	да	Имя справочника, должно быть равно «TypeOfProduct».

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

Параметр Element в ответе содержит информацию о возможных признаках расчета товара.

Он включает элементы справочника:

Key: идентификатор справочника, к которому относится запись (например, TypeOfProduct);

List: контейнер записи справочника, каждая запись соответствует одному типу продукции.

Каждый блок List описывает один тип продукции в виде структуры Element и содержит в себе:

Key: числовой идентификатор типа продукции (например, 1,2,3 и т.д.);
Value: наименование типа продукции (например, Товар, Услуга);
ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).

Структура ответа иерархична:

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

---

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

Параметр	Тип	Обязательно	Описание
Key	string	да	Индекс элемента
Value	string	да	Наименование элемента

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

xml

<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:car="http://www.cargo3.ru">
  <soap:Header/>
  <soap:Body>
    <car:GetReferenceData>
      <car:login>test</car:login>
      <car:password>2016</car:password>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>Reference</car:Key>
          <car:Value>TypeOfProduct</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>

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

xml

<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <m:GetReferenceDataResponse
      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>TypeOfProduct</m:Key>
        <m:List>
          <m:Key>0</m:Key>
          <m:Value xsi:type="xs:string">Товар</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>1</m:Key>
          <m:Value xsi:type="xs:string">Подакцизный товар</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>2</m:Key>
          <m:Value xsi:type="xs:string">Работа</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>3</m:Key>
          <m:Value xsi:type="xs:string">Услуга</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>4</m:Key>
          <m:Value xsi:type="xs:string">Ставка азартной игры</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>5</m:Key>
          <m:Value xsi:type="xs:string">Выигрыш азартной игры</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>6</m:Key>
          <m:Value xsi:type="xs:string">Лотерейный билет</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>7</m:Key>
          <m:Value xsi:type="xs:string">Выигрыш лотереи</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>

Смежные методы

AvailableDeliveryDates

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

BaseUnitsOfMeasurement

Функция позволяет получить список базовых единиц измерения, использующиеся в других функциях при вызове web-сервиса.

CargoStates

Функция позволяет получить список доступных состояний грузов.