Saltar al contenido
memberfy
es-mx

Cria ou executa coupons

POST/api/coupons

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
codeobligatoriostringCoupon code is required
nameobligatoriostringName is required
descriptionopcionalstring
typeobligatorioPERCENTAGE | FIXED | FREE_TRIALInvalid coupon type
discountValueobligatorionumberDiscount value must be positive
maxDiscountopcionalnumber
trialExtensionDaysopcionalinteger
durationobligatorioONCE | FOREVER | REPEATINGInvalid duration
durationInMonthsopcionalinteger
maxUsesopcionalinteger
maxUsesPerUseropcionalinteger
startDateobligatoriostring (date-time)Valid start date required
endDateopcionalstring (date-time)
restrictionopcionalNONE | FIRST_PURCHASE | NEW_CUSTOMER
minPurchaseAmountopcionalnumber
applicableProductsopcional—[]
excludedProductsopcional—[]
applicableToOneTimeopcionalboolean
applicableToSubscriptionopcionalboolean
applicableToInstallmentopcionalboolean
isStackableopcionalboolean

Respuestas

CódigoDescripción
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.

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