Zum Inhalt springen

Cria ou executa coupons

POST/api/coupons

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Header

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

Request-Body application/json

NameTypBeschreibung
codePflichtstringCoupon code is required
namePflichtstringName is required
descriptionoptionalstring
typePflichtPERCENTAGE | FIXED | FREE_TRIALInvalid coupon type
discountValuePflichtnumberDiscount value must be positive
maxDiscountoptionalnumber
trialExtensionDaysoptionalinteger
durationPflichtONCE | FOREVER | REPEATINGInvalid duration
durationInMonthsoptionalinteger
maxUsesoptionalinteger
maxUsesPerUseroptionalinteger
startDatePflichtstring (date-time)Valid start date required
endDateoptionalstring (date-time)
restrictionoptionalNONE | FIRST_PURCHASE | NEW_CUSTOMER
minPurchaseAmountoptionalnumber
applicableProductsoptional—[]
excludedProductsoptional—[]
applicableToOneTimeoptionalboolean
applicableToSubscriptionoptionalboolean
applicableToInstallmentoptionalboolean
isStackableoptionalboolean

Antworten

StatusBeschreibung
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.

curl-Beispiel

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"}'