To use the ShopStyle API, you need to first sign up here to get your unique API key. Once you have this key, you can start making the API calls described below.
To use the ShopStyle API, make sure your Partner ID is appended to all requests.
This document is intended for programmers who would like to develop a client application that will use the ShopStyle API. The client will need to know how to invoke an HTTP request with a particular URL and process the body of the response as either XML or JSON.
Here are the basic steps for using the API, regardless of the client language you are using:
- Choose the method that returns the data your application needs. For example, the /products method is used to get products that match a given category or brand.
- Construct a URL for that method with the appropriate host, method name, and query parameters.
- Invoke the URL as an HTTP GET.
- When the HTTP response arrives, extract the required data elements from the response's body.
The rest of this document describes the details of constructing the right URL for each of the API's methods. The XML format of the responses may be seen by clicking on the sample URLs shown for each method. The responses in JSON format contain identical information, just in a different format.
There are clients implemented in different languages: Ruby, PHP, Python, Objective-C and Java.
All ShopStyle API URLs have the following form:
The METHOD_NAME is taken from the list of methods in the various API shown at left.
The VERSION is the API version with the prefix 'v'. Our latest version is 'v2'. The version can be omitted to always use the latest version available. However we do not guarantee backward compatibility between different versions of the API.
All methods in the API accept these parameters:
|pid||Unique API_KEY string that is assigned to the caller. Sign up here to get your Shopstyle API key. Your Partner ID: This parameter must be present.|
|The format of the response. Supported values are:
|suppressResponseCode||When set to 1 or 'true' the HTTP status will always be 200. Use the field "errorCode" in the response to detect whether the API Call was successful. By default, when an error occur the HTTP Status of the response will be different than 200|