Skip to main content
PATCH
Use este endpoint para alterar rapidamente o status de uma venda sem precisar enviar todos os dados.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Path Parameters

string
required
ID único da venda (UUID)

Headers

string
required
application/json
string
required
API key de autenticação

Body

string
required
Novo status da vendaValores aceitos:
  • PAGA - Venda paga
  • AGUARDANDO PAGAMENTO - Aguardando pagamento
  • CANCELADA - Venda cancelada
  • ENVIADA - Venda enviada
  • ENTREGUE - Venda entregue

Response

Sucesso

boolean
Indica se a operação foi bem-sucedida
object
Dados completos da venda com o status atualizado
string
Mensagem de confirmação com o novo status

Fluxo de Status

Fluxo típico de status de uma venda:
  1. PAGA → Status inicial padrão quando a venda é criada
  2. AGUARDANDO PAGAMENTO → Se o pagamento ainda não foi confirmado
  3. ENVIADA → Quando a mercadoria foi despachada
  4. ENTREGUE → Quando a mercadoria foi recebida pelo cliente
  5. CANCELADA → Se a venda foi cancelada por qualquer motivo
Você pode alterar de qualquer status para qualquer outro status.

Casos de Uso

Exemplos práticos:
  • Confirmar pagamento: Mudar de AGUARDANDO PAGAMENTO para PAGA
  • Despachar mercadoria: Mudar de PAGA para ENVIADA
  • Confirmar entrega: Mudar de ENVIADA para ENTREGUE
  • Cancelar venda: Mudar para CANCELADA de qualquer status
  • Reverter cancelamento: Mudar de CANCELADA para o status apropriado