Jumpseller API
Endpoint Structure All URLs are in the format: https://api.jumpseller.com/v1/path.json?login=XXXXXX&authtoken=storetoken The path is prefixed by the API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Endpoint Structure
All URLs are in the format:
https://api.jumpseller.com/v1/path.json?login=XXXXXX&authtoken=storetokenThe path is prefixed by the API version and the URL takes as parameters the login (your store specific API login) 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.
If you are developing a Jumpseller App, the authentication should be done using OAuth-2. Please read the article Build an App for more information.
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=XXXXXX&authtoken=XXXXXIn curl, you can invoque that URL with:
curl -X GET "https://api.jumpseller.com/v1/products.json?login=XXXXXX&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=XXXXXX&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=XXXXXX&authtoken=XXXXX" -H "Content-Type:application/json"or delete it:
curl -X DELETE "https://api.jumpseller.com/v1/products/123.json?login=XXXXXX&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 snake_case to describe attribute keys (like "created_at").
- All empty value are replaced with 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:
+ 240 (two hundred forty) requests per minute and
+ 8 (eight) requests per second
If you exceed this limit, you'll get a 403 Forbidden (Rate Limit Exceeded) response for subsequent requests.
The rate limits apply by IP address and by store. This means that multiple requests on different stores are not counted towards the same rate limit.
This limits are necessary to ensure resources are correctly used. Your application should be aware of this limits and retry any unsuccessful request, check the following Ruby stub:
tries = 0; max_tries = 3;
begin
HTTParty.send(method, uri) # perform an API call.
sleep 0.5
tries += 1
rescue
unless tries >= max_tries
sleep 1.0 # wait the necessary time before retrying the call again.
retry
end
endFinally, you can review the Response Headers of each request:
Jumpseller-PerMinuteRateLimit-Limit: 60
Jumpseller-PerMinuteRateLimit-Remaining: 59 # requests available on the per-second interval
Jumpseller-PerSecondRateLimit-Limit: 2
Jumpseller-PerSecondRateLimit-Remaining: 1 # requests available on the per-second intervalto better model your application requests intervals.
In the event of getting your IP banned, the Response Header Jumpseller-BannedByRateLimit-Reset informs you the time when will your ban be reseted.
Pagination
By default we will return 50 objects (products, orders, etc) per page. There is a maximum of 100, using a query string &limit=100.
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=XXXXXX&authtoken=XXXXX&page=3&limit=100More
- Jumpseller API wrapper provides a public Ruby abstraction over our API;
- Apps Page…
Endpoints 142
Categories
- GETRetrieve all Categories.
/categories.json?login=string&authtoken=string - POSTCreate a new Category.
/categories.json?login=string&authtoken=stringCategory's permalink is automatically generated from the given category's name. - GETCount all Categories.
/categories/count.json?login=string&authtoken=string - GETRetrieve a single Category.
/categories/:id.json?login=string&authtoken=string - PUTModify an existing Category.
/categories/:id.json?login=string&authtoken=string - DELETEDelete an existing Category.
/categories/:id.json?login=string&authtoken=string
Checkout Custom Fields
- GETRetrieve all Checkout Custom Fields.
/checkout_custom_fields.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new CheckoutCustomField.
/checkout_custom_fields.json?login=string&authtoken=stringType values can be: input, selection, checkbox, date or text. Area values can be: contact, billing_shipping or other. - GETRetrieve a single CheckoutCustomField.
/checkout_custom_fields/:id.json?login=string&authtoken=string - PUTUpdate a CheckoutCustomField.
/checkout_custom_fields/:id.json?login=string&authtoken=string - DELETEDelete an existing CheckoutCustomField.
/checkout_custom_fields/:id.json?login=string&authtoken=string
Countries
- GETRetrieve all Countries.
/countries.json?login=string&authtoken=string - GETRetrieve a single Country information.
/countries/:country_code.json?login=string&authtoken=string - GETRetrieve all Regions from a single Country.
/countries/:country_code/regions.json?login=string&authtoken=string - GETRetrieve a single Region information object.
/countries/:country_code/regions/:region_code.json?login=string&authtoken=string
Custom Fields
- GETRetrieve all Store's Custom Fields.
/custom_fields.json?login=string&authtoken=string - POSTCreate a new Custom Field.
/custom_fields.json?login=string&authtoken=string - GETRetrieve a single CustomField.
/custom_fields/:id.json?login=string&authtoken=string - PUTUpdate a CustomField.
/custom_fields/:id.json?login=string&authtoken=string - DELETEDelete an existing CustomField.
/custom_fields/:id.json?login=string&authtoken=string - DELETEDelete an existing CustomFieldSelectOption.
/custom_fields/:id/select_options/:custom_field_select_option_id.json?login=string&authtoken=string
Custom Field Select Options
- GETRetrieve all Store's Custom Fields.
/custom_fields/:id/select_options.json?login=string&authtoken=string - POSTCreate a new Custom Field Select Option.
/custom_fields/:id/select_options.json?login=string&authtoken=string - GETRetrieve a single SelectOption from a CustomField.
/custom_fields/:id/select_options/:custom_field_select_option_id.json?login=string&authtoken=string - PUTUpdate a SelectOption from a CustomField.
/custom_fields/:id/select_options/:custom_field_select_option_id.json?login=string&authtoken=string
Customer Categories
- GETRetrieve all Customer Categories.
/customer_categories.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new CustomerCategory.
/customer_categories.json?login=string&authtoken=string - GETRetrieve a single CustomerCategory.
/customer_categories/:id.json?login=string&authtoken=string - PUTUpdate a CustomerCategory.
/customer_categories/:id.json?login=string&authtoken=string - DELETEDelete an existing CustomerCategory.
/customer_categories/:id.json?login=string&authtoken=string - GETRetrieves the customers in a CustomerCategory.
/customer_categories/:id/customers.json?login=string&authtoken=string - POSTAdds Customers to a CustomerCategory.
/customer_categories/:id/customers.json?login=string&authtoken=string - DELETEDelete Customers from an existing CustomerCategory.
/customer_categories/:id/customers.json?login=string&authtoken=string
Customers
- GETRetrieve all Customers.
/customers.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new Customer.
/customers.json?login=string&authtoken=string - GETCount all Customers.
/customers/count.json?login=string&authtoken=string - GETRetrieve a single Customer by email.
/customers/email/:email.json?login=string&authtoken=string - GETRetrieve a single Customer by id.
/customers/:id.json?login=string&authtoken=string - PUTUpdate a new Customer.
/customers/:id.json?login=string&authtoken=string - DELETEDelete an existing Customer.
/customers/:id.json?login=string&authtoken=string
Customer Additional Fields
- GETRetrieves the Customer Additional Field of a Customer.
/customers/:id/fields?login=string&authtoken=string - POSTAdds Customer Additional Fields to a Customer.
/customers/:id/fields?login=string&authtoken=string - GETRetrieve a single Customer Additional Field.
/customers/:id/fields/:field_id?login=string&authtoken=string - PUTUpdate a Customer Additional Field.
/customers/:id/fields/:field_id?login=string&authtoken=string - DELETEDelete a Customer Additional Field.
/customers/:id/fields/:field_id?login=string&authtoken=string
Fulfillments
- GETRetrieve all Fulfillments.
/fulfillments.json?login=string&authtoken=string&limit=50&page=1 - GETCount all Fulfillments.
/fulfillments/count.json?login=string&authtoken=string - GETRetrieve a single Fulfillment.
/fulfillments/:id.json?login=string&authtoken=string - GETRetrieve the Fulfillments associated with the Order.
/order/:id/fulfillments.json?login=string&authtoken=string
Hooks
- GETRetrieve all Hooks.
/hooks.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new Hook.
/hooks.json?login=string&authtoken=string - GETRetrieve a single Hook.
/hooks/:id.json?login=string&authtoken=string - PUTUpdate a Hook.
/hooks/:id.json?login=string&authtoken=string - DELETEDelete an existing Hook.
/hooks/:id.json?login=string&authtoken=string
Apps
- GETRetrieve all the Store's JSApps.
/jsapps.json?login=string&authtoken=string - POSTCreate a Store JSApp.
/jsapps.json?login=string&authtoken=string - GETRetrieve a JSApp.
/jsapps/:code.json?login=string&authtoken=string - DELETEDelete an existing JSApp.
/jsapps/:code.json?login=string&authtoken=string
Orders
- GETRetrieve all Orders.
/orders.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new Order.
/orders.json?login=string&authtoken=stringOrders created externally keep the given order product's values (bypassing internal promotion or product amounts). - GETRetrieve orders filtered by Order Id.
/orders/after/:id.json?login=string&authtoken=stringFor example the GET /orders/after/5000 will return Order 5001, 5002, 5003, etc. - GETCount all Orders.
/orders/count.json?login=string&authtoken=string - GETRetrieve orders filtered by status.
/orders/status/:status.json?login=string&authtoken=string - GETRetrieve a single Order.
/orders/:id.json?login=string&authtoken=string - PUTModify an existing Order.
/orders/:id.json?login=string&authtoken=stringOnly status, shipment_status, tracking_number, tracking_company, tracking_url, additional_information and additional_fields are available for update. An email… - GETRetrieve all Order History.
/orders/:id/history.json?login=string&authtoken=string - POSTCreate a new Order History Entry.
/orders/:id/history.json?login=string&authtoken=string
Pages
- GETRetrieve all Pages.
/pages.json?login=string&authtoken=string&limit=50&page=1 - POSTCreate a new Page.
/pages.json?login=string&authtoken=string - GETCount all Pages.
/pages/count.json?login=string&authtoken=string - GETRetrieve a single Page by id.
/pages/:id.json?login=string&authtoken=string - PUTUpdate a Page.
/pages/:id.json?login=string&authtoken=string - DELETEDelete an existing Page.
/pages/:id.json?login=string&authtoken=string
Partners
- GETRetrieve statistics.
/partners/stores.json?partner_code=string&auth_token=string&page=1&from=string&to=string - GETRetrive store creation status.
/store/check_status.json?partner_code=string&auth_token=string&store_code=string&locale=en - POSTCreate a Partnered Store
/store/create.json?partner_code=string&auth_token=string
Payment Methods
- GETRetrieve all Store's Payment Methods.
/payment_methods.json?login=string&authtoken=string - GETRetrieve a single Payment Method.
/payment_methods/:id.json?login=string&authtoken=string
Products
- GETRetrieve all Products.
/products.json?login=string&authtoken=string&limit=50&page=1&locale=string - POSTCreate a new Product.
/products.json?login=string&authtoken=string&locale=string - GETRetrieves Products after the given id.
/products/after/:id.json?login=string&authtoken=string&locale=string - GETRetrieve Products filtered by category.
/products/category/:category_id.json?login=string&authtoken=string&locale=string - GETCount Products filtered by category.
/products/category/:category_id/count.json?login=string&authtoken=string&locale=string - GETCount all Products.
/products/count.json?login=string&authtoken=string - GETRetrieve a Product List from a query.
/products/search.json?login=string&authtoken=string&locale=string&query=string&fields=skuEndpoint example: https://api.jumpseller.com/v1/products/search.json?login=XXXXXX&authtoken=XXXXX&query=test&fields=name,description - GETRetrieve Products filtered by status.
/products/status/:status.json?login=string&authtoken=string&locale=string - GETCount Products filtered by status.
/products/status/:status/count.json?login=string&authtoken=string&locale=string - GETRetrieve a single Product.
/products/:id.json?login=string&authtoken=string&locale=string - PUTModify an existing Product.
/products/:id.json?login=string&authtoken=string&locale=string - DELETEDelete an existing Product.
/products/:id.json?login=string&authtoken=string
Product Attachments
- GETRetrieve all Product Attachments.
/products/:id/attachments.json?login=string&authtoken=string - POSTCreate a new Product Attachment.
/products/:id/attachments.json?login=string&authtoken=string - GETCount all Product Attachments.
/products/:id/attachments/count.json?login=string&authtoken=string - GETRetrieve a single Product Attachment.
/products/:id/attachments/:attachment_id.json?login=string&authtoken=string - DELETEDelete a Product Attachment.
/products/:id/attachments/:attachment_id.json?login=string&authtoken=string
Product DigitalProducts
- GETRetrieve all Product DigitalProducts.
/products/:id/digital_products.json?login=string&authtoken=string - POSTCreate a new Product DigitalProduct.
/products/:id/digital_products.json?login=string&authtoken=string - GETCount all Product DigitalProducts.
/products/:id/digital_products/count.json?login=string&authtoken=string - GETRetrieve a single Product DigitalProduct.
/products/:id/digital_products/:digital_product_id.json?login=string&authtoken=string - DELETEDelete a Product DigitalProduct.
/products/:id/digital_products/:digital_product_id.json?login=string&authtoken=string
Product Custom Fields
- GETRetrieve all Product Custom Fields
/products/:id/fields.json?login=string&authtoken=string - POSTAdd an existing Custom Field to a Product.
/products/:id/fields.json?login=string&authtoken=string - GETCount all Product Custom Fields.
/products/:id/fields/count.json?login=string&authtoken=string - PUTUpdate value of Product Custom Field
/products/:product_id/fields/:field_id.json?login=string&authtoken=string - DELETEDelete value of Product Custom Field
/products/:product_id/fields/:field_id.json?login=string&authtoken=string
Product Images
- GETRetrieve all Product Images.
/products/:id/images.json?login=string&authtoken=string - POSTCreate a new Product Image.
/products/:id/images.json?login=string&authtoken=string - GETCount all Product Images.
/products/:id/images/count.json?login=string&authtoken=string - GETRetrieve a single Product Image.
/products/:id/images/:image_id.json?login=string&authtoken=string - DELETEDelete a Product Image.
/products/:id/images/:image_id.json?login=string&authtoken=string
Product Options
- GETRetrieve all Product Options.
/products/:id/options.json?login=string&authtoken=string - POSTCreate a new Product Option.
/products/:id/options.json?login=string&authtoken=string - GETCount all Product Options.
/products/:id/options/count.json?login=string&authtoken=string - GETRetrieve a single Product Option.
/products/:id/options/:option_id.json?login=string&authtoken=string - PUTModify an existing Product Option.
/products/:id/options/:option_id.json?login=string&authtoken=string - DELETEDelete a Product Option.
/products/:id/options/:option_id.json?login=string&authtoken=string
Product Option Values
- GETRetrieve all Product Option Values.
/products/:id/options/:option_id/values.json?login=string&authtoken=string - POSTCreate a new Product Option Value.
/products/:id/options/:option_id/values.json?login=string&authtoken=string - GETCount all Product Option Values.
/products/:id/options/:option_id/values/count.json?login=string&authtoken=string - GETRetrieve a single Product Option Value.
/products/:id/options/:option_id/values/:value_id.json?login=string&authtoken=string - PUTModify an existing Product Option Value.
/products/:id/options/:option_id/values/:value_id.json?login=string&authtoken=string - DELETEDelete a Product Option Value.
/products/:id/options/:option_id/values/:value_id.json?login=string&authtoken=string
Product Variants
- GETRetrieve all Product Variants.
/products/:id/variants.json?login=string&authtoken=string - POSTCreate a new Product Variant.
/products/:id/variants.json?login=string&authtoken=string - GETCount all Product Variants.
/products/:id/variants/count.json?login=string&authtoken=string - GETRetrieve a single Product Variant.
/products/:id/variants/:variant_id.json?login=string&authtoken=string - PUTModify an existing Product Variant.
/products/:id/variants/:variant_id.json?login=string&authtoken=string
Promotions
- GETRetrieve all Promotions.
/promotions.json?login=string&authtoken=string&limit=0&page=0 - POSTCreate a new Promotion.
/promotions.json?login=string&authtoken=string - GETRetrieve a single Promotion.
/promotions/:id.json?login=string&authtoken=string - PUTUpdate a Promotion.
/promotions/:id.json?login=string&authtoken=string - DELETEDelete an existing Promotion.
/promotions/:id.json?login=string&authtoken=string
Shipping Methods
- GETRetrieve all Store's Shipping Methods.
/shipping_methods.json?login=string&authtoken=string - POSTCreates a Shipping Method.
/shipping_methods.json?login=string&authtoken=string - GETRetrieve a single Shipping Method.
/shipping_methods/:id.json?login=string&authtoken=string - PUTUpdate a Shipping Method.
/shipping_methods/:id.json?login=string&authtoken=string - DELETEDelete an existing Shipping Method.
/shipping_methods/:id.json?login=string&authtoken=string
Stores
- GETRetrieve Store Information.
/store/info.json?login=string&authtoken=string - GETRetrieve Store Languages.
/store/languages.json?login=string&authtoken=string
Taxes
- GETRetrieve all Taxes.
/taxes.json?login=string&authtoken=string - POSTCreate a new Tax.
/taxes.json?login=string&authtoken=string - GETRetrieve a single Tax information.
/taxes/:id.json?login=string&authtoken=string
API details
- Base URL
https://api.jumpseller.com/v1- Authentication
- None declared in the description
- Operations
- 142 operations on 82 pathsGET 80POST 25DELETE 20PUT 17
- Main resources
- Products 12Orders 9Customer Categories 8Customers 7Categories 6Custom Fields 6Pages 6Product Option Values 6Product Options 6Checkout Custom Fields 5
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Jumpseller API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Jumpseller API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Retrieve all Categories.” (GET /categories.json?login=string&authtoken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Jumpseller API?
Endpoint Structure All URLs are in the format: https://api.jumpseller.com/v1/path.json?login=XXXXXX&authtoken=storetoken The path is prefixed by the API… It is listed under E-commerce and has 142 endpoints.
Who publishes the Jumpseller API?
It is listed from Jumpseller's public API description (an OpenAPI document), not published by Jumpseller on Swastik Codes. Anyone who controls jumpseller.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Jumpseller API?
Requests go to https://api.jumpseller.com/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Jumpseller API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Jumpseller API have?
142 operations on 82 paths (80 GET, 25 POST, 20 DELETE, 17 PUT). The largest groups are Products, Orders, Customer Categories, Customers.
Is forking the Jumpseller API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.