Demander API - Order Status

This article is part of the REST Integration API documentation.

Documentation to consult, insert, update and delete order status.

Consultation

Lists the company’s order statuses. Without filter, considers dataAlteracao from the last 6 months.

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

Return:

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

Insert or update

POST upsert by key codigo.

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

Property	Type	Size	Mandatory	Description
code	int		✓	Status code. Unique identifier used to insert or update (upsert).
description	string	50	✓	Status name. Examples: Invoiced, Cancelled.
active	int			Values: `0` or `1`. Default on inclusion: `1`.
cancelaPedido	int			Values: `0` or `1`. When `1`, the order is canceled upon receiving this status. Default on inclusion: `0`.
consideraLimiteCredito	int			Values: `0` or `1`. When `1`, it considers the status in credit limit validation. Default on inclusion: `0`.
enviaPedidoRetorno	int			Values: `0` or `1`. Defines whether the order with this status should be resent to the ERP. Default on inclusion: `1`.
abateSaldoBonificacao	int			Values: `0` or `1`. Default on inclusion: `0`.

Body:

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

Return:

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

Delete

Removes order status.

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

Return:

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