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:


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


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.


Your store's code is found at the base url of your Admin Panel which has the format https://storecode.jumpseller.com.
Your store's authentication token is found at the Account section accessed from the main menu of your Admin Panel. It 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:


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)

    //$storecode = 'Your LOGIN here';
    //$storetoken = 'Your AUTH TOKEN here';
    $data = array(  "product" => array( "name"=>"name of product here","price"=>"price of product here"  ), 
    $data_string = json_encode($data) // encode JSON; 
    $call = curl_call($storecode, $storetoken, $data_string) // insert product data;
        function curl_call($storecode, $storetoken, $data_string) {
        $url = 'https://api.jumpseller.com/v1/products.json?login='.$storecode.'&authtoken='.$storetoken;
        $ch = curl_init($url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
            'Content-Type: application/json',
            'Content-Length: ' . strlen($data_string)
        //post method
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);                                                                                                                   
        $result = curl_exec($ch);
            // Check HTTP status code
            if (!curl_errno($ch)) {
              switch ($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) {
                case 200:  # OK
                  echo 'Unexpected HTTP code: ', $http_code, "\n";

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 limiting

You can perform 60 (sixty) requests per minute 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.


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.


Explore Methods


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