Storefront API Wish List - WEBSALE Dokumentation

The Storefront API for wish lists allows products to be saved, managed, and quickly found again later. It offers endpoints for creating, renaming, and deleting wish lists as well as for adding and removing individual products.

Supported methods

List of all supported methods.

Command	Endpoints	GET	PUT	POST	DELETE
Retrieve a wish list.	`watchList/load`
Retrieve all wish lists.	`watchList/list`
Retrieve the position of a product on the wish list.	`watchList/getItemId`
Check whether a product is already on a specific wish list.	`watchList/checkHasProduct`
Check on how many wish lists a particular product is included.	`watchList/countListsWithProduct`
Create a new wish list.	`watchList/add`
Add one or more products to one or more wish list(s).	`watchList/addItem`
Delete a product from a wish list.	`watchList/deleteItem`
Rename a wish list.	`watchList/rename`
Permanently delete a wish list.	`watchList/delete`

Methods for the wish list

With these methods, wish lists in the customer account can be managed: you can either load individual wish lists including the saved products or list all wish lists belonging to the logged-in user. In addition, you can check whether or how often a product is on wish lists, create new wish lists, add products (individually or in bulk) to one or more wish lists or remove them again, as well as rename or delete entire wish lists.

watchList/load

The following call loads a wish list including all saved items. It can be used to further process wish lists together with product data. Example call that displays the wish list with the ID watchlist_132_cf76964799db4ce

GET https://<your-shop>.de/api/v1/watchList/load?watchListId=watchlist_132_cf76964799db4ce

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the wish list to be loaded.

Example response

{
  "id": "watchlist_132_cf76964799db4ce",
  "watchListName": "testlist67",
  "items": [
    {
      "id": "6d90bbb6c33294ddcd91",
      "freeFields": {},
      "product": {
        "id": "146-78608",
        "itemNumber": "67",
        "name": "Plushie",
        "price": 6.7,
        "custom": { "image": {} },
        "isSetProduct": true,
        "setProducts": [
          { "id": "147-15732", "quantityFactor": 1, "usePrice": true, "hidden": false, "fixQuantity": false }
        ],
        "taxRateId": "19",
        "new": true,
        "timestampCreatedAt": "2025-11-04T09:27:18.000Z",
        "timestampUpdatedAt": "2025-11-10T07:52:20.000Z"
      }
    }
  ]
}

GET watchList/list

The following call displays all wish lists of the currently logged-in customer account. It can be used to display, select, or switch between multiple wish lists of a user.

GET https://<your-shop>.de/api/v1/watchList/list

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Example response

[
  {
    "watchListId": "watchlist_37_default",
    "watchListName": "Wish list"
  },
  {
    "watchListId": "watchlist_37_basket",
    "watchListName": "Saved for later"
  }
]

GET watchList/getItemId

The following call returns the position ID of a specific product within a particular wish list. The position ID is the same as the ID of an entry in watchList/load. Example call that returns the position of the product with the ID 146-78608 from the wish list with the ID watchlist_132_cf76964799db4ce

GET https://<your-shop>.de/api/v1/watchList/getItemId?watchListId=watchlist_132_cf76964799db4ce&productId=146-78608

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the wish list in which the product is located.
`productId`	string	Required field ID of the product in the watchlist.

Example response

{
  "itemId": "6d90bbb6c33294ddcd91"
}

GET watchList/checkHasProduct

The following call can be used to check whether a particular product is already on a specific wish list. It can be used to toggle wish list buttons or prevent duplicate entries. Example call to check whether the product with the ID 146-78608 is present on the wish list with the ID watchlist_132_cf76964799db4ce

GET https://<your-shop>.de/api/v1/watchList/checkHasProduct?watchListId=watchlist_132_cf76964799db4ce&productId=146-78608

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the wish list to be searched.
`productId`	string	Required field ID of the product to search for.

Example response

{
  "isOnList": true
}

GET watchList/countListsWithProduct

The following call counts how many wish lists the specified product is saved on. It can be used on product and category pages to signal that the product is in demand, and can be displayed, for example, with the notice “Saved on xxx wish lists”. Example call that counts how often the product with the ID 146-78608 is on wish lists

GET https://<your-shop>.de/api/v1/watchList/countListsWithProduct?productId=146-78608

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`productId`	string	Required field ID of the product to search wish lists for.

Example response

{
  "count": 2
}

POST watchList/add

The following call creates a new wish list for the currently logged-in user. Example call that creates a new wish list with the name "Please, I need this"

POST https://<your-shop>.de/api/v1/watchList/add

Example request

{
  "watchListName": "Please, I need this"
}

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListName`	string	Required field Name of the watchlist to be created.

Example response

{}

Error codes

Code	Description
`notLoggedIn`	The user is not logged in.

PUT watchList/addItem

The following call lets you add one or more products to one or more wish lists. It can be used for wish list buttons on product/listing pages as well as for bulk actions. Example call that adds the products with the ID 147-15732 and 146-78608 to the wish list with the ID watchlist_132_cf76964799db4ce

PUT https://<your-shop>.de/api/v1/watchList/addItem

Example request

{
  "watchListIds": {
    "watchlist_132_cf76964799db4ce": "watchlist_132_cf76964799db4ce"
  },
  "multiProducts": {
    "147-15732": "147-15732",
    "146-78608": "146-78608"
  }
}

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListIds`	object	Required field List of target wish lists. Key and value are the watchlist IDs. At least one ID must be specified.
`productId`	string	A product to be added. Required field if `multiproducts` is not passed.
`multiProducts`	object	Adds several products in one call. Key and value are product IDs. Required field if `productId` is not passed.
`freeFields`	object	Optional. Free additional data on the products. With `multiProducts`, these values apply to all added products.

