Loja
Pedidos
Crie e gerencie pedidos para seus clientes. Ao criar um pedido, uma fatura e um link de pagamento são gerados automaticamente. Os preços vêm diretamente do catálogo de produtos.
Listar pedidos
GET
/v1/orders
Parâmetros opcionais: status, payment_status, customer (UUID), search, limit, page
Status: pending, confirmed, processing, shipped, delivered, completed, canceled, refunded
Status do pagamento: pending, paid, partially_paid, refunded
Criar pedido
POST
/v1/orders
Corpo
{
"customer_id": "uuid-del-cliente",
"items": [
{ "product_id": "uuid-producto-1", "quantity": 2 },
{ "product_id": "uuid-producto-2", "quantity": 1 }
],
"notes": "Entregar antes de las 5pm",
"shipping_name": "Juan Pérez",
"shipping_phone": "+5215512345678",
"shipping_address": "Av. Reforma 123, CDMX"
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
customer_id | uuid | Sim | UUID do cliente |
items | array | Sim | Lista de produtos com product_id e quantity |
notes | string | Não | Notas visíveis para o cliente |
internal_notes | string | Não | Notas internas |
currency | string | Não | Moeda ISO 4217 |
shipping_name | string | Não | Nome do destinatário |
shipping_phone | string | Não | Telefone do destinatário |
shipping_address | string | Não | Endereço de entrega |
metadata | object | Não | Metadados personalizados |
Obter pedido
GET
/v1/orders/{'{id}'}
Inclui o cliente, os itens com produtos e a fatura associada.
Ciclo de vida do pedido
POST
/v1/orders/{'{id}'}/cancel
— Cancelar pedido (restaura o estoque)
POST
/v1/orders/{'{id}'}/ship
— Marcar como enviado
POST
/v1/orders/{'{id}'}/deliver
— Marcar como entregue
POST
/v1/orders/{'{id}'}/complete
— Marcar como concluído
Fluxo típico: pending → confirmed → shipped → delivered → completed
Itens do pedido
GET
/v1/orders/{'{id}'}/items
Retorna os itens do pedido com o detalhe de cada produto.
Esta página ajudou?
Obrigado por avisar.