API de Demander: estado del pedido

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar el estado del pedido.

Consulta

Enumera los estados de los pedidos de la empresa. Sin filtro, considera dataAlteracao de los ú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"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	entero		✓	Código de estado. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	50	✓	Nombre del estado. Ejemplos: Facturado, Cancelado.
activo	entero			Valores: `0` o `1`. Valor predeterminado de inclusión: `1`.
cancelaPedido	entero			Valores: `0` o `1`. Cuando `1`, el pedido se cancela al recibir este estado. Valor predeterminado de inclusión: `0`.
consideraLimiteCredito	entero			Valores: `0` o `1`. Cuando `1`, considera el estado en validación de límite de crédito. Valor predeterminado de inclusión: `0`.
enviaPedidoRetorno	entero			Valores: `0` o `1`. Define si la orden con este estado debe reenviarse al ERP. Valor predeterminado de inclusión: `1`.
abateSaldoBonificacao	entero			Valores: `0` o `1`. Valor predeterminado de inclusión: `0`.

Cuerpo:

{
  "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"
}

Eliminar

Elimina el estado del pedido.

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

Retorno:

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