Quandoo Merchants API

openapi: 3.0.3
info:
  title: Quandoo Public Partner Availabilities Merchants API
  description: The Quandoo Public Partner API is a multi-purpose REST API for the Quandoo restaurant reservations platform. It lets partners check merchant availability, search merchants, read merchant reservation and enquiry settings, create and manage reservations and reservation enquiries, manage customers and reviews, handle preorders and reservation tags, and validate phone numbers. Reservation and enquiry creation is idempotent via an agent-specific unique identifier. Derived from the official Quandoo Swagger specification at https://api.quandoo.com/swagger.json.
  version: 1.0.0
  contact:
    name: Quandoo Developers
    email: developers@quandoo.com
    url: https://docs.quandoo.com/
servers:
- url: https://public-api.prod.quandoo.com
  description: Production
security:
- API_TOKEN: []
tags:
- name: Merchants
paths:
  /v1/merchants/{merchantId}/similar:
    get:
      tags:
      - Merchants
      summary: Quandoo Allows to Get a Merchant by Id and Find Similar Merchants
      operationId: searchSimilar_1
      description: "This endpoint allows to receive detailed information for a particular merchant in the system and for restaurants that are similar to this one.\nA merchant is similar if all the following conditions are met:\n1. Location: the recommended merchants are within 30 km radius from the main merchant\n2. The similar merchants are bookable online\n3. The similar merchants have the main cuisine in common\n\nThis merchant should be specified by their identifier **merchantId**, which is mandatory.\nThe endpoint can take optional request header **Accept-Language**.\nThis header is used to determine correct locale and has an effect on translation of merchant's entity fields, that may be omitted.\n\nThe 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\".\n\nThe endpoint returns status `HTTP 200` if the request is successful. In a successful requests the specified merchant was found.\n\nIf the merchant has no products allowed for a web search, i.e. is not bookable, response data with `HTTP 200` is returned, but the field `merchant` is not set. Instead, the merchant search message is set.\n\nThe endpoint will return status `HTTP 404` if the merchant, specified by identifier, was not found.\n\nExample curl:\n```\ncurl  -H 'X-Quandoo-AuthToken: {INSERT_KEY_HERE}' -H 'Accept-Language: de_DE' 'https://{host}/v{X}/merchants/11/similar'\n```\n\nExample responses:\n`merchant bookable`\n```\n{\n    \"merchant\": {\n        \"id\":11,\n        \"name\":\"Test merchant\",\n        \"phoneNumber\":\"+27113901837\",\n        \"currency\":\"ZAR\",\n        \"locale\":\"en_ZA\",\n        \"timezone\":\"Africa/Johannesburg\",\n        \"location\":{\n            \"coordinates\":{\n                \"latitude\":33.9,\n                \"longitude\":18.4\n            },\n            \"address\":{\n                \"street\":\"Tamerlan street\",\n                \"number\":\"6A\",\n                \"zipcode\":\"10787\",\n                \"city\":\"Cape Town\",\n                \"country\":\"ZAF\"\n            }\n        },\n        \"reviewScore\": \"5.3\",\n        \"tagGroups\":[\n            {\n                \"type\":\"CUISINE\",\n                \"tags\":[\n                    {\n                        \"id\":25,\n                        \"name\":\"Testküche Hauptkategorie\"\n                    },\n                    {\n                        \"id\":28,\n                        \"name\":\"Test cuisine\"\n                    }\n                ]\n            }\n        ],\n        \"images\":[\n            {\n                \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\"\n            }\n        ],\n        \"documents\":[],\n        \"links\":[\n            {\n                \"href\":\"https://{host}/{path}?aid=16\",\n                \"method\":\"GET\",\n                \"rel\":\"DETAILS\"\n            },\n            {\n                \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\",\n                \"method\":\"GET\",\n                \"rel\":\"WIDGET\"\n            },\n            {\n                \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\",\n                \"method\":\"GET\",\n                \"rel\":\"WIDGET_DETAILS\"\n            }\n        ],\n        \"bookable\": true,\n        \"openingTimes\": {\n          \"standardOpeningTimes\": {\n            \"SATURDAY\": [\n              {\n                \"start\": \"09:00:00\",\n                \"end\": \"20:00:00\"\n              }\n            ],\n            \"SUNDAY\": [\n              {\n                \"start\": \"09:00:00\",\n                \"end\": \"18:00:00\"\n              }\n            ]\n          }\n        },\n        \"ccvEnabled\": true,\n        \"chain\": {\n           \"id\": 1,\n           \"name\": \"Test chain\"\n        }\n    },\n   \"recommendedMerchants\": {\n        \"merchants\": [\n            {\n                \"id\":12,\n                \"name\":\"similar merchant\",\n                \"phoneNumber\":\"+27113901838\",\n                \"currency\":\"ZAR\",\n                \"locale\":\"en_ZA\",\n                \"timezone\":\"Africa/Johannesburg\",\n                \"location\":{\n                    \"coordinates\":{\n                        \"latitude\":33.8,\n                        \"longitude\":18.4\n                    },\n                    \"address\":{\n                        \"street\":\"Tamerlan street\",\n                        \"number\":\"5A\",\n                        \"zipcode\":\"10787\",\n                        \"city\":\"Cape Town\",\n                        \"country\":\"ZAF\"\n                    }\n                },\n                \"reviewScore\": \"5.3\",\n                \"tagGroups\":[\n                    {\n                        \"type\":\"CUISINE\",\n                        \"tags\":[\n                            {\n                                \"id\":25,\n                                \"name\":\"Testküche Hauptkategorie\"\n                            },\n                            {\n                                \"id\":28,\n                                \"name\":\"Test cuisine\"\n                            }\n                        ]\n                    }\n                ],\n                \"images\":[\n                    {\n                        \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\"\n                    }\n                ],\n                \"documents\":[],\n                \"links\":[\n                    {\n                        \"href\":\"https://{host}/{path}?aid=16\",\n                        \"method\":\"GET\",\n                        \"rel\":\"DETAILS\"\n                    },\n                    {\n                        \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\",\n                        \"method\":\"GET\",\n                        \"rel\":\"WIDGET\"\n                    },\n                    {\n                        \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\",\n                        \"method\":\"GET\",\n                        \"rel\":\"WIDGET_DETAILS\"\n                    }\n                ],\n                \"bookable\": true,\n                \"openingTimes\": {\n                  \"standardOpeningTimes\": {\n                    \"SATURDAY\": [\n                      {\n                        \"start\": \"09:00:00\",\n                        \"end\": \"20:00:00\"\n                      }\n                    ],\n                    \"SUNDAY\": [\n                      {\n                        \"start\": \"09:00:00\",\n                        \"end\": \"18:00:00\"\n                      }\n                    ]\n                  }\n                },\n                \"ccvEnabled\": true,\n                \"chain\": {\n                   \"id\": 1,\n                   \"name\": \"Test chain\"\n                }\n            }\n        ],\n        \"size\": 1,\n        \"offset\": 0,\n        \"limit\": 10\n    }\n}\n```\n\n`merchant not bookable`\n```\n{\n    \"merchantSearchMessage\": \"MERCHANT_NOT_BOOKABLE\",\n    \"recommendedMerchants\": {\n        \"limit\": 10,\n        \"merchants\": [...],\n        \"offset\": 0,\n        \"size\": 0\n    }\n}\n```"
      parameters:
      - name: merchantId
        in: path
        required: true
        description: merchantId
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        required: false
        description: Sort order. Default sorting will be by proximity.
        schema:
          type: string
          enum:
          - CLOSEST
          default: CLOSEST
      - name: limit
        in: query
        required: false
        description: Max number of merchant recommendations to return.
        schema:
          type: integer
          format: int32
          default: 10
      - name: Accept-Language
        in: header
        required: false
        description: Locale.<br>Format:<br>&lt;language code&gt;[_&lt;country code&gt;]
        schema:
          type: string
          default: en_GB
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantWithRecommendationsDto'
              examples:
                SearchSimilar1200Example:
                  summary: Default searchSimilar_1 200 response
                  x-microcks-default: true
                  value:
                    merchant:
                      id: 1
                      name: Sample Restaurant
                      phoneNumber: 030120765890
                      currency: EUR
                      locale: de_DE
                      timezone: 70200
                      location: {}
                      reviewScore: string
                      tagGroups:
                      - {}
                      images:
                      - {}
                      documents:
                      - {}
                      links:
                      - {}
                      bookable: true
                      openingTimes: {}
                      ccvEnabled: true
                      chain: {}
                      ivrRedirectNumber: string
                      shortDescription: Window table preferred if available.
                      longDescription: Window table preferred if available.
                    merchantSearchMessage: MERCHANT_NOT_BOOKABLE
                    recommendedMerchants:
                      merchants:
                      - {}
                      size: 1
                      offset: 1
                      limit: 1
        '404':
          description: Merchant not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                SearchSimilar1404Example:
                  summary: Default searchSimilar_1 404 response
                  x-microcks-default: true
                  value:
                    errorType: BAD_REQUEST_ERROR
                    errorMessage: Window table preferred if available.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/merchants/{merchantId}:
    get:
      tags:
      - Merchants
      summary: Quandoo Allows to Get a Merchant by Id
      operationId: search_2
      description: "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.\n\nThe 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\".\n\nThe endpoint returns status `HTTP 200` if the request is successful.\nThe endpoint will return status `HTTP 404` if the merchant, specified by identifier, was not found or has no products, allowed for a web search. \n\nExample curl:\n```\ncurl  -H 'X-Quandoo-AuthToken: {INSERT_KEY_HERE}' -H 'Accept-Language: de_DE' 'https://{host}/v{X}/merchants/11'\n```\n\nExample response:\n```\n{\n    \"id\":11,\n    \"name\":\"Test merchant\",\n    \"phoneNumber\":\"+27113901837\",\n    \"currency\":\"ZAR\",\n    \"locale\":\"en_ZA\",\n    \"timezone\":\"Africa/Johannesburg\",\n    \"location\":{\n        \"coordinates\":{\n            \"latitude\":33.9,\n            \"longitude\":18.4\n        },\n        \"address\":{\n            \"street\":\"Tamerlan street\",\n            \"number\":\"6A\",\n            \"zipcode\":\"10787\",\n            \"city\":\"Cape Town\",\n            \"country\":\"ZAF\"\n        }\n    },\n    \"reviewScore\": \"5.3\",\n    \"tagGroups\":[\n        {\n            \"type\":\"CUISINE\",\n            \"tags\":[\n                {\n                    \"id\":25,\n                    \"name\":\"Testküche Hauptkategorie\"\n                },\n                {\n                    \"id\":28,\n                    \"name\":\"Test cuisine\"\n                }\n            ]\n        }\n    ],\n    \"images\":[\n        {\n            \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\"\n        }\n    ],\n    \"documents\":[],\n    \"links\":[\n        {\n            \"href\":\"https://{host}/{path}?aid=16\",\n            \"method\":\"GET\",\n            \"rel\":\"DETAILS\"\n        },\n        {\n            \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\",\n            \"method\":\"GET\",\n            \"rel\":\"WIDGET\"\n        },\n        {\n            \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\",\n            \"method\":\"GET\",\n            \"rel\":\"WIDGET_DETAILS\"\n        }\n    ],\n    \"bookable\": true,\n    \"openingTimes\": {\n      \"standardOpeningTimes\": {\n        \"SATURDAY\": [\n          {\n            \"start\": \"09:00:00\",\n            \"end\": \"20:00:00\"\n          }\n        ],\n        \"SUNDAY\": [\n          {\n            \"start\": \"09:00:00\",\n            \"end\": \"18:00:00\"\n          }\n        ]\n      }\n    },\n    \"ccvEnabled\": true,\n    \"chain\": {\n       \"id\": 1,\n       \"name\": \"Test chain\"\n    }\n}\n```"
      parameters:
      - name: merchantId
        in: path
        required: true
        description: merchantId
        schema:
          type: integer
          format: int32
      - name: Accept-Language
        in: header
        required: false
        description: Locale.<br>Format:<br>&lt;language code&gt;[_&lt;country code&gt;]
        schema:
          type: string
          default: en_GB
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantDetailsDto'
              examples:
                Search2200Example:
                  summary: Default search_2 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Sample Restaurant
                    phoneNumber: 030120765890
                    currency: EUR
                    locale: de_DE
                    timezone: 70200
                    location:
                      coordinates: {}
                      address: {}
                    reviewScore: string
                    tagGroups:
                    - type: {}
                      tags: {}
                    images:
                    - url: {}
                    documents:
                    - name: {}
                      url: {}
                      format: {}
                      description: {}
                    links:
                    - href: {}
                      method: {}
                      rel: {}
                    bookable: true
                    openingTimes:
                      standardOpeningTimes: {}
                    ccvEnabled: true
                    chain:
                      id: 1
                      name: Sample Restaurant
                    ivrRedirectNumber: string
                    shortDescription: Window table preferred if available.
                    longDescription: Window table preferred if available.
        '404':
          description: Merchant not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Search2404Example:
                  summary: Default search_2 404 response
                  x-microcks-default: true
                  value:
                    errorType: BAD_REQUEST_ERROR
                    errorMessage: Window table preferred if available.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/merchants:
    get:
      tags:
      - Merchants
      summary: Quandoo Allows to Get Merchant Information by Parameters
      operationId: search
      description: "###Description\n\nThis endpoint is used to search merchants by a set of parameters.\nFor each merchant in the result there is information about location, language and tags that describe this merchant's basic characteristics, there is also a set of images selected by the merchant.\n\n####Possible query parameters:\n\n##Mandatory geo parameters (at least one of two options must be provided)\n\n* **place**: Filter for merchant on a country, city or district whose name matches the parameter. (if the parameter does not match any city or district on the system it is ignored)\n* **centerPoint**: Filter merchants within the circle defined by center on centerPoint and radius defined by radius parameter (if not informed defaults to 10). Center point has the format LATITUDE,LONGITUDE with both parameters as numbers with . as decimal separator (e.g `centerPoint=52.547928,13.4085728`)\n\n* **query**: Filter merchants using text similarity on a number of merchant fields like name, description, categories and tags\n* **placeIds**: DEPRECATED. Filter for merchant by id of place. Semicolon separated integer value.\n* **radius**: The radius of the circle to filter merchants in **kilometers**. Defaults to 10 and is only used if *centerPoint* is also informed\n* **bookable**: Boolean value, if informed true means that only merchants that are online bookable will be returned and false means that only merchants that are NOT online bookable will be returned\n* **tags**: Filter out merchants with the selected tags text. Semicolon separated text value. All or nothing field: if a tag is not found, the query will fail. Cannot be used in conjunction with 'tagIds' parameter.\n* **tagIds**: Filter out merchants with the selected tag ids. Semicolon separated text value. All or nothing field: if a tag is not found, the query will fail. Cannot be used in conjunction with 'tags' parameter.\n* **reviewScoreMax**: Filter out merchants with review score higher than the one informed.\n* **onlyWithAttributes**: This field only accepts the value **documents** for now. If informed only merchants with documents will be returned. You need to have required permissions to use this filter\n* **capacity**: Number of people. In order to be effective, \"place\", \"date\" and \"fromTime\" must also be set.\n* **date**: Date of the desired reservation in merchants' time zone. Format: yyyy-MM-dd. Availability search is only activated if \"place\" is specified.\n* **fromTime**: Beginning of the desired reservation time frame in merchants' time zone. Format: HH:mm. Consider a 3h buffer for the time (0.5h before the given time and 2.5h after)\n* **offset**: Number of merchants to skip on the result. Defaults to 0\n* **limit**: Maximum number of merchants to return. Defaults to 100 and cannot be more than 100.\n* **ivrNumber**: Filter out merchants with phone number.\n\n\n####Result fields for Merchant object:\n\n* **id**: Id of the merchant\n* **name**: Name of the merchant\n* **phoneNumber**: The phone number of the merchant\n* **currency**: Currency of the merchant in the ISO 4217 letter format\n* **locale**: Locale used to communicate with this merchant\n* **timezone**: Canonical Timezone name\n* **location**: Location of the merchant, contains both an geo located point and an address if available\n* **reviewScore**: Review score of the merchant\n* **tagGroups**: Tags (grouped) about relevant merchant characteristics\n* **images**: Group of images selected by the merchant\n* **documents**: Group of documents released by this merchant (e.g seasonal menus )\n* **links**: Links for other pages or api operations for this merchant\n* **bookable**: The flag indicates whether the merchant is bookable or not\n* **openingTimes**: Group of opening times: restaurant opening times for this merchant. Time range beginning may be greater than the end time of the range, when this range goes beyond the day when it was started, e.g. 19:00:00 - 02:00:00\n* **ccvEnabled**: If true, credit card information is required when creating a reservation\n* **chain**: Merchant chain information, if any\n* **ivrRedirectNumber**: The IVR forwarding phone number, requires permission\n* **shortDescription**: Merchant short description, requires permission\n* **longDescription**: Merchant long description, requires permission\n\n\n###Authenticated use of the api:\n* Field `documents` is only accessible for authorized callers and will be empty otherwise.\n* Queries with parameter `onlyWithAttributes` are only allowed for authorized callers and will return `HTTP 403` for unauthorized requests\n\n#####How?\nIn order to make an authenticated call the caller must send a header name `X-Quandoo-AuthToken` with the token obtained from contact with Quandoo.\n\n###Pagination of the result:\n\nThe result contains the fields `size` with the number of all merchants that matched the informed parameters, `offset` and `limit` defining which merchants from the complete list are on this response,\nand the caller can use query parameters `offset` and `limit` to get different merchants on the result list\n\n###Examples:\n\nExample curl:\n```\ncurl -H 'X-Quandoo-AuthToken: INSERT_KEY_HERE' 'https://{host}/v{X}/merchants?query=Zim&place=Berlin&amp;centerPoint=52.5479288%2C13.4085728&radius=10&bookable=true&reviewScoreMax=200&onlyWithAttributes=documents&offset=0&limit=100'\n```\n\nExample response:\n```\n{\n  \"merchants\": [\n    {\n      \"id\": 215,\n      \"name\": \"a-merchant-Zim\",\n      \"phoneNumber\": \"+49153153153\",\n      \"currency\": \"EUR\",\n      \"locale\": \"de_DE\",\n      \"timezone\": \"Europe/Berlin\",\n      \"location\": {\n        \"coordinates\": {\n          \"latitude\": 55,\n          \"longitude\": 12\n        },\n        \"address\": {}\n      },\n      \"reviewScore\": \"5.3\",\n      \"tagGroups\": [\n        {\n          \"type\": \"CUISINE\",\n          \"tags\": [\n            {\n              \"id\": 63,\n              \"name\": \"Testküche Hauptkategorie\"\n            },\n            {\n              \"id\": 66,\n              \"name\": \"Test cuisine\"\n            }\n          ]\n        }\n      ],\n      \"images\": [],\n      \"documents\": [\n        {\n          \"name\": \"Main Menu\",\n          \"url\": \"https://d2s6u6f7snurg9.cloudfront.net/partner/uploads/MD-document-3ec1dc15-1b69-463f-bdd2-c060b9bf844d.pdf\",\n          \"format\": \"pdf\",\n          \"description\": \"Seasonal Main Menu\"\n        }\n      ],\n      \"links\": [\n        {\n          \"href\": \"https://{host}/{path}?aid=16\",\n          \"method\": \"GET\",\n          \"rel\": \"DETAILS\"\n        },\n        {\n          \"href\": \"https://{host}/{path}?aid=16&countryId=NLD\",\n          \"method\": \"GET\",\n          \"rel\": \"WIDGET\"\n        },\n        {\n          \"href\": \"https://{host}/{path}/details?aid=16&countryId=NLD\",\n          \"method\": \"GET\",\n          \"rel\": \"WIDGET_DETAILS\"\n        }\n      ],\n      \"bookable\": true,\n      \"ccvEnabled\": true,\n      \"chain\": {\n        \"id\": 1,\n        \"name\": \"Test chain\"\n      },\n      \"ivrRedirectNumber\": \"+49153153153\",\n      \"shortDescription\": \"Test short description\",\n      \"longDescription\": \"Test long description\",\n    },\n    {\n      \"id\": 219,\n      \"name\": \"another merchants Zim\",\n      \"phoneNumber\": \"+49154154154\",\n      \"currency\": \"EUR\",\n      \"locale\": \"de_DE\",\n      \"timezone\": \"Europe/Berlin\",\n      \"location\": {\n        \"coordinates\": {\n          \"latitude\": 52,\n          \"longitude\": 13\n        },\n        \"address\": {\n          \"street\": \"Wintersteinstr.\",\n          \"number\": \"15\",\n          \"zipcode\": \"10587\",\n          \"city\": \"Berlin\",\n          \"country\": \"DEU\"\n        }\n      },\n      \"reviewScore\": \"4.7\",      \n      \"tagGroups\": [\n        {\n          \"type\": \"CUISINE\",\n          \"tags\": [\n            {\n              \"id\": 79,\n              \"name\": \"Testküche Hauptkategorie\"\n            },\n            {\n              \"id\": 82,\n              \"name\": \"Test Japanese\"\n            }\n          ]\n        },\n        {\n          \"type\": \"PRICE\",\n          \"tags\": [\n            {\n              \"id\": 84,\n              \"name\": \"Test expensive\"\n            }\n          ]\n        }\n      ],\n      \"images\": [\n        {\n          \"url\": \"https://dci5ez2ey8tr9.cloudfront.net/1482eec7-e585-4821-b096-8a9941e0d2eb/25_sld.jpg\"\n        }\n      ],\n      \"documents\": [],\n      \"links\": [\n        {\n          \"href\": \"https://{host}/{path}?aid=16\",\n          \"method\": \"GET\",\n          \"rel\": \"DETAILS\"\n        },\n        {\n          \"href\": \"https://{host}/{path}?aid=16&countryId=NLD\",\n          \"method\": \"GET\",\n          \"rel\": \"WIDGET\"\n        },\n        {\n          \"href\": \"https://{host}/{path}/details?aid=16&countryId=NLD\",\n          \"method\": \"GET\",\n          \"rel\": \"WIDGET_DETAILS\"\n        }\n      ],\n      \"bookable\": true,\n      \"openingTimes\": {\n        \"standardOpeningTimes\": {\n          \"SATURDAY\": [\n            {\n              \"start\": \"09:00:00\",\n              \"end\": \"20:00:00\"\n            }\n          ],\n          \"SUNDAY\": [\n            {\n              \"start\": \"09:00:00\",\n              \"end\": \"18:00:00\"\n            }\n          ]\n        }\n      },\n      \"ccvEnabled\": true,\n      \"chain\": {\n        \"id\": 1,\n        \"name\": \"Test chain\"\n      },\n      \"ivrRedirectNumber\": \"+49153153153\",\n      \"shortDescription\": \"Test short description\",\n      \"longDescription\": \"Test long description\",\n    }\n  ],\n  \"size\": 2,\n  \"offset\": 0,\n  \"limit\": 100\n}\n```"
      parameters:
      - name: query
        in: query
        required: false
        description: Search query for a merchant name
        schema:
          type: string
      - name: place
        in: query
        required: false
        description: 'Search query for a place (country, city or district) name: the most relevant places, if any, are taken as a filter'
        schema:
          type: string
      - name: placeIds
        in: query
        required: false
        description: DEPRECATED. Filter by place found by id. Semicolon separated.
        schema:
          type: string
      - name: centerPoint
        in: query
        required: false
        description: Search with coordinates and radius. "radius" argument can be set, otherwise default value of 10 km will be used.<br>Format:<br>53.1222,13.0303<br>where latitude=53.1222, longitude=13.0303
        schema:
          type: string
      - name: radius
        in: query
        required: false
        description: Radius for coordinate-based search
        schema:
          type: integer
          format: int32
          default: 10
      - name: bookable
        in: query
        required: false
        description: Filter only bookable merchants
        schema:
          type: boolean
      - name: tags
        in: query
        required: false
        description: 'Filter by tags found by text. The value can be either in English or in the specific locale. Semicolon separated. All or nothing behaviour: if one single tag is not found, the whole request fails. Cannot be used in combination with ''groupedTagIds'' parameter.'
        schema:
          type: string
      - name: tagIds
        in: query
        required: false
        description: 'Filter by tags found by id. Semicolon separated. All or nothing behaviour: if one single tag id is not found, the whole request fails. Cannot be used in combination with ''tags'' parameter.'
        schema:
          type: string
      - name: reviewScoreMax
        in: query
        required: false
        description: Filter by max review score (100 - 600)
        schema:
          type: integer
          format: int32
      - name: onlyWithAttributes
        in: query
        required: false
        description: Search with attributes specified only. Attribute "documents" is currently supported, requires permission
        schema:
          type: string
      - name: capacity
        in: query
        required: true
        description: Number of people. In order to be effective, "date" and "fromTime" must also be set.
        schema:
          type: integer
          format: int32
          default: 2
      - name: date
        in: query
        required: false
        description: 'Date of the desired reservation in merchants'' time zone. Format: yyyy-MM-dd. Availability search is only activated if "place" is specified.'
        schema:
          type: string
          format: date
      - name: fromTime
        in: query
        required: false
        description: 'Beginning of the desired reservation time frame in merchants'' time zone. Format: HH:mm. Consider a 3h buffer for the time (0.5h before the given time and 2.5h after)'
        schema:
          type: string
      - name: offset
        in: query
        required: false
        description: offset
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        required: false
        description: limit
        schema:
          type: integer
          format: int32
          default: 100
      - name: Accept-Language
        in: header
        required: false
        description: language
        schema:
          type: string
      - name: ivrNumber
        in: query
        required: false
        description: ivrNumber
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantDetailsDtoList'
              examples:
                Search200Example:
                  summary: Default search 200 response
                  x-microcks-default: true
                  value:
                    merchants:
                    - id: {}
                      name: {}
                      phoneNumber: {}
                      currency: {}
                      locale: {}
                      timezone: {}
                      location: {}
                      reviewScore: {}
                      tagGroups: {}
                      images: {}
                      documents: {}
                      links: {}
                      bookable: {}
                      openingTimes: {}
                      ccvEnabled: {}
                      chain: {}
                      ivrRedirectNumber: {}
                      shortDescription: {}
                      longDescription: {}
                    size: 1
                    offset: 1
                    limit: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Search400Example:
                  summary: Default search 400 response
               

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/quandoo/refs/heads/main/openapi/quandoo-merchants-api-openapi.yml