Saltar al contenido

Lista as compras da comunidade (Vendas)

GET/api/manage/purchases

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
statusopcionalqueryCOMPLETED | ACTIVE | REFUNDED | DISPUTED | PENDING | PROCESSING | FAILED
productIdopcionalquerystring (uuid)
paymentMethodopcionalqueryCREDIT_CARD | DEBIT_CARD | PIX | BOLETO | BANK_TRANSFER | WALLET_BALANCE
refundedopcionalquerybooleantrue: só as compras com algum reembolso
situationopcionalquerystringA 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`.
fromopcionalquerystring (date-time)Data da compra a partir de
toopcionalquerystring (date-time)Data da compra até
searchopcionalquerystringNome ou e-mail do comprador
pageopcionalqueryinteger
limitopcionalqueryinteger

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

CódigoDescripción
200Lista paginada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/manage/purchases" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"