Cadastre-se ou entre com o seu E-mail

FAQ

Versões da API 

API e versionamento:

Esta é a primeira versão da API disponibilizada, no próximo ano, teremos melhorias aplicadas e informaremos as mudanças para os usuários.

Dentre as melhorias terão: adição de todos os campos existentes no CNP, hoje estão restritos, atualizações no swagger, mudanças no json, dentre outras mudanças

Os dados cadastrados em homologação serão apagados após um período de tempo. O ambiente de homologação é para testes, não podem ser considerados como dados finais para geração de GTIN, são apenas testes.

Para ter acesso ao ambiente de produção, envie email para suporteapi@gs1br.org e receba as orientações para acessar o ambiente de produção. Apenas assim, poderá gerar, alterar, atualizar seus GTINs na base oficial do CNP - Cadastro Nacional de Produtos.

 
Onde encontrar a documentação Técnica da API 
Autenticação
API Browser
Modelos de Requisição


A documentação Técnica da API (Autenticação, Modelos de JSON e Swagger) se econtram nos links acima.

 
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.

 
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.

 
Dicionário de Dados
Campos Nome Negócio Descrição
"globalTradeItemNumber"
EX: 7899999999999
Número do GTIN Número único de identificação global do produto. Conhecido como também código de barras do item.(Campo Obrigatório)
"productDescription":
EX: Descrição do Produto
Descrição do Produto Descrição principal do produto codificado, marca, características e conteúdo.(Campo Obrigatório)
"CodigoTipoGTIN": EX: 3 Tipo de numeração de GTIN a ser cadastrado (1 para GTIN-8; 2 para GTIN-12; 3 para GTIN-13; 4 para GTIN-14) Tipo de numeração de GTIN a ser cadastrado.
GTIN-8 possui 8 dígitos e é a numeração atribuída para pequenos itens
(produtos com este GTIN somente podem ser cadastrados via atendimento direto GS1, e sua descrição não poder ser alterada depois de criada).
GTIN-12 possui 12 dígitos e é a numeração dos códigos do EUA/Canadá fornecidos pela GS1 Brasil conhecida como UCC.
GTIN-13 possui 13 dígitos e é a identificação do item.
GTIN-14 possui 14 dígitos e é a identificação do agrupamento de item.
(Campo Obrigatório)
"tradeItemCountryOfOrigin":
EX: 76
Código do País de Origem Código do país de origem do produto. Ver Anexos com a lista de códigos de países.(Campo Obrigatório)
"countryCode":EX: 076 Código do País de Destino Código do principal país de destino do produto.Ver Anexos com a lista de códigos de países. (Campo Obrigatório)
"CodeSegment": EX: 999999999 Segmento 1º nível da Classificação Global de Produtos. GPC.(Campo Obrigatório)
"CodeFamily": EX: 99999999 Família 2º nível da Classificação Global de Produtos. GPC.(Campo Obrigatório)
"CodeClass": EX: 99999999 Classe 3º nível da Classificação Global de Produtos. GPC.(Campo Obrigatório)
"CodeBrick": EX: 99999999 Brick/Subclasse 4º nível da Classificação Global de Produtos. GPC.(Campo Obrigatório)
"IndicadorCompartilhaDados":
EX: 0 ou 1
Compartilha Dados 0 - Não | 1 - Sim. Indica se os dados do produto carregado serão compartilhados. (Campo Obrigatório)
"brandName":
EX: Nome da Marca
Marca Marca do produto.(Campo Obrigatório)
"modelNumber":
Ex: Celular A234
Modelo Característica que diferencia um produto de outro.
“importClassificationValue”: EX: 0100.12.00 NCM Nomenclatura Comum do MERCOSUL (NCM).(Campo Obrigatório)
"startAvailabilityDateTime":
EX: 21/05/2018-23:50
Data de Lançamento para o Mercado Data que o produto foi ou será lançado ao mercado. (Campo Obrigatório quando o Status do Produto for Inativo)
"grossWeight": EX: 0.008 Peso Bruto Peso bruto do produto com três casas decimais. (Campo Obrigatório)
"grossWeightMeasurementUnitCode":
EX: KGM
Unidade de Peso Unidade de medida do peso bruto. Ver anexos a lista de códigos de medidas aceitos no campo.(Campo Obrigatório)
"CodigoLingua": EX: 348 Código da língua Código do idioma do produto. Ver Anexos com a lista de códigos aceitos no campo.(Campo obrigatório)
“images” : [
{ "URL":"https://socd.vteximg.com.br/arquivos//",
"Nome":"Lata",
"CodigoTipoURL": 1
}]
"URL" URL da imagem do produto.
"Nome" da URL de imagem a ser carregada.
" CodigoTipoURL" Código do tipo da URL do produto.
"URL" URL da imagem do produto a ser carregada. (Campo Obrigatório).
"Nome" da URL de imagem a ser carregada.(Campo Obrigatório)
" CodigoTipoURL" Código do tipo da URL do produto: valores de código variam de 1 a 5.(Campo Obrigatório)
"alternateItemIdentificationId":
EX:0123456789012234
Código Interno Número de identificação interna do produto.
"responsibilityStatement": EX: S ou N Termo de responsabilidade Aceite do termo de responsabilidade. (Campo Obrigatório)
"CEST":
EX: [01.001.02,01.001.03,01.001.04]
Ou [01.001.02,01.001.03]
ou : [01.001.02]
ou : [00.000.00]
CEST Código Especificador da Substituição Tributária. CEST. Podem ser até três.
"CodigoProdutoOrigem" :
EX: 7898901000068
Campo deve ser preenchido quando o tipo do GTIN for GTIN-14 opção 4 GTIN Origem é o número que origina a numeração da caixa, podendo ser GTIN-8, GTIN-12 ou GTIN-13.(Campo Obrigatório para produto GTIN-14)
“totalQuantityOfNextLowerLevelTradeItem”
EX:10
Quantidade de itens na caixa Quantidade de itens dentro da caixa.
(Campo obrigatório para GTIN-14)
"CAD": EX: 999 Número de Cadastro Número do cadastro da empresa na GS1 Brasil. Esta opção é obrigatória para empresas em que o mesmo CNPJ possui mais de um cadastro na GS1 Brasil.
"agency": [{ "id": 1, "alternateItemIdentificationId": "A0001" }, { "id": 5, "alternateItemIdentificationId": "I0001" } ]
} ]
"Id" Agência, Órgão ou Entidade Reguladora quando aplicável ao tipo de produto.
"alternateItemIdentificationId" Agência reguladora ou outro Órgão quando aplicável ao tipo de produto
"Id"Agência, Órgão ou Entidade Reguladora quando aplicável ao tipo de produto.
Exemplo: 1
"alternateItemIdentificationId" Nome ou descrição da agência ou órgão regulador, quando aplicável.
Exemplo:ANATEL
“items” : [
{
"globalTradeItemNumber": "7898901000068",
"quantidade": 0} ]
GTIN contido Campo deve ser preenchido quando o GTIN contiver outros GTINs, EX: Kit de Produtos
Anexos 

