Cadastre-se ou entre com o seu E-mail

FAQ

API Guide 

A partir de 08/07/2019, a GS1 Brasil disponiliza aos seus associados a solução completa para acesso aos Dados de produtos.

API de Cadastro de Produtos:

Esta API possibilita aos Donos das Marcas: Cadastrar e Atualizar seus produtos no CNP - Cadastro Nacional de Produtos. E uma vez que se utiliza a API em produção os dados são atualizados no portal CNP.

API de Consulta de Produtos:

Esta API possibilita a Varejos, Distribuidores e Provedores de solução a consultar os produtos que estão cadastrados no Cadastro Nacional de Produtos. E o também o próprio Dono da Marca gerenciar os seus produtos no CNP.

 
Onde encontrar a documentação Técnica da API 
Autenticação
Manual do Usuário da API
Dicionário de Dados - País
Dicionário de Dados - Estado
Dicionário de Dados - Idioma


A documentação Técnica da API (Autenticação, Modelos de JSON e Swagger) se encontram no link: Manual do Usuário.

 
Para o que Serve a API 



1 - Cadastro de produtos:

O Endpoint de cadastro de produto é para todos os produtos (com ou sem GTIN) que não se encontram na base de dados da GS1.

2 - Cadastro de produto que não possui GTIN:

Ao realizar o cadastro de um produto, ele receberá um GTIN, caso tenha preenchido todos os campos obrigatórios, seu GTIN receberá o Status ATIVO. Caso preencha todos os campos obrigatórios exceto peso, unidade de medida do peso, Nome da Imagem, URL de Imagem, Tipo de Imagem, receberá o Status INATIVO. É possível atualizá-lo depois com as informações faltantes descritas acima para que o mesmo se torne ativo.

Caso no cadastro do seu produto seja preenchido o campo "Data de Lançamento ao Mercado", o produto será cadastrado e receberá o Status INATIVO, esta informação poderá ser modificada com uma atualização no cadastro do produto.

Poderão ser cadastrados somente GTINs referentes ao CNPJ cadastrado junto a GS1 e consumirão os GTINs atribuídos a este CNPJ apontado.

3 - Cadastro de produto que já possui GTIN:

Ao realizar o cadastro de um produto que já possui um GTIN, o mesmo será validado para verificar se o GTIN enviado é um GTIN válido dentro do sistema CNP.

Caso tenha preenchido todos os campos obrigatórios, seu produto GTIN receberá o Status ATIVO, caso contrário, receberá o Status INATIVO (conforme descrito acima). É possível atualizá-lo depois com mais informações para que o mesmo se torne ativo. Caso não tenham todas as informações, o cadastro não será realizado.

4 - Atualização de produto:

A atualização de um produto serve para atualizar informações de produtos que já estão cadastrados na base de dados da GS1, apenas poderão ser atualizados os campos que estão presentes no JSON de atualização de produto.

O Endpoint de atualização serve para todos os produtos cadastrados na base de dados da GS1.

5 - Consultar os produtos cadastrados na base GS1:

Caso seja associado à GS1 Brasil, usuários do CNP, o acesso ao GET possibilitará a consulta de seus produtos cadastrados. Para a liberação ao acesso de outros produtos que não seja do seu cadastro, é possível pelo mesmo canal, mediante assinatura de contrato específico.

 
Métodos 

POST = O método POST é utilizado na criação dos recursos ou no envio de informações que serão processadas. Neste método é possível a geração de GTINs 12, 13 e 14.

PATCH = O método PATCH serve para atualizações parciais de um registro. Neste método é possível atualizar os GTINs 8, 12, 13 e 14.

GET = O método GET é utilizado para consultas de recursos já existentes, por exemplo, consulta de produtos. Para usuários do CNP – Cadastro Nacional de Produtos, as consultas são realizadas para ter acesso aos seus próprios produtos. Para os usuários contratuais, o acesso é para os GTINs da base de acordo com os limites de consulta.

As URLs receberão as mensagens HTTP através dos métodos POST, GET e PATCH. Cada tipo de mensagem deve ser enviada para um recurso identificado através do path.

 
O que a API não faz 


1 - A API não possibilita a criação de usuários. (Para criação de novo usuário acesse o CNP: https://cnp.gs1br.org/)

2 - A API não cria licenças/prefixos.

3 - A API não cria cadastro de associados. (Para Novo Associado, acesse: https://www.gs1br.org/filiacao-online/tabela-de-valores)

4 - A API não deve ser utilizada para chamadas assíncronas.

 
Termos de uso 

API de Cadastro de Produtos: Os termos de uso estão atrelados ao uso do CNP, que estão disponíveis para os associados no portal https://cnp.gs1br.org/ -> Meu perfil -> Termos assinados.

API de Consulta de Produtos: Os termos de uso relacionados ao uso desta API estão consolidados no contrato de consumo de dados, assinado junto a GS1 Brasil. A solicitação de uso deve ser feita por meio de envio de email: api@gs1br.org

 
Português, Brasil