GET:favorites/page.json

Description

Get all favorites of a given shop.

See also: Pagination.

Permission bit: "customer_favorites.read"

Topic: Customers

Query Parameters

customer_id: String

Show only favorites of a certain customer

Example: ?customer_id=str

last_key: String

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

Example: ?last_key=str

limit: Int

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

Example: ?limit=5

offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: FavoriteSortBy

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

Example: ?sort_by=created_at

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true

type: FavoriteType

Filter favorites by a type

Example: ?type=inventory

Response Body

CustomerFavoritePage

Response Body Type

Loading module