getFavorites.v1

POST

/shopgate.user.getFavorites.v1

This pipeline is used to retrieve the favorites of a user. Favorites are the products, retrieved from shopgate.catalog.getProducts.v1 pipeline, but can additionally contain metadata.

Request Body

Media typeapplication/json

object

Example^generated

{}

Responses

ok

Successful response

Media typeapplication/json

object

products

required

object

metadata

object

...

Example

{
  "products": [
    {
      "id": "abc123",
      "metadata": {
        "metaPropKey": "metaPropValue"
      },
      "...": "all properties of BasicProduct"
    }
  ]
}

EUNKNOWN

Returns one or multiple error messages.

Media typeapplication/json