A entidade Produtos permite gerenciar os produtos no Mercos. Com ela você também pode controlar informações como grades (variações) e categorias.
Para gerenciar as variações dos Produtos, utilize o campo produtos_grade, como no exemplo em parâmetros do JSON de envio dos Produtos Grade.
Para gerenciar as imagens dos Produtos, deverá ser utilizada a entidade Imagens do Produto 🔗 informando o ID do produto.
Para gerenciar diferentes preços dos mesmos produtos, deverá ser utilizada a entidade Tabelas de Preço 🔗 informando o ID do produto.
Já para Categorias de Produtos 🔗 basta informar o ID da categoria no campo categoria_id do JSON de envio do produto.
Filtro disponível
Você pode aplicar o seguinte filtro na consulta GET:
- excluido:
- 0 ou false = Não excluído
- 1 ou true = Excluído
Exemplo: ?excluido=false
Estrutura da Resposta (GET)
Importante
- Produtos excluídos não serão exibidos em tela para o usuário, e os produtos inativos só apareceram mediante a seleção no menu de filtros
- Ao enviar informações sobre as dimensões do produto que serão utilizadas para o cálculo do volume, é necessário o preenchimento dos 03 (três) campos: Largura, Altura e Comprimento.
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único |
| codigo | String: 50 | Código de referência do produto |
| nome | String: 100 | Nome do produto. |
| comissao | Double | Comissão do produto. Ex: 5.0 para 5%. Informe null caso não queira calcular comissões pela Mercos. |
| preco_tabela | Double | Preço deste produto na tabela padrão. |
| preco_minimo | Double | Preço mínimo do produto para o recurso da Rentabilidade (apenas Plano Ouro) |
| ipi | Double | Caso não possua IPI, informe null. |
| tipo_ipi | String: 1 | Tipo do IPI do produto: "P" para percentual, "V" para valor fixo em Reais. |
| st | Double | Percentual de Substituição Tributária do produto. Caso não possua ST ou se esse imposto deve ser calculado com base na regra vinculada ao NCM, informe null. |
| moeda | String: 1 | Moeda do produto: Real ("0"), Dólar ("1") ou Euro ("2"). |
| unidade | String: 10 | Unidade de medida do produto, por exemplo "Kg" ou "Cx". Opcional. |
| saldo_estoque | Double: 7 | Saldo de estoque do produto. Valor máximo suportado: 9999999.99 |
| observacoes | String: 5000 | Utilize para guardar quaisquer informações que não tenham campos específicos. |
| ultima_alteracao | DateTime | Data e hora da última modificação deste produto na Mercos. |
| excluido | Boolean | Indica se o produto está excluído. Os produtos excluídos não poderão mais ser atualizados. Após excluir um produto "excluido": true, este processo não tem retorno, será necessário criar outro produto. |
| ativo | Boolean | Indica se o produto está ativo. Os produtos inativos podem ser atualizados, inclusive podendo voltar a ser ativos. |
| categoria_id | Integer | Identificador único da categoria relacionada ao produto. |
| codigo_ncm | String | Código do NCM - Nomenclatura Comum do Mercosul, utilizado para cálculo automático do ST. |
| multiplo | Double | Múltiplo de venda do produto. |
| peso_bruto | Double | Peso bruto do produto em kg (com até 3 casas decimais). |
| largura | Double | Largura da embalagem do produto em centímetros (com até 5 casas decimais). |
| altura | Double | Altura da embalagem do produto em centímetros (com até 5 casas decimais). |
| comprimento | Double | Comprimento da embalagem do produto em centímetros (com até 5 casas decimais). |
| peso_dimensoes_unitario | Boolean | Indica se o peso bruto e as dimensões (Largura, Altura e Comprimento) informadas são unitárias. Em caso de caixa master esse campo deve ser enviado como falso = 0. (1 = Peso e dimensões unitárias - 0 = Peso e dimensões não são unitárias) |
| exibir_no_b2b | Boolean | Indica se o produto é exibido no e-commerce B2B. (1 = Produto é exibido no e-commerce B2B - 0 = Produto não é exibido no e-commerce B2B) |
| precos_especificos | Boolean | Indica se os produtos grade vão herdar do agregador as tabelas de preço, ou se terão preços específicos. |
| produtos_grade | Lista | Lista de produtos grade que o produto possui. |
Parâmetros de Envio - Produto simples (POST / PUT)
Importante:
Para requisições do tipo PUT envie apenas os campos que deseja alterar.
| Campo | Tipo | Descrição |
|---|---|---|
| codigo | String: 50 | Código de referência do produto |
| nome (obrigatório) | String: 100 | Nome do produto. |
| comissao | Double | Comissão do produto. Ex: 5.0 para 5%. Informe null caso não queira calcular comissões pela Mercos. |
| preco_tabela (obrigatório) | Double | Preço deste produto na tabela padrão. |
| preco_minimo | Double | Preço mínimo do produto para o recurso da Rentabilidade (apenas Plano Ouro) |
| ipi | Double | Caso não possua IPI, informe null. |
| tipo_ipi | String: 1 | Tipo do IPI do produto: "P" para percentual, "V" para valor fixo em Reais. |
| st | Double | Percentual de Substituição Tributária do produto. Caso não possua ST ou se esse imposto deve ser calculado com base na regra vinculada ao NCM, informe null. |
| moeda | String: 1 | Moeda do produto: Real ("0"), Dólar ("1") ou Euro ("2"). |
| unidade | String: 10 | Unidade de medida do produto, por exemplo "Kg" ou "Cx". Opcional. |
| saldo_estoque | Double: 7 | Saldo de estoque do produto. Valor máximo suportado: 9999999.99 |
| observacoes | String: 5000 | Utilize para guardar quaisquer informações que não tenham campos específicos. |
| excluido | Boolean | Indica se o produto está excluído. Os produtos excluídos não poderão mais ser atualizados. Após excluir um produto "excluido": true, este processo não tem retorno, será necessário criar outro produto. |
| ativo | Boolean | Indica se o produto está ativo. Os produtos inativos podem ser atualizados, inclusive podendo voltar a ser ativos. |
| categoria_id | Integer | Identificador único da categoria relacionada ao produto. |
| codigo_ncm | String | Código do NCM - Nomenclatura Comum do Mercosul, utilizado para cálculo automático do ST. |
| multiplo | Double | Múltiplo de venda do produto. |
| peso_bruto | Double | Peso bruto do produto em kg (com até 3 casas decimais). |
| largura | Double | Largura da embalagem do produto em centímetros (com até 5 casas decimais). |
| altura | Double | Altura da embalagem do produto em centímetros (com até 5 casas decimais). |
| comprimento | Double | Comprimento da embalagem do produto em centímetros (com até 5 casas decimais). |
| peso_dimensoes_unitario | Boolean | Indica se o peso bruto e as dimensões (Largura, Altura e Comprimento) informadas são unitárias. Em caso de caixa master esse campo deve ser enviado como falso. |
| exibir_no_b2b | Boolean | Indica se o produto é exibido no e-commerce B2B. Por padrão esse campo é verdadeiro, caso deseje que o produto não seja exibido no B2B, esse campo deve ser enviado como falso. |
| precos_especificos | Boolean | Indica se os produtos grade vão herdar do agregador as tabelas de preço, ou se terão preços específicos. |
| produtos_grade | Lista | Lista de produtos grade que o produto possui. Caso o produto possua produtos grades e nada for informado neste campo, os produtos grade serão atualizados apenas com os dados que são herdados do produto agregador. |
Parâmetros do JSON de envio dos Produtos Grade: objeto produtos_grade (POST / PUT)
produtos_grade (POST / PUT)Quando realizar uma requisição do tipo PUT, só envie os campos que deseja alterar. Não é possível alterar os itens de variação de um produto por este endpoint.
Para maiores detalhes de implementação e de como estes produtos funcionam, baixe: Guia Produtos Grade
Importante:Não deve ser enviado
itens_variacoes_idseitens_variacoes_nomesno mesmo produto grade. Escolha uma das duas
| Campo | Tipo | Descrição |
|---|---|---|
| id (Utilizado apenas para editar o produto grade no PUT) | Integer | Identificador único do produto grade. |
| codigo | String: 50 | Código de referência do produto |
| itens_variacoes_ids (obrigatório no POST) | Lista | Lista de itens de variação IDs que devem ser vinculadas ao produto grade. |
| itens_variacoes_nomes (obrigatório no POST) | Lista | Lista de dicionários, onde é apresentado o nome das variações e dos itens de variação que devem ser vinculadas ao produto grade. |
| exibir_no_b2b | Boolean | Indica se o produto é exibido no e-commerce B2B. Por padrão esse campo é verdadeiro, caso deseje que o produto não seja exibido no B2B, esse campo deve ser enviado como falso. |
| ativo | Boolean | Indica se o produto está ativo. Os produtos inativos podem ser atualizados, inclusive podendo voltar a ser ativos. |
| excluido | Boolean | Indica se o produto está excluído. Os produtos excluídos não poderão mais ser atualizados. Após excluir um produto "excluido": true, este processo não tem retorno, será necessário criar outro produto. |
| preco_tabela | Double | Preço deste produto na tabela padrão. Deve ser enviado este campo quando os produtos grade possuirem preços específicos de acordo com o produto agregador. |
Estrutura da resposta (POST / PUT)
Sucesso
Caso a requisição seja um sucesso a resposta retornará o id do produto e o id e código de seus produtos grade, na mesma ordem que foram enviados, no Body da requisição.
Esses ids devem ser armazenados caso seja necessário fazer alterações posteriormente.
Exemplo:
{
"id": 190,
"produtos_grade": [
{
"id": 191,
"codigo": "123"
}
]
}Erro
Caso a requisição encontre um ou mais erros, eles serão retornados informado campo e o tipo de erro, no Body da requisição.
Exemplo:
{
"mensagem": "Dados inválidos",
"erros": [
{
"campo": "produtos_grade",
"mensagem": "Não é possível criar um produto grade excluído."
}
]
}