API overview

Back to top

1. Getting started

The v3 API is the latest version of our API.

  1. Account key: This can be found in your account api keys page.
  2. Private key: This key is almost exclusively used for updating catalogs, so you may not use it very often. You can find your private key on the account api keys page.
  3. Catalog key: This will be generated and given to you when you create a catalog from the catalog dashboard.

Using the different keys outlined above you can now start making api calls.

NOTE - If you are an existing Rakuten PopShops Data Pack publisher and would like to utilize PopShops v3 API service you have two options for access to the v3 API. You can either upgrade your existing Data Pack subscription account (please contact us at support@popshops.com to request an upgrade) or you can create a PopShops Express account.

Back to top

2. How do you get information from the API?

The Data Pack API calls are implemented as a RESTful API. Various response formats are provided (XML,JSON,CSV) depending on the specific API call being made. To make an API call you will need to have your account and catalog keys. The catalog key corresponds to a custom collection of merchants you build in the Manage catalogs dashboard.

See specific API calls to find the list of allowed response formats, HTTP methods, required parameters, and optional parameters.

Back to top

3. Premium

Premium data fields, call parameters, and response sets are available in Rakuten PopShops upgraded Data Pack plans, Custom Corporate API plans and in Rakuten PopShops Express Service. Some of the premium features include browsing products by category, receiving product identifiers in the response set (upc, mpn, isbn, etc.), estimated tax and estimated shipping, managing product exclusions, custom feed integrations, and more. Please contact support@popshops.com, if you are interested in more information regarding premium level API access.

Back to top

4. API fair usage limit

The Data Pack API provides for fair usage of up to 5,000 API server requests per month with a standard Data Pack API subscription.

A server call request is each time Rakuten PopShops servers are contacted with your unique account/catalog keys. The API may return many results on a query, but it is counted as one call. Pagination, filtering, and clicks are counted as additional server calls. It is recommended that you blacklist bots from your websites to reduce usage costs.

For pricing on higher volume server request quota please contact support@popshops.com.

Back to top

5. What can you do with the API?

The Rakuten PopShops API was created and designed for affiliate marketers who are either developers or have development resources to work with. Regretfully, Rakuten PopShops can not help you with your custom PHP, ASP, Rails, or teach you how to parse XML.

With the Rakuten PopShops API you can create anything from a dynamic super mall to a range of niche coupon sites, and have complete control over the code including HTML and the content calls to populate your websites.

Rakuten PopShops API access is available with DataPack account subscriptions and/or with Rakuten PopShops custom and corporate solutions.

Back to top

6. Custom tracking IDs

You can use your own custom defined tracking ids to help you manage your sales. Each network gives you a custom tracking id that can be added to an affiliate link, although they all name it something different, but in a nutshell it appends the text (or code) that you want to an affiliate link. You can then run reports at the network level for that specific tracking ID.

You can dynamically append any information, including tracking ids for commission tracking (reported via your network account) in the v3 API using the parameter tracking_id. This will have your custom tracking id dynamically inserted into any final affiliate product links your website users click on.