Example response

{}

Error codes

Code	Description
`invalidProductId`	The requested product does not exist.
`invalidVariantId`	The product was found, but not the associated variant.
`watchListNotFound`	The specified wish list does not exist.

PUT watchList/rename

The following call renames an existing wish list. Example call that renames the wish list with the ID watchlist_132_cf76964799db4ce to "List 67"

PUT https://<your-shop>.de/api/v1/watchList/rename

Example request

{
	"watchListId": "watchlist_132_cf76964799db4ce",
	"newWatchListName": "List 67"
}

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the wish list to be renamed.
`newWatchListName`	string	Required field New name for the wish list.

Example response

{}

Error codes

Code	Description
`watchListNotFound`	The wish list with the specified ID does not exist.The wish list with the specified ID does not exist.
`notChangeablenotChangeable`	The wish list may not be renamed. (The wish list may not be renamed. (only active for the automatically created default wish lists)

DELETE watchList/deleteItem

This call removes a particular product from a wish list. Example call that removes the product with the watchListItemId 6d90bbb6c33294ddcd91 (this ID is obtained via the call to watchList/getItemId) from the wish list with the ID watchlist_132_cf76964799db4ce

DELETE https://<your-shop>.de/api/v1/watchList/deleteItem

Example request

{
  "watchListId": "watchlist_132_cf76964799db4ce",
  "watchListItemId": "6d90bbb6c33294ddcd91"
}

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the watchlist from which the entry should be removed.
`watchListItemId`	string	Required field Position ID of the product to be removed.

Example response

{}

Error codes

Parameter	Code
`invalidItemId`	No entry with this ID exists on the wish list.
`watchListNotFound`	The wish list with the specified ID does not exist.

DELETE watchList/delete

The following call permanently deletes an existing wish list. Example call that permanently removes the wish list with the ID watchlist_132_cf76964799db4ce

DELETE https://<your-shop>.de/api/v1/watchList/delete

Example request

{
  "watchListId": "watchlist_132_cf76964799db4ce"
}

Parameter overview

Header parameters

Parameter	Description
`x-session`	Required field ID of the current session. More information: Storefront API Basics

Body parameters

Parameter	Type	Description
`watchListId`	string	Required field ID of the wish list to be deleted.

Example response

{}

Error codes

Parameter	Description
`watchListNotFound`	The specified wish list does not exist.
`notChangeable`	The wish list may not be renamed. (The wish list may not be renamed. (only active for the automatically created default wish lists)

​Supported methods

​Methods for the wish list

​watchList/load

​Parameter overview

​Header parameters

​Body parameters

​Example response

​GET watchList/list

​Parameter overview

​Header parameters

​Example response

​GET watchList/getItemId

​Parameter overview

​Header parameters

​Body parameters

​Example response

​GET watchList/checkHasProduct

​Parameter overview

​Header parameters

​Body parameters

​Example response

​GET watchList/countListsWithProduct

​Parameter overview

​Header parameters

​Body parameters

​Example response

​POST watchList/add

​Example request

​Parameter overview

​Header parameters

​Body parameters

​Example response

​Error codes

​PUT watchList/addItem

​Example request

​Parameter overview

​Header parameters

​Body parameters

​Example response

​Error codes

​PUT watchList/rename

​Example request

​Parameter overview

​Header parameters

​Body parameters

​Example response

​Error codes

​DELETE watchList/deleteItem

​Example request

​Parameter overview

​Header parameters

​Body parameters

​Example response

​Error codes

​DELETE watchList/delete

​Example request

​Parameter overview

​Header parameters

​Body parameters

​Example response

​Error codes

Supported methods

Methods for the wish list

watchList/load

Parameter overview

Header parameters

Body parameters

Example response

GET watchList/list

Parameter overview

Header parameters

Example response

GET watchList/getItemId

Parameter overview

Header parameters

Body parameters

Example response

GET watchList/checkHasProduct

Parameter overview

Header parameters

Body parameters

Example response

GET watchList/countListsWithProduct

Parameter overview

Header parameters

Body parameters

Example response

POST watchList/add

Example request

Parameter overview

Header parameters

Body parameters

Example response

Error codes

PUT watchList/addItem

Example request

Parameter overview

Header parameters

Body parameters

Example response

Error codes

PUT watchList/rename

Example request

Parameter overview

Header parameters

Body parameters

Example response

Error codes

DELETE watchList/deleteItem

Example request

Parameter overview

Header parameters

Body parameters

Example response

Error codes

DELETE watchList/delete

Example request

Parameter overview

Header parameters

Body parameters

Example response

Error codes