Reward Stores

The "Reward Stores" method returns a comprehensive list of all your reward stores, including their available bundles and associated information. This allows you to retrieve all store data in a single, efficient request.

Endpoint

GET /v1/admin/stores

Response

{
"code": 200,
"data": [
  {
    "uid": "fa237349c9b84878946ce418a2d0447c",
    "label": "Premium Currency Store",
    "description": "Check out discounted prices for the Premium Currency bundles!",
    "startDate": "2024-03-22T00:00:00",
    "endDate": "2030-12-31T23:55:00",
    "isActive": true,
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/ad2c01ab-6987-4f41-8b62-8affa5a662c0_shop_3982744.png",
    "storeBundles": [
      {
        "uid": "f61008ac628649a4974ea3e3c2ba3cc6",
        "label": "Bronze Pack",
        "description": null,
        "cost": 10,
        "costDeliverableUId": "c41aeded06d04613ac567f05c63c4209",
        "costLabel": "Ruby",
        "imageName": "https://rapidmulestorage.blob.core.windows.net/images/d5bb6c57-53dd-49a3-baf8-1ba328a3c8b2_a2280ab9-1eec-4625-b97e-d0cbe960dbe0_coin.png",
        "costImageName": "https://rapidmulestorage.blob.core.windows.net/images/c44ea35a-cf57-4961-82c7-8f9f5f64d1bf_gem.png",
        "initialStock": 0,
        "remainingStock": 0,
        "storeBundleContents": [
          {

Response Fields

Field	Type	Description
uid	string	Unique identifier for the store
label	string	Display name of the store
description	string	Description of the store
startDate	string	ISO 8601 timestamp of when the store opens
endDate	string	ISO 8601 timestamp of when the store closes
isActive	boolean	Whether this store is currently active
imageName	string	URL to the store's icon/image
storeBundles	array	Available bundles in this store

Bundle Fields

Field	Type	Description
uid	string	Unique identifier for the bundle
label	string	Display name of the bundle
cost	number	Cost to purchase the bundle
costLabel	string	Label for the cost currency
costDeliverableUId	string	UID of the deliverable used as currency
initialStock	number	Initial stock (0 = unlimited)
remainingStock	number	Remaining stock (0 = unlimited if initialStock is 0)
storeBundleContents	array	Items included in the bundle

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/stores \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

• Store UI: Display all available stores and bundle offerings
• Bundle Affordability Check: Verify player can afford specific bundles
• Limited Stock Tracking: Monitor bundle inventory and availability

Error Codes

Code	Description	Resolution
1001	Payload is null	Check request parameters
4001	Invalid AuthKey	Verify API key

Related Endpoints

• Buy Store Bundle - Purchase a bundle from a store
• Player Detail - Check player's inventory