MercuryG2B:GetProductItemList:v3.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
== Общие сведения ==
# Операция '''GetProductItemList''' предназначена для получения списка номенклатуры с возможностью фильтрации по дополнительным параметрам.
# В список попадают только актуальные записи (active = true).
# Поддерживается возможность постраничного вывода.
# Добавить, изменить или удалить записи номенклатуры можно с помощью операции [[MercuryG2B:ModifyProducerStockList:v3.0]].
== Спецификация запроса ==
== Спецификация запроса ==


Версия 06:08, 17 октября 2023

Общие сведения

  1. Операция GetProductItemList предназначена для получения списка номенклатуры с возможностью фильтрации по дополнительным параметрам.
  2. В список попадают только актуальные записи (active = true).
  3. Поддерживается возможность постраничного вывода.
  4. Добавить, изменить или удалить записи номенклатуры можно с помощью операции MercuryG2B:ModifyProducerStockList:v3.0.

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getProductItemListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • по умолчанию значение 100;
  • максимально возможное значение 1000.
004 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • по умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:productType>?</dt:productType> dt:ProductType [0..1]

Тип продукции

  • первый уровень иерархического справочника продукции ИС Меркурий
007 ···<dt:product> dt:Product [0..1]

Продукция

  • второй уровень иерархического справочника продукции ИС Меркурий
008 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор продукции
009 ···</dt:product>
010 ···<dt:subProduct> dt:SubProduct [0..1]

Вид продукции

  • третий уровень иерархического справочника продукции ИС Меркурий
011 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции
012 ···</dt:subProduct>
013 ···<dt:businessEntity> dt:BusinessEntity [0..1] Хозяйствующий субъект (владелец продукции)
014 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта
015 ···</dt:businessEntity>
016 ···<dt:producer> dt:BusinessMember [0..1] Производитель продукции
017 ······<dt:businessEntity> dt:BusinessEntity [0..1] Хозяйствующий субъект (производитель продукции)
018 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта
019 ······</dt:businessEntity>
020 ······<dt:enterprise> dt:Enterprise [0..1] Предприятие-производитель продукции
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия
022 ······</dt:enterprise>
023 ···</dt:producer>
024 ···<dt:globalId>?</dt:globalId> dt:GTINType [0..1] GTIN
025 </ws:getProductItemListRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getProductItemListResponse>
002 ···<dt:productItemList total="?" offset="?" count="?"> dt:ProductItemList [1..1]

Список наименований продукции номенклатуры

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:productItem> dt:ProductItem [1..1] Сведения о наименовании продукции (номенклатуре)
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Флаг активности записи

  • true - запись активна;
  • false - запись не активна.
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, что запись является последней в истории

  • true - да;
  • false - нет.
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус записи
009 ·········<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания записи
010 ·········<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата последнего изменения записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<dt:globalID>?</dt:globalID> dt:GTINType [0..1]

Trade Identification Number (GTIN)

  • идентификационный номер продукции производителя
013 ·········<dt:name>?</dt:name> bs:String255 [0..1] Наименование номенклатуры
014 ·········<dt:code>?</dt:code> bs:String255 [0..1]

Артикул

  • код продукции в соответствии с внутренним кодификатором производителя
015 ·········<dt:productType>?</dt:productType> dt:ProductType [1..1]

Тип продукции

  • первый уровень иерархического справочника продукции ИС Меркурий
016 ·········<dt:product> dt:Product [1..1]

Продукция

  • второй уровень иерархического справочника продукции ИС Меркурий
017 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
018 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
019 ············<dt:name>?</dt:name> bs:String255 [0..1] Наименование продукции
020 ·········</dt:product>
021 ·········<dt:subProduct> dt:SubProduct [1..1]

Вид продукции

  • третий уровень иерархического справочника продукции ИС Меркурий
