Перейти к содержимому

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

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

SOAP Endpoint: GetReferenceData Обновлено: 2026-05-15
  • Endpoint: GetReferenceData
  • SOAP-метод: DeliveryType
  • Группа: GetReferenceData
  • Создано: 16.04.2026 · Обновлено: 15.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>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 
<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>

Пример ответа (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>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>

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

AvailableDeliveryDates

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

BaseUnitsOfMeasurement

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

CargoStates

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