Skip to main content
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

Query Parameters

include
string
fields[wishlist]
string
per_page
integer
is_variant_included
string

Response

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