API - Cadastrar Produto

API - Cadastro Produto

POST https://sandbox-api.invoisys.com.br/api/produto

Método para realizar o cadastro de um novo produto.

Headers

Name Type Description

Name	Type	Description
Content-type	string	`application/x-www-form-urlencoded`
Accept	string	`application/json`
Authorization	string	`bearer <valor>`

Content-type

string

application/x-www-form-urlencoded

string

application/json

Authorization

string

bearer <valor>

Request Body

Name	Type	Description
id	integer	Este campo será preenchido automaticamente após a finalização do cadastro. É importante ter o ID sempre em mãos, pois o mesmo será requisitado no momento da emissão.
codigo	string	Informar o código do produto. Exemplo: "TESTE001"
description	string	Informar a descrição do produto. Exemplo; "Produto teste"
bloqueado	boolean	Informar se o produto está bloqueado ou não, da seguinte maneira: "true", para produto bloqueado/inativo. "false", para produto não bloqueado
tipoMaterial: {key}	integer	Informar o tipo de produto. O tipo de produto pode ser consultado por meio da API: Tipo de Material
tipoMaterial: {value}	string	Campo preenchido automaticamente com base no campo tipoMaterial: {key}
ncm	string	Informar o código NCM (Código da Nomenclatura Comum do Mercosul) do produto (Somente números)
cest	string	Informar o código CEST (Código Especificador da Substituição Tributária) do produto (Somente números)
ibpt	boolean	Informar se fará a utilização da tabela IBPT ou não, da seguinte maneira: "true", para utilizar "false", para não utilizar
origemMaterial: {key}	string	Informar a origem do material. A origem do material pode ser consultada por meio da API: Origem do Material
origemMaterial: {value}	string	Campo preenchido automaticamente com base no campo origemMaterial: key
percentualDeImpostos	string	Informar o percentual de impostos sobre o valor do produto
ean	string	Informar o Código GTIN (Global Trade Item Number), no formato GTIN-8, GTIN-12, GTIN-13 ou GTIN-14. Caso não possua, informar o literal "SEM GTIN".
eanTributario	string	Se o produto faturado for o mesmo que o produto tributável, informar o EAN tributário com o mesmo código informado no campo EAN. Caso não possua, informar o literal "SEM GTIN".
extensaoTabelaIPI	string	Informar a extensão do código NCM para produtos nos quais possuem alíquota de IPI diferenciada.
valorUnitarioComercial	number	Informar o valor unitário comercial do produto (Utilizar "." paras as casas decimais)
unidadeMedidaComercial: {key}	integer	Informar a unidade de medida comercial do produto. A unidade de medida comercial pode ser consultada por meio da API: Unidade de Medida
unidadeMedidaComercial: {value}	string	Campo preenchido automaticamente com base no campo unidadeMedidaComercial: {key}
valorUnitarioTributario	number	Informar o valor unitário tributário do produto (Utilizar "." paras as casas decimais)
unidadeMedidaTributaria: {key}	integer	Informar a unidade de medida tributária do produto. A unidade de medida tributária pode ser consultada por meio da API: Unidade de Medida
unidadeMedidaTributaria: {value}	string	Campo preenchido automaticamente com base no campo unidadeMedidaTributaria: {key}
pesoLiquido	number	Informar o peso liquido do produto em kg (Utilizar "." paras as casas decimais)
pesoBruto	number	Informar o peso bruto do produto em kg (Utilizar "." paras as casas decimais)
tipoEspecifico: {key}	integer	Informar o tipo de especificação do produto. O tipo de especificação pode ser consultado por meio da API: Tipo de Especificação do Produto
tipoEspecifico: {value}	string	Campo preenchido automaticamente com base no campo tipoEspecifico: {key}
valorTotalTributos	number	Informar o valor total de tributos do produto (Utilizar "." paras as casas decimais)
empresa: {id}	integer	Informar o Id da empresa na qual será cadastrado o produto
empresa: {cnpj}	string	Campo preenchido automaticamente com base no campo empresa: {id}
empresa: {razaoSocial}	string	Campo preenchido automaticamente com base no campo empresa: {id}
empresa: {nomeFantasia}	string	Campo preenchido automaticamente com base no campo empresa: {id}
ICMS ou ISSQN	string	É possível especificar a tributação que incidirá sobre o produto. Para materiais, utiliza-se o ICMS. Você pode conferir o preenchimento no tópico: ICMS. Para NFC-e com serviços, utiliza-se o ISSQN. Você pode conferir o preenchimento no tópico: ISSQN.
imagemBase64	string	Informar imagem convertida na Base64.
cfopPadraoNFCe	string	Informar o CFOP (Código Fiscal de Operações e Prestações) que será padrão para as emissões de NFC-e.

