Skip to main content
PATCH
/
api
/
v3
/
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.update('wl_abc123', {
  name: 'Updated Name',
}, {
  token: '<token>',
})
{
  "id": "wl_UkLWZg9DAJ",
  "name": "Updated Name",
  "token": "NUaszyr9oB7MvNSvd2Ri7qHf",
  "is_default": false,
  "is_private": true
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json
​
name
string
Example:

"Updated Name"

​
is_private
boolean
Example:

true

​
is_default
boolean
Example:

false

Response

200 - application/json

wishlist updated

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