Get a wishlist

GET

api

store

wishlists

{id}

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const wishlist = await client.wishlists.get('wl_abc123', {
  expand: ['items.product'],
}, {
  token: '<token>',
})

{
  "id": "wl_UkLWZg9DAJ",
  "name": "My Wishlist",
  "token": "ChUn1LGAz64UyN74XjVJAMP1",
  "is_default": false,
  "is_private": true
}

{
  "error": {
    "code": "record_not_found",
    "message": "Wishlist not found"
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Authorization

string

header

required

JWT token for authenticated customers

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

string

required

Query Parameters

expand

string

Comma-separated associations to expand (eg items.product to get wishlist items with associated products)

fields

string

Comma-separated list of fields to include (e.g., name,slug,price). id is always included.

Response

wishlist found

string

required

name

string

required

token

string

required

is_default

boolean

required

is_private

boolean

required

items

object[]

Show child attributes

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const wishlist = await client.wishlists.get('wl_abc123', {
  expand: ['items.product'],
}, {
  token: '<token>',
})

{
  "id": "wl_UkLWZg9DAJ",
  "name": "My Wishlist",
  "token": "ChUn1LGAz64UyN74XjVJAMP1",
  "is_default": false,
  "is_private": true
}

{
  "error": {
    "code": "record_not_found",
    "message": "Wishlist not found"
  }
}

API basics

Endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response