Enrich multiple transactions - POST

Find merchants based on raw transaction data

Searches for an array of merchants. This endpoint is typically used for transaction list views. You send in multiple transactions at once in a single request.

POSThttps://europe-west2.snowdrop-mrs.com/api/v3/merchant/list

Authorization

HeaderApiKeyAuth

Body

application/json

Start with our guide on how to use MRS to enrich raw transaction data.

This endpoint returns a JSON object containing the following properties, as well as an array of enriched 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

If you wish to submit crowdsourcing reports, this id is required, 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

forceCacheableFieldsarray of string

An optional array of response fields that will be force returned from our internal sources. This is useful if you want to cache fields such as the name or website during an extended call. Allowed values are: name, website, img, category, categories

Example: ["name","website"]

transactions*array of object

Response

200400401403404500

A JSON object containing one property per transaction enriched.

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

Headers

Body

application/json

idarray of one of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://europe-west2.snowdrop-mrs.com/api/v3/merchant/list', {
    method: 'POST',
    headers: {
      "X-Api-Key": "HeaderApiKeyAuth <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "extended",
      "logo_size": "2x",
      "defaultLogo": true,
      "additionalInfo": false,
      "clearResponse": true,
      "forceCacheableFields": [
        "name",
        "website"
      ],
      "transactions": [
        {
          "id": "text",
          "merchant_name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "id": [
    {
      "name": "text",
      "website": "text",
      "position": {
        "type": "Point",
        "coordinates": [
          1
        ]
      },
      "img": "text",
      "logoImg": "text",
      "categoryImg": "text",
      "logoScore": 1,
      "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": 1,
        "relative_time_description": "text",
        "text": "text",
        "time": 1,
        "translated": true
      },
      "opening_hours": {
        "open_now": true,
        "periods": [
          {
            "open": {
              "date": "text",
              "day": 1,
              "time": 1700,
              "truncated": true
            },
            "close": {
              "date": "text",
              "day": 1,
              "time": 1700,
              "truncated": true
            }
          }
        ],
        "special_days": [
          {
            "date": "text",
            "exceptional_hours": true
          }
        ],
        "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": 1,
      "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": []
        },
        "brandCategory": {
          "parentCategory": "Retail & Shopping",
          "categoryGroup": "Retail & Department Stores",
          "categoryType": "Furniture"
        },
        "verifiedInputDate": "2024-09-02T08:46:35.785Z"
      },
      "aggregateLevel": {
        "id": "64b70cd0584b4b1e7ebcf36d",
        "name": "Carrefour",
        "img": "https://storage.googleapis.com/production-mrs-tm-logos/6273e58dbb09494554c93ae3_2x.png",
        "website": "https://www.carrefour.com/"
      },
      "store": {
        "id": "66c78aa32cea1a4463b8c634"
      }
    }
  ]
}