Stores

Bulk Update Store Items

Changed on

Updates multiple store items.

patch/v1/store_items/{store_id}

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/store_items/{store_id}
  • Auth
    HTTP bearer

Path parameters

store_idstring required

Request body

discount_percentinteger nullable
bonus_percentinteger nullable
bonus_fixedinteger nullable

The user will receive a fixed quantity of the item.

positioninteger nullable
namestring nullable
descriptionstring nullable
image_urlstring uri nullable
max_purchasesinteger nullable
global_max_purchasesinteger nullable
requirements_mismatch_behavior'hide_from_store' | 'disable' | 'disable_and_show_description'
custom_badgestring nullable

The custom badge for the item

start_atinteger nullable
end_atinteger nullable
min_amountinteger nullable
reward_points_percentnumber nullable
reward_points_fixedinteger nullable
loyalty_points_percentinteger nullable
loyalty_points_fixedinteger nullable
is_free_itemboolean
rotation_weightinteger nullable
max_reward_points_percentinteger 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
show_global_max_purchase_counterboolean nullable
card_type'default' | 'featured'
show_first_on_category_listboolean nullable
bonus_item_idstring nullable
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
price_pointinteger nullable
price_template_idstring nullable
quantityinteger nullable
idstring required

The unique identifier of the item

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.

show_global_max_purchase_counterboolean nullable

Whether to show purchases left from the global limit when there is no per-user limit.

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
object_type'item' | 'lootbox' | 'subscription' | 'virtual_currency' | 'piggy_bank_offer' | 'pick_one_offer' | 'rolling_offer'
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

  • 340a9e018b87Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • d06893be93ccRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the ////////// response property for the response status

    • warning

      added the new rolling enum value to the /////////// response property for the response status

    • warning

      added the new rolling enum value to the ///////// response property for the response status

    • warning

      added the new rolling enum value to the /////// response property for the response status

    • warning

      added the new rolling enum value to the //////// response property for the response status

    • warning

      added the new rolling enum value to the ////// response property for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the /// response property for the response status

    • warning

      added the new rolling enum value to the ///// response property for the response status

    • warning

      added the new rolling enum value to the ///// response property for the response status

    • warning

      added the new rolling_offer enum value to the / response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /// to the response with the status