Bem-vindo \u00e0 API do sistema Catálogo de Produtos.
\nO sistema Catálogo de Produtos permite a manutenção de catálogos de produtos e operadores estrangeiros, individualizados por empresa, visando ao reuso das informações nas operações de comércio exterior.
\n
As informações sobre os produtos e operadores estrangeiros podem ser importadas de arquivos JSON, tanto pela interface Web, via upload de arquivo, quando pelo acionamento dos serviços descritos a seguir. A estrutura do arquivo JSON é a mesma para as duas modalidades de uso.
\nNo arquivo com os produtos a serem importados, além dos dados básicos, devem ser preenchidos os atributos associados ao código NCM de cada produto. Os atributos preenchidos para cada produto devem respeitar os códigos do respectivo ambiente - treinamento (validação) ou produção. Devem ser considerados somente os atributos que contenham o objetivo Produto.
\nNos endereços a seguir estão disponíveis as relações de atributos por NCM para cada ambiente:
\n\nAs operações que podem ser gerenciadas pela API do sistema são:
\nPara utilizar os serviços disponíveis, deve-se considerar a maneira de autenticação de cada serviço, conforme padrão Portal Único do Comércio Exterior para os serviços, com exceção da Consultar LPCO por Chave de Acesso para o perfil de TERCEIROS. Segue abaixo os padrões:
\nhttps://{ambiente}/catp/api/{serviço}
\nOnde, em {ambiente} deve-se informar o ambiente desejado dentre os ambientes disponíveis na tabela abaixo e em {serviço} utilizar a URI do serviço desejado.
\n \n| Nome do Ambiente | \nURL de acesso | \nP\u00fablico alvo | \n
|---|---|---|
| Ambiente de Homologa\u00e7\u00e3o | \nhom.pucomex.serpro.gov.br | \nIntervenientes p\u00fablicos (conforme perfil de acesso) | \n
| Ambiente de Valida\u00e7\u00e3o das Empresas | \nval.portalunico.siscomex.gov.br | \nIntervenientes privados | \n
| Ambiente de Produ\u00e7\u00e3o | \nportalunico.siscomex.gov.br | \nTodos os intervenientes (p\u00fablicos e privados) | \n
\n
Exemplo: Para o serviço \"Incluir/Alterar Produtos\" a URI é \n
https://val.portalunico.siscomex.gov.br/catp/api/ext/produto
\n", "version": "1.0.0", "title": "Cat\u00e1logo de Produtos" }, "basePath": "/catp/api", "paths": { "/ext/fabricante": { "post": { "tags": [ "V\u00ednculos de Fabricante-Produtor a Produto" ], "summary": "**(Deprecated)** Vincular/Desvincular Fabricante-Produtor a Produto - Os novos endpoints substituir\u00e3o o recurso atual, que ser\u00e1 descontinuado/removido em 01/01/2026. ", "description": "", "operationId": "incluir", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Lista de Fabricantes/Produtores", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/FabricanteIntegracaoDTO" } } }, { "name": "Authorization", "in": "header", "description": "JSON Web Token (JWT) contendo as informa\u00e7\u00f5es do usu\u00e1rio. Este token \u00e9 recuperado no par\u00e2metro Set-Token no response da autentica\u00e7\u00e3o", "required": true, "type": "string" }, { "name": "X-CSRF-Token", "in": "header", "description": "Token de preven\u00e7\u00e3o contra ataques CSRF. Este token \u00e9 recuperado no par\u00e2metro X-CSRF-Token no response da autentica\u00e7\u00e3o", "required": true, "type": "string" } ], "responses": { "200": { "description": "Opera\u00e7\u00e3o realizada com sucesso", "schema": { "type": "array", "items": { "$ref": "#/definitions/LoteValidacaoDTO" } } }, "400": { "description": "Requisi\u00e7\u00e3o mal formatada" }, "422": { "description": "Erro(s) de valida\u00e7\u00e3o da camada de neg\u00f3cio" }, "401": { "description": "Usu\u00e1rio n\u00e3o autenticado ou autentica\u00e7\u00e3o inv\u00e1lida" }, "500": { "description": "Erro interno no servidor" }, "204": { "description": "Opera\u00e7\u00e3o realizada com sucesso. Nenhum conte\u00fado retornado" }, "403": { "description": "Usu\u00e1rio n\u00e3o tem permiss\u00e3o de acesso ao recurso" }, "404": { "description": "Recurso n\u00e3o encontrado" } }, "deprecated": true } }, "/ext/fabricante/exportar/{cpfCnpjRaiz}": { "get": { "tags": [ "V\u00ednculos de Fabricante-Produtor a Produto" ], "summary": "Exportar V\u00ednculos de Fabricante-Produtor a Produto", "description": "", "operationId": "downloadOperadorEstrangeiro", "consumes": [ "application/json" ], "produces": [ "application/zip" ], "parameters": [ { "name": "cpfCnpjRaiz", "in": "path", "description": "CPF ou CNPJ raiz da empresa respons\u00e1vel. Informar os 8 primeiros d\u00edgitos do CNPJ, suprimindo os pontos