1. Home
  2. Compras
  3. Endpoint: Editando produtos de um pedido

Endpoint: Editando produtos de um pedido

Endpoint que permite adicionar e mudar a quantidade de produtos em um pedido na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/comercial/pedido/{pedidoId}/produto

Método: PUT

Parâmetros

Headers

HeaderValor
Authorization<token_de_acesso>
Content-Typeapplication/json;charset=UTF-8

Path parameters

ParâmetroValor
pedidoIdId do pedido, deve ser passado na URL como parâmetro de path

Body Attributes

Campos principais

Nome AtributoTipoValor
ignorarFornecedorQtdMinBooleanSe true ignora a quantidade mínima do produto no pedido

Por padrão é false
ignorarFornecedorQtdMaxBooleanSe true ignora a quantidade máxima do produto no pedido

Por padrão é false
itensLista de Objeto ItemOs atributos relacionados a essa lista de objeto estão listados em uma tabela abaixo.

Requerido

Campos do Objeto Item

Nome AtributoTipoValor
produtoIdIntegerCódigo do produto
quantidadeIntegerQuantidades do produto

Exemplo

fetch("https://api.sults.com.br/api/v1/comercial/pedido/{produtoId}/produto",
{
	method: "PUT",
	headers: {
		"Authorization": "<token_de_acesso>"
	},
    body: {
		"ignorarFornecedorQtdMin": false,
		"ignorarFornecedorQtdMax": false,
		"itens": [
			{
				"produtoId": 1,
				"quantidade": 3
			}
		]
	}
})

Resposta

Após a operação ser concluída com sucesso, é retornado o status code 200, porém sem nenhuma informação extra. Caso algum erro aconteça com a operação, é retornado detalhes sobre o erro.

Atualizado em 06/08/2024