Dados de Retorno

A resposta da API será o objeto JSON, conforme exemplo abaixo:

{    "error": false,    "mensagem": "OK",    "cabecalho": {        "cnpj": "81657641000115",        "prod_env": 2,        "prod_ret": 1,        "prod_nao_ret": 1    },    "prod_ret": [        {            "grupo_id": 23375,            "codigo_cenario_fiscal_id": 8,            "prod_ean": "7898575511785",            "prod_nome": "Cachepot NC Pequeno Sem Micro Amarelo 10UN",            "ncm": "4819.20.00",            "cest": "",            "pis_cofins": {                "cst_ent_lp": "70",                "cst_sai_lp": "1 ",                "cst_ent": "50",                "cst_sai": "1 ",                "cst_ent_sn": "99",                "cst_sai_sn": "49",                "aliq_pis_ent": 1.65,                "aliq_pis_sai": 1.65,                "aliq_pis_ent_lp": 0.0,                "aliq_pis_sai_lp": 0.65,                "aliq_cofins_ent": 7.6,                "aliq_cofins_sai": 7.6,                "aliq_cofins_ent_lp": 0.0,                "aliq_cofins_sai_lp": 3.0,                "nri": "",                "amp_legal": "",                "red_pis_ent": 0.0,                "red_pis_sai": 0.0,                "red_cofins_ent": 0.0,                "red_cofins_sai": 0.0            },            "ipi": {                "cst_ent": "3 ",                "cst_sai": "53",                "aliq_ipi_ent": 0.0,                "aliq_ipi_sai": 0.0,                "codenq": "",                "ex": ""            },            "cfop": "5102",            "cst": "0 ",            "csosn": "102",            "desonerado": "S",            "aliq_icms_interna": 18.0,            "aliq_icms_interestadual": null,            "reducao_bc_icms": 0.0,            "reducao_bc_icms_st": 0.0,            "aliq_icms_st": 0.0,            "iva": null,            "iva_ajust": null,            "iva_ajust_4": null,            "iva_ajust_7": null,            "iva_ajust_12": null,            "fcp": 0.0,            "cod_benef": "            ",            "p_difer": null,            "p_isencao": null,            "picms_deson": 0.0,            "mot_des_icms": "",            "isento": "N",            "inf_pdv": {                "picms_pdv": 18.0,                "simb_pdv": "",                "cst_icms": "0 ",                "csosn": "102",                "cst_ent": "50",                "cst_sai": "1 ",                "aliq_pis_ent": 1.65,                "aliq_pis_sai": 1.65,                "aliq_cofins_ent": 7.6,                "aliq_cofins_sai": 7.6            }        }    ],    "prod_nao_ret": [        {            "cprod": "1005",            "cean": "36894",            "xprod": "CACHEPO PEQ AMARELO 10X1",            "ncm": "49119900",            "picms": 0.0,            "ppis": 0.0,            "pcofins": 0.0,            "icms_cst": "",            "csosn": null,            "cst_pis": 0,            "cest": "",            "alerta": "Produto não encontrado. Aguarde cadastro."        }    ]}

Observações importantes:
Em todas as consultas, sempre retornaremos o campo grupo_id. Este campo identifica o grupo tributário ao qual o produto pertence e deve ser armazenado na base do cliente. Assim, quando seu sistema receber atualizações tributárias de um determinado grupo, saberá exatamente quais produtos estão vinculados a esse grupo e que precisam ser atualizados automaticamente.

Descrição dos Campos do Objeto de Retorno

Campo	Tipo	Descrição
error	boolean	Indica se houve erro na requisição.
mensagem	string	Mensagem de status da requisição.
cabecalho	objeto	Informações do cabeçalho da resposta (ver tabela abaixo).
prod_ret	array	Lista de produtos encontrados e processados (ver tabela abaixo).
prod_nao_ret	array	Lista de produtos não encontrados/processados (ver tabela abaixo).

Detalhamento do objeto cabecalho

Campo	Tipo	Descrição
cnpj	string	CNPJ do cliente.
prod_env	int	Quantidade de produtos enviados.
prod_ret	int	Quantidade de produtos retornados.
prod_nao_ret	int	Quantidade de produtos não retornados.

Detalhamento do array prod_ret (produtos encontrados)

