Jumpseller API is a REST-style API that uses JSON for serialization and a pair of tokens for authentication.
Please use it responsibly and send us your feedback.

Endpoint Structure


All URLs are in the format:

https://api.jumpseller.com/v1/path.json?login=storecode&authtoken=storetoken

The path is prefixed by the API version and the URL takes as parameters the login (your store code) and your authentication token.

Version


The current version of the API is v1.
If we change the API in backward-incompatible ways, we'll increase the version number and maintain stable support for the old urls.

Authentication


The API uses a token-based authentication with a combination of a login key and an auth token. Both parameters can be found on the left sidebar of the Account section, accessed from the main menu of your Admin Panel. The auth token of the user can be reset on the same page.

The auth token is a 32 characters string.

Curl Examples

To request all the products at your store, you would append the products index path to the base url to create an URL with the format:

https://api.jumpseller.com/v1/products.json?login=storecode&authtoken=XXXXX

In curl, you can invoque that URL with:

curl -X GET "https://api.jumpseller.com/v1/products.json?login=storecode&authtoken=XXXXX"

To create a product, you will include the JSON data and specify the MIME Type:

curl -X POST -d '{ "product" : {"name": "My new Product!", "price": 100} }' "https://api.jumpseller.com/v1/products.json?login=storecode&authtoken=XXXXX" -H "Content-Type:application/json"

and to update the product identified with 123:

curl -X PUT -d '{ "product" : {"name": "My updated Product!", "price": 99} }' "https://api.jumpseller.com/v1/products/123.json?login=storecode&authtoken=XXXXX" -H "Content-Type:application/json"

or delete it:

curl -X DELETE "https://api.jumpseller.com/v1/products/123.json?login=storecode&authtoken=XXXXX" -H "Content-Type:application/json"

PHP Examples

Create a new Product (POST method)

$url = 'https://api.jumpseller.com/v1/products.json?login=XXXXX&authtoken=XXXXX;
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); //post method
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "product" : {"name": "My updated Product!", "price": 99} }');                                                                                                                   

$result = curl_exec($ch);
print_r($result);
curl_close($ch);

Plain JSON only. No XML.

  • We only support JSON for data serialization.
  • Our node format has no root element.
  • We use snakecase to describe attribute keys (like "createdat").
  • All empty value are replaced with a null strings.
  • All API URLs end in .json to indicate that they accept and return JSON.
  • POST and PUT methods require you to explicitly state the MIME type of your request's body content as "application/json".

Rate Limit

You can perform a maximum of 60 (sixty) requests per minute and 2 (two) requests per second from the same IP address. That averages 1 request per second.

If you exceed this limit, you'll get a 403 Forbidden (Rate Limit Exceeded) response for subsequent requests.

This limits are necessary to ensure resources are correctly used.
Your application should be aware of this limits and retry any unsuccessful request.

Pagination

We will return a maximum of 50 objects (products, orders, etc) per page. If the result set gets paginated it is your responsibility to check the next page for more objects -- you do this by using query strings &page=2, &page=3 and so on.

https://api.jumpseller.com/v1/products.json?login=storecode&authtoken=XXXXX&page=3

Explore Methods

More

  • Exceller is a tiny app, allowing you to edit your store's products on the fly
  • all it's codebase is available for free for you to copy and modify as you will.
  • Apps Page showcases external integrations with Jumpseller done by technical experts.