Skip to main content
GET
/
api
/
v3
/
store
/
wishlists
/
{id}
Spree SDK
import { createSpreeClient } from '@spree/sdk'

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

const wishlist = await client.store.wishlists.get('wl_abc123', {
  expand: 'wished_items',
}, {
  bearerToken: '<token>',
})
{
  "id": "wl_UkLWZg9DAJ",
  "name": "My Wishlist",
  "token": "Z9ceWN6JEScradeaE1xhS6ic",
  "created_at": "2026-03-06T16:06:51.758Z",
  "updated_at": "2026-03-06T16:06:51.758Z",
  "is_default": false,
  "is_private": true
}

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

​
id
string
required

Query Parameters

​
expand
string

Expand wished_items

​
fields
string

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

Response

wishlist found

​
id
string
required
​
name
string
required
​
token
string
required
​
created_at
string
required
​
updated_at
string
required
​
is_default
boolean
required
​
is_private
boolean
required
​
items
object[]