GetReferenceData: Packages — Виды упаковок для грузовых мест

Try it — Packages

SOAP Request

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

Response

GetReferenceData: Packages — Виды упаковок для грузовых мест

Создано 16.04.2026
Обновлено 19.05.2026

Endpoint: GetReferenceData
Soap-method: Packages

Описание

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

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

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

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

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

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

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

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

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

List: контейнер одного типа упаковки.

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

Key: уникальный идентификатор типа упаковки (например, a5744bf7-4cfa-11df-9d7c-0015170f8c09);
Value: название и описание типа упаковки (например, Конверт (W:27 х H:35 см.));
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	Другие свойства элемента справочника

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

Блок Fields содержит признак упаковки по умолчанию:

Key: идентификатор поля (Default);
Value: значение поля (true/false);
ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).

Параметр	Тип	Обязательно	Описание
Default	boolean		Признак упаковки по умолчанию. true- упаковка рекомендуется/выбрана по умолчанию false- обычная упаковка, не по умолчанию

Примеры запроса/ответа

XML Request
XML Response

<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>packages</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>Package</m:Key>
        <m:List>
          <m:Key>a5744bf7-4cfa-11df-9d7c-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Конверт (W:27 х H:35 см.)</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>dc67affa-4ec7-11df-9d7c-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Тубус</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>5ff8b054-70b4-11e0-8bb9-001e67086478</m:Key>
          <m:Value xsi:type="xs:string">Коробка</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>4f40a9a9-ec9c-11e8-b06c-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">Треугольный тубус</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>5981a1d9-ec9c-11e8-b06c-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">Пакет</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>