Create a wishlist - Spree Commerce documentation

POST

api

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,
}, {
  token: '<token>',
})

{
  "id": "wl_gbHJdmfrXB",
  "name": "Birthday Ideas",
  "token": "LoTGXDT4V69PBMZXRWaS9Sjg",
  "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

string

required

name

string

required

token

string

required

is_default

boolean

required

is_private

boolean

required

items

object[]

Show child attributes

List wishlists

Get a wishlist

⌘I

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,
}, {
  token: '<token>',
})

{
  "id": "wl_gbHJdmfrXB",
  "name": "Birthday Ideas",
  "token": "LoTGXDT4V69PBMZXRWaS9Sjg",
  "is_default": false,
  "is_private": true
}