Try it — ItemsInStock
SOAP Request

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

GetReferenceData: ItemsInStock — Товары, подробная информация

  • Создано 16.04.2026
  • Обновлено 19.05.2026
  • Endpoint: GetReferenceData
  • Soap-method: ItemsInStock
Описание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Key: идентификатор справочника, строка со значением ItemsInStock;

List: массив элементов справочника (список товаров в наличии).

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

  • Key: уникальный идентификатор товара (например, e4c6b1f5-69ea-11ef-86c1-005056bbb928);
  • Value: наименование товара;
  • ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
  • Fields: массив дополнительных атрибутов товара.

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

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

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

Параметр Тип Обязательно Описание
Key string Уникальный номер элемента справочника в формате GUID (Globally Unique Identifier)
Value string Наименование товара
Fields Element Другие свойства элемента справочника
Properties Element Дополнительные характеристики товара
Возвращаемые параметры Fields

Каждый блок Fields содержит набор расширенных характеристик, специфичных для данного типа справочника :

  • Key: идентификатор поля (например, FullName);
  • Value: значение поля;
  • ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
Параметр Тип Обязательно Описание
FullName string Полное наименование
Article string Артикул товара
ID string ID товара
Balance float Количество товара, фактически находящееся на складе
Reserve float Количество товара, зарезервированное под оформленные заказы
Measure string GUID (Globally Unique Identifier) единицы измерения товара
Примеры запроса/ответа 
<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>ItemsInStock</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>
<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>ItemsInStock</m:Key>
        <m:List>
          <m:Key>e4c6b1f5-69ea-11ef-86c1-005056bbb928</m:Key>
          <m:Value xsi:type="xs:string">Отшелушивающий гель-пенка для лица с волокном люффы   Intense Micro Luffa Foaming Gel</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>FullName</m:Key>
            <m:Value xsi:type="xs:string">Отшелушивающий гель-пенка для лица с волокном люффы   Intense Micro Luffa Foaming Gel</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Article</m:Key>
            <m:Value xsi:type="xs:string">617.005 1</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ID</m:Key>
            <m:Value xsi:type="xs:string">#T#00000000000000131391</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Measure</m:Key>
            <m:Value xsi:type="xs:string">e4c6b235-69ea-11ef-86c1-005056bbb928</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Balance</m:Key>
            <m:Value xsi:type="xs:decimal">39</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Reserve</m:Key>
            <m:Value xsi:type="xs:decimal">0</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>eb41105f-6b69-11ef-86c1-005056bbb928</m:Key>
          <m:Value xsi:type="xs:string">ART_01</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>FullName</m:Key>
            <m:Value xsi:type="xs:string">ART_01</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Article</m:Key>
            <m:Value xsi:type="xs:string">ART_01</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ID</m:Key>
            <m:Value xsi:type="xs:string">#T#00000000000000131417</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Measure</m:Key>
            <m:Value xsi:type="xs:string">eb411072-6b69-11ef-86c1-005056bbb928</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Balance</m:Key>
            <m:Value xsi:type="xs:decimal">9</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Reserve</m:Key>
            <m:Value xsi:type="xs:decimal">0</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>5169f332-7300-11ef-86c1-005056bbb928</m:Key>
          <m:Value xsi:type="xs:string">Насыщенный увлажняющий крем для сухой и очень сухой кожи лица / Super hydrating rich cream</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>FullName</m:Key>
            <m:Value xsi:type="xs:string">Насыщенный увлажняющий крем для сухой и очень сухой кожи лица / Super hydrating rich cream</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Article</m:Key>
            <m:Value xsi:type="xs:string">1640.125</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ID</m:Key>
            <m:Value xsi:type="xs:string">#T#00000000000000131475</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Measure</m:Key>
            <m:Value xsi:type="xs:string">5169f40b-7300-11ef-86c1-005056bbb928</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Balance</m:Key>
            <m:Value xsi:type="xs:decimal">30</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Reserve</m:Key>
            <m:Value xsi:type="xs:decimal">0</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>