Lista as compras da comunidade (Vendas)
GET/api/manage/purchases
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
F-55. Owner, admin, finance ou SuperAdmin, na comunidade do `X-CommunityId`. As compras (produto avulso, plano e adicional), da mais nova à mais antiga, com o comprador, o valor, a forma de pagamento, a taxa da plataforma, o líquido, o que já foi reembolsado (`refundedAmount`), o que ainda pode ser (`refundableAmount`), como se reembolsa (`refundMethod`) e o último reembolso (`lastRefund`). Nunca o custo do provedor.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
statusfacoltativo | query | COMPLETED | ACTIVE | REFUNDED | DISPUTED | PENDING | PROCESSING | FAILED | |
productIdfacoltativo | query | string (uuid) | |
paymentMethodfacoltativo | query | CREDIT_CARD | DEBIT_CARD | PIX | BOLETO | BANK_TRANSFER | WALLET_BALANCE | |
refundedfacoltativo | query | boolean | true: só as compras com algum reembolso |
situationfacoltativo | query | string | A situação da venda, um ou mais valores separados por vírgula (a paginação e o total contam só o que casa): `PAID` (paga, sem reembolso), `PROCESSING` (último reembolso em processamento), `AWAITING_BALANCE` (último reembolso aguardando saldo), `REFUNDED` (reembolsada por inteiro, ou `REFUNDED` sem reembolso registrado), `PARTIALLY_REFUNDED` (reembolsada em parte), `SETTLED_OUTSIDE` (boleto devolvido direto), `IN_REVIEW` (em revisão pela Memberfy), `DECLINED` (último reembolso recusado), `DISPUTED` (em chargeback, sem reembolso), `AWAITING_PAYMENT` (pagamento pendente) e `FAILED` (pagamento recusado). O "último reembolso" é o `lastRefund`. |
fromfacoltativo | query | string (date-time) | Data da compra a partir de |
tofacoltativo | query | string (date-time) | Data da compra até |
searchfacoltativo | query | string | Nome ou e-mail do comprador |
pagefacoltativo | query | integer | |
limitfacoltativo | query | integer |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Risposte
| Codice | Descrizione |
|---|---|
200 | Lista paginada. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/manage/purchases" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"