PATCH
/
api
/
v2
/
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

The body is of type object.

Response

200
application/vnd.api+json

200 Success - Returns the wishlist object.

The response is of type object.