Carregando...
 

API de Integração - Produtos

Produtos

Produtos disponíveis para movimentação.

Propriedades

DescriçãoTipo
idnumber
codigostring
descricaostring
descricaoLongastring
descricaoTecnicastring
destaquestring
especificacaostring
tipoDerivacaostring
derivacaostring
aplicacaostring
unidadestring
descricaoUnidade string
qtdDisponivelnumber(20,10
qtdFisicanumber(20,10
permitirEstoqueNegativostring
preconumber
precoPromocionalnumber(20,10)
dtInicialPrecoPromocionalstring
dtFinalPrecoPromocionalstring
unidadeSugestaoComercialstring
descricaoUnidadeSugestaoComercstring
fatorMultUnidadeSugestaoComercnumber
alturanumber
larguranumber
profundidadenumber
pesoBrutonumber
pesoLiquidonumber
idCategorianumber
codCategoriastring
descricaoCategoriastring
idFabricantenumber
codFabricantenumber
nomeFabricantestring
idGruponumber
codGruponumber
descricaoGrupostring
idGrupoEcom1number
codGrupoEcom1number
descricaoGrupoEcom1string
idGrupoEcom2number
codGrupoEcom2number
descricaoGrupoEcom2string
idGrupoEcom3number
codGrupoEcom3number
descricaoGrupoEcom3string
ncmstring
QtdMultiplaVendanumber
qtdMultiplaEstoquenumber
origemMercadoriaUltEntTribstring
qtdImagensnumber
publicadostring
dataModificacaodate

Endpoints

GET /api/produtos

Retorna uma lista de produtos

Parâmetros

NomeDescriçãoTipo
empresaCódigo da Empresanumber
codigo Código do Produtosstring
IdGrupo Id do Grupo de Produtosnumber
IdCategoria Id da Categoria de Produtosnumber
IdGrupoEcom1 Id do Grupo Ecom1 de Produtosnumber
IdGrupoEcom2 Id do Grupo Ecom2 de Produtosnumber
IdGrupoEcom3 Id do Grupo Ecom3 de Produtosnumber
modificadosApos Data de modificação do registro (formato ISO 8601 'YYYY-MM-DD"T"HH:MI:SS TZH:TZM'. Ex: "2022-01-01T12:00:00-03:00"). Retorna todos os registros com data/hora de alteração posterior ao parâmetrodate


Exemplo

curl --request GET \
     --url ${URL_BASE}/api/produtos \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK  

[{
	"descricaogrupoecom2": null,
	"qtddisponivel": 100,
	"descricaogrupoecom3": null,
	"descricaogrupoecom1": null,
	"idgrupoecom1": null,
	"descricaolonga": null,
	"especificacao": null,
	"qtdimagens": 1,
	"descricaotecnica": "<HEAD>\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\n<BODY>\n<P>Teste de Produtos e-comm</P>\n<P>Ainda mais uma linha para ver como fica.</P>\n<P>!!!!</P></BODY>",
	"tipoderivacao": null,
	"idgrupoecom3": null,
	"idgrupoecom2": null,
	"dtfinalprecopromocional": null,
	"preco": 77.9,
	"qtdmultiplavenda": 10,
	"pesobruto": 0.0,
	"precopromocional": null,
	"ncm": "11223344",
	"codcategoria": "1",
	"datamodificacao": "2021-04-08T03:59:53-03:00",
	"id": 22,
	"qtdmultiplaestoque": null,
	"codgrupo": 1,
	"idgrupo": 1,
	"publicado": "S",
	"descricaocategoria": "Categoria 1",
	"qtdfisica": 100,
	"codigo": "10",
	"largura": 0.0,
	"pesoliquido": 0.0,
	"permitirestoquenegativo": "N",
	"idcategoria": 1,
	"origemmercadoriaultenttrib": null,
	"profundidade": 0.0,
	"nomefabricante": null,
	"descricao": "Cuia Campeira Couro com Bocal Inox 3521",
	"descricaogrupo": "Cuias",
	"altura": 0.0,
	"idfabricante": null,
	"dtinicialprecopromocional": null,
	"destaque": "N",
	"codfabricante": null,
	"codgrupoecom2": null,
	"codgrupoecom1": null,
	"codgrupoecom3": null,
	"derivacao": null
}, {
	"descricaogrupoecom2": null,
	"qtddisponivel": 0,
	"descricaogrupoecom3": null,
	"descricaogrupoecom1": null,
	"idgrupoecom1": null,
	"descricaolonga": "Cuia Artesanal Trabalhada DL",
	"especificacao": null,
	"qtdimagens": 1,
	"descricaotecnica": "<HEAD>\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\n<BODY>Cuia Artesanal Trabalhada DL DT 3</BODY>",
	"tipoderivacao": null,
	"idgrupoecom3": null,
	"idgrupoecom2": null,
	"dtfinalprecopromocional": null,
	"preco": 79.0,
	"qtdmultiplavenda": null,
	"pesobruto": 0.0,
	"precopromocional": null,
	"ncm": "11223344",
	"codcategoria": "2",
	"datamodificacao": "2021-04-08T03:59:53-03:00",
	"id": 30,
	"qtdmultiplaestoque": null,
	"codgrupo": 1,
	"idgrupo": 1,
	"publicado": "S",
	"descricaocategoria": "Categoria 2",
	"qtdfisica": 0,
	"codigo": "14",
	"largura": 0.0,
	"pesoliquido": 0.0,
	"permitirestoquenegativo": "N",
	"idcategoria": 2,
	"origemmercadoriaultenttrib": null,
	"profundidade": 0.0,
	"nomefabricante": null,
	"descricao": "Cuia Artesanal Trabalhada",
	"descricaogrupo": "Cuias",
	"altura": 0.0,
	"idfabricante": null,
	"dtinicialprecopromocional": null,
	"destaque": "N",
	"codfabricante": null,
	"codgrupoecom2": null,
	"codgrupoecom1": null,
	"codgrupoecom3": null,
	"derivacao": null
}]


GET /api/produtos/{id}

Retorna o produto conforme id solicitado

Exemplo

curl --request GET \
     --url ${URL_BASE}/api/produtos/22 \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK  

{
	"descricaogrupoecom2": null,
	"qtddisponivel": 100,
	"descricaogrupoecom3": null,
	"descricaogrupoecom1": null,
	"idgrupoecom1": null,
	"descricaolonga": null,
	"especificacao": null,
	"qtdimagens": 1,
	"descricaotecnica": "<HEAD>\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\n<BODY>\n<P>Teste de Produtos e-comm</P>\n<P>Ainda mais uma linha para ver como fica.</P>\n<P>!!!!</P></BODY>",
	"tipoderivacao": null,
	"idgrupoecom3": null,
	"idgrupoecom2": null,
	"dtfinalprecopromocional": null,
	"preco": 77.9,
	"qtdmultiplavenda": 10,
	"pesobruto": 0.0,
	"precopromocional": null,
	"ncm": "11223344",
	"codcategoria": "1",
	"datamodificacao": "2021-04-08T03:59:53-03:00",
	"id": 22,
	"qtdmultiplaestoque": null,
	"codgrupo": 1,
	"idgrupo": 1,
	"publicado": "S",
	"descricaocategoria": "Categoria 1",
	"qtdfisica": 100,
	"codigo": "10",
	"largura": 0.0,
	"pesoliquido": 0.0,
	"permitirestoquenegativo": "N",
	"idcategoria": 1,
	"origemmercadoriaultenttrib": null,
	"profundidade": 0.0,
	"nomefabricante": null,
	"descricao": "Cuia Campeira Couro com Bocal Inox 3521",
	"descricaogrupo": "Cuias",
	"altura": 0.0,
	"idfabricante": null,
	"dtinicialprecopromocional": null,
	"destaque": "N",
	"codfabricante": null,
	"codgrupoecom2": null,
	"codgrupoecom1": null,
	"codgrupoecom3": null,
	"derivacao": null
}


POST /api/produtos

Inserir/cadastrar produto(s)

Propriedades

DescriçãoTipo
empresaCódigo da empresanumber
produtos.codigoCódigo do produtostring
produtos.descricaoDescrição do produtostring
produtos.unmedUnidade do produtostring
produtos.prodservClassificação do item como "Produto" ou "Serviço"string
produtos.grupoGrupo do produtonumber
produtos.catprodutoCategoria do produtostring
produtos.cod_pdmCódigo do padrão descritivo do produtonumber
produtos.cod_grp_lib_acessoCódigo do grupo de liberação de acesso para os usuáriosnumber
produtos.cod_grupo_ncmCódigo do produto de acordo com NCMnumber
produtos.cod_nbsCódigo do serviço de acordo com o NBSstring
produtos.produtos_compos.cod_subprodutoCódigo do materialstring
produtos.produtos_compos.quantidadeQuantidade necessária para realizar 1 unidade do produto produzidonumber(20,10)
produtos.produtos_compos.sequenciaSequência do materialnumber


Exemplo

curl --request POST \
     --url ${URL_BASE}/api/produtos \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK  

{"empresa":4,
 "produtos":[{"codigo":"000",
              "descricao":"ZZZZ",
              "unmed":"PC",
              "prodserv":"P",
              "grupo":98,
              "catproduto":"1",
              "cod_pdm":1
              "cod_grp_lib_acesso":1,
              "cod_grupo_ncm":9974,
              "cod_nbs":1,
              "produtos_compos":
                        [{"cod_subproduto":"200011",
                          "quantidade":3.5,
                          "sequencia":10
                        }]
            }]
}



POST /api/engenharia_produto/produzido

Retorna a estrutura do produto produzido


Propriedades

DescriçãoTipo
empresaCódigo da empresanumber
cod_produtoCódigo do produtostring


Exemplo

curl --request POST \
     --url ${URL_BASE}/api/engenharia_produto/materiais \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK

{"empresa":99,
 "codigo":"9999"
}



POST /api/engenharia_produto/materiais

Retorna os materiais/produtos.

Propriedades

DescriçãoTipo
empresaCódigo da empresanumber
cod_produtoCódigo do produtostring
cod_editadoCódigo editado do produtostring
descr_produtoDescrição do produtostring
grupoCódido do grupo do produtostring
categoria_produtoCódigo da categoria do produtostring
cod_origemCódigo da origem do produtostring


Exemplo

curl --request POST \
     --url ${URL_BASE}/api/engenharia_produto/materiais \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK  

{"empresa":99,
 "cod_produto":"9999",
 "cod_editado":"9999",
 "descr_produto":"ZZZZZ",
 "grupo":99,
 "categoria_produto":"999",
 "cod_origem":"999"
}