curl -X POST \
  'https://{YOUR_PERSONALIZE_WEBSTORE_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "playerId": "vip2247691"
  }'

{
  "version": 2,
  "logo": "game_logo_main",
  "status": "valid",
  "sessionMetadata": {
    "abTestGroup": "variant_A",
    "locale": "en-US",
    "campaignId": "summer_2025"
  },
  "profileFrameId": "diamond_frame",
  "playerLevelName": "Diamond Tier",
  "bannerExternalId": "welcome_banner_01",
  "playerLevel": {
    "assetId": "level_diamond",
    "text": "15% OFF",
    "endsIn": 1735689600000
  },
  "playerLevelBanners": [
    {
      "assetId": "seasonal_banner",
      "designId": "banner_design_01",
      "text": [
        {
          "id": "title",
          "content": "Summer Sale"
        },
        {
          "id": "subtitle",
          "content": "Up to 50% off"
        }
      ],
      "endsIn": 1735689600000
    }
  ],
  "offersOrder": "priceLowToHigh",
  "sectionsOrder": [
    "featured",
    "daily_deals",
    "bundles"
  ],
  "segments": [
    "vip_players",
    "high_spenders",
    "active_users"
  ],
  "focus": {
    "publisherBundleId": "mega_bundle"
  },
  "attributes": {
    "player_tier": "diamond",
    "monetization_persona": "whale",
    "last_purchase_days": 3
  },
  "storeTheme": {
    "bgImageMobile": "mobile_bg_asset_123",
    "bgImageDesktop": "desktop_bg_asset_456"
  },
  "balances": [
    {
      "publisherProductId": "gold_coins",
      "quantity": 15420
    },
    {
      "publisherProductId": "gems",
      "quantity": 850
    },
    {
      "publisherProductId": "energy",
      "quantity": 95
    }
  ],
  "offers": [
    {
      "publisherOfferId": "starter_pack_01",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Perfect for new players"
      },
      "offerDescriptionOverride": "Everything you need to get started! A great value bundle with essential resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 999,
        "discount": 25,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 5000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_common",
                  "text": "Rarity: Common"
                },
                {
                  "assetId": "bonus_starter",
                  "text": "Starter Bonus: +50%"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 100,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 50,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "progress_bar_1",
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "500"
            }
          ]
        },
        {
          "index": 2,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "700"
            }
          ]
        },
        {
          "index": 3,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "800"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "weekend_special",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Limited time weekend deal"
      },
      "offerDescriptionOverride": "Don't miss out on this exclusive weekend offer with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 4999,
        "discount": 40,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 1200,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_rare",
                  "text": "Rarity: Rare"
                },
                {
                  "assetId": "bonus_weekend",
                  "text": "Weekend Bonus: +100%"
                },
                {
                  "assetId": "time_limited",
                  "text": "Time Limited"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 25000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 200,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "mega_bundle",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Best value for your money"
      },
      "offerDescriptionOverride": "Our most popular bundle! Get the best value with this mega pack of resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 9999,
        "discount": 50,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 100000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_epic",
                  "text": "Rarity: Epic"
                },
                {
                  "assetId": "bonus_mega",
                  "text": "Mega Bonus: +200%"
                },
                {
                  "assetId": "best_value",
                  "text": "Best Value"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 5000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 500,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "daily_deal_gems",
      "offerDescriptionOverride": "Today's special: Premium gems at a discount!",
      "priceDiscount": {
        "priceBeforeDiscount": 1999,
        "discount": 30,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Refreshes daily"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 500,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "daily_special",
                  "text": "Daily Special"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 10000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 75,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "energy_boost",
      "offerDescriptionOverride": "Need more energy? This pack will keep you going!",
      "priceDiscount": {
        "priceBeforeDiscount": 499,
        "discount": 20,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Energy pack"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "energy",
              "quantity": 150,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "instant_boost",
                  "text": "Instant Boost"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 2500,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "vip_exclusive",
      "offerDescriptionOverride": "Exclusive VIP bundle with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 19999,
        "discount": 35,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "VIP members only"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 15000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_legendary",
                  "text": "Rarity: Legendary"
                },
                {
                  "assetId": "vip_exclusive",
                  "text": "VIP Exclusive"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 250000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 1000,
              "priority": "Sub"
            }
          ]
        }
      ]
    }
  ]
}

Web Store Personalization

Personalize Web Store Callback

This is a callback API. Appcharge calls this endpoint on your server when specific events occur.

Notifies your system to personalize the web store for a player.

