Merchant Match API – Connexity Publishers

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.

Endpoint Details
URL: https://api.cnnx.link/api/keyword/merchantMatch

Production URL Example:

https://api.cnnx.link/api/keyword/merchantMatch?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
&keyword=[KEYWORD]

Method: GET

Request Query Parameters

Parameter	Value	Description
publisherId	unsignedint (required)	Publisher ID used to track which publisher is requesting content
apiKey	string (required)	Key used to authenticate the publisher request.
keyword	string (required)	A keyword to use in searching for related Merchants. Value needs to be URL Encoded.

Sample Request:

https://api.cnnx.link/api/keyword/merchantMatch?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]&ke
yword=Bedding

Sample Response - Single merchant mapping to keyword

{"merchantMatches":[{
"merchantId":417,
"merchantName":"Macy's",
"merchantUrl":"http://www.macys.com",
"deeplinkEcpc":48,
"deeplinkUrl":"https://link.sylikes.com/?publisherId=[PUBLISHER_ID]&url=http%3A%2F%2Fwww.macys
.com&af_creative_id=1234",
"searchCategoryId":13030200,
"productSearchUrl":"https://catalog.bizrate.com/services/catalog/v1/api/product/1?publisherId=
[PUBLISHER_ID]&apiKey=[API_KEY]&categoryId=13030200&keyword=&offersOnly=true&merchantId=417"}]}

Sample Response - Multiple merchant mapping to keyword

{"merchantMatches":[{
"merchantId":326058,"merchantName":"Wayfair","merchantUrl":"http://www.wayfair.com","deeplinkEc
pc":87,"deeplinkUrl":"https://link.sylikes.com/?publisherId=[PUBLISHER_ID]&url=http%3A%2F%2Fwww
.wayfair.com&af_creative_id=1234","searchCategoryId":13170100,"productSearchUrl":"https://catal
og.bizrate.com/services/catalog/v1/api/product/1?publisherId=[PUBLISHER_ID]&apiKey=9015f86c984
47449f8a6ee795b871c79&categoryId=13170100&keyword=&offersOnly=true&merchantId=326058"},

{"merchantId":401,"merchantName":"Walmart","merchantUrl":"http://www.walmart.com","deeplinkEcpc"
:9,"deeplinkUrl":"https://link.sylikes.com/?publisherId=[PUBLISHER_ID]&url=http%3A%2F%2Fwww.wal
mart.com&af_creative_id=1234","searchCategoryId":13010500,"productSearchUrl":"https://catalog.bi
zrate.com/services/catalog/v1/api/product/1?publisherId=[PUBLISHER_ID]&apiKey=9015f86c98447449
f8a6ee795b871c79&categoryId=13010500&keyword=&offersOnly=true&merchantId=401"}]}

Response Details

Parameter	Description
merchantId	Connexity merchant identifier (integer)
merchantName	The merchant name
merchantUrl	The Merchant Home Page URL
deeplinkEcpc	Estimated CPC value for a valid merchant deep link click (integer)
deeplinkUrl	Monetizing link for the Merchant Home Page
searchCategoryId	Integer value which uniquely identifies a CNX category. Values can be discovered through the Taxonomy Service.
searchKeyword	An overriding search keyword to be used in Catalog request
productSearchUrl	The Catalog API URL for the product offers for the returned merchant based on the requested keyword

Related articles