Skip to main content

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​

ParameterTypeRequiredDescription
storeIDstringYesUnique 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​

FieldTypeDescription
uidstringUnique identifier for the store
labelstringDisplay name of the store
descriptionstringDescription of the store
startDatestringISO 8601 timestamp of when the store opens
endDatestringISO 8601 timestamp of when the store closes
isActivebooleanWhether this store is currently active
imageNamestringURL to the store's icon/image
storeBundlesarrayBundles available in this store

Bundle Fields​

FieldTypeDescription
uidstringUnique identifier for the bundle
labelstringDisplay name of the bundle
costnumberCost to purchase the bundle
costLabelstringLabel for the cost currency
costDeliverableUIdstringUID of the deliverable used as currency
initialStocknumberInitial stock (0 = unlimited)
remainingStocknumberRemaining stock (0 = unlimited if initialStock is 0)
storeBundleContentsarrayItems 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​

CodeDescriptionResolution
4001Invalid AuthKeyVerify API key or store id
Related Endpoints