Limiting the display time for items in the store
You can set the display period for an item in the store to:
- maintain the relevance of the catalog at a given time, for example, during holiday sales
create an item in advance without displaying it in the catalog
- bundles
- game keys
- Create bundle or Update bundle API call for bundles
Create game, Update game by SKU or Update game by ID API call for game keys
periods[0].date_from
with the date and time of the beginning of item display period inYYYY-MM-DDThh:mm:ss±TMZ
format, whereTMZ
is the time zone indicator inhh:mm
GMT format.periods[0].date_until
with the date and time of the end of the item display period inYYYY-MM-DDThh:mm:ss±TMZ
format, whereTMZ
is the time zone indicator inhh:mm
GMT format. To not indicate the end of an item’s display period, passnull
.
You can set up multiple periods for displaying an item in the store. To do this, pass an array of objects with the start and end dates of all periods in the API calls.
Example:
"periods": [
{
"date_from": "2022-06-10T14:00:00+03:00",
"date_until": "2022-06-30T14:00:00+03:00"
},
{
"date_from": "2022-07-10T14:00:00+03:00",
"date_until": "2022-07-30T14:00:00+03:00"
},
{
"date_from": "2022-08-10T14:00:00+03:00",
"date_until": "2022-08-30T14:00:00+03:00"
}
]
The getting catalog methods return the items that are displayed in the store at the time of the request. To obtain information about items whose display period has not yet started or has already expired, pass the show_inactive_time_limited_items parameter with a value of 1
when requesting the catalog.
Item display time limits are not taken into account within a bundle.
Example
- You create a
Booster virtual item and set its display period from October 29th to November 15th. - You create a
Legendary Start Pack bundle that includes theBooster . The bundle does not have a time limit, so it is always visible in the store. - On October 20th, a user opens your in-game store. You use the following methods:
- Get virtual items list to display the catalog of virtual items.
- Get list of bundles to display the catalog of bundles.
show_inactive_time_limited_items
parameter in these methods. - You retrieve the item catalog:
- The
Booster is not included in the response of the Get virtual items list, because its display period is from October 29th to November 15th. If you pass the parametershow_inactive_time_limited_items:1
in the Get virtual items list, theBooster is included in the response, and the periods array indicates the period when it is available for purchase. - The
Booster is included in the response of the Get list of bundles as part of theLegendary Start Pack bundle, and the user can obtain it regardless of the value of theshow_inactive_time_limited_items
parameter.
- The
Found a typo or other text error? Select the text and press Ctrl+Enter.