Appcharge calls this endpoint when:

A player logs in to your web store.
A player completes a purchase.
Every 5 minutes after the player’s last sync.

Your server responds with the most current player data and all available offers for the player. Appcharge then updates the web store for the player accordingly.

POST

{YOUR_PERSONALIZE_WEBSTORE_ENDPOINT}

curl -X POST \
  'https://{YOUR_PERSONALIZE_WEBSTORE_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "playerId": "vip2247691"
  }'

{
  "version": 2,
  "logo": "game_logo_main",
  "status": "valid",
  "sessionMetadata": {
    "abTestGroup": "variant_A",
    "locale": "en-US",
    "campaignId": "summer_2025"
  },
  "profileFrameId": "diamond_frame",
  "playerLevelName": "Diamond Tier",
  "bannerExternalId": "welcome_banner_01",
  "playerLevel": {
    "assetId": "level_diamond",
    "text": "15% OFF",
    "endsIn": 1735689600000
  },
  "playerLevelBanners": [
    {
      "assetId": "seasonal_banner",
      "designId": "banner_design_01",
      "text": [
        {
          "id": "title",
          "content": "Summer Sale"
        },
        {
          "id": "subtitle",
          "content": "Up to 50% off"
        }
      ],
      "endsIn": 1735689600000
    }
  ],
  "offersOrder": "priceLowToHigh",
  "sectionsOrder": [
    "featured",
    "daily_deals",
    "bundles"
  ],
  "segments": [
    "vip_players",
    "high_spenders",
    "active_users"
  ],
  "focus": {
    "publisherBundleId": "mega_bundle"
  },
  "attributes": {
    "player_tier": "diamond",
    "monetization_persona": "whale",
    "last_purchase_days": 3
  },
  "storeTheme": {
    "bgImageMobile": "mobile_bg_asset_123",
    "bgImageDesktop": "desktop_bg_asset_456"
  },
  "balances": [
    {
      "publisherProductId": "gold_coins",
      "quantity": 15420
    },
    {
      "publisherProductId": "gems",
      "quantity": 850
    },
    {
      "publisherProductId": "energy",
      "quantity": 95
    }
  ],
  "offers": [
    {
      "publisherOfferId": "starter_pack_01",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Perfect for new players"
      },
      "offerDescriptionOverride": "Everything you need to get started! A great value bundle with essential resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 999,
        "discount": 25,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 5000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_common",
                  "text": "Rarity: Common"
                },
                {
                  "assetId": "bonus_starter",
                  "text": "Starter Bonus: +50%"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 100,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 50,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "progress_bar_1",
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "500"
            }
          ]
        },
        {
          "index": 2,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "700"
            }
          ]
        },
        {
          "index": 3,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "800"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "weekend_special",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Limited time weekend deal"
      },
      "offerDescriptionOverride": "Don't miss out on this exclusive weekend offer with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 4999,
        "discount": 40,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 1200,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_rare",
                  "text": "Rarity: Rare"
                },
                {
                  "assetId": "bonus_weekend",
                  "text": "Weekend Bonus: +100%"
                },
                {
                  "assetId": "time_limited",
                  "text": "Time Limited"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 25000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 200,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "mega_bundle",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Best value for your money"
      },
      "offerDescriptionOverride": "Our most popular bundle! Get the best value with this mega pack of resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 9999,
        "discount": 50,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 100000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_epic",
                  "text": "Rarity: Epic"
                },
                {
                  "assetId": "bonus_mega",
                  "text": "Mega Bonus: +200%"
                },
                {
                  "assetId": "best_value",
                  "text": "Best Value"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 5000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 500,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "daily_deal_gems",
      "offerDescriptionOverride": "Today's special: Premium gems at a discount!",
      "priceDiscount": {
        "priceBeforeDiscount": 1999,
        "discount": 30,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Refreshes daily"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 500,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "daily_special",
                  "text": "Daily Special"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 10000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 75,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "energy_boost",
      "offerDescriptionOverride": "Need more energy? This pack will keep you going!",
      "priceDiscount": {
        "priceBeforeDiscount": 499,
        "discount": 20,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Energy pack"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "energy",
              "quantity": 150,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "instant_boost",
                  "text": "Instant Boost"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 2500,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "vip_exclusive",
      "offerDescriptionOverride": "Exclusive VIP bundle with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 19999,
        "discount": 35,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "VIP members only"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 15000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_legendary",
                  "text": "Rarity: Legendary"
                },
                {
                  "assetId": "vip_exclusive",
                  "text": "VIP Exclusive"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 250000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 1000,
              "priority": "Sub"
            }
          ]
        }
      ]
    }
  ]
}

