Blog Home | Forum Home | iCodes UK | iCodes US


Webservices v2 Requests

Valid RequestTypes:

Codes
Offers
MerchantList
CategoryList
NetworkList
PrintableVouchers

Codes and Offers :

Valid Action -> Full
Valid Action -> Expiring [Sort]
Valid Action -> PostDated [Sort]
Valid Action -> New [Sort]
Valid Action -> All [Sort]
Valid Action -> Exclusive [Sort]
Valid Action -> Category -> valid query -> category_id [Sort]
Valid Action -> Merchant -> valid query -> merchant name [Sort]
Valid Action -> Search -> valid query -> keywords[NarrowBy] [Sort]
Valid Action -> Icid -> valid query -> Icid

Sort Parameters:

Sort=StartDateLow
Sort=StartDateHigh
Sort=ExpiryDateLow
Sort=ExpiryDateHigh
Sort=id

NarrowBy Parameters:

NarrowBy=category_id

MerchantList:

Valid Action -> Full
Valid Action -> Category -> valid query -> category_id[GroupBy]
Valid Action -> Search -> valid query -> merchant name -> string -> [0-9][GroupBy]
Valid Action -> All[GroupBy]
Valid Action -> Codes -> valid query -> category_id[GroupBy]
Valid Action -> Offers -> valid query -> category_id[GroupBy]
Valid Action -> Icid -> valid query -> Icid

PrintableVouchers:

Valid Action -> Full
Valid Action -> All
Valid Action -> Category -> valid query -> category_id
Valid Action -> Exclusive

GroupBy Parameters:

GroupBy=Merchant

Relationship Parameters:

Relationship=joined

Network Parameters:  (to include all networks do not use this parameter)

Network=affiliate_window,webgains,buy

Paging Parameters:

Page
PageSize: Number of items returned per page (maximum 50) (default 20)

Default Settings

Merchants you have selected as JOINED will contain YOUR affiliate ID’s.
Merchants you have selected as NOT JOINED will contain OUR affiliate ID’s or link directly to the merchant.
Merchants you have selected as REJECTED will not be included.

Settings with Relationship=joined

Merchants you have selected as JOINED will contain YOUR affiliate ID’s.
Merchants you have selected as NOT JOINED will not be included.
Merchants you have selected as REJECTED will not be included.

Example requests:

Request all merchants begining with ‘A’
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=MerchantList&Action=Search&Query=a&Page=1&GroupBy=Merchant&PageSize=10

Request all merchants begining with ’A’ with codes
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Merchants&Query=a&GroupBy=Merchant&Page=a&PageSize=10

Request all merchants within category 4
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=MerchantList&Action=Category&Query=4&GroupBy=Merchant&Page=1&PageSize=10

Request all merchants with codes within category 4
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=MerchantList&Action=Codes&Query=4&Page=1&GroupBy=Merchant&PageSize=10

Request all codes within category 4
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Category&Query=4&Sort=StartDateHigh&Page=1&PageSize=10

Request post dated codes
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=PostDated&Sort=StartDateHigh&PageSize=10

Request expiring codes
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Expiring&Sort=ExpiryDateLow&PageSize=10

Request featured codes
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Icid&Query=1234,2345

Request new codes
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=New&Sort=StartDateHigh&PageSize=10

Request codes for merchant Comet
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Merchant&Query=Comet&PageSize=10

Seach all codes matching dvd
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=Codes&Action=Search&Query=dvd&Sort=StartDateHigh&Page=1&PageSize=10

Request category list
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=CategoryList

Request network list
http://webservices.icodes.co.uk/ws2.php?UserName=xmlsite&SubscriptionID=eecca5b6365d9607ee5a9d336962c534&RequestType=NetworkList

Please Note: What we refer to as the <merchant id> in the feeds is the id of the merchant required to build the affiliate link. Some networks such as CJ, Buy.at, Linkshare also have a seperate merchant id to identify the merchant in their own system… we do not include that merchant id in our feeds.

Comments are closed.

Recent Comments