GetReferenceData: DeliveryType — Виды доставок

Try it — DeliveryType

SOAP Request

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

Response

GetReferenceData: DeliveryType — Виды доставок

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

Endpoint: GetReferenceData
Soap-method: DeliveryType

Описание

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

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

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

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

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

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

Параметр Element в ответе содержит информацию о видах грузов.

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

Key: идентификатор справочника deliverytype;

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

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

Key: название вида доставки для передачи в других методах (NameOfdeliverytype);
Value:техническое наименование типа доставки (код);
ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
Fields: массив дополнительных атрибутов.

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

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

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

Параметр	Тип	Описание
Key	string	Название параметра
Value	string	Значение
Fields	Element	Другие свойства элемента справочника

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

Каждый элемент Fields содержит один атрибут:

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

Параметр	Тип	Обязательно	Описание
Information	string		Дополнительная информация
Default	boolean		Признак вида доставки, которая используется по умолчанию

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

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>DeliveryType</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>deliverytype</m:Key>
        <m:List>
          <m:Key>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">ДоставкаДоДверей</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Дверь-Дверь</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">СкладДверь</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Склад-Дверь</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">ДоставкаCOD</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">COD</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">Самовывоз</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Дверь-Склад (самовывоз)</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">СкладСклад</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Склад-Склад  (самовывоз)</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">ДоставкаСВозвратом</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">с возвратом</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>NameOfdeliverytype</m:Key>
          <m:Value xsi:type="xs:string">ДоставкаСУведомлением</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">с уведомлением</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>