Sign in
Stores

Get Store Items

get/v1/store_items/{store_id}

Path parameters

store_idstring required

Response

Successful Response

discount_percentinteger nullable
bonus_percentinteger nullable
bonus_fixedinteger nullable

The user will receive a fixed quantity of the item.

positioninteger required
namestring nullable
descriptionstring nullable
image_urlstring uri nullable
max_purchasesinteger nullable

The maximum number of purchases allowed for the item per user.

global_max_purchasesinteger nullable

The maximum number of purchases allowed for the item across all users.

custom_badgestring nullable

The custom badge of the item

campaign_idstring nullable
user_campaign_idstring nullable
bond_user_idstring nullable
start_atinteger nullable
end_atinteger nullable
min_amountinteger nullable
max_reward_points_percentinteger nullable
reward_points_percentnumber nullable

Percentage of reward points for the item.

reward_points_fixedinteger nullable

Fixed reward points for the item.

loyalty_points_percentinteger nullable

Percentage of loyalty points for the item.

loyalty_points_fixedinteger nullable

Fixed loyalty points for the item.

is_free_itemboolean
rotation_weightinteger nullable
max_purchases_period_type'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second'
max_purchases_period_valueinteger nullable
max_purchases_limit_type'global' | 'personal'
show_disabled_by_max_purchasesboolean nullable

Whether to show the item as disabled when max purchases limit is reached.

requirements_mismatch_behavior'hide_from_store' | 'disable' | 'disable_and_show_description'
card_type'default' | 'featured'
show_first_on_category_listboolean nullable

Whether to show the item first on the category list

bonus_item_idstring nullable

The ID of the bonus item that will be given to the user when they purchase this item.

bonus_item_quantityinteger nullable

The fixed quantity of the bonus item

bonus_item_percentinteger nullable

The user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.

bonus_badgestring nullable

Custom text for bonus badge

priceinteger nullable

The price of the item in minor currency units. The system will automatically adjust this to the closest available price point. If you want to set a specific price point, use price_template_id instead.

price_pointinteger nullable

The price point

price_template_idstring nullable

The ID of the price template

quantityinteger nullable

The quantity of the item

item_idstring required
idstring required
created_atnumber required
store_idstring required
created_from_campaign_node_idstring nullable
created_from_campaign_versionstring nullable
disabledboolean
purchases_leftinteger
next_purchase_atnumber
next_reset_atnumber
current_purchase_countinteger
background_image_urlstring uri
applied_store_promotion_idstring
applied_store_promotion_idsstring[]

Changes

Changed in 3 of the 14 revisions of this API.110

  • fbb6b66272c85See the full diff
    • ○

      added the optional property items/bonus_items/items/nested_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/dynamic_nested_items_read/items/nested_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/item/oneOf[subschema #1: ItemRead]/nested_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/item/oneOf[subschema #3: SubscriptionRead]/nested_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/item/oneOf[subschema #3: SubscriptionRead]/subscription_settings/plans/items/nested_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

  • 63f522cab1392See the full diff
    • ○

      added the optional property items/item/oneOf[subschema #2: LootboxRead]/lootbox_settings/price_step_up to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/item/oneOf[subschema #2: LootboxRead]/lootbox_settings/progress_reset_at to the response with the 200 status

      response-optional-property-added

  • ef61f771db1d13See the full diff
    • ▲

      added ItemRead LootboxRead SubscriptionRead VirtualCurrencyRead to the items/item response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property items/bonus_items/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/dynamic_nested_items_read/items/quantity_expression to the response with the 200 status

      response-optional-property-added

    • ○

      removed ItemRead LootboxRead SubscriptionRead VirtualCurrencyRead from the items/item response property anyOf list for the response status 200

      response-property-any-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog