GetReferenceData: SerialNumbersOfItems — Серийные номера товаров клиента
- Endpoint:
GetReferenceData - SOAP-метод:
SerialNumbersOfItems - Группа: GetReferenceData
- Создано: 16.04.2026 · Обновлено: 19.05.2026
Описание
Функция позволяет получить список серийных номеров товаров клиента, необходимых для использования в других функциях при вызове 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>SerialNumbersOfItems</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>
Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
Reference | string | да | Имя справочника, должно быть равно «SerialNumbersOfItems» |
Search | string | нет | ??? Указан в примере метода, но не работает |
Возвращаемые параметры
Параметр Element в ответе содержит информацию о серийных номерах.
Он включает элементы справочника:
Key: идентификатор справочника, к которому относится запись (например, Projects);
List: контейнер записи справочника.
Каждая запись справочника из списка List в виде структуры Element содержит в себе:
- Key: Уникальный идентификатор записи (GUID) (например, 0837e701-01f4-11ea-9985-005056bb6b60);
- 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: название дополнительного поля (например, FullName,СountryСode);
- Value: значение дополнительного поля (может быть пустым);
- ValueType: тип значения (string, boolean, и т.д.).
Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
ItemsActicle | string | нет | Артикул товара |
ID | string | нет | ID элемента |
ExpirationDate | dateTime | нет | Срок годности |
GTIN | string | нет | Идентификатор продукта GTIN |
KIS | string | нет | Контрольный (идентификационный) знак (КиЗ) |
NumberGTD | string | нет | Номер ГТД |
SerialNumber | string | нет | Серийный номер товара |
Certificate | string | нет | Номер сертификата |
Country | string | нет | GUID страны товара из классификатора стран (см. метод GetrefernseData). |
Пример запроса (XML Request)
<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>SerialNumbersOfItems</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>
</car:parameters>
</car:GetReferenceData>
</soap:Body>
</soap:Envelope>
Смежные методы
AvailableDeliveryDates
Функция позволяет получить информацию о возможных датах доставки груза.
BaseUnitsOfMeasurement
Функция позволяет получить список базовых единиц измерения, использующиеся в других функциях при вызове web-сервиса.
CargoStates
Функция позволяет получить список доступных состояний грузов.