curl -X POST \
  'https://{YOUR_PERSONALIZE_WEBSTORE_ENDPOINT}' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  -H 'signature: <signature>' \
  -d '{
    "playerId": "vip2247691"
  }'

{
  "version": 2,
  "logo": "game_logo_main",
  "status": "valid",
  "sessionMetadata": {
    "abTestGroup": "variant_A",
    "locale": "en-US",
    "campaignId": "summer_2025"
  },
  "profileFrameId": "diamond_frame",
  "playerLevelName": "Diamond Tier",
  "bannerExternalId": "welcome_banner_01",
  "playerLevel": {
    "assetId": "level_diamond",
    "text": "15% OFF",
    "endsIn": 1735689600000
  },
  "playerLevelBanners": [
    {
      "assetId": "seasonal_banner",
      "designId": "banner_design_01",
      "text": [
        {
          "id": "title",
          "content": "Summer Sale"
        },
        {
          "id": "subtitle",
          "content": "Up to 50% off"
        }
      ],
      "endsIn": 1735689600000
    }
  ],
  "offersOrder": "priceLowToHigh",
  "sectionsOrder": [
    "featured",
    "daily_deals",
    "bundles"
  ],
  "segments": [
    "vip_players",
    "high_spenders",
    "active_users"
  ],
  "focus": {
    "publisherBundleId": "mega_bundle"
  },
  "attributes": {
    "player_tier": "diamond",
    "monetization_persona": "whale",
    "last_purchase_days": 3
  },
  "storeTheme": {
    "bgImageMobile": "mobile_bg_asset_123",
    "bgImageDesktop": "desktop_bg_asset_456"
  },
  "balances": [
    {
      "publisherProductId": "gold_coins",
      "quantity": 15420
    },
    {
      "publisherProductId": "gems",
      "quantity": 850
    },
    {
      "publisherProductId": "energy",
      "quantity": 95
    }
  ],
  "offers": [
    {
      "publisherOfferId": "starter_pack_01",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Perfect for new players"
      },
      "offerDescriptionOverride": "Everything you need to get started! A great value bundle with essential resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 999,
        "discount": 25,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 5000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_common",
                  "text": "Rarity: Common"
                },
                {
                  "assetId": "bonus_starter",
                  "text": "Starter Bonus: +50%"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 100,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 50,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "progress_bar_1",
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "500"
            }
          ]
        },
        {
          "index": 2,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "700"
            }
          ]
        },
        {
          "index": 3,
          "products": [
            {
              "publisherProductId": "coins",
              "quantity": "800"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "weekend_special",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Limited time weekend deal"
      },
      "offerDescriptionOverride": "Don't miss out on this exclusive weekend offer with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 4999,
        "discount": 40,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 1200,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_rare",
                  "text": "Rarity: Rare"
                },
                {
                  "assetId": "bonus_weekend",
                  "text": "Weekend Bonus: +100%"
                },
                {
                  "assetId": "time_limited",
                  "text": "Time Limited"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 25000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 200,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "mega_bundle",
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Best value for your money"
      },
      "offerDescriptionOverride": "Our most popular bundle! Get the best value with this mega pack of resources.",
      "priceDiscount": {
        "priceBeforeDiscount": 9999,
        "discount": 50,
        "type": "percentage"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gold_coins",
              "quantity": 100000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_epic",
                  "text": "Rarity: Epic"
                },
                {
                  "assetId": "bonus_mega",
                  "text": "Mega Bonus: +200%"
                },
                {
                  "assetId": "best_value",
                  "text": "Best Value"
                }
              ]
            },
            {
              "publisherProductId": "gems",
              "quantity": 5000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 500,
              "priority": "Sub"
            }
          ],
          "progressBarPoints": [
            {
              "publisherBarId": "progress_bar_1",
              "points": 200
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "daily_deal_gems",
      "offerDescriptionOverride": "Today's special: Premium gems at a discount!",
      "priceDiscount": {
        "priceBeforeDiscount": 1999,
        "discount": 30,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Refreshes daily"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 500,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "daily_special",
                  "text": "Daily Special"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 10000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 75,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "energy_boost",
      "offerDescriptionOverride": "Need more energy? This pack will keep you going!",
      "priceDiscount": {
        "priceBeforeDiscount": 499,
        "discount": 20,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "Energy pack"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "energy",
              "quantity": 150,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "instant_boost",
                  "text": "Instant Boost"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 2500,
              "priority": "Sub"
            }
          ]
        }
      ]
    },
    {
      "publisherOfferId": "vip_exclusive",
      "offerDescriptionOverride": "Exclusive VIP bundle with premium rewards!",
      "priceDiscount": {
        "priceBeforeDiscount": 19999,
        "discount": 35,
        "type": "percentage"
      },
      "offerDesignOverride": {
        "offerDesignSubtitleTextOverride": "VIP members only"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "gems",
              "quantity": 15000,
              "priority": "Main",
              "traits": [
                {
                  "assetId": "rarity_legendary",
                  "text": "Rarity: Legendary"
                },
                {
                  "assetId": "vip_exclusive",
                  "text": "VIP Exclusive"
                }
              ]
            },
            {
              "publisherProductId": "gold_coins",
              "quantity": 250000,
              "priority": "Sub"
            },
            {
              "publisherProductId": "energy",
              "quantity": 1000,
              "priority": "Sub"
            }
          ]
        }
      ]
    }
  ]
}

