> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter a lista de pedidos da plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Retorna de forma paginada os pedidos de recarga da conta, adequado para localizar IDs de pedidos, visualizar o status de pagamento e realizar conciliação.

## Preparação

Crie um [Account Token](https://platform.acedata.cloud/documents/platform-token) e obtenha o UUID da conta atual em `GET /api/v1/platform-tokens/me/`.

```shell theme={null}
export PLATFORM_TOKEN='seu token de conta'
export USER_ID='seu UUID de conta'
```

## Visão geral da API

| Item | Conteúdo |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/orders/` |
| Autenticação | Account Token, o token OAuth requer `orders:read` |
| Paginação | `count` + `items` |

Usuários comuns devem passar seu próprio `user_id`; caso contrário, a paginação poderá retornar `403` ao encontrar objetos sem permissão.

## Parâmetros de consulta

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `user_id` | UUID | Obrigatório para usuários comuns | Conta à qual o pedido pertence; suporta parâmetros repetidos |
| `pay_way` | string | Não | Filtrar por método de pagamento; suporta valores repetidos ou separados por vírgulas |
| `state` | string | Não | Filtrar por status; suporta valores repetidos ou separados por vírgulas |
| `created_at_from/to` | datetime | Não | Intervalo de tempo de criação |
| `finished_at_from/to` | datetime | Não | Intervalo de tempo de conclusão |
| `limit` / `offset` | integer | Não | Paginação |
| `ordering` | string | Não | `created_at`, `-created_at`, `finished_at` ou `-finished_at` |

A lista atual não oferece suporte para filtragem por `application_id`, `service_id`, `package_id`, `payment_method` ou `tag`; o nome do campo de método de pagamento é `pay_way`.

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/orders/' \
  --data-urlencode "user_id=${USER_ID}" \
  --data-urlencode 'state=Paid,Finished' \
  --data-urlencode 'pay_way=Stripe' \
  --data-urlencode 'limit=100' \
  -H "Authorization: Bearer ${PLATFORM_TOKEN}"
```

## Descrição da resposta

A resposta é `{count, items}`. Os itens da lista online incluem `id`, `user_id`, `application_id/application_ids`, `package_id/package_ids`, `price`, `amount`, `discount`, `remaining_amount`, `state`, `pay_way`, `pay_id`, `pay_url`, `finished_at`, `expired_at`, `invoice`, `metadata` e campos de tempo.

* Os status reais são `Pending`, `Paid`, `Finished`, `Expired`, `Failed`, `Refunded`; não existe `Cancelled`.
* Os nomes dos campos são `pay_way`, `finished_at`, `discount` e `price`, e não `payment_method`, `paid_at`, `discount_rate` ou `final_price`.
* `price` é o preço final registrado do pedido; a moeda e os detalhes de liquidação podem estar em metadata controlada, não sendo possível inferi-los por conta própria apenas com base no método de pagamento.

## APIs relacionadas

* [Criar pedido de recarga](https://platform.acedata.cloud/documents/platform-order-create)
* [Obter detalhes do pedido](https://platform.acedata.cloud/documents/platform-order-detail)
* [Pagar pedido](https://platform.acedata.cloud/documents/platform-order-pay)
* [Atualizar status do pedido](https://platform.acedata.cloud/documents/platform-order-refresh)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.