Skip to main content
GET
/
api
/
v2
/
storefront
/
wishlists
/
default
Retrieve the default Wishlist
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists/default \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "28",
    "type": "wishlist",
    "attributes": {
      "token": "1inBHcJnxBrVEMAZb9esRqZP",
      "name": "My Wishlist",
      "is_private": false,
      "is_default": true,
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": [
          {
            "id": "14",
            "type": "wished_item"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

​
include
string

Specify the related resources you would like to receive in the included section of the response body. You can also retrieve related resources of included resources by using the dot notation, eg. wished_items.variant. More information.

​
fields[wishlist]
string

Specify the fields you would like returned in the response body. More information.

​
is_variant_included
string

Check for the presence of a variant in a wishlist by passing the variant ID, if the variant is present in the wishlist, the variant_included attribute will return true

Response

200 Success - Returns the wishlist object.

​
data
Wishlist · object
required
​
included
Wishlist Includes · object[]