Headers

x-publisher-token

string

Publisher token.

signature

string

The signed payload.

Body

application/json

playerId

string

Player ID (the same value as the publisherPlayerId property returned in the Authenticate Player Callback).

Response

200 - application/json

Successful operation

status

enum<string>

required

Web store personalization request status.

Available options:

valid,

invalid

Example:

"valid"

sessionMetadata

object

required

Container for storing any pertinent information related to the player's session. If enabled, this is sent back in the Grant Award Callback as well.

version

integer

The used version. In this case, the value is ‘2’

Example:

2

logo

string

Logo ID provided when a file is uploaded to the Assets Library. Use this to display a logo in your web store.

Example:

"MY_LOGO_ASSET_ID"

profileFrameId

string

Corresponds to the profile frame picture ID uploaded to the asset library in Appcharge's dashboard. Displayed above the player's profile picture.

Example:

"profileFrame123"

playerLevelName

string

Aligns with the player level picture name/ID uploaded to the asset library in Appcharge's dashboard. Displayed alongside the footer.

Example:

"playerLevelName"

bannerExternalId

string

Aligns with the banner asset ID uploaded to the asset library in Appcharge’s dashboard. Displayed at the top of the screen.

Example:

"playerLevelAssetId"

playerLevel

object

Presents discounts related to the player’s level.

Show child attributes

playerLevel.assetId

string

required

The ID of the asset relevant to the player’s level, uploaded to the asset library in Appcharge’s dashboard.

Example:

"playerLevel1"

playerLevel.text

string

Text to be displayed on top of the asset.

Example:

"10%"

playerLevel.endsIn

number

Epoch timestamp in milliseconds indicating when the level discount will end.

Example:

1728283121000

playerLevelBanners

object[]

List of banners to display to players based on their game level.

Show child attributes

playerLevelBanners.assetId

string

required

The banner ID in the Asset Library.

playerLevelBanners.designId

string

required

ID provided by Appcharge specifying the banner type and design.

playerLevelBanners.text

object[]

List of text objects for displaying the banner text.

Show child attributes

playerLevelBanners.text.id

string

The text ID that specifies the text’s placement in the banner.

playerLevelBanners.text.content

string

The text displayed in the banner.

playerLevelBanners.endsIn

number

Unix timestamp indicating when the banner expires. For example, 1720051200 represents July 4, 2024.

offersOrder

enum<string>

default:priceLowToHigh

Defines the order of offers.

Available options:

publisherOrder,

priceHighToLow,

priceLowToHigh

sectionsOrder

string[]

An array of publisher’s section ids that defines the order of sections for the store.

segments

string[]

The list of segments associated with the player.

focus

object

Customize which offer you want to focus on.

Show child attributes

focus.publisherBundleId

string

The id of the bundle to focus on in the web store.

Example:

"bundle123"

attributes

object

A set of custom key-value pairs that you can define to tag players for segmentation and A/B testing. These attributes can then be used to filter players in the Publisher Dashboard.

Example: { "BF_test": "test", "monetization_persona": "non_payer" }

storeTheme

object

Information about the web store theme.

Show child attributes

storeTheme.bgImageMobile

string

Name of the background image asset for mobile devices. This value overrides the background image set in the Publisher Dashboard and must match the name of an asset uploaded via the Dashboard or the Assets API.

Example:

"mobile_bg_asset_123"

storeTheme.bgImageDesktop

string

