Get Merchant List

This endpoint allows to get merchants list available to a customer.

Request

GET <API base url>/customers/{customerId}/merchants

URL query parameters

Name	Type	Required	Description
language	string	yes	Two letter language code according to ISO 639-1
query	string	no	Search query
isFavorite	bool	no	If specified, only merchants are added to favorite by customer are shown
categories	string[]	no	Filter by one or multiple categories: retail, automobile, electronics, shopping, kids, pets , wellness, wineAndDine, travel, entertainmentAndSport, education, taxi, repair, utilities, visa, banks, others
settlements	string[]	no	If specified, only merchants with locations in specified settlements are shown // deprecated
regionIds	uint64[]	no	If specified, only merchants with offers in specified regions are shown
skip	uint32	no	Paging support: number of records to skip
take	uint32	no	Paging support: number of records to return
showArchived	boolean	no	If specified, merchants with ended offers are included

Response

On success:

{
  "value": {
    "totalCount": required number,
    "data": required array of {
      "id": required number,
      "marketName": required string,
      "logo": optional string (as URL),
      "isFavorite": required boolean,
      "recentOffer": required {
        "announcedFrom": required date,
        "receivedAt": required date
      },
      "offers": required {
        "totalCount": required number
      },
        "activeOfferCount": required number,
        "category": optional string,
        "regions": optional array {
          "id": required number,
          "name": required string,
          "geometry": optional string
        }
    }
  }
}