Jumpseller API

OpenAPI apis-guru ecommerce

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 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 . Please read the article 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:

In curl, you can invoque that URL with:

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

and to update the product identified with 123:

or delete it:

PHP Examples

Create a new Product (POST method)

php

$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 methodcurl_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:

ruby

tries = 0; max_tries = 3;begin  HTTParty.send(method, uri) # perform an API call.  sleep 0.5  tries += 1rescue  unless tries >= max_tries    sleep 1.0 # wait the necessary time before retrying the call again.    retry  endend

Finally, you can review the Response Headers of each request:

text

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 interval

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

provides a public Ruby abstraction over our API;
showcases external integrations with Jumpseller done by technical experts;
provides an easy way to upload and temporaly host for images and files.

$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 methodcurl_setopt($ch, CURLOPT_POSTFIELDS, '{ "product" : {"name": "My updated Product!", "price": 99} }');
$result = curl_exec($ch);print_r($result);curl_close($ch);

tries = 0; max_tries = 3;begin  HTTParty.send(method, uri) # perform an API call.  sleep 0.5  tries += 1rescue  unless tries >= max_tries    sleep 1.0 # wait the necessary time before retrying the call again.    retry  endend

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 interval

Homepage: https://api.apis.guru/v2/specs/jumpseller.com/1.0.0.json
Provider: jumpseller.com
OpenAPI version: 2.0
Spec (JSON): https://api.apis.guru/v2/specs/jumpseller.com/1.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/jumpseller.com/1.0.0/openapi.yaml

Tools (144)

Extracted live via the executor SDK.

apps.deleteJsappsCodeJson

Delete an existing JSApp.
apps.getJsappsCodeJson

Retrieve a JSApp.
apps.getJsappsJson

Retrieve all the Store's JSApps.
apps.postJsappsJson

Create a Store JSApp.
categories.deleteCategoriesIdJson

Delete an existing Category.
categories.getCategoriesCountJson

Count all Categories.
categories.getCategoriesIdJson

Retrieve a single Category.
categories.getCategoriesJson

Retrieve all Categories.
categories.postCategoriesJson

Category's permalink is automatically generated from the given category's name.
categories.putCategoriesIdJson

Modify an existing Category.
checkoutCustomFields.deleteCheckoutCustomFieldsIdJson

Delete an existing CheckoutCustomField.
checkoutCustomFields.getCheckoutCustomFieldsIdJson

Retrieve a single CheckoutCustomField.
checkoutCustomFields.getCheckoutCustomFieldsJson

Retrieve all Checkout Custom Fields.
checkoutCustomFields.postCheckoutCustomFieldsJson

Type values can be: input, selection, checkbox, date or text. Area values can be: contact, billing_shipping or other.
checkoutCustomFields.putCheckoutCustomFieldsIdJson

Update a CheckoutCustomField.
countries.getCountriesCountryCodeJson

Retrieve a single Country information.
countries.getCountriesCountryCodeRegionsJson

Retrieve all Regions from a single Country.
countries.getCountriesCountryCodeRegionsRegionCodeJson

Retrieve a single Region information object.
countries.getCountriesJson

Retrieve all Countries.
customerAdditionalFields.deleteCustomersIdFieldsFieldId

Delete a Customer Additional Field.
customerAdditionalFields.getCustomersIdFields

Retrieves the Customer Additional Field of a Customer.
customerAdditionalFields.getCustomersIdFieldsFieldId

Retrieve a single Customer Additional Field.
customerAdditionalFields.postCustomersIdFields

Adds Customer Additional Fields to a Customer.
customerAdditionalFields.putCustomersIdFieldsFieldId

Update a Customer Additional Field.
customerCategories.deleteCustomerCategoriesIdCustomersJson

Delete Customers from an existing CustomerCategory.
customerCategories.deleteCustomerCategoriesIdJson

Delete an existing CustomerCategory.
customerCategories.getCustomerCategoriesIdCustomersJson

Retrieves the customers in a CustomerCategory.
customerCategories.getCustomerCategoriesIdJson

Retrieve a single CustomerCategory.
customerCategories.getCustomerCategoriesJson

Retrieve all Customer Categories.
customerCategories.postCustomerCategoriesIdCustomersJson

Adds Customers to a CustomerCategory.
customerCategories.postCustomerCategoriesJson

Create a new CustomerCategory.
customerCategories.putCustomerCategoriesIdJson

