Merchant

Endpoint URL: http://api.prosperent.com/api/merchant
HTTP Method: GET or POST

Request Parameters
Parameter Name Required Data Type Format/Values (Default in bold) Description
filterAverageCommission No string Average Commission or range Filter merchants by their average commission.
filterAveragePaymentPercentage No float Average payment percentage or range Filter merchants by their average payment percentage.
filterCategory No string pipe seperated values or null Filter merchants by a category or categories.
filterConversionRate No string Conversion Rate or range Filter to filter results by.
filterDateActive No date YYYY-MM-DD or range Filter merchants by the date they were made active.
filterDeepLinking No boolean true or false Filter merchants by whether they allow or disallow deep linking.
filterDomain No string pipe seperated values or null Filter merchants by their domain.
filterEpc No float Earnings per click or range Filter merchants by their earnings per click.
filterMaxPaymentPercentage No float Maximum payment percentage or range Filter merchants by their maximum payment percentage.
filterMerchantId No int pipe seperated values Filter by the merchant's ID. This ID is specific to one merchant across other networks.
filterMerchant No string pipe seperated values Filter merchants by their names.
filterMerchantWeight No float Merchant weight or range Filter merchants by their weight.
filterMinPaymentPercentage No float Minimum payment percentage or range Filter merchants by their minimum payment percentage.
filterNumCouponsUS No integer Number of coupons or range Filter by the number of coupons a merchant has in their data feed.
filterNumLocalDealsUS No integer Number of local deals or range Filter by the number of local deals a merchant has in their data feed.
filterNumProductsCA No integer Number of products or range Filter by the number of CA products a merchant has in their data feed.
filterNumProducts No integer Number of products or range Filter by the number of products a merchant has in their data feed.
filterNumProductsUK No integer Number of products or range Filter by the number of UK products a merchant has in their data feed.
filterNumTravelOffersUS No integer Number of travel offers or range Filter by the number of travel offers a merchant has in their data feed.
filterProductDatafeed No boolean true or false Filter merchants by whether they have a product data feed or not.
sortBy No array • averageCommission
• averagePaymentPercentage
• category
• conversionRate
• dateActive
• deepLinking
• domain
• epc
• groupCount
• maxPaymentPercentage
• merchant
• merchantId
• merchantWeight
• minPaymentPercentage
• numProducts
• numProductsCA
• numProductsUK
• numCouponsUS
• numTravelOffersUS
• numLocalDealsUS
• productDatafeed
Sort results by the sort method in either ascending or descending order.

Append either of the following to change the sort direction:
asc
• desc
groupBy No string • category
• deepLinking
• productDatafeed
Group results by one of the attributes.
limit No integer 10 Amount of results you want to receive from the API call.
page No integer 1 Enter a page number to get the next set of results.
imageSize No string • 60x30
• 120x60
Size of the merchant's logo to be returned.
imageMaskDomain No string Allows you to make your image URLs appear as though they are coming from your own domain instead of Prosperent. Requires a CNAME entry at your DNS Provider. Start this field with http:// or https:// DNS must be through CloudFlare.
imageType No string • original
• black
• white
Changes the image that is returned. Original, black text, white text.
api_key No string If you supply your API Key, we will give you back the list of merchants that you have been approved for. Log in to view your API keys.
httpHost No string Your domain, without any path (mysite.com) If you supply your httpHost in addition to your API Key, we'll send back a list of merchants that have approved not only your account, but your site as well.
showFilteredMerchants No boolean true or false When set to true, this endpoint will return all merchants that are excluded from your results based on the supplied apiKey and/or httpHost.
A note about merchant approvals: When you start with Prosperent, you are approved for all programs. But over time, some merchants may elect not to work with your account or a specific site. Keep an eye on this endpoint while using your apiKey and/or httpHost and we'll always keep you up to date on your approved merchants.
Response Fields
Field Name Data Type Format Description
errors array Will show any errors that may have occured, otherwise it will be empty.
warnings array Will show any warnings that may have occured, otherwise it will be empty.
data array Displays the merchant data.
merchant string The merchant's name.
merchantId int The ID of the merchant, this ID is specific to only one merchant.
logoUrl string The URL for the merchant's logo.
color1 string The primary color of the merchant's logo.
color2 string If provided, the secondary color of the merchant's logo.
domain string The domain of the merchant.
category string The category of the merchant's products.
productDatafeed boolean 1 (true) or 0 (false) Whether the merchant has a product data feed or not.
deepLinking boolean 1 (true) or 0 (false) Whether the merchant has a allows deep linking or not.
numProducts integer 0 The number of products a merchant has.
numProductsCA integer 0 The number of CA products a merchant has.
numProductsUK integer 0 The number of UK products a merchant has.
numCouponsUs integer 0 The number of coupons a merchant has.
numLocalDealsUS integer 0 The number of local deals a merchant has.
numTravelOffersUS integer 0 The number of travel offers a merchant has.
minPaymentPercentage float 0.00 The minimum percentage of a commission.
maxPaymentPercentage float 0.00 The maximum percentage of a commission.
averagePaymentPercentage float 0.00 The average percentage of a commission.
conversionRate float 0.00 How well the merchant converts.
epc float 0.00 The earnings per click of the merchant.
merchantWeight float 0.00 Internal weight given to merchants based on their network performance.
dateActive date YYYY-MM-DD Date that a merchant was made active.
page integer 0 The page number of the result set.
limit integer 0 The limit you have set.
totalRecords integer 0 Total records for the page of results.
totalRecordsAvailable integer 0 Total merchants available to you for one search.
totalRecordsFound integer 0 Total merchants available that match your filters.
Build a Request
 
Response and URL
Total Records for Request: 33,090
Books-A-Million
123456
Testclear.com
123457
MisterArt.com
123458