Find coupons and deals

Back to top

1. Deals API

If you would like to query for deals against the api you can use the following to search or browse through all available deals in a catalog. A merchant type is used to categorize a merchant.

Request URL

http://api.popshops.com/v2/brgymtenmw5ea9unauesmh9nz/deals.xml?catalog_key=48qsligejm5qng6cv5waprcoq&include_deal_ids=1

Sample requests

Find deals with the term "free" in their name:
http://api.popshops.com/v2/brgymtenmw5ea9unauesmh9nz/deals.xml?catalog_key=48qsligejm5qng6cv5waprcoq&keywords=free

Find deals for free shipping:
http://api.popshops.com/v2/brgymtenmw5ea9unauesmh9nz/deals.xml?catalog_key=48qsligejm5qng6cv5waprcoq&deal_type_id=1

Required request parameters

Field Value Description
catalog_key 48qsligejm5qng6cv5waprcoq Unique key identifying a catalog of merchants. This key is assigned by Rakuten PopShops and can be found in your settings.

Optional request parameters

Field Value Description
keywords string A list of keywords to search across your catalog merchants. keywords=ipod Is a basic search for products containing the keyword "ipod"
keywords=ipod -case is a search for products containing the keyword "ipod" and NOT containing the keyword "case"
deal_type_id integer A Rakuten PopShops deal_type id, limiting deals to a specific deal type (Free shipping, Gift, Sales/Clearance, etc.)
deal_sort
  • start_on_asc
  • start_on_desc
  • end_on_asc
  • end_on_desc
  • merchant_name_asc
  • merchant_name_desc
Newest start on dates, latest start on dates, newest end on dates, oldest end on dates, merchant names a-z, merchant names z-a
specific
  • 1 or 0
Indicates whether or not the deal is specific to certain products for a merchant, or if the deal applies to all products from a merchant. The default response brings back both specific and non-specific.
start_on mm/dd/yyyy The date a deal starts on.
end_on mm/dd/yyyy The date a deal ends on.
start_on_min mm/dd/yyyy The earliest date a deal starts on. This can be used with the start_on_max to bring back a list of deals beginning within a specified date range.
start_on_max mm/dd/yyyy The latest date a deal starts on. This can be used with the start_on_min to bring back a list of deals beginning within a specified date range.
end_on_min mm/dd/yyyy The earliest date a deal ends on. This can be used with the end_on_max to bring back a list of deals expiring within a specified date range.
end_on_max mm/dd/yyyy The latest_date a deal ends on. This can be used with the end_on_min to bring back a list of deals expiring within a specified date range.
merchant_id integer A Rakuten PopShops merchant id, limiting deals to a specific merchant
merchant_type_id integer A Rakuten PopShops merchant_type id, limiting deals to a specific merchant type (Appliances, Apparel, Jewelry, etc.)
deal_limit 1 - 100 default is 25 Number of deals to display at a time.
deal_offset integer default is 0 Number to offset the deal results by. For example, to display page 11 with 10 deals per page the deal_limit should be set to 10 and deal_offset should be 110.
url_subid string Custom subid/sid to be appended in any final affiliate deal urls.
include_deal_ids boolean1 or 0 Deal id information will be included on deal nodes. Defaults to 0.

Response fields

Field Description
search_results Contains all of the query responses. Attributes:
  • keywords: any keywords passed in
  • deal_type_id: any deal_type_id passed in
  • deal_sort: any deal_sort passed in
  • specific: any specific passed in
  • start_on: any start_on passed in
  • end_on: any end_on passed in
  • start_on_min: any start_on_min passed in
  • start_on_max: any start_on_max passed in
  • end_on_min: any end_on_min passed in
  • end_on_max: any end_on_max passed in
  • deal_limit: any product_limit passed in
  • deal_offset: any product_offset passed in
  • merchant_id: any merchant_id passed in
  • merchant_type_id: any merchant_type_id passed in
deals Contains deals available matching the query. Attributes:
  • total_count: Total number of deals matching the query.
  • restrictions: Global restrictions that apply to any deal returned.
deal Contains an individual deal. Attributes:
  • name: The name of the deal.
  • description: A description of the deal.
  • url: The redirect url for the deal.
  • image_url: If an image is available for the deal, this will be a url for that image.
  • specific: This is a boolean (true/false) indicating whether the deal is specific to a product, or applies to all products from the merchant.
  • start_on: The start date the deal is valid.
  • end_on: The end date the deal is no longer valid.
  • code: Any associated code for the deal. This is a code that would need to be used to redeem the deal.
  • deal_type_ids: The deal_type id indicating what kind of deal this is.
  • restrictions: Any applicable restrictions unique to this deal or merchant.
  • merchant_id: A unique id for the merchant.
  • merchant_type_id: The id of the merchant_type the merchant of this deal belongs to.
  • id: unique id for specific deal
Back to top

2. Deal types API

You can use this to find a list of all available deal types. A deal type is used to categorize a deal. You can use deal_type ids to further filter product/deal queries.

Request URL

http://api.popshops.com/v2/brgymtenmw5ea9unauesmh9nz/deal_types.xml

Request parameters

None

Response fields

Field Description
deal_types Contains all of the query responses. Attributes:
  • total_count: the total count of deal types available
deal_type Contains individual deal types. Attributes:
  • id: Unique id for the deal type that can be used as a parameter value in deal queries.
  • name: The name of the deal type
  • deal_count: The total count of deals available for this specific deal type