OPoptimove
Store

Store Item Catalog

Active store items for the brand. Each item grants rewardQuantity of rewardId in exchange for effectivePrice of priceCurrencyId.

Compare effectivePrice against the player's balance from GET /player-rewards/brand/{brandId}/player/{playerId} to decide whether the Buy button is enabled, and disable it outright when soldOut is true.

Only active items are returned; there is no client-side status filtering to do.

get/store/items/brand/{brandId}

Request

  • Base URL
    https://opti-ls-api-us.optimove.net/api
  • URL
    https://opti-ls-api-us.optimove.net/api/store/items/brand/{brandId}
  • Auth
    none declared

Path parameters

brandIdstring uuid required
Example:aebb6a6a-bdef-480f-8096-e13f9c3d4969

Brand UUID returned by GET /brands/default/{tenantId}.

Response

Array of active store items.

idstring uuid

UUID of the store item. Pass as itemId to the buy endpoint.

titlestring

Display name shown on the store card.

rewardIdstring uuid

Reward granted on purchase. Look up in the rewards catalog by matching against id.

rewardQuantityinteger

How much of the reward is granted.

priceCurrencyIdstring uuid

UUID of the currency the item is priced in. Match against the player's reward balances to check affordability.

priceAmountinteger

Configured list price. For what the player actually pays, use effectivePrice.

priceCurrencyNamestring

Denormalised currency name, so you can render the price without joining to the rewards catalog.

priceCurrencyIconstring nullable

URL to the currency icon. null if none configured.

basePriceinteger

Price before any discount. Render struck through when onSale is true.

effectivePriceinteger

Price the player pays. Compare against the player's balance to enable or disable the Buy button.

onSaleboolean

true when a discount is active. Drives the sale badge and the struck-through basePrice.

soldOutboolean

true when no stock remains. Disable the Buy button.

discountEndsAtstring date-time nullable

When the active discount ends, if scheduled. null for open-ended or no discount. Use to render a countdown.

categoryIdstring uuid

UUID of the category. Group cards by this.

categoryNamestring nullable

Display name of the category. null if not set.

tagIdstring uuid nullable

UUID of an optional merchandising tag (e.g. "New"). null if untagged.

tagNamestring nullable

Display text for the tag ribbon.

tagColorstring nullable

Hex color for the tag ribbon (e.g. #5d12ff). Validate it is a hex color before writing it into a style.

imagestring nullable

Item image, falling back to the granted reward's icon. Validate it is an https URL from a trusted host before using in src.

Changes

No recorded changes to this operation across all 1 revision of this API.