Name

Type

Description

integer

Este campo será preenchido automaticamente após a finalização do cadastro. É importante ter o ID sempre em mãos, pois o mesmo será requisitado no momento da emissão.

codigo

string

Informar o código do produto. Exemplo: "TESTE001"

description

string

Informar a descrição do produto. Exemplo; "Produto teste"

bloqueado

boolean

Informar se o produto está bloqueado ou não, da seguinte maneira: "true", para produto bloqueado/inativo. "false", para produto não bloqueado

tipoMaterial: {key}

integer

Informar o tipo de produto. O tipo de produto pode ser consultado por meio da API: Tipo de Material

tipoMaterial: {value}

string

Campo preenchido automaticamente com base no campo tipoMaterial: {key}

ncm

string

Informar o código NCM (Código da Nomenclatura Comum do Mercosul) do produto (Somente números)

cest

string

Informar o código CEST (Código Especificador da Substituição Tributária) do produto (Somente números)

ibpt

boolean

Informar se fará a utilização da tabela IBPT ou não, da seguinte maneira: "true", para utilizar "false", para não utilizar

origemMaterial: {key}

string

Informar a origem do material. A origem do material pode ser consultada por meio da API: Origem do Material

origemMaterial: {value}

string

Campo preenchido automaticamente com base no campo origemMaterial: key

percentualDeImpostos

string

Informar o percentual de impostos sobre o valor do produto

ean

string

Informar o Código GTIN (Global Trade Item Number), no formato GTIN-8, GTIN-12, GTIN-13 ou GTIN-14. Caso não possua, informar o literal "SEM GTIN".

eanTributario

string

Se o produto faturado for o mesmo que o produto tributável, informar o EAN tributário com o mesmo código informado no campo EAN. Caso não possua, informar o literal "SEM GTIN".

extensaoTabelaIPI

string

Informar a extensão do código NCM para produtos nos quais possuem alíquota de IPI diferenciada.

valorUnitarioComercial

number

Informar o valor unitário comercial do produto (Utilizar "." paras as casas decimais)

unidadeMedidaComercial: {key}

integer

Informar a unidade de medida comercial do produto. A unidade de medida comercial pode ser consultada por meio da API: Unidade de Medida

unidadeMedidaComercial: {value}

string

Campo preenchido automaticamente com base no campo unidadeMedidaComercial: {key}

valorUnitarioTributario

number

Informar o valor unitário tributário do produto (Utilizar "." paras as casas decimais)

unidadeMedidaTributaria: {key}

integer

Informar a unidade de medida tributária do produto. A unidade de medida tributária pode ser consultada por meio da API: Unidade de Medida

unidadeMedidaTributaria: {value}

string

Campo preenchido automaticamente com base no campo unidadeMedidaTributaria: {key}

pesoLiquido

number

Informar o peso liquido do produto em kg (Utilizar "." paras as casas decimais)

pesoBruto

number

Informar o peso bruto do produto em kg (Utilizar "." paras as casas decimais)

tipoEspecifico: {key}

integer

Informar o tipo de especificação do produto. O tipo de especificação pode ser consultado por meio da API: Tipo de Especificação do Produto

tipoEspecifico: {value}

string

Campo preenchido automaticamente com base no campo tipoEspecifico: {key}

valorTotalTributos