Update a CustomerCategory.
customers.deleteCustomersIdJson

Delete an existing Customer.
customers.getCustomersCountJson

Count all Customers.
customers.getCustomersEmailEmailJson

Retrieve a single Customer by email.
customers.getCustomersIdJson

Retrieve a single Customer by id.
customers.getCustomersJson

Retrieve all Customers.
customers.postCustomersJson

Create a new Customer.
customers.putCustomersIdJson

Update a new Customer.
customFields.deleteCustomFieldsIdJson

Delete an existing CustomField.
customFields.deleteCustomFieldsIdSelectOptionsCustomFieldSelectOptionIdJson

Delete an existing CustomFieldSelectOption.
customFields.getCustomFieldsIdJson

Retrieve a single CustomField.
customFields.getCustomFieldsJson

Retrieve all Store's Custom Fields.
customFields.postCustomFieldsJson

Create a new Custom Field.
customFields.putCustomFieldsIdJson

Update a CustomField.
customFieldSelectOptions.getCustomFieldsIdSelectOptionsCustomFieldSelectOptionIdJson

Retrieve a single SelectOption from a CustomField.
customFieldSelectOptions.getCustomFieldsIdSelectOptionsJson

Retrieve all Store's Custom Fields.
customFieldSelectOptions.postCustomFieldsIdSelectOptionsJson

Create a new Custom Field Select Option.
customFieldSelectOptions.putCustomFieldsIdSelectOptionsCustomFieldSelectOptionIdJson

Update a SelectOption from a CustomField.
fulfillments.getFulfillmentsCountJson

Count all Fulfillments.
fulfillments.getFulfillmentsIdJson

Retrieve a single Fulfillment.
fulfillments.getFulfillmentsJson

Retrieve all Fulfillments.
fulfillments.getOrderIdFulfillmentsJson

Retrieve the Fulfillments associated with the Order.
hooks.deleteHooksIdJson

Delete an existing Hook.
hooks.getHooksIdJson

Retrieve a single Hook.
hooks.getHooksJson

Retrieve all Hooks.
hooks.postHooksJson

Create a new Hook.
hooks.putHooksIdJson

Update a Hook.
orders.getOrdersAfterIdJson

For example the GET /orders/after/5000 will return Order 5001, 5002, 5003, etc.
orders.getOrdersCountJson

Count all Orders.
orders.getOrdersIdHistoryJson

Retrieve all Order History.
orders.getOrdersIdJson

Retrieve a single Order.
orders.getOrdersJson

Retrieve all Orders.
orders.getOrdersStatusStatusJson

Retrieve orders filtered by status.
orders.postOrdersIdHistoryJson

Create a new Order History Entry.
orders.postOrdersJson

Orders created externally keep the given order product's values (bypassing internal promotion or product amounts).
orders.putOrdersIdJson

Only status, shipment_status, tracking_number, tracking_company, tracking_url, additional_information and additional_fields are available for update. An email is send if shipment_status changes.
pages.deletePagesIdJson

Delete an existing Page.
pages.getPagesCountJson

Count all Pages.
pages.getPagesIdJson

Retrieve a single Page by id.
pages.getPagesJson

Retrieve all Pages.
pages.postPagesJson

Create a new Page.
pages.putPagesIdJson

Update a Page.
partners.getPartnersStoresJson

Retrieve statistics.
partners.getStoreCheckStatusJson

Retrive store creation status.
partners.postStoreCreateJson

Create a Partnered Store
paymentMethods.getPaymentMethodsIdJson

Retrieve a single Payment Method.
paymentMethods.getPaymentMethodsJson

Retrieve all Store's Payment Methods.
productAttachments.deleteProductsIdAttachmentsAttachmentIdJson

Delete a Product Attachment.
productAttachments.getProductsIdAttachmentsAttachmentIdJson

Retrieve a single Product Attachment.
productAttachments.getProductsIdAttachmentsCountJson

Count all Product Attachments.
productAttachments.getProductsIdAttachmentsJson

Retrieve all Product Attachments.
productAttachments.postProductsIdAttachmentsJson

Create a new Product Attachment.
productCustomFields.deleteProductsProductIdFieldsFieldIdJson

Delete value of Product Custom Field
productCustomFields.getProductsIdFieldsCountJson

Count all Product Custom Fields.
productCustomFields.getProductsIdFieldsJson

Retrieve all Product Custom Fields
productCustomFields.postProductsIdFieldsJson

