GET
/
api
/
v2
/
storefront
/
wishlists
List all Wishlists
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "4",
      "type": "wishlist",
      "attributes": {
        "token": "gD1QP6SybtooojnxtkXPvcvh",
        "name": "My Wishlist",
        "is_private": false,
        "is_default": false,
        "variant_included": true
      },
      "relationships": {
        "wished_items": {
          "data": [
            {
              "id": "4",
              "type": "wished_item"
            },
            {
              "id": "5",
              "type": "wished_item"
            }
          ]
        }
      }
    },
    {
      "id": "8",
      "type": "wishlist",
      "attributes": {
        "token": "LKWCxupq2gsN9DRhwuNBCrf5",
        "name": "Fathers Day",
        "is_private": true,
        "is_default": true,
        "variant_included": false
      },
      "relationships": {
        "wished_items": {
          "data": [
            {
              "id": "6",
              "type": "wished_item"
            }
          ]
        }
      }
    },
    {
      "id": "7",
      "type": "wishlist",
      "attributes": {
        "token": "QHnjcCvz21Dtzc6isWyiyBxM",
        "name": "Black Friday",
        "is_private": false,
        "is_default": false,
        "variant_included": false
      },
      "relationships": {
        "wished_items": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "count": 3,
    "total_count": 3,
    "total_pages": 1
  },
  "links": {
    "self": "http://localhost:3000/api/v2/storefront/wishlists?is_variant_included=150",
    "next": "http://localhost:3000/api/v2/storefront/wishlists?page=1",
    "prev": "http://localhost:3000/api/v2/storefront/wishlists?page=1",
    "last": "http://localhost:3000/api/v2/storefront/wishlists?page=1",
    "first": "http://localhost:3000/api/v2/storefront/wishlists?page=1"
  }
}

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.

​
per_page
integer

Number of requested records per page when paginating collection

​
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
application/vnd.api+json

200 Success - Returns an array of wishlist objects.

The response is of type object.