022 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
023 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
024 ············<dt:name>?</dt:name> bs:String255 [0..1] Наименование вида продукции
025 ·········</dt:subProduct>
026 ·········<dt:correspondsToGost>?</dt:correspondsToGost> xs:boolean [1..1] Соответствие ГОСТ
027 ·········<dt:gost>?</dt:gost> bs:String255 [0..1] ГОСТ
028 ·········<dt:producer> dt:BusinessEntity [0..1] Хозяйствующий субъект (ХС) производитель продукции
029 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии ХС
030 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор ХС
031 ············<dt:name>?</dt:name> bs:String255 [0..1] Наименование ХС
032 ············<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО ХС
033 ·········</dt:producer>
034 ·········<dt:tmOwner> dt:BusinessEntity [0..1] ХС-собственник торговой марки
035 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии ХС
036 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор ХС
037 ············<dt:name>?</dt:name> bs:String255 [0..1] Наименование ХС
038 ············<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО ХС
039 ·········</dt:tmOwner>
040 ·········<dt:producing> dt:ProductItemProducing [0..*] Список площадок, на которых выпускается данная продукция
041 ···········<dt:location> dt:Enterprise [1..1] Площадка, осуществляющая выпуск продукции
042 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии площадки
043 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор площадки
044 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование площадки
045 ············</dt:location>
046 ·········</dt:producing>
047 ·········<dt:packaging> dt:Packaging [0..1] Фасовка
048 ············<dt:packagingType> dt:PackingType [1..1] Тип упаковки
049 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии типа упаковки
050 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор упаковки
051 ···············<dt:globalID>?</dt:globalID> dt:PackingCodeType [1..1] Уникальный идентификатор упаковки
052 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование упаковки
053 ············</dt:packagingType>
054 ············<dt:quantity>?</dt:quantity> xs:integer [0..1] Количество единиц упаковки
055 ············<dt:volume>?</dt:volume> bs:Decimal [0..1] Объём единицы упаковки товара
056 ············<dt:unit> dt:Unit [0..1] Единица измерения объёма единицы упаковки товара
057 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения
058 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
059 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
060 ············</dt:unit>
061 ·········</dt:packaging>
062 ·········<dt:additionalCharacteristics> dt:ProductItemCharacterictics [0..1] Дополнительные характеристики продукции
063 ············<dt:classification> dt:ClassificationAttribute [0..1] Классификация продукции
064 ···············<dt:attrCode listID="?" listAgencyID="?" listName="?" listVersionID="?" name="?">PRODUCT_CATEGORY</dt:attrCode> dt:CodeType [1..1] Код атрибута - Категория продукции
065 ···············<dt:attrName>Категория продукции</dt:attrName> bs:Ntext [1..1] Наименование атрибута
066 ···············<dt:classCode listID="?" listAgencyID="?" listName="?" listVersionID="?" name="?">?</dt:classCode> dt:CodeType [1..1]

Код значения атрибута "Категория продукции"

  • Возможные значения:
    • UNDEFINED - категория не определена
    • UNCLASSIFIED – не классифицировано
    • RAW – сырец, исходное сырьё
    • INTERMEDIATE – полуфабрикат
    • CONSUMER_PACKAGED – готовая продукция (в потреб. упаковке)
067 ···············<dt:className>?</dt:className> bs:Text [1..1]

Наименование значения атрибута

  • Текстовое представление значения classCode:
    • Категория не определена
    • Не классифицировано
    • Сырец, исходное сырьё
    • Полуфабрикат
    • Готовая продукция (в потребительской упаковке)
068 ············</dt:classification>
069 ············<dt:attribute> dt:MeasuredAttribute [0..1] Дополнительный атрибут продукции
070 ···············<dt:attrCode listID="?" listAgencyID="?" listName="?" listVersionID="?" name="?">MILK_FAT_MASS_FRACTION</dt:attrCode> dt:CodeType [1..1] Код атрибута - Массовая доля жира
071 ···············<dt:attrName>Массовая доля жира</dt:attrName> bs:Ntext [1..1] Наименование атрибута
072 ···············<dt:attrValue> dt:ComplexMeasure [1..1]

Значение атрибута

  • Значение атрибута должно быть задано одним из следующих способов:
    • указано value - точное значение атрибута
    • указано minValue и maxValue - интервал значений атрибута
    • указано minValue - нижнее предельное значение (не ниже)
    • указано maxValue - верхнее предельное значение (не выше)
073 ··················<dt:value>?</dt:value> bs:Decimal [0..1]

Точное значение

  • точность до 3-х знаков после запятой
074 ··················<dt:minValue>?</dt:minValue> bs:Decimal [0..1]