Name of the background image asset for desktop devices. This value overrides the background image set in the Publisher Dashboard and must match the name of an asset uploaded via the Dashboard or the Assets API.

Example:

"desktop_bg_asset_456"

Example:

{
  "bgImageMobile": "mobile_bg_asset_123",
  "bgImageDesktop": "desktop_bg_asset_456"
}

balances

object[]

A list of product balances of the player.

Show child attributes

balances.publisherProductId

string

required

The publisher's product id.

Example:

"product123"

balances.quantity

integer

required

The quantity of the product. Should be greater than or equal to 0 and less than or equal to 24 digits long.

Example:

5

offers

object[]

Show child attributes

offers.publisherOfferId

string

required

The publisher's offer id.

Example:

"offer123"

offers.productsSequence

object[]

required

The sequence of the products included in the offer. Rolling offers should be the same amount of sequences as the amount of sub offers configured in the Publisher Dashboard.

Show child attributes

offers.productsSequence.index

integer

required

The position of this offer or sub-offer within the parent offer. Each index should be a positive integer starting from 1.

Note: For the Progress Bar offer, this property defines the mission order.

Required range: x >= 1

offers.productsSequence.products

object[]

required

The products in a given offer.

Note: For the Progress Bar offer, this property defines the reward received when completing the given mission.

Show child attributes

offers.productsSequence.products.publisherProductId

string

required

The product Id.

Example:

"product123"

offers.productsSequence.products.quantity

integer

required

The quantity of the product. Should be minimum 0 and equal to or less than 24 digits long.

Example:

2

offers.productsSequence.products.priority

enum<string>

Specifies the display priority of a product within the offer.

Available options:

Main,

Sub

offers.productsSequence.products.traits

object[]

A list of visual or descriptive features associated with the product. Useful for distinguishing variants, bonuses, or unique characteristics of the product.

Show child attributes

offers.productsSequence.products.traits.assetId

string

required

The asset ID of the trait, located in the Asset Library.

Example:

"burn_damage_icon"

offers.productsSequence.products.traits.text

string

required

The label or descriptor associated with the trait.

Example:

"Burn Damage"

offers.productsSequence.products.rarityProductInfo

object

Details about the rarity of the product.

Show child attributes

offers.productsSequence.products.rarityProductInfo.stars

integer

The number of icons (stars) representing the rarity of the product. Displayed next to the product and inside the tooltip.

Example:

5

object[]
object

Show child attributes

The section representing each product type available in the tooltip.

Example:

"Special Offers"

Show child attributes

The publisher's product ID.

Example:

"Coin"

The text associated with the product.

Example:

"20%"

offers.productsSequence.productSale

object

Details on the product sale. This field is only relevant for Rolling Offers. To define a product sale for other offer types, refer to the corresponding 'productSale' field at the root level within 'offers'.

Show child attributes

offers.productsSequence.productSale.amountBeforeSale

integer

Offer amount in USD before sale is applied.

offers.productsSequence.productSale.sale

integer

Sale amount in percentage.

offers.productsSequence.productSale.type

integer

Will be 'percentage' by default. Optional values are 'percentage', 'multiplier', 'fixed_amount'.

offers.productsSequence.priceDiscount

object

Used to define the discount for the offer price. This is only relevant for Rolling Offers. To define a price discount for other offer types, refer to the corresponding 'priceDiscount' field at the root level within the 'offers' object.

Show child attributes

offers.productsSequence.priceDiscount.discount

integer

required

The discount percentage, min of 0

Example:

20

offers.productsSequence.priceDiscount.type

enum<string>

required

The type of discount, currently only "percentage" is supported.

Available options:

percentage

Example:

"percentage"

offers.productsSequence.priceDiscount.priceBeforeDiscount

integer

The original price of the offer before discount. Copied to FE without any logic on Appcharge’s side. The minimum should be 0.

Example:

100

offers.productsSequence.badges

object[]

A list of badges in the offer. If you do not want to have badges, then it should be sent as an empty array. This field is only relevant for Rolling Offers. To define badges for other offer types, refer to the 'badges' field at the root level within the 'offers' object.

Show child attributes

offers.productsSequence.badges.publisherBadgeId

string

required

The publisher's badge id.

Example:

"badge123"

offers.productsSequence.badges.position

enum<string>

required

This field is outdated. The position of the badge should be set from Dashboard only.

Available options:

right,

left,

center

Example:

"center"

offers.productsSequence.badges.ribbonTextOverride

string

