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

Endpoint: Editando um pedido

Endpoint que permite cancelar ou trocar a situação de um pedido na plataforma da SULTS.

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

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
canceladoIntegerSe true cancela o pedido
Se false reativa o pedido cancelado
canceladoMotivoStringDescrição do motivo do cancelamento
situacaoIdInteger referente a um dos valores abaixo:

2 – Aguardando
3 – Faturado
4 – Enviado
5 – Entregue
Identificador da situação atual do pedido.

Exemplo

fetch("https://api.sults.com.br/api/v1/comercial/pedido/{pedidoId}",
{
	method: "PUT",
	headers: {
		"Authorization": "<token_de_acesso>"
	},
	body: {
		"cancelado": "true",
		"canceladoMotivo": "Motivo cancelamento",
		"situacaoId": 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 26/02/2024