For guides on how to actually implement MRS, see Getting Started.
This page contains the openAPI technical documentation for MRS.
You can either download the full detailed HTML and YAML files in the .zip file below, or you can browse a shortened version on this page as a quick reference. The shortened version does not include sample requests or other details, so downloading the full openAPI spec zip file below is recommended.
See the clearResponse property for options on how MRS can respond when a merchant has not been identified. If clearResponse is explicitly set to false and a merchant is not found, an empty array will be returned.
A JSON object containing the following properties.
In the /merchant/list and /merchant endpoints, the 'X-Request-Id' and 'X-Timestamp' headers are returned. In order to submit a crowdsourcing request, you must store these values and send them in the 'requestId' and 'requestTimstamp' fields.
If the report is in relation to a transaction in a /merchant/list request, you must also include the 'transactionId' field of that transaction.
requestId*string
You must send us the value of the X-Request-Id header you received from us.
requestTimestamp*number
You must send us the value of the X-Timestamp header you recieved from us. We supply this as a string in the header, but you must convert it to a number before sending it back to us.
transactionIdstring
If the request that's being reported was a list request, you must also provide the ID of that specific transaction that you provided in the list request so that we know what transaction in the request the report is reffering to
wrongFieldsarray of enum
Array of strings. Specifies which field(s) are wrong and thus caused the report. This array is optional, unless you are sending suggestions, see below.
If “name” is identified as incorrect in wrongFields, “name” or “place_id” must be provided via Suggestions.
If “img” is identified as incorrect in wrongFields, “img” or “place_id” must be provided via Suggestions.
If “address” is identified as incorrect in wrongFields, “address”, “position” or “place_id” must be provided via Suggestions.
If “position” is identified as incorrect in wrongFields, “position”, “address” or “place_id” must be provided via Suggestions.
If “place_id” is identified as incorrect in wrongFields, “place_id” must be provided via Suggestions.
commentsstring
Pass the user comments on this crowdsourcing report
suggestionsobject
Response
Confirmation that the report was inserted correctly
A JSON object containing the following properties, as well as an array of transactions. Each transaction must have a unique id property, which is used to identify the transaction in the response.
The id only has to be unique for this request, and can be any string. You could use the numeric index of the transaction in the transaction array, generate a unique UUID then and there for each transaction, etc
This id is required when submitting crowdsourcing reports, as it is used to identify the transaction within the request.
The other parameters for each transaction are the same as the individual /v3/merchant request above.
List requests are recommended to contain 25 or less elements. Requests with higher amounts can be supported. Very long lists might have an impact on response times.
Please contact us with any questions on this.
type*enum
extendedrestrictive
logo_sizeenum
2x1x
defaultLogoboolean
languagestring
additionalInfoboolean
clearResponseboolean
transactions*array of object
Response
A JSON object containing one property per transaction sent.
The keys of this object are the ID that was provided, previously passed in as the "id" property in each transaction array element.
The value of this property is the array of merchants that were found when searching for that specific transaction
{"id": [ {"name":"text","website":"text","position": {"type":"Point","coordinates": [0 ] },"img":"text","logoImg":"text","categoryImg":"text","logoScore":0,"address":"text","postal_code":"text","street_number":"text","route":"text","locality":"text","administrative_area_level_1":"text","administrative_area_level_2":"text","country":"text","phone":"text","rating":4.1,"reviews": [ {"author_name":"A Google User","author_url":"text","profile_photo_url":"text","language":"text","original_language":"text","rating":0,"relative_time_description":"text","text":"text","time":0,"translated":false } ],"opening_hours": {"open_now":false,"periods": [ {"open": {"date":"text","day":0,"time":1700,"truncated":false },"close": {"date":"text","day":0,"time":1700,"truncated":false } } ],"special_days": [ {"date":"text","exceptional_hours":false } ],"type":"text","weekday_text": ["Monday: 9:00 AM – 5:00 PM","Tuesday: 9:00 AM – 5:00 PM","Wednesday: 9:00 AM – 5:00 PM","Thursday: 9:00 AM – 5:00 PM","Friday: 9:00 AM – 5:00 PM","Saturday: Closed","Sunday: Closed" ] },"price_level":0,"place_id":"ChIJN1t_tDeuEmsRUsoyG83frY4","category":"text","categories": ["text" ],"intermediary": {"name":"Paypal","website":"https://www.paypal.com","img":"https://storage.googleapis.com/production-mrs-tm-logos/6273e53abb09494554c93872_2x.png" },"isClearResponse":false,"cachePolicy": {"name":"Google","website":"Google","position":"Google","img":"Google","logoImg":"Google","categoryImg":"Google","logoScore":"Google","address":"Google","postal_code":"Google","street_number":"Google","route":"Google","administrative_area_level_1":"Google","administrative_area_level_2":"Google","country":"Google","phone":"Google","opening_hours":"Google","place_id":"Google","category":"Google","categories":"Google","isClearResponse":"MRS" },"brand": {"id":"64b70cd0584b4b1e7ebcf35d","name":"Carrefour Express","img":"https://storage.googleapis.com/production-mrs-brand-logos/6273e357bb09494554c92a5a_2x.png","website":"http://www.carrefour.com/","esg": {"participations": [ {"id":"630561c28c48c27179d0db9b","name":"United Nations Sustainable Development Goals", "description": "The United Nations (UN) has established a set of 17 global goals, designed to be a \"shared blueprint for peace and prosperity for people and the planet, now and into the future\"",
"img": "https://storage.googleapis.com/production-mrs-esg-logos/630561c28c48c27179d0db9b/scheme_logo_2x.png",
"website":"https://www.un.org/sustainabledevelopment/","commitments": [ {"id":"63063ff489751fe27401ed69","name":"Goal 13: Climate Action","displayOrder":12,"committed":true, "img": "https://storage.googleapis.com/production-mrs-esg-logos/630561c28c48c27179d0db9b/commitments/63063ff489751fe27401ed69_2x.jpg",
"description": "Climate change is affecting every country on every continent. It is disrupting national economies and affecting lives. Weather patterns are changing, sea levels are rising, and weather events are becoming more extreme.\\nAlthough greenhouse gas emissions are projected to drop about 6 per cent in 2020 due to travel bans and economic slowdowns resulting from the COVID-19 pandemic, this improvement is only temporary. Climate change is not on pause. Once the global economy begins to recover from the pandemic, emissions are expected to return to higher levels.\\nSaving lives and livelihoods requires urgent action to address both the pandemic and the climate emergency.\\nThe Paris Agreement, adopted in 2015, aims to strengthen the global response to the threat of climate change by keeping a global temperature rise this century well below 2 degrees Celsius above pre-industrial levels. The agreement also aims to strengthen the ability of countries to deal with the impacts of climate change, through appropriate financial flows, a new technology framework and an enhanced capacity building framework.",
"website":"https://www.un.org/sustainabledevelopment/climate-change/" } ] } ] } } } ]}
