Vai al contenuto
memberfy
it-it

Cria ou executa coupons

POST/api/coupons

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia 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.

Header

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

Corpo della richiesta application/json

NomeTipoDescrizione
codeobbligatoriostringCoupon code is required
nameobbligatoriostringName is required
descriptionfacoltativostring
typeobbligatorioPERCENTAGE | FIXED | FREE_TRIALInvalid coupon type
discountValueobbligatorionumberDiscount value must be positive
maxDiscountfacoltativonumber
trialExtensionDaysfacoltativointeger
durationobbligatorioONCE | FOREVER | REPEATINGInvalid duration
durationInMonthsfacoltativointeger
maxUsesfacoltativointeger
maxUsesPerUserfacoltativointeger
startDateobbligatoriostring (date-time)Valid start date required
endDatefacoltativostring (date-time)
restrictionfacoltativoNONE | FIRST_PURCHASE | NEW_CUSTOMER
minPurchaseAmountfacoltativonumber
applicableProductsfacoltativo—[]
excludedProductsfacoltativo—[]
applicableToOneTimefacoltativoboolean
applicableToSubscriptionfacoltativoboolean
applicableToInstallmentfacoltativoboolean
isStackablefacoltativoboolean

Risposte

CodiceDescrizione
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Esempio con curl

curl -X POST "https://api.memberfy.net/api/coupons" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","name":"string","type":"PERCENTAGE","discountValue":10,"duration":"ONCE","startDate":"2026-01-01T12:00:00.000Z"}'