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.
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
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. |
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 |
|
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 |
|
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. |
Field | Description |
---|---|
search_results |
Contains all of the query responses. Attributes:
|
deals |
Contains deals available matching the query. Attributes:
|
deal |
Contains an individual deal. Attributes:
|
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.
http://api.popshops.com/v2/brgymtenmw5ea9unauesmh9nz/deal_types.xml
None
Field | Description |
---|---|
deal_types |
Contains all of the query responses. Attributes:
|
deal_type |
Contains individual deal types. Attributes:
|