Add Item to Wishlist

The Add Item to Wishlist endpoint adds a variant to an existing wishlist by creating a new wished_item. A wished item in a wishlist is comparable to a line item in a cart.

Each wished item references a single variant, holds the desired quantity and returns price information determined by the variant price in current currency, and desired quantity.

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.

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

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.display_price

string

data.attributes.display_total

string

data.attributes.price

string

data.attributes.quantity

integer

data.attributes.total

string

data.id

string

required

data.relationships

object

required

Show child attributes

data.relationships.variant

object

Show child attributes

data.relationships.variant.data

object | null

Show child attributes

data.relationships.variant.data.id

string

required

data.relationships.variant.data.type

string

required

data.type

string

default:

wished_item

required

included

object[]

Show child attributes

included.attributes

object

required

Show child attributes

included.attributes.backorderable

boolean

included.attributes.currency

string

included.attributes.depth

string | null

included.attributes.display_price

string

included.attributes.height

string | null

included.attributes.in_stock

boolean

Indicates if Variant is in stock

included.attributes.is_master

boolean

Indicates if Variant is the master Variant

included.attributes.options_text

string

included.attributes.price

string

included.attributes.purchasable

boolean

Indicates if Variant is in stock or backorderable

included.attributes.sku

string

included.attributes.weight

string | null

included.attributes.width

string | null

included.id

string

required

included.relationships

object

required

Show child attributes

included.relationships.images

object

Show child attributes

included.relationships.images.data

array

Show child attributes

included.relationships.images.data.id

string

required

included.relationships.images.data.type

string

required

included.relationships.option_values

object

Show child attributes

included.relationships.option_values.data

array

Show child attributes

included.relationships.option_values.data.id

string

required

included.relationships.option_values.data.type

string

required

included.relationships.product

object

Show child attributes

included.relationships.product.data

object | null

Show child attributes

included.relationships.product.data.id

string

required

included.relationships.product.data.type

string

required

included.type

string

default:

variant

required