Storefront

Storefront endpoints provide product collections, promotions, pricing, published listings, and application storefront previews.

Storefront Collection Object

Represents a localized collection of storefront products.

Storefront Collection Structure

Field	Type	Description
id	snowflake	The ID of the collection
application_id	snowflake	The ID of the application
name	string	The name of the collection
description	string	The description of the collection
products	array[storefront product object]	The products in the collection
created_at	ISO8601 timestamp	When the collection was created
updated_at	ISO8601 timestamp	When the collection was last updated
unpublished_at?	ISO8601 timestamp	When the collection was unpublished
unpublish_settings?	unpublish settings object	The collection's scheduled unpublish settings
tenant_metadata	object	Tenant-specific presentation metadata

Unpublish Settings Structure

Field	Type	Description
will_unpublish_at?	ISO8601 timestamp	When the collection is scheduled to be unpublished

Storefront Product Object

Represents a localized product and its SKUs.

Storefront Product Structure

Field	Type	Description
id	snowflake	The ID of the product
sku_ids	array[snowflake]	The IDs of the SKUs in the product
name	string	The name of the product
summary	string	The summary of the product
options	array[product option object]	The selectable product options
created_at	ISO8601 timestamp	When the product was created
updated_at	ISO8601 timestamp	When the product was last updated
skus	array[SKU object]	The SKUs in the product
tenant_metadata	object	Tenant-specific product metadata

Product Option Structure

Field	Type	Description
name	string	The name of the product option
option_values	array[string]	The values available for the option

Example Storefront Product

{
  "id": "1422548914485198869",
  "sku_ids": ["1422548914485198870"],
  "name": "Crimson Trail",
  "summary": "A crimson cosmetic trail.",
  "options": [
    {
      "name": "Color",
      "option_values": ["Crimson"]
    }
  ],
  "created_at": "2026-07-02T11:18:42.120000+00:00",
  "updated_at": "2026-08-01T09:04:15.800000+00:00",
  "skus": [],
  "tenant_metadata": {}
}

Represents an application storefront exposed through the Partner SDK.

Field	Type	Description
id	string	The ID of the storefront
published_at	?ISO8601 timestamp	When the storefront was published
application_id	snowflake	The ID of the application
title	string	The title of the storefront
logo_asset_id	snowflake	The ID of the logo asset
light_theme_logo_asset_id	snowflake	The ID of the light theme logo asset
pages	array[storefront page object]	The pages in the storefront
assets	array[object]	The application assets used by the storefront
application?	application object	The storefront application
storefront_pricing?	object	Pricing for the storefront's SKUs
promotions?	map[string, storefront promotion object]	Promotions keyed by promotion ID
store_listings?	array[store listing object]	Published listings included with the storefront

Storefront Page Structure

Field	Type	Description
title	string	The title of the page
leaderboard?	storefront leaderboard object	Leaderboard presentation metadata
sku_ids	array[snowflake]	The IDs of SKUs displayed on the page
sections?	array[storefront section object]	Sections displayed on the page

Storefront Leaderboard Structure

Field	Type	Description
title	string	The title of the leaderboard
description	string	The description of the leaderboard
background_image_asset_id	snowflake	The ID of the background image asset

Storefront Section Structure

Field	Type	Description
title	string	The title of the section
sku_ids	array[snowflake]	The IDs of SKUs in the section

Storefront Promotion Structure

Field	Type	Description
id	string	The ID of the promotion
ends_at?	?ISO8601 timestamp	When the promotion ends
flavor?	string	The presentation flavor (default `default`)
pdp?	?promotion label object	Product detail page presentation
storefront?	?promotion storefront label object	Storefront presentation
checkout?	?promotion label object	Checkout presentation
vc_stream?	?promotion label object	Voice stream presentation

Promotion Label Structure

Field	Type	Description
label	string	The displayed label
tooltip	string	The displayed tooltip
icon	string	The displayed icon

Promotion Storefront Label Structure

Field	Type	Description
header_text	string	The storefront promotion header

Storefront Launch Announcement Object

Represents the announcement shown when a social layer storefront launches.

Storefront Launch Announcement Structure

Field	Type	Description
application_id	snowflake	The ID of the application
light_theme_logo_url?	?string	The light theme logo URL
dark_theme_logo_url?	?string	The dark theme logo URL
background_url?	?string	The background image URL
titles?	?array[string]	The announcement titles
subtitle?	?string	The announcement subtitle
features?	?array[announcement feature object]	The announced features
button_text?	?string	The call-to-action button text

Announcement Feature Structure

Field	Type	Description
asset_url	string	The feature image URL
title	string	The feature title
subtitle	string	The feature subtitle

Example Storefront Launch Announcement

{
  "application_id": "1422548914485198869",
  "light_theme_logo_url": "https://cdn.example.com/storefront/logo-light.png",
  "dark_theme_logo_url": "https://cdn.example.com/storefront/logo-dark.png",
  "background_url": "https://cdn.example.com/storefront/background.png",
  "titles": ["A new shop has arrived"],
  "subtitle": "Discover new items for your next session.",
  "features": [
    {
      "asset_url": "https://cdn.example.com/storefront/feature.png",
      "title": "New cosmetics",
      "subtitle": "Customize your experience."
    }
  ],
  "button_text": "Explore Shop"
}

