Consultar dados de um pedido
GET
/v1/orders/{order_id}
Consulta os detalhes de um pedido previamente criado para um merchant. Basta informar o ID do pedido na URL.
Veja a lista completa de status para entender
o campo status retornado.
Autorizações
bearerAuth
Token Bearer do merchant obtido via POST /oauth2/token usando as
credenciais do merchant (não do app). Veja
Autenticação.
Tipo
HTTP (bearer)
Parâmetros
Parâmetros de Caminho
order_id*
ID do pedido na Appmax.
Tipo
Obrigatóriointeger
Exemplo
3531Respostas
Detalhes do pedido retornados com sucesso.
application/json
JSON "data": { "order": { "id": 3531, "status": "estornado", "total_paid": 8916, "amounts": { "sub_total": 4662, "shipping_value": 2738, "discount": 0, "installment_fee": 1516 }, "created_at": "2025-02-13 14:09:48", "updated_at": "2025-02-13 14:11:55" }, "customer": { "id": 2023, "name": "Junior Almeida", "document_number": "19100000000" }, "payment": { "method": "creditcard", "installments": 12, "installments_amount": 743, "card": { "brand": "visa", "number": "400000****0010" }, "paid_at": "2025-02-13 14:10:20" }, "refund": { "refunded_at": "2025-02-13 14:11:55" } }
{
}
GET
/v1/orders/{order_id}