--- title: "GET /api/v4.0/integrations/configurations/redemption" method: GET path: "/api/v4.0/integrations/configurations/redemption" --- # GET /api/v4.0/integrations/configurations/redemption `GET /api/v4.0/integrations/configurations/redemption` This API retrieves the configurations and rules associated with how customers can redeem points for discounts, coupons, or other rewards. ## Query parameters - `customerId` string ## Response `200` Redemption configurations retrieved successfully - object - `redemptionFactor` number — This factor indicates the value of each loyalty point in terms of currency, defining how many currency units can be obtained by redeeming points. Example: If the redemptionFactor is set to 0.1, this means that a customer can redeem 10 points for 1 USD. - `redemptionRules` object[] — A list of redemption rules that define how points can be redeemed for discounts and coupons. Defines the rules for redeeming points, including points required, value of points, applicable coupons, and eligibility criteria. Example: a redemption rule may allow points to be redeemed for a free product, free shipping, percentage-based discounts, or fixed-amount discounts. - `id` number — The unique identifier for the redemption rule. - `pointsToRedeem` number — The specific number of points needed for redemption. If null, the rule applies to all points. - `valueOfPoint` number — The value of a single point in terms of monetary value for redemption. - `ruleType` string — The type of rule governing the redemption. Possible values include: free_shipping_settings, percentage_discount_settings, free_product_settings, fixed_rate_settings. - `coupon` object — Defines the coupon associated with the redemption rule, if applicable. - `couponType` string — The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom. - `discountValue` number — The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount. - `product` object — Product information for free product coupons. - `productId` string — The unique identifier for the product. - `productName` string — The name of the product. - `variantId` string — The unique identifier for the product variant. - `variantName` string — The name of the product variant. - `productDisplayName` string — The display name associated with the product that configured on the dashboard based on required language. - `collections` object[] — A list of collection IDs that the coupon can be applied to. - `collectionId` string — The unique identifier for the collection. - `collectionName` string — The name for the collection. - `group` object — Coupon group information. - `handle` string — A unique identifier used to reference the coupon group in the system (only appears in the dashboard). - `title` string — The title of the coupon group. - `url` string — The URL for the coupon group. - `iconPath` string — The path to the icon of the coupon group. - `description` string — A description of the coupon group. - `maxPerCustomer` number — The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times. - `startDate` string, date-time — The date when the coupons within this coupon group will become active and valid for redemption. - `expiryDate` string, date-time — The date when the coupons within this coupon group will expire and no longer be valid for redemption. - `isAvailable` boolean — Indicates whether the coupon group is currently available. - `isActive` boolean — Indicates whether the coupon group is currently active. - `options` object — Coupon options and settings. - `name` string — The name of the redemption rule configured on the dashboard based on required language. - `expiryAfter` number — The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount. - `usageLimit` number — The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid. - `capping` number — The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher. - `minOrderValue` number — The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount. - `codePrefix` string — The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is 'SUMMER', the generated coupon codes might look like 'SUMMER12345' or 'SUMMERDISCOUNT'. - `redeemInstructions` string — The instructions on how the customer can redeem the coupon. Example: 'Enter the coupon code at checkout to apply the discount.' - `image` string — A URL or file path for an image representing the redemption rule. - `creationDate` string, date-time — The date when the redemption rule was created. - `isActive` boolean — Indicates whether the redemption rule is currently active and can be used to generate new coupons or not. true → The rule is active, and new coupons can be created and redeemed. false → The rule is inactive, meaning no new coupons can be generated. However, previously created coupons will still be valid and can be redeemed. Example: If isActive is false, customers cannot create new coupons, but any coupons generated before the rule became inactive can still be used. --- [API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/versions/2e4a8bfe2291/schema)