Try it — WarehouseArea

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

GetReferenceData: WarehouseArea — Зонирование

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

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

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

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

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

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

Параметр Тип Обязательно Описание
Reference string Имя справочника, должно быть равно «warehousearea».
Documenttype string Тип документа
Documentnumber string Номер документа
Возвращаемые параметры

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

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

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

List: контейнер записи справочника.

Каждый блок List в виде структуры Element содержит в себе:

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

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

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


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

Параметр Тип Обязательно Описание
Warehouse string Складская зона
Area string Складская ячейка
Возвращаемые параметры Fields

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

  • Key: название свойства (например, Warehouse);
  • Value: значение свойства; 
  • ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
Параметр Тип Обязательно Описание
Warehouse string
Area string
Примеры запроса/ответа
<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>warehousearea</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Documenttype</car:Key>
          <car:Value>waybill</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Documentnumber</car:Key>
          <car:Value>88-AA-00000000000049</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>