TABELA 1 - AGÊNCIA REGULADORA

Código Nome Descrição
1 ANVISA Agência Nacional de VIgilância Sanitária
2 INMETRO Instituto Nacional de Metrologia, Qualidade e Tecnologia
3 ANATEL Instituto Nacional de Telecomunicações
4 MAPA Ministério da Agricultura, Pecuária e Abastecimento

TABELA 2 - CÓDIGO PAÍS

Código País Nome
4 Afeganistão
8 Albania
12 Algeria
20 Andorra
24 Angola
28 Antigua & Barbados
32 Argentina
51 Armênia
36 Austrália
40 Aústria
31 Azerbaijan
44 Bahamas
48 Bahrain
50 Bangladesh
52 Barbados
112 Belarus
56 Bélgica
84 Belize
204 Benin
64 Bhutan
68 Bolívia
70 Bosnia & Herzegovina
72 Botswana
76 Brasil
96 Brunei
100 Bulgária
854 Burkina Faso
108 Burundi
116 Cambódia
120 Cameroon
124 Canadá
132 Cape Verde
140 República Central Africana
148 Chad
152 Chile
156 República da China
170 Colombia
174 Comoros
180 Congo, , (Congo – Kinshasa)
178 Congo, (Congo – Brazzaville)
188 Costa Rica
384 Cote d'Ivoire (Ivory Coast)
191 Croácia
192 Cuba
196 Cyprus
203 Czech Republic
208 Dinamarca
262 Djibouti
212 Dominica
214 República Dominicana
324 Guinea
218 Equador
818 Egito
222 El Salvador
226 Equatorial Guinea
232 Eritreia
233 Estônia
231 Ethiopia
242 Fiji
246 Finlândia
250 França
266 Gabon
270 Gambia
268 Georgia
276 Germany (Alemanha)
288 Ghana
300 Greece (Grécia)
308 Grenada
320 Guatemala
324 Guinea
624 Guinea-Bissau
328 Guyana
332 Haiti
340 Honduras
348 Hungary (Hungria)
352 Iceland (Islândia)
356 India
360 Indonésia
364 Iran
368 Iraque
372 Ireland (Irlanda)
376 Israel
380 Itália
388 Jamaica
392 Japão
400 Jordan
398 Kazakhstan
404 Kenya
296 Kiribati
408 Korea North (Coréia do Norte)
410 Korea South (Coréia do Sul)
414 Kuwait
417 Kyrgyzstan
418 Laos
428 Latvia
422 Lebanon
426 Lesotho
430 Liberia
434 Libya
438 Liechtenstein
440 Lithuania
442 Luxembourg (Luxemburgo)
807 Macedonia
450 Madagascar
454 Malawi
458 Malaysia
462 Maldives
466 Mali
470 Malta
584 Marshall Islands
478 Mauritania
480 Mauritius
484 Mexico
583 Micronesia
498 Moldova
492 Monaco
496 Mongolia
499 Montenegro
504 Morocco(Marrocos)
508 Mozambique
104 Myanmar (Burma)
516 Namibia
520 Nauru
524 Nepal
528 Netherlands (Países Baixos)
554 New Zealand (Nova Zelândia)
558 Nicaragua
562 Niger
566 Nigeria
578 Norway (Noruega)
512 Oman
586 Pakistan (Pasquistão)
585 Palau
591 Panama
598 Papua New Guinea
600 Paraguay
604 Peru
608 Philippines (Filipinas)
616 Poland
620 Portugal
634 Qatar
642 Romania
643 Russia
646 Rwanda
659 Saint Kitts and Nevis
662 Saint Lucia
670 Saint Vincent and the Grenadines
882 Samoa
674 San Marino
678 San Tome and Principe (São Tomé e Princípe)
682 Saudi Arabia (Arábia Saudita)
686 Senegal
688 Serbia (Sérvia)
690 Seychelles
694 Sierra Leone (Serra Leõa)
702 Singapore (Singapura)
703 Slovakia
705 Slovenia
90 Solomon Islands (Ilhas Solomón)
706 Somalia
710 South Africa (África do Sul)
724 Spain (Espanha)
144 Sri Lanka
736 Sudan (Sudão)
740 Suriname
748 Swaziland
752 Sweden
756 Switzerland (Suíça)
760 Syria
762 Tajikistan
834 Tanzania
764 Thailand
626 East Timor(Timor-Leste)
768 Togo
776 Tonga
780 Trinidad and Tobago (Trinidade e Tobago)
788 Tunísia
792 Turkey (Turquia)
795 Turkmenistan
798 Tuvalu
800 Uganda
804 Ukraine (Ucrânia)
784 United Arab Emirates (Emirados Árabes Unidos)
826 United Kingdom (Reino Unido)
840 United States (Estados Unidos)
858 Uruguay
860 Uzbekistan (Uzbequistão
548 Vanuatu
336 Vatican City (Cidade do Vaticano)
862 Venezuela
704 Vietnam
887 Yemen
894 Zambia
716 Zimbabwe
268 Abkhazia
158 China, Republic of (Taiwan)
31 Nagorno-Karabakh
196 Northern Cyprus
498 Pridnestrovie (Transnistria)
706 Somaliland
268 South Ossetia
36 Ashmore and Cartier Islands
162 Christmas Island
166 Cocos (Keeling) Islands
36 Coral Sea Islands
334 Heard Island and McDonald Islands
574 Norfolk Island
540 New Caledonia (Nova Caledonia)
258 French Polynesia (Polinésia Francesa)
175 Mayotte
312 Saint Barthelemy
312 Saint Martin
666 Saint Pierre and Miquelon
876 Wallis and Futuna
260 French Southern and Antarctic Lands
258 Clipperton Island
74 Bouvet Island
184 Cook Islands
570 Niue
772 Tokelau
831 Guernsey
833 Isle of Man
832 Jersey
660 Anguilla
60 Bermuda
86 British Indian Ocean Territory
92 British Virgin Islands
136 Cayman Islands (Ilhas Cayman)
238 Falkland Islands (Islas Malvinas)
292 Gibraltar
500 Montserrat
612 Pitcairn Islands
654 Saint Helena
239 South Georgia & South Sandwich Islands
796 Turks and Caicos Islands
580 Northern Mariana Islands
630 Puerto Rico
16 American Samoa
581 Baker Island
316 Guam
581 Howland Island
581 Jarvis Island
581 Johnston Atoll
581 Kingman Reef
581 Midway Islands
581 Navassa Island
581 Palmyra Atoll
850 U.S. Virgin Islands
850 Wake Island
344 Hong Kong
446 Macau
234 Faroe Islands
304 Greenland
254 French Guiana (Guiana Francesa)
312 Guadeloupe
474 Martinique
638 Reunion
248 Aland
533 Aruba
530 Netherlands Antilles
744 Svalbard
10 Australian Antarctic Territory
10 Ross Dependency
10 Peter I Island
10 Queen Maud Land
10 British Antarctic Territory

TABELA 3 - CÓDIGO LÍNGUA

Código Nome Descrição
4 Acoli Acoli
8 Afrihili Afrihili
10 Ainu Ainu
12 Akkadian Akkadian
14 Aleut Aleut
17 Amharic Amharic
18 English, Old (ca.450-1100) English, Old (ca.450-1100) (Inglês Antigo)
21 Arabic Arabic
22 Official Aramaic (700-300 BCE) Imperial Aramaic (700-300 BCE)(Aramaico)
38 Banda languages Banda languages
39 Bamileke languages Bamileke languages
44 Basque Basque
48 Belarusian Belarusian
60 Braj Braj
62 Batak languages Batak languages
71 Catalan Catalan (Catalão)
79 Chinese Chinese (Chinês)
80 Chuukese Chuukese
123 English English (Inglês)
124 English, Middle (1100-1500) English, Middle (1100-1500)(Inglês)
137 French French (Francês)
148 Germanic languages Germanic languages
150 German German (Alemão)
165 Guarani Guarani
173 Hebrew Hebrew (Hebreu)
192 Iloko Iloko
193 Interlingua (International Auxiliary Language Association) Interlingua (International Auxiliary Language Association)
197 Ingush Ingush
200 Iroquoian languages Iroquoian languages
201 Italian Italian (Italiano)
202 Javanese Javanese (Javanês)
204 Japanese Japanese (Japonês)
230 Korean Korean (Coreano)
291 Multiple languages Multiple languages ( Múltiplas Linguagens)
297 Erzya Erzya
298 Nahuatl languages Nahuatl languages
300 Neapolitan Neapolitan
317 N'Ko N'Ko
318 Pedi Sepedi Northern Sotho
319 Nubian languages Nubian languages
320 Classical Newari Old Newari Classical Nepal Bhasa
324 Nyoro Nyoro
326 Occitan Occitan
328 Oriya Oriya
329 Oromo Oromo
330 Osage Osage
331 Ossetian Ossetic Ossetian Ossetic
332 Turkish, Ottoman (1500-1928) Turkish, Ottoman (1500-1928) (Turco Otomano)
334 Papuan languages Papuan languages
335 Pangasinan Pangasinan
336 Pahlavi Pahlavi
338 Panjabi Punjabi Panjabi Punjabi
339 Papiamento Papiamento
342 Persian Persian
343 Philippine languages Philippine languages
344 Phoenician Phoenician (Fenício)
345 Pali Pali
346 Polish Polish
347 Pohnpeian Pohnpeian
348 Portuguese Portuguese
349 Prakrit languages Prakrit languages
350 Provençal, Old (to 1500) Provençal, Old (to 1500)
351 Pushto Pashto Pushto Pashto
352 Reserved for local use Reserved for local use (Reservado para Uso Local)
354 Rajasthani Rajasthani
355 Rapanui Rapanui
364 Sandawe Sandawe
365 Sango Sango
376 Croatian Croatian
384 Siouan languages Siouan languages
390 Northern Sami Northern Sami
401 Songhai languages Songhai languages
403 Spanish Castilian Spanish Castilian (Espanhol Castelhano)
415 Classical Syriac Classical Syriac
416 Syriac Syriac
417 Tahitian Tahitian
418 Tai languages Tai languages
427 Thai Thai
456 Urdu Urdu
471 Kalmyk Oirat Kalmyk Oirat
472 Xhosa Xhosa
481 Zhuang Chuang Zhuang Chuang
485 No linguistic content Not applicable (Não Aplicável)

TABELA 4 - UNIDADES DE MEDIDA

Código Comum Nome
J57 barrel (UK petroleum) (Barril)
BLL Barrel (US) (Barril)
BUI Bushel (UK)
BUA Bushel (US)
CLT Centilitre (Centilitro)
CMQ Cubic Centimetre (Centímetro Cúbico)
DMA Cubic Decametre (Decâmetro Cúbico)
DMQ Cubic Decimetre (Decímetro Cúbico)
FTQ Cubic Foot (Pé Cúbico)
H19 Cubic Hectometre
INQ Cubic Inch
H20 Cubic Kilometre (Quilômetro Cúbico)
K6 Cubic Metre (Metro Cúbico)
MMQ Cubic Millimetre (Milimetro Cúbico)
YDQ Cubic Yard (Jardas Cúbicas)
G21 Cup [Xícara unidade de volume]
A44 Decalitre (Decalitro)
DLT Decilitre (Decilitro)
BLD Dry Barrel (US)
GLD Dry Gallon (US)
PTD Dry Pint (US)
QTD Dry Quart (US)
OZI Fluid Ounce (UK)
OZA Fluid Ounce (US)
GLI Gallon (UK)
GLL Gallon (US)
HLT Hectolitre (Hectolitro)
K6 Kilolitre (Quilolitro)
PTL Liquid Pint (US)
QTL Liquid Quart (US)
LTR Litre (Litro)
MLT Megalitre (Mega Litro)
4G Microlitre (Micro Litro)
MAL Millilitre (Mililitro)
G23 Peck
L43 Peck (UK)
PTI Pint (UK)
L61 Pint (US Dry)
PT Pint (US)
QTI Quart (UK)
L62 Quart (US dry)
QT Quart (US)
5I Standard Cubic Foot (Pé Cúbico Padrão)
G26 Stere (Estereo)
G24 Tablespoon (US)(Colher de Sopa)
G25 Teaspoon (US) (Colher de Chá)
KGM Kilogram (Quilograma)
MC Microgram (Micrograma)
DJ Decagram (Decagrama)
DG Decigram (Decigrama)
GRM Gram (Grama)
CGM Centigram (Centigrama)
TNE Tonne (metric ton - Tonelada Métrica)
DTN Decitonne
MGM Milligram (Miligrama)
HGM Hectogram (Hectograma)
KTN Kilotonne
2U Megagram (Megagrama)
LBR Pound (Libra)
GRN Grain (Grão)
ONZ Ounce (avoirdupois - Onça)
STI Stone (UK)(Pedra)
MTR Metre (Metro)
DMT Decimetre (Decimetro)
CMT Centimetre (Centimetro)
4H Micrometre (micro metro)
MMT Millimetre (Milimetro)
HMT Hectometre (Hectometro)
KTM Kilometre (Quilômetro)
C45 Nanometre (Nanômetro)
C52 Picometre (Picometro)
A71 Femtometre (Femtometro)
A45 Decametre (Decametro)
A11 Angstrom
H79 French gauge (Calibre Francês)
AK Fathom
INH Inch (Polegadas)
M7 Micro-inch (Micro-Polegada)
FOT Foot (Pé)
YRD Yard (Jardas)
SMI Mile (Statute Mile)
77 Milli-inch (Mili Polegadas)
MAM Megametre
AWG American Wire Gauge (Calibre de Fio Americano)
CEL Celsius (Graus Celsius)
FAH Fahrenheit (Graus Fahrenheit)
KEL Kelvin (Graus Kelvin)
KJO Kilojoule
C15 Millijoule
JOU Joule
J75 Calorie (Calorias)
K51 Kilocalorie
Português, Brasil