GetReferenceData: ShippingMethods — Способы доставки

Try it — ShippingMethods

SOAP Request

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

Response

GetReferenceData: ShippingMethods — Способы доставки

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

Endpoint: GetReferenceData
Soap-method: ShippingMethods

Описание

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

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

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

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

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

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

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

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

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

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

Каждая запись справочника из списка List описывает один способ доставки в виде структуры Element и содержит в себе:

Key: уникальный идентификатор способа доставки (например, e89eb300-7bc5-11dc-a591-0015170f8c09);
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	Другие свойства элемента справочника

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

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

Key: название поля (например, Default);
Value: значение поля;
ValueType: тип значения (float, boolean, и т.д.).

Параметр	Тип	Обязательно	Описание
Default	boolean		Признак способа доставки, используемого по умолчанию. true — является способом доставки по умолчанию , false — не является способом доставки по умолчанию
DimensionalWeightFactor	float		Коэффициент для расчёта объёмного веса, использующийся для данного способа доставки.

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

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>ShippingMethods</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>ShippingMethods</m:Key>
        <m:List>
          <m:Key>e89eb300-7bc5-11dc-a591-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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>3503704c-6b46-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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>5052d0b3-5ea3-46f2-823f-1472686a51dd</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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>54851ddf-47bf-466d-b03a-2316df67f961</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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>b6a5dabf-2ab9-4366-a68f-b5d156c2ed9c</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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>43acfda7-b52b-4dbb-b073-5328f59ed500</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:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>e45b6d73-fd62-44da-82a6-44eb4d1d9490</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">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>DimensionalWeightFactor</m:Key>
            <m:Value xsi:type="xs:decimal">5000</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>