latestSwagger 2.02026-08-172560124.6 KB

6863a5956792

merchants

Allows to get a merchant by id

This endpoint allows to receive detailed information on a particular merchant in the system. This merchant should be specified by their identifier merchantId, which is mandatory. The endpoint can take optional request header Accept-Language. This header is used to determine correct locale and has an effect on translation of merchant's entity fields, that may be omitted.

The expected value of the header Accept-Language should contain language and can contain country, e.g. "de_DE" or "de". Locale by default is "en_GB".

The endpoint returns status HTTP 200 if the request is successful. The endpoint will return status HTTP 404 if the merchant, specified by identifier, was not found or has no products, allowed for a web search.

Example curl:

curl  -H 'X-Quandoo-AuthToken: {INSERT_KEY_HERE}' -H 'Accept-Language: de_DE' 'https://{host}/v{X}/merchants/11'

Example response:

{
    "id":11,
    "name":"Test merchant",
    "phoneNumber":"+27113901837",
    "currency":"ZAR",
    "locale":"en_ZA",
    "timezone":"Africa/Johannesburg",
    "location":{
        "coordinates":{
            "latitude":33.9,
            "longitude":18.4
        },
        "address":{
            "street":"Tamerlan street",
            "number":"6A",
            "zipcode":"10787",
            "city":"Cape Town",
            "country":"ZAF"
        }
    },
    "reviewScore": "5.3",
    "tagGroups":[
        {
            "type":"CUISINE",
            "tags":[
                {
                    "id":25,
                    "name":"Testküche Hauptkategorie"
                },
                {
                    "id":28,
                    "name":"Test cuisine"
                }
            ]
        }
    ],
    "images":[
        {
            "url":"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg"
        }
    ],
    "documents":[],
    "links":[
        {
            "href":"https://{host}/{path}?aid=16",
            "method":"GET",
            "rel":"DETAILS"
        },
        {
            "href":"https://{host}/{path}?aid=16&countryId=NLD",
            "method":"GET",
            "rel":"WIDGET"
        },
        {
            "href":"https://{host}/{path}/details?aid=16&countryId=NLD",
            "method":"GET",
            "rel":"WIDGET_DETAILS"
        }
    ],
    "bookable": true,
    "openingTimes": {
      "standardOpeningTimes": {
        "SATURDAY": [
          {
            "start": "09:00:00",
            "end": "20:00:00"
          }
        ],
        "SUNDAY": [
          {
            "start": "09:00:00",
            "end": "18:00:00"
          }
        ]
      }
    },
    "ccvEnabled": true,
    "chain": {
       "id": 1,
       "name": "Test chain"
    }
}
get/v1/merchants/{merchantId}

Path parameters

merchantIdinteger required

merchantId

Headers

Accept-Languagestring

Locale.<br>Format:<br><language code>[_<country code>]

Response

OK

idinteger required

The id of the merchant.

namestring required

The name of the merchant.

phoneNumberstring required

The phone number of the merchant.

currencystring

The currency of the merchant.

localestring

The locale of the merchant.

timezonestring required

The timezone of the merchant.

reviewScorestring required

The review score of the merchant.

bookableboolean required

The flag indicates whether the merchant is bookable or not.

ccvEnabledboolean required

If true, credit card information is required when creating a reservation.

ivrRedirectNumberstring

The IVR forwarding phone number, requires permission.

shortDescriptionstring

Merchant short description, requires permission.

longDescriptionstring

Merchant long description, requires permission.