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

Passing a quantity value is optional for those wishlist systems that do not support quantities. In this scenario, the returned quantity value will always be `1`, allowing the add-to-cart and pricing to reflect the single representation of the wished item accurately. If the wishlist system you are building allows for setting quantity, add the quantity attribute to the request body with an integer value greater than zero.

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

200 Success - Returns an array of `wished_item` objects.

data

object

required

Show child attributes

data.id

string

required

data.type

string

default:

wished_item

required

data.attributes

object

required

Show child attributes

data.attributes.quantity

integer

data.attributes.price

string

data.attributes.total

string

data.attributes.display_price

string

data.attributes.display_total

string

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

included

object[]

Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.

Show child attributes

included.id

string

required

included.type

string

default:

variant

required

included.attributes

object

required

Show child attributes

included.attributes.sku

string

included.attributes.price

string

included.attributes.currency

string

included.attributes.display_price

string

included.attributes.weight

string | null

included.attributes.height

string | null

included.attributes.width

string | null

included.attributes.depth

string | null

included.attributes.is_master

boolean

Indicates if Variant is the master Variant

included.attributes.options_text

string

included.attributes.purchasable

boolean

Indicates if Variant is in stock or backorderable

included.attributes.in_stock

boolean

Indicates if Variant is in stock

included.attributes.backorderable

boolean

included.relationships

object

required

Show child attributes

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.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