Mix de Produtos API (Mix de Produtos API)

O mix de produtos trabalha com cadastros customizáveis configurados como estruturais no uMov.me e que são criados automaticamente pelo sistema. Ao informar que utiliza mix de produtos (configurações do cadastro de itens), o sistema cria 3 cadastros com alguns campos customizáveis, conforme descrito a seguir.

Os cadastros são os listados abaixo. Veja também a definição específica de cada um dos cadastros.

- Tipo de mix: somente permite criar uma classificação para cada um dos mix. Não é utilizado no mobile ou em outro filtro no Center. Exemplo de tipo de mix: Mix para locais, mix fixo, mix da rede X, ...

- Mix: é a definição do mix que será associado em uma seção, local, tipo de local ou pessoa. Somente tem o ID para vínculo, descrição e seleção de tipo de mix.

- Itens do mix: é o cadastro com todos os produtos que pertencem a um mix. A descrição e identificador alternativo deve ser um sequencial, ou concatenado o id do mix e id do produto. Há campos customizáveis para informar o ID do mix e o ID do produto para cada registro. Também pode ser definida a ordem de exibição do produto no mobile.

Como encontrar os ID's dos cadastros customizáveis que trabalham com mix de produtos?

GET /CenterWeb/api/{$apiKey}/customEntity.xml?structuralFunction=mix

<result>

<resourceName>customEntity</resourceName>

<size>3</size>

<entries>

<entry id="ID_CADASTRO_1" link="/customEntity/ID_CADASTRO_1.xml"/>

<entry id="ID_CADASTRO_2" link="/customEntity/ID_CADASTRO_2.xml"/>

<entry id="ID_CADASTRO_3" link="/customEntity/ID_CADASTRO_3.xml"/>

</entries>

</result>

Buscar a definição de cada um dos cadastros para identificar qual entidade representa:

GET /CenterWeb/api/{$apiKey}/customEntity/ID_CADASTRO_1.xml

GET /CenterWeb/api/{$apiKey}/customEntity/ID_CADASTRO_2.xml

GET /CenterWeb/api/{$apiKey}/customEntity/ID_CADASTRO_3.xml

Tipo de Mix

- Identificado pelo campo structuralFunction = tipomix

<customEntity>

<id>ID_CADASTRO_1</id>

<description>Mix Type</description>

<alternativeIdentifier>MIXTYPE</alternativeIdentifier>

<active>true</active>

<labelDescription>Descrição</labelDescription>

<descriptionAlternativeIdentifier>Identificador Alternativo</descriptionAlternativeIdentifier>

<locked>false</locked>

<structural>true</structural>

<structuralFunction>tipomix</structuralFunction>

<myRecords>false</myRecords>

<customFields/>

</customEntity>

Mix

- Identificado pelo campo structuralFunction = mix

<customEntity>

<id>ID_CADASTRO_2</id>

<description>Mix</description>

<alternativeIdentifier>MIX</alternativeIdentifier>

<active>true</active>

<labelDescription>Descrição</labelDescription>

<descriptionAlternativeIdentifier>Identificador Alternativo</descriptionAlternativeIdentifier>

<locked>false</locked>

<structural>true</structural>

<structuralFunction>mix</structuralFunction>

<myRecords>false</myRecords>

<customFields>

<customField>

<id>ID_CAMPO_TIPOMIX</id>

<fieldType>C</fieldType>

<subType>3</subType>

<alternativeIdentifier>mix_mixType</alternativeIdentifier>

<description>Mix Type</description>

<size>0</size>

<active>true</active>

<entity>6</entity>

<viewQueryOnMobile>false</viewQueryOnMobile>

<mandatoryField>false</mandatoryField>

<sourceDataSet>6</sourceDataSet>

<locked>false</locked>

<orderField>100</orderField>

<structural>true</structural>

<structuralFunction>tipomix</structuralFunction>

</customField>

</customFields>

</customEntity>

Itens do Mix

- Identificado pelo campo structuralFunction = itensmix

<customEntity>

<id>ID_CADASTRO_3</id>

<description>Mix Product</description>

<alternativeIdentifier>MIXITEM</alternativeIdentifier>

<active>true</active>

<labelDescription>Descrição</labelDescription>

<descriptionAlternativeIdentifier>Identificador Alternativo</descriptionAlternativeIdentifier>

<locked>false</locked>

<structural>true</structural>

<structuralFunction>itensmix</structuralFunction>

<myRecords>false</myRecords>

<customFields>

<customField>

<id>ID_CAMPO_MIX</id>

<fieldType>C</fieldType>

<subType>3</subType>

<alternativeIdentifier>mixItem_mix</alternativeIdentifier>

<description>Mix</description>

<size>0</size>

<active>true</active>

<entity>6</entity>

<viewQueryOnMobile>false</viewQueryOnMobile>

<mandatoryField>true</mandatoryField>

<sourceDataSet>6</sourceDataSet>

<locked>false</locked>

<orderField>100</orderField>

<structural>true</structural>

<structuralFunction>mix</structuralFunction>

</customField>

<customField>

<id>ID_CAMPO_ORDEM</id>

<fieldType>N</fieldType>

<alternativeIdentifier>mixItem_order</alternativeIdentifier>

<description>Ordem</description>

<size>4</size>

<active>true</active>

<entity>6</entity>

<viewQueryOnMobile>false</viewQueryOnMobile>

<mandatoryField>false</mandatoryField>

<locked>false</locked>

<orderField>100</orderField>

<structural>true</structural>

<structuralFunction>ordem</structuralFunction>

</customField>

<customField>

<id>ID_CAMPO_ITEM</id>

<fieldType>C</fieldType>

<subType>3</subType>

<alternativeIdentifier>mixItem_item</alternativeIdentifier>

<description>Itens</description>

<size>0</size>

<active>true</active>

<entity>6</entity>

<viewQueryOnMobile>false</viewQueryOnMobile>

<mandatoryField>true</mandatoryField>

<sourceDataSet>3</sourceDataSet>

<locked>false</locked>

<orderField>100</orderField>

<structural>true</structural>

<structuralFunction>item</structuralFunction>

</customField>

</customFields>

</customEntity>