Минимальное значение

  • точность до 3-х знаков после запятой
075 ··················<dt:maxValue>?</dt:maxValue> bs:Decimal [0..1]

Максимальное значение

  • точность до 3-х знаков после запятой
076 ··················<dt:unit> dt:Unit [0..1]

Единица измерения значения атрибута

  • значение массовой доли жира указывается в процентах (%)
077 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения
078 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
079 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
080 ··················</dt:unit>
081 ···············</dt:attrValue>
082 ············</dt:attribute>
083 ············<dt:attribute> dt:MeasuredAttribute [0..1] Дополнительный атрибут продукции
084 ···············<dt:attrCode listID="?" listAgencyID="?" listName="?" listVersionID="?" name="?">MILK_PROTEIN_MASS_FRACTION</dt:attrCode> dt:CodeType [1..1] Код атрибута - Массовая доля белка
085 ···············<dt:attrName>Массовая доля белка</dt:attrName> bs:Ntext [1..1] Наименование атрибута
086 ···············<dt:attrValue> dt:ComplexMeasure [1..1]

Значение атрибута

  • Значение атрибута должно быть задано одним из следующих способов:
    • указано value - точное значение атрибута
    • указано minValue и maxValue - интервал значений атрибута
    • указано minValue - нижнее предельное значение (не ниже)
    • указано maxValue - верхнее предельное значение (не выше)
087 ··················<dt:value>?</dt:value> bs:Decimal [0..1]

Точное значение

  • точность до 3-х знаков после запятой
088 ··················<dt:minValue>?</dt:minValue> bs:Decimal [0..1]

Минимальное значение

  • точность до 3-х знаков после запятой
089 ··················<dt:maxValue>?</dt:maxValue> bs:Decimal [0..1]

Максимальное значение

  • точность до 3-х знаков после запятой
090 ··················<dt:unit> dt:Unit [0..1]

Единица измерения значения атрибута

  • значение массовой доли белка указывается в процентах (%)
091 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения
092 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
093 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
094 ··················</dt:unit>
095 ···············</dt:attrValue>
096 ············</dt:attribute>
097 ············<dt:attribute> dt:MeasuredAttribute [0..1] Дополнительный атрибут продукции
098 ···············<dt:attrCode listID="?" listAgencyID="?" listName="?" listVersionID="?" name="?">DENSITY</dt:attrCode> dt:CodeType [1..1] Код атрибута - Плотность
099 ···············<dt:attrName>Плотность</dt:attrName> bs:Ntext [1..1] Наименование атрибута
100 ···············<dt:attrValue> dt:ComplexMeasure [1..1]

Значение атрибута

  • Значение атрибута должно быть задано одним из следующих способов:
    • указано value - точное значение атрибута
    • указано minValue и maxValue - интервал значений атрибута
101 ··················<dt:value>?</dt:value> bs:Decimal [0..1]

Точное значение

  • точность до 3-х знаков после запятой
102 ··················<dt:minValue>?</dt:minValue> bs:Decimal [0..1]

Минимальное значение

  • точность до 3-х знаков после запятой
103 ··················<dt:maxValue>?</dt:maxValue> bs:Decimal [0..1]

Максимальное значение

  • точность до 3-х знаков после запятой
104 ··················<dt:unit> dt:Unit [0..1]

Единица измерения значения атрибута

  • значение плотности указывается в граммах на кубический сантиметр (г/см3)
105 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения
106 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
107 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
108 ··················</dt:unit>
109 ···············</dt:attrValue>
110 ············</dt:attribute>
111 ·········</dt:additionalCharacteristics>
112 ······</dt:productItem>
113 ···</dt:productItemList>
114 </ws:getProductItemListResponse>

Классификатор справочников и перечислений Codelist

Описание классификатора и назначения опциональных атрибутов типа dt:CodeType (@listID, @listAgencyID, @listName, @listVersionID, @name) приведено на странице: MercuryG2B:Codelist:v2.4r1

Дополнительные сведения об операции

Подробнее о категориях продукции и качественных характеристиках молока и молочной продукции на странице операции ведения справочника номенклатуры: MercuryG2B:ModifyProducerStockList:v3.0

Примеры запросов

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0

Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:GetProductItemList:v3.0&oldid=37893