Cria ou executa validate
POST/api/coupons/validate
- Auth
- Jeton requis
- Clé d’API:
- store:write
- X-CommunityId
X-CommunityIdEnvoyez 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.
Aberto a qualquer pessoa autenticada (é o caminho do comprador) e devolve só validade e desconto. A comunidade é a do `X-CommunityId`. Cupom excluído não é encontrado; `maxUses` conta também os pedidos com o cupom ainda em aberto; o limite por pessoa e a restrição de primeira compra valem para quem tem perfil na comunidade; `productId` de outra comunidade dá 404. Recusas trazem `errors[0].param = code`. Para não servir de oráculo de códigos, depois de 10 códigos recusados em 15 minutos (por conta e comunidade) a resposta é 429 até a janela passar, mesmo para um código bom. O mesmo contador vale para `couponCode` em `calculate-price` e `POST /checkout`.
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
codeobligatoire | string | Coupon code is required |
productIdfacultatif | string (uuid) | Valid product ID required |
amountobligatoire | number | Amount must be greater than 0 |
Réponses
| Statut | Description |
|---|---|
201 | Operação realizada com sucesso. |
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. |
404 | Recurso não encontrado. |
429 | Códigos de cupom recusados demais em pouco tempo. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/coupons/validate" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"code":"string","amount":10}'