Get Merchant by Id

This endpoint allows to get merchant information with list of offers available to a customer.

Request

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

URL query parameters

Name	Type	Required	Description
language	string	yes	Two letter language code according to ISO 639-1
showArchived	boolean	no	If specified, ended offers are included

Response

On success:

{
  "value": {
    "id": required number,
    "marketName": required string,
    "logo": optional string (as URL),
    "images": optional string[] (as URL),
    "legalName": required string,
    "about": optional string,
    "isFavorite": required boolean,
    "phones": optional string,
    "emails": optional string,
    "website": optional string,
    "isOnline": required boolean,
    "fbLink": optional string,
    "vkLink": optional string,
    "instagramLink": optional string,
    "buttonText": optional string,
    "buttonUrl": optional string,
    "category": optional string,
    "recentOffer": required {
      "announcedFrom": required date,
      "receivedAt": required date
    },
    "locations": optional array of {
      "name": optional string,
      "images": optional string[] (as URL),
      "phones": optional string,
      "address": optional string,
      "lon": required double - longitude,
      "lat": required double - latitude,
      "schedule": optional string
    },
    "regions": optional array {
        "id": required number,
        "name": required string,
        "geometry": optional string
    },
    "offers": required {
      "totalCount": required number,
      "data": required array of {
        "id": required number,
        "type": required string (one of - offer, privilege)
        "category": optional string,
        "isOnline": optional boolean,
        "averageCheck": optional string,
        "startDate": optional string (date in format YYYY-MM-DD),
        "endDate": optional string (date in format YYYY-MM-DD),
        "announcedFrom": required date,
        "receivedAt": required date,
        "likesCount": optional number,
        "isLiked": optional boolean,
        "ad": optional {
          "languageCode": required string,
          "name": required string,
          "description": optional string,
          "rewardText": optional string,
          "image": optional string (as URL)
        },
        "stats": required {
          "likeCount": required number,
          "offerRewardLimit": optional number,
          "customerRewardLimit": optional number,
          "offerRewardCount": required number,
          "customerRewardCount": required number,
          "customerSpentRewardCount": required number
        },
        "reward": {
          "type": optional string (one of - discount, gift, certificate, plusX, etc.),
          "certificate": optional {
            "provider": required string,
            "id": optional string // Deprecated. Will be deleted from 01 Jan 2024,
            "ids": optional array of string,
            "value": optional number
          },
          "limit": optional {
            "used": required number,
            "max": required number
          }
        },
        "conditions": optional {
          "type": required string (one of - none, offersAccumulation, transactionsAccumulation),
          "targetCount": optional number,
          "targetAmount": optional number,
        },
        "progress": optional {
          "currentCount": optional number,
          "currentAmount": optional number,
        },
        "regions": optional array {
          "id": required number,
          "name": required string,
          "geometry": optional string
        },
        "marketWide": required boolean
      }
    },
    "activeOfferCount": required number,
  }
}