POST
/
api
/
v2
/
storefront
/
wishlists
/
{token}
/
add_item
{
  "data": {
    "id": "1",
    "type": "wished_item",
    "attributes": {
      "quantity": 3,
      "price": "55.99",
      "total": "167.97",
      "display_price": "$55.99",
      "display_total": "$167.97"
    },
    "relationships": {
      "variant": {
        "data": {
          "id": "149",
          "type": "variant"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
headerrequired

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.

Body

application/vnd.api+json
​
variant_id
string
required

The variant ID that is to be added to the wishlist.

​
quantity
number

Set a quantity greater than 0, or omit the quantity param if your wishlist does not support quantities.

Response

200 - application/vnd.api+json
​
data
object
required
​
included
object[]

Was this page helpful?

Retrieve the default WishlistSet Wished Item Quantity