Campo	Tipo	Descrição
grupo_id	int	Identificador do grupo tributário ao qual o produto pertence. Deve ser salvo na base do cliente.
codigo_cenario_fiscal_id	int	Código do cenário fiscal utilizado na consulta.
prod_ean	string	Código de barras (EAN) do produto.
prod_nome	string	Nome do produto.
ncm	string	Nomenclatura Comum do Mercosul.
cest	string	Código Especificador da Substituição Tributária.
pis_cofins	objeto	Detalhes de PIS/COFINS (ver tabela abaixo).
ipi	objeto	Detalhes de IPI (ver tabela abaixo).
cfop	string	Código Fiscal de Operações e Prestações.
cst	string	Código de Situação Tributária do ICMS.
csosn	string	Código de Situação Tributária do Simples Nacional.
desonerado	string	Indica se o produto é desonerado (“S” para sim, “N” para não).
aliq_icms_interna	float	Alíquota interna de ICMS.
aliq_icms_interestadual	float	Alíquota interestadual de ICMS.
reducao_bc_icms	float	Percentual de redução da base de cálculo do ICMS.
reducao_bc_icms_st	float	Percentual de redução da base de cálculo do ICMS ST.
aliq_icms_st	float	Alíquota de ICMS ST.
iva	float	Índice de Valor Adicionado (IVA).
iva_ajust	float	IVA ajustado.
iva_ajust_4	float	IVA ajustado para alíquota de 4%.
iva_ajust_7	float	IVA ajustado para alíquota de 7%.
iva_ajust_12	float	IVA ajustado para alíquota de 12%.
fcp	float	Percentual do Fundo de Combate à Pobreza.
cod_benef	string	Código de benefício fiscal.
p_difer	float	Percentual de diferimento, se aplicável.
p_isencao	float	Percentual de isenção, se aplicável.
picms_deson	float	Percentual de ICMS desonerado.
mot_des_icms	string	Motivo da desoneração do ICMS.
isento	string	Indica se o produto é isento (“S” para sim, “N” para não).
inf_pdv	objeto	Informações específicas para PDV (ver tabela abaixo).

Detalhamento do objeto pis_cofins

Campo	Tipo	Descrição
cst_ent_lp	string	CST entrada lucro presumido
cst_sai_lp	string	CST saída lucro presumido
cst_ent	string	CST entrada regime normal
cst_sai	string	CST saída regime normal
cst_ent_sn	string	CST entrada Simples Nacional
cst_sai_sn	string	CST saída Simples Nacional
aliq_pis_ent	float	Alíquota de PIS na entrada
aliq_pis_sai	float	Alíquota de PIS na saída
aliq_pis_ent_lp	float	Alíquota de PIS na entrada (lucro presumido)
aliq_pis_sai_lp	float	Alíquota de PIS na saída (lucro presumido)
aliq_cofins_ent	float	Alíquota de COFINS na entrada
aliq_cofins_sai	float	Alíquota de COFINS na saída
aliq_cofins_ent_lp	float	Alíquota de COFINS na entrada (lucro presumido)
aliq_cofins_sai_lp	float	Alíquota de COFINS na saída (lucro presumido)
nri	string	Número do regime/incentivo fiscal
amp_legal	string	Amparo legal
red_pis_ent	float	Redução de base de cálculo de PIS na entrada
red_pis_sai	float	Redução de base de cálculo de PIS na saída
red_cofins_ent	float	Redução de base de cálculo de COFINS na entrada
red_cofins_sai	float	Redução de base de cálculo de COFINS na saída

Detalhamento do objeto ipi

Campo	Tipo	Descrição
cst_ent	string	CST de IPI na entrada
cst_sai	string	CST de IPI na saída
aliq_ipi_ent	float	Alíquota de IPI na entrada
aliq_ipi_sai	float	Alíquota de IPI na saída
codenq	string	Código de enquadramento legal do IPI
ex	string	Exceção de NCM

Detalhamento do objeto inf_pdv

Campo	Tipo	Descrição
picms_pdv	float	Percentual de ICMS para PDV
simb_pdv	string	Símbolo utilizado no PDV
cst_icms	string	CST de ICMS para PDV
csosn	string	CSOSN para PDV
cst_ent	string	CST de entrada para PDV
cst_sai	string	CST de saída para PDV
aliq_pis_ent	float	Alíquota de PIS na entrada para PDV
aliq_pis_sai	float	Alíquota de PIS na saída para PDV
aliq_cofins_ent	float	Alíquota de COFINS na entrada para PDV
aliq_cofins_sai	float	Alíquota de COFINS na saída para PDV

Detalhamento do array prod_nao_ret (produtos não encontrados)

Campo	Tipo	Descrição
cprod	string	Código interno do produto no sistema.
cean	string	Código de barras (EAN) do produto.
xprod	string	Descrição detalhada do produto.
ncm	string	Nomenclatura Comum do Mercosul.
picms	float	Percentual de ICMS.
ppis	float	Percentual de PIS.
pcofins	float	Percentual de COFINS.
icms_cst	string	Código de Situação Tributária do ICMS.
csosn	int	Código de Situação Tributária do Simples Nacional.
cst_pis	string	Código de Situação Tributária do PIS.
cest	string	Código Especificador da Substituição Tributária.
alerta	string	Mensagem de alerta sobre o produto.