Skip to main content

Rewards Catalog API

note

Full API endpoint documentation will be sourced from the codebase. The table below reflects known endpoints.

Endpoints​

MethodPathDescription
GET/v1/rewardsList all active rewards available for the customer
GET/v1/rewards/:idGet details for a specific reward
POST/v1/rewards/:id/redeemRedeem a reward for the authenticated customer
GET/v1/customers/:id/reward_transactionsList all reward redemptions for a customer

Redemption Request​

POST /v1/rewards/:id/redeem
{
"customer_id": "cust_123",
"quantity": 1
}

Redemption Response​

On success, returns the redemption transaction including:

  • transaction_id β€” unique identifier for the redemption
  • code β€” the reward code assigned (if applicable)
  • points_spent β€” points deducted from the customer's balance
  • remaining_balance β€” customer's score_available after redemption