API do Demander - Status de Pedido

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir status de pedido.

Consulta

Lista os status de pedido da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/status-de-pedido?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Retorno:

{
  "statusDePedido": [
    {
      "codigo": 5,
      "descricao": "FATURADO",
      "ativo": 1,
      "cancelaPedido": 0,
      "consideraLimiteCredito": 1,
      "enviaPedidoRetorno": 1,
      "abateSaldoBonificacao": 0,
      "dataAlteracao": "2026-07-27 10:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

Rota: {host}/public/v1/status-de-pedido
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	int		✓	Código do status. Identificador único usado para inserir ou atualizar (upsert).
descricao	string	50	✓	Nome do status. Exemplos: Faturado, Cancelado.
ativo	int			Valores: `0` ou `1`. Padrão na inclusão: `1`.
cancelaPedido	int			Valores: `0` ou `1`. Quando `1`, o pedido é cancelado ao receber este status. Padrão na inclusão: `0`.
consideraLimiteCredito	int			Valores: `0` ou `1`. Quando `1`, considera o status na validação de limite de crédito. Padrão na inclusão: `0`.
enviaPedidoRetorno	int			Valores: `0` ou `1`. Define se o pedido com este status deve ser reenviado ao ERP. Padrão na inclusão: `1`.
abateSaldoBonificacao	int			Valores: `0` ou `1`. Padrão na inclusão: `0`.

Body:

{
  "codigo": 5,
  "descricao": "FATURADO",
  "ativo": 1,
  "cancelaPedido": 0,
  "consideraLimiteCredito": 1,
  "enviaPedidoRetorno": 1,
  "abateSaldoBonificacao": 0
}

Retorno:

{
  "codigo": 5,
  "descricao": "FATURADO",
  "ativo": 1,
  "cancelaPedido": 0,
  "consideraLimiteCredito": 1,
  "enviaPedidoRetorno": 1,
  "abateSaldoBonificacao": 0,
  "dataAlteracao": "2026-07-27 10:00:00"
}

Excluir

Remove o status de pedido.

Rota: {host}/public/v1/status-de-pedido?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}