Articles on: Public API

Points Redemptions

List all points redemptions


GET /rest-api/v1/pointsRedemptions


Body


Name

Type

Description

customerIdentifier

string

Shopify customer ID or email


Response


{
success: boolean
message: string
pointsRedemptions: Array<{
_id: string
name: string
status: boolean
type: "amount" | "percentage" | "shipping" | "free_product" | "store_credit"
rewardValue: number
discountValue: number
purchaseType: "one_time" | "subscription" | "both"
applyProductOption: "all" | "specific_products" | "specific_collections"
applyCollections: Array<string>
applyVariants: Array<{ id: string, variants: Array<{ id: string }> }>
minimumRequirementType: "none"
combinations: []
expireDateType: "none" | "period"
createdAt: string
updatedAt: string
redeemable: boolean
discountPrefix: string
}>
}


Redeem a reward for points


POST /rest-api/v1/pointsRedemptions


Body


Name

Type

Description

customerIdentifier

string

Shopify customer ID or email

pointsAmount

int

Number of points to redeem

rewardId

string

ID for the reward the customer will be redeeming


Response


{
success: boolean
message: string
discountCode: string
}



Updated on: 25/11/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!