Add an existing Custom Field to a Product.
productCustomFields.putProductsProductIdFieldsFieldIdJson

Update value of Product Custom Field
productDigitalProducts.deleteProductsIdDigitalProductsDigitalProductIdJson

Delete a Product DigitalProduct.
productDigitalProducts.getProductsIdDigitalProductsCountJson

Count all Product DigitalProducts.
productDigitalProducts.getProductsIdDigitalProductsDigitalProductIdJson

Retrieve a single Product DigitalProduct.
productDigitalProducts.getProductsIdDigitalProductsJson

Retrieve all Product DigitalProducts.
productDigitalProducts.postProductsIdDigitalProductsJson

Create a new Product DigitalProduct.
productImages.deleteProductsIdImagesImageIdJson

Delete a Product Image.
productImages.getProductsIdImagesCountJson

Count all Product Images.
productImages.getProductsIdImagesImageIdJson

Retrieve a single Product Image.
productImages.getProductsIdImagesJson

Retrieve all Product Images.
productImages.postProductsIdImagesJson

Create a new Product Image.
productOptions.deleteProductsIdOptionsOptionIdJson

Delete a Product Option.
productOptions.getProductsIdOptionsCountJson

Count all Product Options.
productOptions.getProductsIdOptionsJson

Retrieve all Product Options.
productOptions.getProductsIdOptionsOptionIdJson

Retrieve a single Product Option.
productOptions.postProductsIdOptionsJson

Create a new Product Option.
productOptions.putProductsIdOptionsOptionIdJson

Modify an existing Product Option.
productOptionValues.deleteProductsIdOptionsOptionIdValuesValueIdJson

Delete a Product Option Value.
productOptionValues.getProductsIdOptionsOptionIdValuesCountJson

Count all Product Option Values.
productOptionValues.getProductsIdOptionsOptionIdValuesJson

Retrieve all Product Option Values.
productOptionValues.getProductsIdOptionsOptionIdValuesValueIdJson

Retrieve a single Product Option Value.
productOptionValues.postProductsIdOptionsOptionIdValuesJson

Create a new Product Option Value.
productOptionValues.putProductsIdOptionsOptionIdValuesValueIdJson

Modify an existing Product Option Value.
products.deleteProductsIdJson

Delete an existing Product.
products.getProductsAfterIdJson

Retrieves Products after the given id.
products.getProductsCategoryCategoryIdCountJson

Count Products filtered by category.
products.getProductsCategoryCategoryIdJson

Retrieve Products filtered by category.
products.getProductsCountJson

Count all Products.
products.getProductsIdJson

Retrieve a single Product.
products.getProductsJson

Retrieve all Products.

products.getProductsSearchJson

Endpoint example:

products.getProductsStatusStatusCountJson

Count Products filtered by status.
products.getProductsStatusStatusJson

Retrieve Products filtered by status.
products.postProductsJson

Create a new Product.
products.putProductsIdJson

Modify an existing Product.
productVariants.getProductsIdVariantsCountJson

Count all Product Variants.
productVariants.getProductsIdVariantsJson

Retrieve all Product Variants.
productVariants.getProductsIdVariantsVariantIdJson

Retrieve a single Product Variant.
productVariants.postProductsIdVariantsJson

Create a new Product Variant.
productVariants.putProductsIdVariantsVariantIdJson

Modify an existing Product Variant.
promotions.deletePromotionsIdJson

Delete an existing Promotion.
promotions.getPromotionsIdJson

Retrieve a single Promotion.
promotions.getPromotionsJson

Retrieve all Promotions.
promotions.postPromotionsJson

Create a new Promotion.
promotions.putPromotionsIdJson

Update a Promotion.
shippingMethods.deleteShippingMethodsIdJson

Delete an existing Shipping Method.
shippingMethods.getShippingMethodsIdJson

Retrieve a single Shipping Method.
shippingMethods.getShippingMethodsJson

Retrieve all Store's Shipping Methods.
shippingMethods.postShippingMethodsJson

Creates a Shipping Method.
shippingMethods.putShippingMethodsIdJson

Update a Shipping Method.
stores.getStoreInfoJson

Retrieve Store Information.
stores.getStoreLanguagesJson
taxes.getTaxesIdJson

Retrieve a single Tax information.
taxes.getTaxesJson

Retrieve all Taxes.
taxes.postTaxesJson

Create a new Tax.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools