Wishlists

Creates, retrieves, updates, and deletes customer wishlists.

Table Specific Information

Select

The add-in uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = comparison.
CustomerId supports the = comparison.

The rest of the filter is executed client-side within the add-in.

For example, the following queries are processed server-side:

SELECT * FROM Wishlists WHERE Id = 55

SELECT * FROM Wishlists WHERE CustomerId = 5255

Insert

To insert a wishlist, specify at least the CustomerId, Name, IsPublic, and Items columns. Items must be a JSON-formatted array of objects containing ProductId and, optionally, VariantId.

INSERT INTO Wishlists (CustomerId, Name, IsPublic, Items) VALUES (55, 'Holiday List', true, '[{"product_id":126}]')

Update

BigCommerce requires the Items column to be present in the request body when updating a wishlist, so it must be included even if its value is unchanged.

UPDATE Wishlists SET Name = 'Updated List', Items = '[{"product_id":126}]' WHERE Id = 55

Delete

DELETE FROM Wishlists WHERE Id = 55

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique identifier of the wishlist.
CustomerId	Integer	False	The Id of the customer this wishlist belongs to.
Name	String	False	The name of the wishlist.
IsPublic	Boolean	False	Whether the wishlist is publicly viewable.
Token	String	True	A UUID generated internally by BigCommerce that can be used to build a shareable link to the wishlist.
Items	String	False	A JSON-formatted array of wishlist items (product_id, variant_id).