API

Jumpseller API is a REST-style API that uses JSON for serialization and a pair of tokens for authentication.
Right now only Products, Categories and Orders endpoints are available.
Please use it responsibly and send us your feedback.

Get Started!

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. If we change the API in backward-incompatible ways, we'll increase the version number and maintain stable support for the old urls.

Your store's code is found at the base url at your Admin Panel which has the format https://storecode.jumpseller.com.

Your store's authentication token is found at the Account section accessed from a link main menu of your Admin Panel. It is a 32 characters string.

To request all the products at your store, you would append the products index path to the base url to create something similar to:

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

In curl, that looks like:

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

To create a product, it is the same thing except you will include JSON data:

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

Specs

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.

Paginated results

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.

Available Methods

See it Live

  • 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.