Try it — AvailableDeliveryDates
SOAP Request

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

GetReferenceData: AvailableDeliveryDates — Возможные даты доставки

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

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

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

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

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

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

Параметр Тип Обязательно Описание
Reference string Имя справочника, должно быть равно «availabledeliverydates».
Search string Поиск по одному из параметров:
1. GUID (Globally Unique Identifier) географии получения (получение объектов географии см. https://cse-dev-portal.bxb.delivery/site/method?slug=getreferencedata-geography), или код географии клиента, если клиент пользуется собственной географией.
2. Код ФИАС, для этого необходимо передать строку «fias-» и необходимый код ФИАС.
3. Индекс, необходимо указать префикс «postcode-», затем код страны (цифровой, либо Альфа-2, либо Альфа-3) и индекс для поиска.
Пример «postcodeKZA00A0A0». Если код страны не вводится, то по умолчанию поиск осуществляется по России. Пример для России: «postcode-RU-990500» или «postcode-990500» (данный вариант поиска может возвращать не точную информацию).
Geography string Поиск по одному из параметров:
1. GUID (Globally Unique Identifier) географии отправления (получение объектов географии см. https://cse-dev-portal.bxb.delivery/site/method?slug=getreferencedata-geography), или код географии клиента, если клиент пользуется собственной географией.
2. Код ФИАС, для этого необходимо передать строку «fias-» и необходимый код ФИАС.
3. Индекс, необходимо указать префикс «postcode-», затем код страны (цифровой, либо Альфа-2, либо Альфа-3) и индекс для поиска.
Пример «postcodeKZA00A0A0». Если код страны не вводится, то по умолчанию поиск осуществляется по России. Пример для России: «postcode-RU-990500» или «postcode-990500» (данный вариант поиска может возвращать не точную информацию).
other string GUID срочности (см. https://cse-dev-portal.bxb.delivery/site/method?slug=getreferencedata-urgencies).
takedate datetime Предполагаемая дата забора груза, для получения списка доступных дат доставки. По умолчанию расчет производится от текущей даты.
Возвращаемые параметры

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

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

Key: строка со значением ListOfAvailableDeliveryDates;

List: массив элементов, каждый из которых содержит информацию о доступной дате доставки.

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

  • Key: значение DeliveryDates;
  • Properties: массив временных интервалов для данной даты (может отсутствовать или быть несколько);
  • Fields: содержит непосредственно дату доставки.

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

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

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

Параметр Тип Обязательно Описание
Key string Наименование списка дат доставки
List Element Список возможных дат доставки
Описание возможных возвращаемых параметров Properties

Блок Properties содержит в себе возможные интервалы доставки груза и состоит из элементов: 

  • Key: значение Interval;
  • Fields: содержит время начала или окончания интервала.
Параметр Тип Обязательно Описание
TimeFrom dateTime Начало временного интервала доставки
TimeTo dateTime Окончание временного интервала доставки
Возвращаемые параметры Fields

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

  • Key: идентификатор признака (DeliveryDate);
  • Value: значение признака;
  • ValueType: тип значения — строка, указывающая тип Value (datetime и т.п.).
Параметр Тип Обязательно Описание
DeliveryDate dateTime Календарная дата доставки
Примеры запроса/ответа 
<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>availabledeliverydates</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:List>
          <car:Key>takedate</car:Key>
          <car:Value>2025-01-28T11:00:00</car:Value>
          <car:ValueType>dateTime</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>ListOfAvailableDeliveryDates</m:Key>
        <m:List>
          <m:Key>DeliveryDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>DeliveryDate</m:Key>
            <m:Value xsi:type="xs:date">2026-05-29</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>DeliveryDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">14:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>DeliveryDate</m:Key>
            <m:Value xsi:type="xs:date">2026-06-01</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>DeliveryDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">14:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>DeliveryDate</m:Key>
            <m:Value xsi:type="xs:date">2026-06-02</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>DeliveryDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>DeliveryDate</m:Key>
            <m:Value xsi:type="xs:date">2026-06-03</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>DeliveryDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>DeliveryDate</m:Key>
            <m:Value xsi:type="xs:date">2026-06-04</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>