API

Jumpseller API is a REST-style API that uses JSON for serialization and OAuth2 for authentication.
Right now only Products and Orders are available. More methods and capabilities will be added in the near future.
Please use it responsibly, and send us your feedback.

Get Started!

All URLs are in the format:

http://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 OAuth 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 OAuth token is found at the Account section accessed from a link a the top-right corner of your Admin Panel. It is a 32 characters string.

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

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

In curl, that looks like:

curl --get \
  "http://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} }' \
  "http://api.jumpseller.com/v1/products.json?login=storecode&authtoken=XXXXX"

Plain JSON only. No XML.

  • We only support JSON for serialization of data.
  • Our format is to have 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.

Product

Available Methods:

  • GET /v1/products.json - Fecthes the list of all products
  • GET /v1/products/count.json - Counts the list of all products
  • GET /v1/products/:status.json - Fecthes the list of products by their status
  • GET /v1/products/:status/count.json - Counts the list of products by their status
  • GET /v1/products/:id.json - Fecthes a single product
  • GET /v1/products/sku/:sku.json - Fecthes a single product by its SKU
  • PUT /v1/products/:id.json - Modify an existing product
  • POST /v1/products.json - Create a new product
  • DELETE /v1/products/:id.json - Delete an existing product

Product Variant

Available Methods:

  • GET /v1/products/:id/variants/:variant_id.json - Fecthes a single product variant
  • PUT /v1/products/:id/variants/:variant_id.json - Modify an existing product variant
  • POST /v1/products/:id/variants.json - Create a new product variants

Categories

Available Methods:

  • GET /v1/categories.json. - Fecthes the list of all categories
  • GET /v1/categories/:id.json - Fecthes a single category
  • PUT /v1/categories/:id.json - Modify an existing category

Orders

Available Methods:

  • GET /v1/orders.json - Fecthes the list of all orders
  • GET /v1/orders/:status.json - Fecthes the list of orders by their status
  • GET /v1/orders/:id.json - Fecthes a single order

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.