Carrinhos abandonados da comunidade
GET/api/abandoned-carts
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- moderator
- finance
- Chiave API:
- sales:read
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Monetização › Vendas › Abandonados: quem abriu o checkout de um produto pago e não comprou em 60 minutos (`ABANDONED`), e quem pagou até 7 dias depois disso (`RECOVERED`), mais novo primeiro (`abandonedAt`). Cada item: o contato do membro (`member.name`, `member.email`, `member.phone` e `member.phoneCountry` quando o perfil tem), `product` (`id`, `title`, `billingInterval`), `plan` (`id`, `name`) quando o produto é opção de um plano, `amount` e `currency` (o preço quando o checkout foi aberto pela última vez), `paymentMethod` (o do último pedido, `null` se não chegou a escolher), `abandonedAt`, `recoveredAt` e `recoveredAmount` (quanto voltou), `emailSent` e `emailSentAt` (o e-mail de recuperação, ver `abandonedCartEmailEnabled` em `PUT /api/notification-settings`).
Filtros: `productId`, `planId`, `status` (`ABANDONED` ou `RECOVERED`; sem ele, os dois), `from`/`to` (período de `abandonedAt`, ISO 8601) e `search` (nome ou e-mail). Paginação `page`/`limit` (até 100). O carrinho é apagado 90 dias depois do abandono, e quando o membro sai ou é removido da comunidade.
Só owner, admin e finance da comunidade do `X-CommunityId`; moderador e membro recebem 403. Os carrinhos são sempre os dessa comunidade.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
productIdfacoltativo | query | string (uuid) | |
planIdfacoltativo | query | string (uuid) | |
statusfacoltativo | query | ABANDONED | RECOVERED | |
fromfacoltativo | query | string (date-time) | |
tofacoltativo | query | string (date-time) | |
searchfacoltativo | query | string | |
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 | Carrinhos e paginação. |
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. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/abandoned-carts" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"