Documentação API (Forç... » Itens do pedido (Não u...
Export

Itens do pedido (Não usado | Está no Pedido)

Este artigo documenta o processo de itens de um pedido de venda.

Observação: Será analisado em utilizar somente a documentação do pedidos afim de que sempre que um pedido for editado, será enviado o pedido e os itens para o backend.

Consultar item

Consulta item do pedido pelo código

Requisição
Método GET
URL /api/v1/pedidos_venda/{id}/itens/{item}
Formato do conteúdo application/json
Exemplo de uso
/api/v1/pedidos_venda/123456/itens/1
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Código identificador
produto Object      
produto.id Integer - Sim Código identificador
produto.nome String 100 Sim Nome do produto
quantidade Double - Sim Quantidade do item
desconto Double - Não Valor de desconto
comissao Double - Não Valor da comissão
tabela Double - Não Tabela
unitario Double - Não Valor unitário
total Double - Não Valor total
ipiAliquota Double - Não Valor da alíquota
ipiBase Double - Não Valor IPI base
ipiValor Double - Não Valor do IPI
Ipioutras Double - Não Valor de outros encargos do IPI
ipiCst String 2 Não  
stIndicacao Integer - Não

Teve indicação

SIM

NAO
stBase Double - Não  
stIcms Double - Não  
stMva Double - Não  
stIcmsUf Double - Não Valor ICMS do estado
stRbc Double - Não  
cfop String 10 Não  
descritivo String 10000 Não  
valorJuros Double - Não Valor do juros
identificadorSuperior Integer - Não  
identificadorPai Integer - Não  
acessorioSuperior Integer - Não Acessório superior 
classificacaoItemPrincipal Integer - Não Item principal
produtoSubstituto Integer - Não Produto substituto
multiplosProdutos Integer - Não

Múltiplos produtos

SIM

NAO 
valorFrete Double - Não Valor do frete
percentualFrete Double - Não Percentual do frete

Exemplo de resposta

{
	"id": 23,
	"produto": {
		"id": 78,
		"nome": "banana"
	},
	"quantidade": 56.00,
	"desconto": 56.99,
	"comissao": 89.88,
	"tabela": 89.99,
	"unitario": 88.88,
	"total": 69.99,
	"ipiAliquota": 56.77,
	"ipiBase": 56.77,
	"ipiValor": 78.44,
	"Ipioutras": 89.00,
	"ipiCst": "50",
	"stIndicacao": "SIM",
	"stBase": 78.32,
	"stIcms": 89.78,
	"stMva": 10.00,
	"stIcmsUf": 32.99,
	"stRbc": 10.00,
	"cfop": "jhdsgbhsdb",
	"descritivo": "",
	"valorJuros": 89.98,
	"identificadorSuperior": 2,
	"identificadorPai": 1,
	"acessorioSuperior": 3,
	"classificacaoItemPrincipal": 1,
	"produtoSubstituto": 23,
	"multiplosProdutos": "NAO",
	"valorFrete": 23.65,
	"percentualFrete": 78.22
}

Inserir item

Insere um item novo na base de dados.

Requisição  
Método POST
URL /api/v1/pedidos_venda/{id}/itens

Formato do conteúdo

 application/json
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
item Integer - Sim Número do item
produto Object - Sim Produto
produto.id Integer - Sim Identificador do produto
quantidade Double - Sim Quantidade do item
desconto Double - Não Valor de desconto
comissao Double - Não Valor da comissão
tabela Double - Não Tabela
unitario Double - Não Valor unitário
total Double - Não Valor total
stIcms Double - Não  
valorFrete Double - Não Valor do frete
percentualFrete Double - Não Percentual do frete
observacao String 1000 Não  
valorJuros Double - Não Valor do juros

Exemplo de conteúdo da requisição

{
	"item": 1,
	"produto": {
		"id": 78
	},
	"quantidade": 56.00,
	"desconto": 56.99,
	"comissao": 89.88,
	"tabela": 89.99,
	"unitario": 88.88,
	"total": 69.99,
	"stIcms": 89.78,
	"valorFrete": 23.65,
	"percentualFrete": 78.22,
  	"observacao": "",
  	"valorJuros": 43.33
}

Resposta

A API retornará o código do novo item cadastrado.

Estrutura de dados do resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
id Integer - Sim Código identificador do item

Exemplo de resposta

{
  "id": 123456
}

Editar item

Atualiza um item do pedido na base de dados.

Requisição  
Método PUT
URL /api/v1/pedidos_venda/{id}/itens/{item}
Formato do conteúdo application/json
Parâmetro de URL  
id Número do pedido
item Número do item
Exemplo de uso
/api/v1/pedidos_venda/123456/itens/1
Estrutura de dados da resposta
 		       
Propriedade Tipo Tamanho Obrigatório Descrição
produto Object      
produto.id Integer - Sim Código identificador
quantidade Double - Sim Quantidade do item
desconto Double - Não Valor de desconto
comissao Double - Não Valor da comissão
tabela Double - Não Tabela
unitario Double - Não Valor unitário
total Double - Não Valor total
stIcms Double - Não  
valorFrete Double - Não Valor do frete
percentualFrete Double - Não Percentual do frete
valorJuros Double - Não Valor do juros

Exemplo de conteúdo da requisição

{
	"produto": {
		"id": 78
	},
	"quantidade": 56.00,
	"desconto": 56.99,
	"comissao": 89.88,
	"tabela": 89.99,
	"unitario": 88.88,
	"total": 69.99,
	"stIcms": 89.78,
	"valorFrete": 23.65,
	"percentualFrete": 78.22,
  	"valorJuros": 43.56
}

Deletar item

Exclui um item

Requisição  
Método DELETE
URL /api/v1/pedidos_venda/{id}/itens/{item}
Parâmetro de URL  
id Número do pedido
item Número do ítem
Exemplo de uso
/api/v1/pedidos_venda/123456/itens/1
Back to top
Itens do pedido (Não u... | Documentação

An Error Occurred

An unknown error occurred

Return to home

Back to top