Itens e relacionados (aditionalInfoItem (Itens em Destaque))

A API de Itens em Destaque permite criar a definição de itens em destaque no uMov.me. A partir dele é possível indicar os itens em destaque e fazer a associação nos cadastros de seções, locais e itens.

Descrição de um Item em Destaque

image.png

Inclusão de um Item em Destaque

POST /CenterWeb/api/{$apiKey}/aditionalInfoItem.xml

Este recurso serve para incluir um Item em Destaque. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um Item em Destaque no ambiente em questão. Confira a descrição do Item em Destaque para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:

<aditionalInfoItem>

<item>

<alternativeIdentifier>id_alternativo_item</alternativeIdentifier>

</item>

<featuredInfo>descrição</featuredInfo>

<active>true</active>

<section>

<alternativeIdentifier>id_alternativo_seção</alternativeIdentifier>

</section>

<serviceLocal>

<alternativeIdentifier>id_alternativo_local</alternativeIdentifier>

</serviceLocal>

</aditionalInfoItem>

Buscar todos os registros de todos itens em destaque

GET /CenterWeb/api/{$apiKey}/aditionalInfoItem.xml

Este recurso serve para buscar todos os itens em destaque dados de um grupo específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<result>

<resourceName>aditionalInfoItem</resourceName>

<size>1</size>

<entries>

<entry id="id" link="/aditionalInfoItem/id.xml"/>

</entries>

</result>

Buscar um registro específico de item em destaque

GET /CenterWeb/api/{$apiKey}/aditionalInfoItem/{id}.xml

Este recurso serve para buscar dados de um item em destaque específico do sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<aditionalInfoItem>

<id>8</id>

<clientId>22022</clientId>

<section>

<id>805992</id>

<description>Produtos do Pedido</description>

<order>0</order>

<alternativeIdentifier>01</alternativeIdentifier>

<active>true</active>

<mandatory>1</mandatory>

<useItem>2</useItem>

<findItemsByIdentifier>false</findItemsByIdentifier>

<itemFillMode>0</itemFillMode>

<groupingItemsTypeOnMobile>1</groupingItemsTypeOnMobile>

<activityHistoryReportType>V</activityHistoryReportType>

<displayItemsInMobile>0</displayItemsInMobile>

<seeItemsCollectedAutomatically>false</seeItemsCollectedAutomatically>

<quizMode>false</quizMode>

<locked>false</locked>

<markCompleteGroup>false</markCompleteGroup>

<documentation />

<executionWayItem>0</executionWayItem>

<mobileItemViewWay>0</mobileItemViewWay>

<cleanFilterSearchItem>false</cleanFilterSearchItem>

<displaySection>false</displaySection>

<beepItemNotFound>true</beepItemNotFound>

<automaticItemAdvance>false</automaticItemAdvance>

<focusOnFirstEditableField>true</focusOnFirstEditableField>

<allowDuplicateItems>false</allowDuplicateItems>

<displaySingleItem>false</displaySingleItem>

<allowChangeViewMobile>true</allowChangeViewMobile>

<toggleItems>false</toggleItems>

<finalizationIconSection>0</finalizationIconSection>

</section>

<item>

<id>53351048</id>

<description>AMOR DISPLAY 540G</description>

<alternativeIdentifier>AMOR DISPLAY 540G</alternativeIdentifier>

<active>true</active>

<insertModule>importer</insertModule>

<updatedModule>importer</updatedModule>

</item>

<serviceLocal>

<id>48906842</id>

<description>Thomas e Milena Lavanderia ME</description>

<active>true</active>

<alternativeIdentifier>002</alternativeIdentifier>

<corporateName>Thomas e Milena Lavanderia ME</corporateName>

<country>Brasil</country>

<state>SP</state>

<city>São Paulo</city>

<street>Rua José Gabriel Nunez</street>

<streetNumber>583</streetNumber>

<zipCode>03923110</zipCode>

<phoneStd>51</phoneStd>

<phoneNumber>36982991</phoneNumber>

<email>lavanderia@lavanderia.br</email>

<geoCoordinate>-23.59394310,-46.50958390</geoCoordinate>

<geoCoordinatePrecision>GEOMETRIC_CENTER</geoCoordinatePrecision>

<origin>3</origin>

<isToSearchGeocorder>false</isToSearchGeocorder>

<processGeocoordinate>false</processGeocoordinate>

<exportStatus>2</exportStatus>

<insertModule>api</insertModule>

<updatedModule>api</updatedModule>

</serviceLocal>

<featuredInfo>AMOR DISPLAY 540G e Thomas e Milena Lavanderia ME</featuredInfo>

<active>true</active>

</aditionalInfoItem>

Atualização de um registro específico de item em destaque

POST /CenterWeb/api/{$apiKey}/aditionalInfoItem/{id}.xml

Este recurso serve para atualizar dados de um item em destaque específico do sistema.

<aditionalInfoItem>

<item>

<alternativeIdentifier>id_alternativo_item</alternativeIdentifier>

</item>

<featuredInfo>descrição</featuredInfo>

<active>true</active>

<section>

<alternativeIdentifier>id_alternativo_seção</alternativeIdentifier>

</section>

<serviceLocal>

<alternativeIdentifier>id_alternativo_local</alternativeIdentifier>

</serviceLocal>

</aditionalInfoItem>