Create a Wishlist

Creates a new wishlist for the current user in the current store.

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

fields[wishlist]

string

Specify the fields you would like returned in the response body. More information.

Body

application/json

name

string

required

The Wishlist name.

is_default

boolean

Whether the wishlist is set to the users default wishlist for the current store. Defaults to false.

is_private

boolean

Set the Wishlist to public or private. Defaults to true (private).

Response

200 - application/vnd.api+json

data

object

required

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.is_default

boolean

data.attributes.is_private

boolean

data.attributes.name

string

data.attributes.token

string

data.attributes.variant_included

boolean

Returns true or false depending on the variant ID passed in through the is_variant_included query param.

data.id

string

required

data.relationships

object

required

Show child attributes

data.relationships.wished_items

object

Show child attributes

data.relationships.wished_items.data

array

Show child attributes

data.relationships.wished_items.data.id

string

required

data.relationships.wished_items.data.type

string

required

data.type

string

default:

wishlist

required

included

object[]

Show child attributes

included.attributes

object

required

Show child attributes

included.attributes.display_price

string

included.attributes.display_total

string

included.attributes.price

string

included.attributes.quantity

integer

included.attributes.total

string

included.id

string

required

included.relationships

object

required

Show child attributes

included.relationships.variant

object

Show child attributes

included.relationships.variant.data

object | null

Show child attributes

included.relationships.variant.data.id

string

required

included.relationships.variant.data.type

string

required

included.type

string

default:

wished_item

required