Get loyalty program configuration
Retrieves the shop's active loyalty campaign configuration: its tiers (ordered by starting points) and milestones (ordered by points needed). Returns NOT_FOUND when the shop has no active loyalty campaign.
Authorization
hmac Versioned HMAC-SHA256 signature authenticating server-to-server SDK requests (your backend calling Stash), as opposed to client-side SDK operations. Recommended over the deprecated X-Stash-Api-Key for the best security. Header format: v1;{appId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} using your app ingress secret (the ingress secret is shown base64-encoded in Studio; base64-decode it to the raw bytes used as the HMAC key), where {requestBody} is the compact canonical request JSON for POST requests and empty for GET requests. The timestamp must be within 5 minutes of Stash server time. Your appId is your immutable app identifier, shown in Stash Studio under Project Settings > App details; your ingress secret is under Project Settings > API Secrets.
In: header
Path Parameters
Shop identifier from Stash Studio
Response Body
application/json
application/json
curl -X GET "https://example.com/sdk/studio/string/loyalty"{ "activeCampaign": { "campaignId": "string", "tiers": [ { "tierId": "string", "name": "string", "startPoints": 0, "pointsPerDollar": 0, "pointsMultiplierPermille": 0, "iconUrl": "string", "milestones": [ { "milestoneId": "string", "name": "string", "pointsNeeded": 0, "rewards": [ { "itemId": "string", "quantity": 0, "type": "LOYALTY_REWARD_TYPE_UNSPECIFIED" } ] } ] } ] }}How is this guide?
Un-abort offers POST
Removes the aborts each entry names, so those offers show again on each player's next catalog read whenever your Get Catalog response returns them, with no catalog fetched again from your server. An entry removes exactly one abort: an identifier alone removes the abort without a version, and an identifier with a version removes the abort for that version, written as the abort lists it. Versions that another active abort of the same offer still covers stay hidden: removing the abort of 7 while an abort of 5 is active shows versions 6 and 7 again and keeps 5 and lower hidden. It also removes aborts made in Stash Studio. An entry that names no active abort changes nothing. At most 100 entries per call.
Get loyalty configuration GET
Retrieves the shop's loyalty configuration in the shape UpdateLoyaltyConfig accepts: display settings, bonus definitions, reward products with their status, and every campaign (season) with its status. Product rewards are returned by SKU. Use it to verify a sync. Returns NOT_FOUND when the shop has no loyalty program.