Try it — DeliveryInfo
SOAP Request

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

GetReferenceData: DeliveryInfo — Параметры доставки

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

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

Параметры запроса
Параметр Тип Обязательно Описание
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>deliveryinfo</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

Параметр Тип Обязательно Описание
Reference string Имя справочника, должно быть равно «DeliveryInfo».
Search string GUID географии получателя
Geography string GUID географии отправителя
other string GUID срочности
takedate datetime Предполагаемая дата забора груза для получения расчетной плановой даты доставки.
Возвращаемые параметры

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

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

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

List: контейнер параметров доставки, группирует все параметры для доставки одного маршрута.

Блок List описывает параметры доставки и содержит в себе:

  • Key: идентификатор набора данных (например,Data);
  • Fields: контейнер одного параметра доставки.

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

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

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

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

Каждый блок Fields описывает один параметр доставки (точку отправления, точку назначения, сроки, условия и т.д.):

  • Key: идентификатор поля (например, From);
  • Value: значение поля;
  • ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
Параметр Тип Обязательно Описание
From string Наименование места отправления груза
FromGuid string Уникальный идентификатор географического объекта отправления в формате GUID
To string Наименование места назначения
ToGuid string Уникальный идентификатор географического объекта назначения в формате GUID
Office string Название офиса
MinPeriod float Минимальный период доставки
MaxPeriod float Максимальный период доставки
Urgency string Категория срочности доставки
UrgencyGuid string Уникальный номер срочности в формате GUID (Globally Unique Identifier)
UrgencyDescription string Описание условий срочной доставки
COD boolean Возможность оплаты при получении.
true - наложенный платеж доступен;
false - наложенный платеж недоступен.
WithReturn boolean Возможность возврата термоконтейнеров/термодатчиков (только для термоперевозок)
PaymentByRecipient boolean Возможность оплаты получателем
Agent string Название транспортной компании или агента, который учувствует в доставке
PlanDeliveryDate datetime Расчетная плановая дата доставки, при условии что была передана предполагаемая дата забора груза (параметр takedate)
Примеры запроса/ответа 
<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>DeliveryInfo</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Search</car:Key>
          <car:Value>cf862f56-442d-11dc-9497-0015170f8c09</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Geography</car:Key>
          <car:Value>cf862f56-442d-11dc-9497-0015170f8c09</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>other</car:Key>
          <car:Value>18c4f207-458b-11dc-9497-0015170f8c09</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>DeleiveryInfo</m:Key>
        <m:List>
          <m:Key>Data</m:Key>
          <m:Fields>
            <m:Key>From</m:Key>
            <m:Value xsi:type="xs:string">Москва г</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>FromGuid</m:Key>
            <m:Value xsi:type="xs:string">cf862f56-442d-11dc-9497-0015170f8c09</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>To</m:Key>
            <m:Value xsi:type="xs:string">Москва г</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ToGuid</m:Key>
            <m:Value xsi:type="xs:string">cf862f56-442d-11dc-9497-0015170f8c09</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Office</m:Key>
            <m:Value xsi:type="xs:string">Центральный офис</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>MinPeriod</m:Key>
            <m:Value xsi:type="xs:decimal">1</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>MaxPeriod</m:Key>
            <m:Value xsi:type="xs:decimal">3</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Urgency</m:Key>
            <m:Value xsi:type="xs:string">Срочная</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>UrgencyGuid</m:Key>
            <m:Value xsi:type="xs:string">18c4f207-458b-11dc-9497-0015170f8c09</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>UrgencyDescription</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>COD</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>WithReturn</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>PaymentByRecipient</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Agent</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>