Skip to main content
PATCH
/
api
/
v2
/
storefront
/
wishlists
/
{token}
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({wishlist: {name: 'Birthday Ideas'}})
};

fetch('https://demo.spreecommerce.org/api/v2/storefront/wishlists/{token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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 Success - Returns the wishlist object.

data
Wishlist · object
required
included
Wishlist Includes · object[]