DesenvolvedoresReferência da APIPedidos

Listar pedidos

GET
/orders

Pedidos da loja, do mais recente para o mais antigo, com filtros por status, forma de pagamento, cliente e período.

Chave: Só chave secreta (chamada pelo servidor).

Escopo: orders:read.

Autorização

chaveSecreta
headerAutorizaçãoBearer <chave de API>

Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.

Parâmetros de consulta

limit?integer

Itens por página (1 a 100).

Intervalo1 <= value <= 100
Padrão20
cursor?string

Valor de meta.pagination.nextCursor da página anterior.

Tamanholength <= 200
status?string
Value in"pending""paid""completed""cancelled""expired""refunded"
paymentStatus?string
Value in"pending""paid""partially_refunded""refunded""failed""cancelled""chargeback"
method?string
Value in"pix""boleto""card""nupay"
customerId?string
Formatouuid
q?string

Busca por número, e-mail ou nome.

Tamanholength <= 100
createdFrom?string
Formatodate-time
createdTo?string
Formatodate-time

Corpo da resposta

Sucesso.

application/json
  1. response
data*array<>
meta*
curl -X GET 'https://minepag.com.br/api/v1/orders'
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "number": -9007199254740991,      "externalId": "string",      "status": "pending",      "paymentStatus": "pending",      "source": "checkout",      "environment": "sandbox",      "currency": "BRL",      "subtotal": -9007199254740991,      "discountTotal": -9007199254740991,      "total": -9007199254740991,      "refundedTotal": -9007199254740991,      "customer": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "email": "string",        "name": "string"      },      "metadata": {        "property1": null,        "property2": null      },      "createdAt": "2019-08-24T14:15:22Z",      "paidAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "cancelledAt": "2019-08-24T14:15:22Z",      "refundedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "requestId": "string",    "pagination": {      "limit": -9007199254740991,      "hasMore": true,      "nextCursor": "string"    }  }}