Skip to main content
POST
/
api
/
v3
/
store
/
wishlists
Spree SDK
import { createClient } from '@spree/sdk'

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

const wishlist = await client.wishlists.create({
  name: 'Birthday Ideas',
  is_private: true,
}, {
  bearerToken: '<token>',
})
{
  "id": "wl_gbHJdmfrXB",
  "name": "Birthday Ideas",
  "token": "JhhpRLM7ard57UCuJ9BwTzEX",
  "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

Body

application/json
​
name
string
required
Example:

"Birthday Ideas"

​
is_private
boolean
Example:

true

​
is_default
boolean
Example:

false

Response

wishlist created

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