Store Details
Returns the full detail of a single reward store, including all of its bundles and the deliverables each bundle contains. Use this when you already have a store's uid (for example from Reward Stores) and need the complete configuration for that one store.
Endpoint
GET /v1/admin/stores/{storeID}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
storeID | string | Yes | Unique identifier (uid) of the store to retrieve |
Response
Success Response
{
"code": 200,
"data": [
{
"uid": "d54fab37809b4aaa97f6202b4e1bfb34",
"label": "Reward Store",
"description": "Reward Store",
"startDate": "2025-08-01T00:00:00",
"endDate": "2035-08-01T00:00:00",
"isActive": true,
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/e8be6912-d7da-4514-9810-6fedeafe7762_reward_store.png",
"storeBundles": [
{
"uid": "491789d530924cb4b1dcce791505ac53",
"label": "Football Jersey",
"description": "Football Jersey",
"cost": 50,
"costDeliverableUId": "b12a802d49584af89ef8a40be0b2c49e",
"costLabel": "Coins",
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/d74d40cf-58e4-498d-bfdd-6edc8a460683_jersey.png",
"costImageName": "https://rapidmulestorage.blob.core.windows.net/images/a8c7e227-8c01-49fd-bb19-e9a510c20e30_toggen.png",
"initialStock": 100,
"remainingStock": 100,
"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 | Bundles available 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/{{storeID}} \
-H "AuthKey: YOUR_API_KEY"
Use Cases
- Store Detail Page: Render a single store's full bundle catalog
- Bundle Affordability Check: Verify a player can afford a specific bundle before purchase
- Stock Validation: Read remaining stock right before a purchase
Error Codes
| Code | Description | Resolution |
|---|---|---|
| 4001 | Invalid AuthKey | Verify API key or store id |
Related Endpoints
- Reward Stores - List all stores and bundles
- Buy Store Bundle - Purchase a bundle from a store