GetProductItemList v2.0
Общие сведения
Операция GetProductItemList предназначена для получения списка наименований продукции с возможностью фильтрации по уровням продукции иерархического справочника, по номенклатуре определенного предприятия-производителя или всех предприятий определенного хозяйствующего субъекта. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Добавить записи номенклатуры производителя можно с помощью операции ModifyProducerStockListOperation. Выполнение операции заканчивается либо возвратом списка наименований продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- идентификатор типа продукции (1 уровень иерархического справочника);
- глобальный идентификатор продукции (2 уровень иерархического справочника).
- глобальный идентификатор вида продукции (3 уровень иерархического справочника).
- глобальный идентификатор предприятия-производителя.
- глобальный идентификатор хозяйствующего субъекта.
Выходные данные
- список продукции (4 уровень иерархического справочника), отфильтрованный по заданным параметрам.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getProductItemListRequest> | |||
002 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. |
003 | ······<bs:count>10</bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
004 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
005 | ···</bs:listOptions> | |||
006 | ···<dt:productType>1</dt:productType> | dt:ProductType | [0..1] | Тип продукции.
|
007 | ···<dt:product> | dt:Product | [0..1] | Продукция.
|
008 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор продукции. |
009 | ···</dt:product> | |||
010 | ···<dt:subProduct> | dt:SubProduct | [0..1] | Вид продукции.
|
011 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор вида продукции. |
012 | ···</dt:subProduct> | |||
013 | ···<dt:businessEntity> | dt:BusinessEntity | [0..1] | Хозяйствующий субъект (владелец продукции). |
014 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор хозяйствующего субъекта. |
015 | ···</dt:businessEntity> | |||
016 | ···<dt:enterprise> | dt:Enterprise | [0..1] | Данные о предприятии-производителе продукции (только для 2.0).
|
017 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор предприятия. |
018 | ···</dt:enterprise> | |||
019 | ···<dt:producer> | dt:BusinessMember | [0..1] | (v2.1) Производитель продукции. |
020 | ······<dt:businessEntity> | dt:BusinessEntity | [0..1] | (v2.1) Хозяйствующий субъект (производитель продукции). |
021 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | (v2.1) Глобальный идентификатор хозяйствующего субъекта. |
022 | ······</dt:businessEntity> | |||
023 | ······<dt:enterprise> | dt:Enterprise | [0..1] | (v2.1) Предприятие-производитель продукции. |
024 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | (v2.1) Глобальный идентификатор предприятия. |
025 | ······</dt:enterprise> | |||
026 | ···</dt:producer> | |||
027 | ···<dt:globalID>4607147136201</dt:globalID> | dt:GTINType | [0..1] | (v2.1) GTIN |
028 | </ws:getProductItemListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getProductItemListResponse> | |||
002 | ···<dt:productItemList total="2" offset="0" count="2"> | dt:ProductItemList | [1..1] | Список номенклатуры.
|
003 | ······<dt:productItem> | dt:ProductItem | [0..*] | Данные о номенклатуре производителя |
004 | ·········<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии номенклатуры. |
005 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор номенклатуры. |
006 | ·········<bs:active>true</bs:active> | xs:boolean | [1..1] | Описание, является ли запись активной.
|
007 | ·········<bs:last>true</bs:last> | xs:boolean | [1..1] | Описание, является ли версия записи последней.
|
008 | ·········<bs:status>100</bs:status> | bs:VersionStatus | [1..1] | Статус версии номенклатуры. |
009 | ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания номенклатуры. |
010 | ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения номенклатуры. |
011 | ·········<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. |
012 | ·········<dt:globalID>4607147136201</dt:globalID> | dt:GTINType | [0..1] | Trade Identification Number (GTIN).
|
013 | ·········<dt:name>Название</dt:name> | bs:String255 | [0..1] | Наименование продукции. |
014 | ·········<dt:code>12</dt:code> | bs:String255 | [0..1] | Артикул.
|
015 | ·········<dt:productType>1</dt:productType> | dt:ProductType | [1..1] | Тип продукции.
|
016 | ·········<dt:product> | dt:Product | [1..1] | Продукция.
|
017 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии продукции. |
018 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор продукции. |
019 | ·········</dt:product> | |||
020 | ·········<dt:subProduct> | dt:SubProduct | [1..1] | Вид продукции.
|
021 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии вида продукции. |
022 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор вида продукции. |
023 | ·········</dt:subProduct> | |||
024 | ·········<dt:correspondsToGost>true</dt:correspondsToGost> | xs:boolean | [1..1] | Соответствует ли ГОСТу. |
025 | ·········<dt:gost>ГОСТ-621187/53</dt:gost> | bs:String255 | [0..1] | ГОСТ. |
026 | ·········<dt:producer> | dt:BusinessEntity | [0..1] | ХС-производитель продукции. |
027 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии хозяйствующего субъекта-владельца. |
028 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор хозяйствующего субъекта-владельца. |
029 | ·········</dt:producer> | |||
030 | ·········<dt:tmOwner> | dt:BusinessEntity | [0..1] | ХС-собственник торговой марки. |
031 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии хозяйствующего субъекта-владельца. |
032 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор хозяйствующего субъекта-владельца. |
033 | ·········</dt:tmOwner> | |||
034 | ·········<dt:producing> | dt:ProductItemProducing | [0..*] | Список площадок, на которых выпускается данная продукция. |
035 | ············<dt:location> | dt:Enterprise | [1..1] | Площадка, осуществляющая выпуск продукции. |
036 | ···············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии предприятия. |
037 | ···············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор предприятия. |
038 | ············</dt:location> | |||
039 | ·········</dt:producing> | |||
040 | ·········<dt:packaging> | dt:Packaging | [0..1] | Фасовка. |
041 | ············<dt:packagingType> | dt:PackingType | [1..1] | Тип упаковки. |
042 | ···············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии типа упаковки. |
043 | ···············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор упаковки. |
044 | ···············<dt:globalID>BE</dt:globalID> | dt:PackingCodeType | [1..1] | Уникальный идентификатор упаковки. |
045 | ···············<dt:name>Пакет (пачка/связка)</dt:name> | bs:String255 | [1..1] | Наименование упаковки. |
046 | ············</dt:packagingType> | |||
047 | ············<dt:quantity>10</dt:quantity> | xs:int | [0..1] | Количество единиц упаковки. |
048 | ············<dt:volume>50</dt:volume> | bs:Decimal | [0..1] | Объём единицы упаковки товара. |
049 | ············<dt:unit> | dt:Unit | [0..1] | Единица измерения объёма единицы упаковки товара. |
050 | ···············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии единицы измерения. |
051 | ···············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор единицы измерения. |
052 | ···············<dt:name>кг</dt:name> | bs:String255 | [1..1] | Наименование единицы измерения |
053 | ············</dt:unit> | |||
054 | ·········</dt:packaging> | |||
055 | ······</dt:productItem> | |||
056 | ···</dt:productItemList> | |||
057 | </ws:getProductItemListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Примеры запросов
Получение списка номенклатуры производителей по виду продукции (3 уровень иерархического справочника)
Получение списка номенклатуры производителей по виду продукции. Вывод первых трёх записей без смещения.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
<soapenv:Header/>
<soapenv:Body>
<ws:getProductItemListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<dt:subProduct>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
</ws:getProductItemListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<v2:getProductItemListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
<dt:productItemList count="3" total="201" offset="0">
<dt:productItem>
<bs:uuid>fe037d3f-952d-427c-9890-e3a35c6051f4</bs:uuid>
<bs:guid>e131554d-300a-4767-817c-ed4583edcb57</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:20:38+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:20:38+03:00</bs:updateDate>
<dt:name>ГРУДКА с кожей цыпленка-бройлера охлажд. (подложка)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>false</dt:correspondsToGost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
<dt:productItem>
<bs:uuid>ec511dc1-19e2-44bc-9080-b1c6451cd18d</bs:uuid>
<bs:guid>51a211aa-f02d-46b7-88aa-53a9c5d73267</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:21:48+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:21:48+03:00</bs:updateDate>
<dt:name>ФИЛЕ без кожи цыпленка-бройлера охлажд. (подложка)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>false</dt:correspondsToGost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
<dt:productItem>
<bs:uuid>f5f1a1de-88d6-49fc-ac53-4ed0bc8be78e</bs:uuid>
<bs:guid>5e09860b-9a6e-4011-8fda-8642c08da263</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:22:08+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:22:08+03:00</bs:updateDate>
<dt:name>ГОЛЕНЬ с кожей цыпленка-бройлера охлажд. (подложка)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>false</dt:correspondsToGost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
</dt:productItemList>
</v2:getProductItemListResponse>
</soap:Body>
</soapenv:Envelope>
Получение списка номенклатуры конкретного предприятия-производителя
Получение списка номенклатуры конкретного предприятия-производителя. Вывод первых трёх записей без смещения.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
<soapenv:Header/>
<soapenv:Body>
<ws:getProductItemListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<dt:enterprise>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:enterprise>
</ws:getProductItemListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<v2:getProductItemListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
<dt:productItemList count="3" total="348" offset="0">
<dt:productItem>
<bs:uuid>fe037d3f-952d-427c-9890-e3a35c6051f4</bs:uuid>
<bs:guid>e131554d-300a-4767-817c-ed4583edcb57</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:20:38+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:20:38+03:00</bs:updateDate>
<dt:name>ГРУДКА с кожей цыпленка-бройлера охлажд. (подложка)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>false</dt:correspondsToGost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
<dt:productItem>
<bs:uuid>1e2ce8f6-dd21-4870-9758-504383864dc0</bs:uuid>
<bs:guid>a92afbd2-34f6-4a87-9ad8-3298ad96e8fe</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:21:27+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:21:27+03:00</bs:updateDate>
<dt:name>Тушка цыпленка-бройлера 1 сорта охлажд. (фас.)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>80161573-7639-2493-c5dd-e10f05935cce</bs:uuid>
<bs:guid>bcb270cd-84fa-f3ad-6e4b-705eb50d703f</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>true</dt:correspondsToGost>
<dt:gost>ГОСТ 31962-2013</dt:gost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
<dt:productItem>
<bs:uuid>ec511dc1-19e2-44bc-9080-b1c6451cd18d</bs:uuid>
<bs:guid>51a211aa-f02d-46b7-88aa-53a9c5d73267</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2015-04-13T09:21:48+03:00</bs:createDate>
<bs:updateDate>2015-04-13T09:21:48+03:00</bs:updateDate>
<dt:name>ФИЛЕ без кожи цыпленка-бройлера охлажд. (подложка)</dt:name>
<dt:productType>1</dt:productType>
<dt:product>
<bs:uuid>e42c2a82-2624-eeeb-9193-8187a888d276</bs:uuid>
<bs:guid>337f79dc-4376-6e33-dabe-d5447913b97d</bs:guid>
</dt:product>
<dt:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
</dt:subProduct>
<dt:correspondsToGost>false</dt:correspondsToGost>
<dt:producing>
<dt:location>
<bs:uuid>84723ee8-0cc3-4b5c-97a0-00a32b0d3f8d</bs:uuid>
<bs:guid>b2fdaf3c-78cc-4a2a-893a-b98f83bfe569</bs:guid>
</dt:location>
</dt:producing>
</dt:productItem>
</dt:productItemList>
</v2:getProductItemListResponse>
</soap:Body>
</soapenv:Envelope>