A text that will override the ribbon's text provided in publisherBadgeId. Only relevant when the badge sent in publisherBadgeId is from type 'Ribbon'.

offers.productsSequence.progressBarPoints

object[]

The contribution of this offer toward the progress bar. A points ribbon is displayed with the number of points for offers that define this field.

Note: Currently you can only have 1 progress bar object.

Show child attributes

offers.productsSequence.progressBarPoints.publisherBarId

string

The publisher's external bar ID.

Example:

"progress-bar-1"

offers.productsSequence.progressBarPoints.points

integer

Number of points awarded toward the progress bar when this offer is purchased or claimed.

Example:

1000

offers.endsIn

number

Epoch timestamp in milliseconds indicating how much time remains on the countdown timer for the offer displayed in the web store, regardless of its schedule.

Example:

"1743077489"

offers.offerDescriptionOverride

string

The description that will be displayed instead of the current offer description in the store UI.

offers.offerDesignOverride

object

Show child attributes

offers.offerDesignOverride.offerDesignSubtitleTextOverride

string

The text that will be displayed instead of the current subtitle in the offer UI.

offers.offerDesignOverride.offerDesignId

string

This is the offerExternalUiId, which is used to override the offer UI for the store.

offers.offerDesignOverride.offerBackgroundImageOverride

string

Image URL used to override the current background image.

offers.productSale

object

Details on the product sale. This field is not applicable for Rolling Offers. To define a product sale for Rolling Offers, refer to the 'productSale' field within 'productsSequence'.

Show child attributes

offers.productSale.amountBeforeSale

integer

Offer amount in USD before sale is applied.

offers.productSale.sale

integer

Sale amount in percentage.

offers.productSale.type

integer

Will be 'percentage' by default. Optional values are 'percentage', 'multiplier', 'fixed_amount'.

offers.priceDiscount

object

Used to define the discount for the offer price. This field is not applicable for Rolling Offers. To define an offer discount for Rolling Offers, refer to the 'priceDiscount' field within 'productsSequence'.

Show child attributes

offers.priceDiscount.discount

integer

required

The discount percentage, min of 0

Example:

20

offers.priceDiscount.type

enum<string>

required

The type of discount, currently only "percentage" is supported.

Available options:

percentage

Example:

"percentage"

offers.priceDiscount.priceBeforeDiscount

integer

The original price of the offer before discount. Copied to FE without any logic on Appcharge’s side. The minimum should be 0.

Example:

100

offers.badges

object[]

A list of badges in the offer. If you do not want to have badges, then it should be sent as an empty array. This field is not applicable for Rolling Offers. To define badges for Rolling Offers, refer to the ‘badges’ field within ‘productsSequence’.

Show child attributes

offers.badges.publisherBadgeId

string

required

The publisher's badge id.

Example:

"badge123"

offers.badges.position

enum<string>

required

This field is outdated. The position of the badge should be set from Dashboard only.

Available options:

right,

left,

center

Example:

"center"

offers.badges.ribbonTextOverride

string

A text that will override the ribbon's text provided in publisherBadgeId. Only relevant when the badge sent in publisherBadgeId is from type 'Ribbon'.

offers.dynamicOfferUi

object

Details of the dynamic user interface for the offer. Deprecated

Show child attributes

offers.dynamicOfferUi.salePercentage

integer

required

Sale amount in percentage.

offers.dynamicOfferUi.badges

object[]

A list of badges in the offer.

Show child attributes

offers.dynamicOfferUi.badges.publisherBadgeId

string

required

The publisher's badge id.

Example:

"badge123"

offers.dynamicOfferUi.badges.position

enum<string>

required

This field is outdated. The position of the badge should be set from Dashboard only.

Available options:

right,

left,

center

Example:

"center"

offers.dynamicOfferUi.badges.ribbonTextOverride

string

A text that will override the ribbon's text provided in publisherBadgeId. Only relevant when the badge sent in publisherBadgeId is from type 'Ribbon'.

offers.dynamicOfferUi.amountBeforeSale

integer

Offer amount in USD before sale is applied.

offers.dynamicOfferUi.salePercentageDisplayType

string

Will be 'percentage' by default. Optional values are 'percentage', 'multiplier', 'fixed_amount'.

offers.dynamicOfferUi.offerDesignId

string

This is the offerExternalUiId, which is used to override the offer UI for the store.

Introduction Trigger Web Store Personalization

⌘I

Overview

What's New

Web Store

Checkout

Media

Events Center

Translations

Personalize Web Store Callback

Headers

Body

Response