Update a Wishlist - Spree Commerce Guides

API basics

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Products
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
- GET
  List all Wishlists
- POST
  Create a Wishlist
- GET
  Retrieve a Wishlist
- DEL
  Delete a Wishlist
- PATCH
  Update a Wishlist
- GET
  Retrieve the default Wishlist
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

PATCH

api

storefront

wishlists

{token}

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists/{token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "wishlist": {
    "name": "Birthday Ideas"
  }
}'

{
  "data": {
    "id": "28",
    "type": "wishlist",
    "attributes": {
      "token": "1inBHcJnxBrVEMAZb9esRqZP",
      "name": "My Wishlist",
      "is_private": false,
      "is_default": true,
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": [
          {
            "id": "14",
            "type": "wished_item"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Path Parameters

token

string

required

The token is a unique string used to identify the target resource.

Query Parameters

fields[wishlist]

string

Specify the fields you would like returned in the response body. More information.

Body

application/vnd.api+json

wishlist

object

Response

200 - application/vnd.api+json

data

object

required

included

object[]

Was this page helpful?

Suggest edits Raise issue

Delete a Wishlist Retrieve the default Wishlist

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/wishlists/{token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "wishlist": {
    "name": "Birthday Ideas"
  }
}'

{
  "data": {
    "id": "28",
    "type": "wishlist",
    "attributes": {
      "token": "1inBHcJnxBrVEMAZb9esRqZP",
      "name": "My Wishlist",
      "is_private": false,
      "is_default": true,
      "variant_included": false
    },
    "relationships": {
      "wished_items": {
        "data": [
          {
            "id": "14",
            "type": "wished_item"
          }
        ]
      }
    }
  }
}