number

Informar o valor total de tributos do produto (Utilizar "." paras as casas decimais)

empresa: {id}

integer

Informar o Id da empresa na qual será cadastrado o produto

empresa: {cnpj}

string

Campo preenchido automaticamente com base no campo empresa: {id}

empresa: {razaoSocial}

string

Campo preenchido automaticamente com base no campo empresa: {id}

empresa: {nomeFantasia}

string

Campo preenchido automaticamente com base no campo empresa: {id}

ICMS ou ISSQN

string

É possível especificar a tributação que incidirá sobre o produto. Para materiais, utiliza-se o ICMS. Você pode conferir o preenchimento no tópico: ICMS. Para NFC-e com serviços, utiliza-se o ISSQN. Você pode conferir o preenchimento no tópico: ISSQN.

imagemBase64

string

Informar imagem convertida na Base64.

cfopPadraoNFCe

string

Informar o CFOP (Código Fiscal de Operações e Prestações) que será padrão para as emissões de NFC-e.

{
  "id": 1164,
  "codigo": "C_01",
  "description": "API PÃO DE FORMA",
  "bloqueado": false,
  "tipoMaterial": {
    "key": 1,
    "value": "string"
  },
  "ncm": "99999999",
  "cest": "9999999",
  "ibpt": true,
  "origemMaterial": {
    "key": 1,
    "value": "string"
  },
  "percentualDeImpostos": 0,
  "ean": "SEM GTIM",
  "eanTributario": "SEM GTIN",
  "codigoBeneficioFiscal": "",
  "extensaoTabelaIPI": "",
  "valorUnitarioComercial": 50,
  "unidadeMedidaComercial": {
    "key": 15,
    "value": "string"
  },
  "valorUnitarioTributario": 0,
  "unidadeMedidaTributaria": {
    "key": 25,
    "value": "string"
  },
  "pesoLiquido": 1,
  "pesoBruto": 15,
  "tipoEspecifico": {
    "key": 1,
    "value": "string"
  },
  "valorTotalTributos": 0,
  "empresa": {
    "id": 9424,
    "cnpj": null,
    "razaoSocial": null,
    "nomeFantasia": null
  },
  "icmS00": null,
  "icmS10": null,
  "icmS20": null,
  "icmS30": null,
  "icmS40_41_50": null,
  "icmS51": null,
  "icmS60": null,
  "icmS70": null,
  "icmS90": null,
  "icmssN101": null,
  "icmssN102": null,
  "icmssN201": null,
  "icmssN202": null,
  "icmssN500": null,
  "icmssN900": null,
  "issqn": null,
  "imagemBase64": null,
  "cfopPadraoNFCe": 0,
  "validationError": []
}

Swagger

Você poderá acessar esta API em nossa plataforma Swagger

Modelo de Envio 📝

{
  "codigo": "C_01",
  "description": "API PÃO DE FORMA",
  "bloqueado": false,
  "tipoMaterial": {
    "key": 1,
    "value": "string"
  },
  "ncm": "99999999",
  "cest": "9999999",
  "ibpt": true,
  "origemMaterial": {
    "key": 1,
    "value": "string"
  },
  "percentualDeImpostos": 0,
  "ean": "SEM GTIM",
  "eanTributario": "SEM GTIN",
  "codigoBeneficioFiscal": "",
  "extensaoTabelaIPI": "",
  "valorUnitarioComercial": 50,
  "unidadeMedidaComercial": {
    "key": 15,
    "value": "string"
  },
  "valorUnitarioTributario": 0,
  "unidadeMedidaTributaria": {
    "key": 25,
    "value": "string"
  },
  "pesoLiquido": 1,
  "pesoBruto": 15,
  "tipoEspecifico": {
    "key": 1,
    "value": "string"
  },
  "valorTotalTributos": 0,
  "empresa": {
    "id": 9424
  }
}

APIs Relacionadas 🎈

Referências à API 📌

Passo-a-Passo da NFC-e

PreviousProduto NextICMS

Last updated 3 years ago