Coupon Lifecycle

curl -X GET "https://api.zupy.com/api/v2/rewards/?customer_id=2awTHloSJX7kGGprFerOOsvABcd" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

curl -X POST "https://api.zupy.com/api/v2/customers/2awTHloSJX7kGGprFerOOsvABcd/rewards/2bxRKmpWJY8lHHqsGfsQQtwCDef/redeem/" \
  -H "X-API-Key: zupy_pk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"use_z_tokens": false}'

# All coupons for a customer
curl -X GET "https://api.zupy.com/api/v2/coupons/issued/?customer_id=2awTHloSJX7kGGprFerOOsvABcd" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

# Only active coupons
curl -X GET "https://api.zupy.com/api/v2/coupons/issued/?customer_id=2awTHloSJX7kGGprFerOOsvABcd&status=active" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

curl -X POST "https://api.zupy.com/api/v2/customers/2awTHloSJX7kGGprFerOOsvABcd/coupons/2cxSLnqYLZ0nJJsuIhuSSvyFGij/validate/" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

# Pass the CZ-code directly in the path — no GET needed.
curl -X POST "https://api.zupy.com/api/v2/customers/{customer_id}/coupons/CZ-914F15F3/validate/" \
  -H "X-API-Key: zupy_pk_..." \
  -H "X-OTP-Session: ..."

# Company-wide
curl -X GET "https://api.zupy.com/api/v2/coupons/issued/stats/" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

# Per reward
curl -X GET "https://api.zupy.com/api/v2/coupons/issued/stats/?reward_id=2cx...reward" \
  -H "X-API-Key: zupy_pk_your_api_key_here"

import requests

BASE_URL = "https://api.zupy.com/api/v2"
HEADERS = {"X-API-Key": "zupy_pk_your_api_key_here"}
customer_id = "2awTHloSJX7kGGprFerOOsvABcd"
customer_phone = "+5511987654321"

# ── Step 0 (when OTP is required): get a trusted session ──
requests.post(
    f"{BASE_URL}/auth/request-otp/",
    json={"identifier": customer_phone},
    headers=HEADERS,
)
# Customer receives a 6-digit code via WhatsApp. Collect it from them, then:
otp_code = input("OTP from customer: ")
verify = requests.post(
    f"{BASE_URL}/auth/verify-otp/",
    json={"identifier": customer_phone, "otp_code": otp_code},
    headers=HEADERS,
).json()["data"]
otp_session = verify["otp_session"]
AUTHED = {**HEADERS, "X-OTP-Session": otp_session}

# ── Step 1: Browse rewards the customer can afford ──
response = requests.get(
    f"{BASE_URL}/rewards/",
    params={"customer_id": customer_id, "redeemable": True},
    headers=HEADERS,
)
rewards = response.json()["data"]
print(f"Found {len(rewards)} redeemable rewards")

# ── Step 2: Redeem the first available reward ──
reward_id = rewards[0]["id"]
response = requests.post(
    f"{BASE_URL}/customers/{customer_id}/rewards/{reward_id}/redeem/",
    json={"use_z_tokens": False},
    headers=AUTHED,  # uses the OTP session
)
coupon = response.json()["data"]
print(f"Coupon created: {coupon['coupon_code']}, valid until {coupon['valid_until']}")
print(f"Customer balance: {coupon['new_balance']} pts, {coupon['new_z_balance']} Z$")

# ── Step 3: List active coupons (returns the KSUID 'id' field) ──
response = requests.get(
    f"{BASE_URL}/coupons/issued/",
    params={"customer_id": customer_id, "status": "active"},
    headers=HEADERS,
)
active_coupons = response.json()["data"]
print(f"{len(active_coupons)} active coupons")

# ── Step 4: Validate the coupon at the point of sale ──
# IMPORTANT: pass the KSUID 'id' field, NOT the CZ-XXX coupon_code.
coupon_ksuid = active_coupons[0]["id"]
response = requests.post(
    f"{BASE_URL}/customers/{customer_id}/coupons/{coupon_ksuid}/validate/",
    headers=AUTHED,
)
result = response.json()["data"]
print(f"Coupon {result['coupon_code']} used at {result['validated_at']}")
print(f"Remaining uses: {result['remaining_usages']} / {result['total_usages_allowed']}")