Lista as compras da comunidade (Vendas)

GET/api/manage/purchases

Auth: Jeton requis
Clé d’API:: sales:read
X-CommunityId: X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.

Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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.

Paramètres

Nom	Emplacement	Type	Description
`status`facultatif	query	`COMPLETED \| ACTIVE \| REFUNDED \| DISPUTED \| PENDING \| PROCESSING \| FAILED`
`productId`facultatif	query	`string (uuid)`
`companyId`facultatif	query	`string (uuid)`	Só as compras da empresa; outra comunidade ou empresa inexistente devolve lista vazia
`paymentMethod`facultatif	query	`CREDIT_CARD \| DEBIT_CARD \| PIX \| BOLETO \| BANK_TRANSFER \| WALLET_BALANCE \| FREE`
`refunded`facultatif	query	`boolean`	true: só as compras com algum reembolso
`situation`facultatif	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`.
`from`facultatif	query	`string (date-time)`	Data da compra a partir de
`to`facultatif	query	`string (date-time)`	Data da compra até
`search`facultatif	query	`string`	Nome ou e-mail do comprador, ou nome da empresa
`page`facultatif	query	`integer`
`limit`facultatif	query	`integer`

En-têtes

Nom	Type	Description
`X-CommunityId`facultatif	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

Statut	Description
`200`	Lista paginada.
`400`	Requisição inválida — falha de validação.
`401`	Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
`403`	Autenticado, mas sem permissão para esta operação.
`500`	Erro interno do servidor.

Exemple curl

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