> ## Documentation Index > Fetch the complete documentation index at: https://developers.appstle.com/llms.txt > Use this file to discover all available pages before exploring further. # Redeem customer points for rewards ## OpenAPI ````yaml /loyalty/admin-api-swagger.json post /api/external/redeem-points openapi: 3.0.1 info: description: '' title: Admin APIs version: 0.0.1 servers: - url: https://loyalty-admin.appstle.com security: [] tags: - description: >- Admin APIs for enrolling customers into the loyalty program, retrieving customer loyalty details, and updating profile information such as birth date. name: Customer Enrollment & Profile - description: >- Admin APIs for managing customer point balances, transaction history, point earning rules, top customers leaderboard, and approving pending transactions. name: Points & Earn Rules - description: >- Admin APIs for redeeming customer points, managing redemption rules, and validating or updating discount codes generated through loyalty redemptions. name: Redemptions & Discount Codes - description: >- Admin APIs for retrieving storefront widget label translations consumed by the loyalty widget on the merchant's storefront. name: Storefront Widgets & Labels paths: /api/external/redeem-points: post: tags: - Redemptions & Discount Codes summary: Redeem customer points for rewards operationId: externalRedeemPoints parameters: - description: API key for authentication in: header name: X-API-Key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerLoyaltyRequestVM' required: true responses: '200': content: application/json: example: availablePoints: 150 creditedPoints: 500 currentVipTier: Gold customerStatus: ACTIVE pendingPoints: 0 rewards: - createAt: '2025-01-29T10:30:00Z' discountCode: LOYALTY15OFF discountType: PERCENTAGE discountValue: 15 expiryDate: '2025-06-30T23:59:59Z' id: 12346 pointsRedeemed: 100 status: UNUSED spentAmount: 1250.99 storeCreditBalance: 0 schema: $ref: '#/components/schemas/CustomerLoyaltyResponseVM' description: Points successfully redeemed and reward generated '400': content: application/json: schema: example: details: >- Customer has 50 points but needs 100 points for this redemption error: Insufficient points type: string description: Invalid request '401': content: application/json: schema: example: error: Invalid API key type: string description: Unauthorized - Invalid or missing X-API-Key security: - X-API-Key: [] components: schemas: CustomerLoyaltyRequestVM: description: >- Redemption request with customer ID/email, redeem rule ID, points to redeem example: customerId: 67890 points: 100 redeemRuleId: 5 variantId: 12345678 properties: customerEmail: description: > Customer's email address. Alternative to customerId for identifying the customer. Provide either customerId OR customerEmail, not both. Must be a valid email address that exists in your Shopify store. Example: customer@example.com example: customer@example.com nullable: true type: string customerId: description: > Shopify customer ID (numeric). Identifies which customer is redeeming points. Provide either customerId OR customerEmail, not both. Example: 67890 example: 67890 format: int64 nullable: true type: integer points: description: > Number of points to redeem. Must be positive. If not provided, uses the default points value from the redemption rule. Customer must have at least this many available points. Example: 100.0 example: 100 format: double nullable: true type: number redeemRuleId: description: > ID of the redemption rule to use. Determines what reward the customer receives. Use GET /api/external/point-redeem-rules to get available redemption options. Must be an active redemption rule configured in your loyalty program. Example: 5 example: 5 format: int64 type: integer variantId: description: > Shopify product variant ID. Required when redeeming for product-specific rewards (free product). Not required for discount codes or store credit rewards. Must be a valid variant ID from your Shopify catalog. Example: 12345678 example: 12345678 format: int64 nullable: true type: integer required: - redeemRuleId type: object CustomerLoyaltyResponseVM: properties: achievableTierId: format: int64 type: integer availablePoints: format: double type: number createAt: format: date-time type: string creditedPoints: format: double type: number currentVipTier: type: string customerStatus: enum: - ACTIVE - INACTIVE - EXCLUDED - EXCLUDED_BY_CUSTOMER type: string dob: format: date type: string expiringPointsAmount: format: double type: number pendingPoints: format: double type: number pointsExpireAt: format: date-time type: string referralLink: type: string referredCompleted: format: int64 type: integer rewardedForCreatingAccount: type: boolean rewardedForFacebook: type: boolean rewardedForInstagram: type: boolean rewardedForNewsLetter: type: boolean rewardedForPinterest: type: boolean rewardedForSharingOnFacebook: type: boolean rewardedForSharingOnX: type: boolean rewardedForSms: type: boolean rewardedForTiktok: type: boolean rewardedForTwitter: type: boolean rewardedForYoutube: type: boolean rewards: items: $ref: '#/components/schemas/CustomerReward' type: array spentAmount: format: double type: number storeCreditBalance: format: double type: number storeCreditCurrency: type: string vipTierExpiredAt: format: date-time type: string type: object CustomerReward: properties: amount: format: double type: number createAt: format: date-time type: string customerId: format: int64 type: integer description: type: string discountCode: type: string discountCodeId: type: string expireDate: format: date-time type: string id: format: int64 type: integer lastExpiryReminderSentDate: format: date-time type: string orderId: format: int64 type: integer orderName: type: string pointRedeemRuleId: format: int64 type: integer pointTransactionId: format: int64 type: integer productData: type: string rewardType: enum: - STORE_CREDIT - DISCOUNT_CODE - POINTS type: string shop: type: string status: enum: - USED - UNUSED - REFUNDED - EXPIRED - SUBSCRIPTION_ACTIVE - CANCELED type: string usageCount: format: int64 type: integer usedAt: format: date-time type: string variantId: format: int64 type: integer required: - createAt - customerId - discountCode - shop - status type: object ````