Customers > Customers > favoritesPage
Commerce APICustomersCustomersfavoritesPage
favoritesPage
GET:favorites/page.json

Description

Get all favorites of a given shop.

See also: Pagination.

Permission bit: "customer_favorites.read"

Topic: Customers

Arguments

customer_id: String

Show only favorites of a certain customer


last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: FavoriteSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


type: FavoriteType

Filter favorites by a type


Result

CustomerFavoritePage

Preview (typescript)

Loading module