Endpoints

List Storefront Collections

GET/storefront/collections

Returns an object containing a collections array of storefront collection objects.

Query String Params

Field	Type	Description
collection_ids	array[snowflake]	The IDs of the collections to return
locale	string	The language to return
with_bundled_skus?	boolean	Whether bundled SKUs are included
include_google_sku_ids?	boolean	Whether Google Play SKU IDs are included
include_unpublished_products?	boolean	Whether unpublished products are included
include_unpublished_collections?	boolean	Whether unpublished collections are included
ignore_cache?	boolean	Whether cached storefront data is ignored

List Storefront Collections For Application

GET/storefront/collections/applications

Returns an object containing a collections array of storefront collection objects for an application.

Query String Params

Field	Type	Description
application_id	snowflake	The ID of the application
locale	string	The language to return
with_bundled_skus?	boolean	Whether bundled SKUs are included
include_google_sku_ids?	boolean	Whether Google Play SKU IDs are included
include_unpublished_products?	boolean	Whether unpublished products are included
include_unpublished_collections?	boolean	Whether unpublished collections are included
ignore_cache?	boolean	Whether cached storefront data is ignored
sku_types?	array[integer]	The SKU types to include
include_pricing?	boolean	Whether pricing is included

Get Storefront Collection

GET/storefront/collections/{collection.id}

Returns a storefront collection object.

List Storefront Products By SKU IDs

GET/storefront/products/skus

Returns an object containing a products array of storefront product objects.

Query String Params

Field	Type	Description
sku_ids	array[snowflake]	The IDs of the SKUs to return products for
locale	string	The language to return
with_bundled_skus?	boolean	Whether bundled SKUs are included
include_google_sku_ids?	boolean	Whether Google Play SKU IDs are included
ignore_cache?	boolean	Whether cached storefront data is ignored

Get Storefront Product By SKU ID

GET/storefront/products/sku/{sku.id}

Returns a storefront product object for a SKU.

List Storefront Promotions

GET/storefront/promotions

Returns an object containing a promotions array of storefront promotion objects.

Query String Params

Field	Type	Description
application_ids	array[snowflake]	The IDs of the applications
promotion_id_override?	snowflake	The ID of the promotion to use as an override

Get Storefront Pricing

GET/storefront/pricing

Returns storefront pricing for an application or up to 50 SKUs.

Query String Params

Field	Type	Description
application_id?	snowflake	The ID of the application
sku_ids?	array[snowflake]	The IDs of the SKUs
country_code?	string	The country code used for pricing
promotion_id_override?	snowflake	The ID of the promotion to use as an override

List Published Store Listings

GET/store/published-listings/skus

Returns a list of store listing objects for an application.

Query String Params

Field	Type	Description
application_id	snowflake	The ID of the application

Get Published Store Listing

GET/store/published-listings/skus/{sku.id}

Returns a store listing object for a SKU.

List Published Store Listing Subscription Plans

GET/store/published-listings/skus/{sku.id}/subscription-plans

Returns a list of subscription plan objects for a SKU.

Query String Params

Field	Type	Description
country_code?	string	The country code used for pricing
payment_source_id?	snowflake	The ID of the payment source
include_unpublished?	boolean	Whether unpublished plans are included
revenue_surface?	string	The revenue surface requesting the plans
payment_gateway?	integer	The payment gateway

GET/partner-sdk/guilds/{guild.id}/application-storefront

Returns a social layer storefront object for a guild.

GET/partner-sdk/applications/{application.id}/application-storefront

Returns a social layer storefront object for an application.

GET/partner-sdk/applications/{application.id}/storefronts/preview

Returns a list of partial social layer storefront objects.

GET/partner-sdk/applications/{application.id}/storefront/{storefront.id}/preview

Returns a social layer storefront object.

GET/partner-sdk/applications/{application.id}/storefront/skus/{sku.id}

Returns a store listing, storefront metadata, and application assets for a social layer storefront SKU.

Query String Params

Field	Type	Description
with_google_sku_ids?	boolean	Whether Google Play SKU IDs are included
country_code?	string	The country code used for pricing
payment_gateway?	integer	The payment gateway
promotion_id_override?	snowflake	The ID of the promotion to use as an override

Response Body

Field	Type	Description
store_listing	store listing object	The listing for the SKU
storefront_metadata?	object	Storefront presentation metadata
assets	array[object]	Application assets used by the listing

POST/partner-sdk/applications/{application.id}/storefront/skus/{sku.id}/eligibility

Starts an eligibility check for a social layer SKU.

Response Body

Field	Type	Description
interaction_id	string	The ID of the eligibility interaction

GET/partner-sdk/guilds/{guild.id}/application-storefront/announcement

Returns the storefront announcement for a guild.

GET/partner-sdk/storefront-launch-announcement

Returns a nullable storefront launch announcement object.