Skip to content

putFavorites.v1

POST
/shopgate.user.putFavorites.v1

This pipeline is used to replace the user’s favorite list for Engage Theme versions below 6.7.0. Theme versions 6.7.0 and higher use addFavorites and deleteFavorites instead.

Media typeapplication/json
object
productIds
required
productIds

List of product IDs

Array<string>
favoritesListId
favoritesListId

The ID of the favorite list. Apps without support for multiple favorite lists use the implicit list DEFAULT.

string
Example
1

Returns an empty object.

Media typeapplication/json
object
Examplegenerated
{}

Returns one or multiple error messages.

Media typeapplication/json