Wishlists

Wishlists contain store SKUs saved by users and control how saved items are shared.

Wishlist Object

A user's store wishlist.

Wishlist Structure

Field	Type	Description
id	snowflake	The ID of the wishlist
user_id	snowflake	The ID of the user who owns the wishlist
wishlist_items	array[wishlist item object]	The items in the wishlist
storefront_pricing?	array[object]	Storefront pricing for the wishlist's SKUs
visibility	integer	The visibility
applications?	array[application object]	Applications referenced by wishlist items

Wishlist Visibility

Value	Name	Description
0	PRIVATE	The wishlist is only visible to its owner
1	PUBLIC	The wishlist is visible on the owner's profile

Wishlist Item Structure

Field	Type	Description
sku_id	snowflake	The ID of the SKU
sku_product_line	integer	The product line of the SKU
sku_name	string	The name of the SKU
is_owned	boolean	Whether the wishlist owner owns the SKU
gifter_user_id?	?snowflake	The ID of the user who gifted the SKU
sku?	SKU object	The SKU
collectibles_item?	collectible object	The collectible represented by the item
bundle_items?	array[collectible object]	The collectibles represented by a bundle

Collectible wishlist items contain either collectibles_item or bundle_items.

Example Wishlist

{
  "id": "1415376298170224701",
  "user_id": "852892297661906993",
  "wishlist_items": [
    {
      "sku_id": "1212569433834881034",
      "sku_product_line": 7,
      "sku_name": "Midnight Glow",
      "is_owned": false,
      "gifter_user_id": null,
      "collectibles_item": {
        "type": 1,
        "sku_id": "1212569433834881034"
      }
    }
  ],
  "visibility": 1,
  "applications": []
}

Wishlist Recommendations Object

Recommendations for gifting wishlist items.

Wishlist Recommendations Structure

Field	Type	Description
skus	array[SKU object]	The recommended SKUs
skus_to_user_and_reason	map[snowflake, object]	A mapping of SKU IDs to recommendation recipient details
applications	array[application object]	Applications referenced by the recommended SKUs
storefront_pricing?	array[object]	Storefront pricing for the recommended SKUs

Endpoints

Get Wishlist

GET/wishlists/{wishlist_id}

Returns a wishlist object.

Query String Params

Field	Type	Description
source?	string	The source of the request (default `USER_PROFILE`)
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing, either `google` or `apple`

Modify User Wishlist

PATCH/users/@me/wishlists/{wishlist_id}

Modifies the current user's wishlist visibility. Returns the updated wishlist object on success.

JSON Params

Field	Type	Description
visibility	integer	The wishlist visibility
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing, either `google` or `apple`

Add Wishlist Item

POST/users/@me/wishlist/items

Adds a SKU to the current user's wishlist. Returns the updated wishlist object on success.

JSON Params

Field	Type	Description
sku_id	snowflake	The ID of the SKU
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing, either `google` or `apple`

Delete User Wishlist Item

DELETE/users/@me/wishlists/{wishlist_id}/items/{sku.id}

Removes the SKU from the current user's wishlist. Returns the updated wishlist object on success.

Query String Params

Field	Type	Description
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing, either `google` or `apple`

Modify User Wishlist Item

PATCH/users/@me/wishlists/{wishlist_id}/items/{sku.id}

Reorders a SKU in the current user's wishlist. Returns the updated wishlist object on success.

JSON Params

Field	Type	Description
previous_sku_id?	snowflake	The ID of the SKU to place before this SKU
next_sku_id?	snowflake	The ID of the SKU to place after this SKU
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing, either `google` or `apple`

List User Wishlist Recommendations

GET/wishlist/gift-recommendations

Returns a wishlist recommendations object.

Query String Params

Field	Type	Description
application_ids	array[snowflake]	The application IDs to include
user_ids	array[snowflake]	The user IDs to include
max_recommendations?	integer	The maximum number of recommendations to return (default 20)
localize?	boolean	Whether to localize the recommendations (default true)
country_code?	string	The ISO 3166-1 alpha-2 country code used for pricing
payment_gateway?	string	The mobile payment gateway used for pricing

Example Response

{
  "skus": [],
  "skus_to_user_and_reason": {},
  "applications": [],
  "storefront_pricing": []
}