Try it — Items

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

GetReferenceData: Items — Товары

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

Функция позволяет получить список товаров клиента (интернет-магазина), необходимых для использования в других функциях при вызове 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>Items</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

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

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

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

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

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

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

  • Key: Уникальный идентификатор проекта (GUID) (например, 73d2cef3-f328-11e4-a887-001e67086478);
  • Value: наименование товара (например, Зажим черный);
  • ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
  • Properties: массив блоков товаров;
  • Fields: массив атрибутов товаров.

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

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


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

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

Массив Properties представляет список товаров. 

Параметр Тип Обязательно Описание
SerialNumber string Серийный номер товара в формате GUID (Globally Unique Identifier)
Name string Название нового элемента в БД "Карго"
ExpirationDate string Срок до
GTIN string Идентификатор продукта GTIN
KIS string Контрольный (идентификационный) знак (КиЗ)
NumberGTD string Номер ГТД
UIN string УИН ювелирного изделия
Certificate string Номер сертификата
Country string GUID страны товара из классификатора стран (см метод GetrefernseData).
Возвращаемые параметры Fields

Блок Fields содержит в себе основные атрибуты товаров и состоит из элементов:

  • Key: имя поля (например,FullName);
  • Value: значение поля;
  • ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
Параметр Тип Обязательно Описание
FullName string Полное наименование
Article string Артикул товара
ID string ID товара
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>Items</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Search</car:Key>
          <car:Value>123-3</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>Items</m:Key>
        <m:List>
          <m:Key>73d2cef3-f328-11e4-a887-001e67086478</m:Key>
          <m:Value xsi:type="xs:string">Зажим черный</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>FullName</m:Key>
            <m:Value xsi:type="xs:string">Зажим черный</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Article</m:Key>
            <m:Value xsi:type="xs:string">123-3</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ID</m:Key>
            <m:Value xsi:type="xs:string">#T#00000000000000090019</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Measure</m:Key>
            <m:Value xsi:type="xs:string">79de0cab-f328-11e4-a887-001e67086478</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>