Enable Customer Keyword Search
The Merchant Match API allows Publishers to use keywords submitted by users to find one or more Connexity merchants that match a user’s search criteria.
Through the search, Publishers are able to display a listing of merchants along with listings of merchant product offers.
Common Use Cases
- Search for merchants by user-provided keywords
- Display a list of merchants offering products relevant to the keyword
- Generate deep links for monetizing merchant pages
Customizing Search Results
Rules give publishers direct control over how search results appear for their traffic. Rather than relying on universal defaults, Connexity can tailor matching behavior to support publisher's conquesting strategies and tighter curation of results - including pinning preferred merchants, suppressing others, and restricting results to an approved set.
These rules are optional and can be configured with the help of your Account Manager.
URL
https://api.cnnx.link/api/keyword/merchantMatch?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
&keyword=[KEYWORD]
Sample Response - Single merchant mapping to keyword
{
"merchantMatches": [
{
"merchantId": 43811,
"merchantName": "Aeropostale",
"merchantUrl": "https://www.aeropostale.com",
"deeplinkEcpc": 67,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=https%3A%2F%2Fwww.aeropostale.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=43811&categoryId=1"
}
]
}
Sample Response - Multiple merchant mapping to keyword
{
"merchantMatches": [
{
"merchantId": 43811,
"merchantName": "Aeropostale",
"merchantUrl": "https://www.aeropostale.com",
"deeplinkEcpc": 67,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=https%3A%2F%2Fwww.aeropostale.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=43811&categoryId=1"
},
{
"merchantId": 19246,
"merchantName": "Brooks Brothers",
"merchantUrl": "http://www.brooksbrothers.com",
"deeplinkEcpc": 388,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=http%3A%2F%2Fwww.brooksbrothers.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=19246&categoryId=1"
}
]
}
Response Details
| Parameter | Description |
| merchantId | The unique identifier of the merchant |
| merchantName | The name of the merchant |
| merchantUrl | The homepage URL of the merchant |
| deeplinkEcpc | Estimated CPC value for a valid merchant deep link click |
| deeplinkUrl | Monetized link for the merchant’s homepage |
| searchCategoryId | The ID of the Connexity category related to the search |
| searchKeyword | An overriding search keyword to be used in the Catalog API URL |
| searchBrandId | The ID of the retailer brand to be used in the Catalog API URL |
| productSearchUrl | The Catalog API URL for product offers from the matched merchant |
Response Attributes
- This table is currently missing Brand ID and Keyword ID
| Attribute | Type | Description |
| merchantId | integer | The unique identifier of the merchant |
| merchantName | string | The name of the merchant |
| merchantUrl | string | The homepage URL of the merchant |
| deeplinkEcpc | integer | Estimated CPC value for a valid merchant deep link click |
| deeplinkUrl | string | Monetized link for the merchant’s homepage |
| searchCategoryId | integer | The ID of the Connexity category related to the search |
| searchKeyword | string | An overriding search keyword to be used in the Catalog API URL |
| searchBrandId | integer | The ID of the retailer brand to be used in the Catalog API URL |
| productSearchUrl | string | The Catalog API URL for product offers from the matched merchant |
Example Responses (JSON)
Single Merchant Match
{
"merchantMatches": [
{
"merchantId": 43811,
"merchantName": "Aeropostale",
"merchantUrl": "https://www.aeropostale.com",
"deeplinkEcpc": 67,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=https%3A%2F%2Fwww.aeropostale.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=43811&categoryId=1"
}
]
}
Multiple Merchant Matches
{
"merchantMatches": [
{
"merchantId": 43811,
"merchantName": "Aeropostale",
"merchantUrl": "https://www.aeropostale.com",
"deeplinkEcpc": 67,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=https%3A%2F%2Fwww.aeropostale.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=43811&categoryId=1"
},
{
"merchantId": 19246,
"merchantName": "Brooks Brothers",
"merchantUrl": "http://www.brooksbrothers.com",
"deeplinkEcpc": 388,
"deeplinkUrl": "https://link.sylikes.com/?publisherId=12345&url=http%3A%2F%2Fwww.brooksbrothers.com&af_creative_id=3091",
"searchCategoryId": 1,
"searchKeyword": null,
"searchBrandId": null,
"productSearchUrl": "https://catalog.bizrate.com/services/catalog/v1/api/product/1?offersOnly=true&publisherId=12345&apiKey=YOUR_API_KEY&keyword=&merchantId=19246&categoryId=1"
}
]
}
Comments
0 comments
Article is closed for comments.