jumpseller-api

name	jumpseller-api
description	Jumpseller API skill. Use when working with Jumpseller for store, hooks.json, hooks. Covers 182 endpoints.
version	1.0.0
generator	lapsh

Jumpseller API

API version: 1.0.0

Auth

Bearer basic | ApiKey login in query | ApiKey authtoken in query | ApiKey partner_code in query | ApiKey auth_token in query

Base URL

https://api.jumpseller.com/v1

Setup

1. Set Authorization header with your Bearer token
2. GET /store/info.json -- verify access
3. POST /hooks.json -- create first hooks.json

Endpoints

182 endpoints across 42 groups. See references/api-spec.lap for full details.

store

Method	Path	Description
GET	/store/info.json	Retrieve Store Information.
GET	/store/languages.json	Retrieve Store Languages.
POST	/store/create.json	Create a Partnered Store
GET	/store/check_status.json	Retrive store creation status.

hooks.json

Method	Path	Description
GET	/hooks.json	Retrieve all Hooks.
POST	/hooks.json	Create a new Hook.

hooks

Method	Path	Description
GET	/hooks/{id}.json	Retrieve a single Hook.
PUT	/hooks/{id}.json	Update a Hook.
DELETE	/hooks/{id}.json	Delete an existing Hook.

jsapps.json

Method	Path	Description
GET	/jsapps.json	Retrieve all the Store's JSApps.
POST	/jsapps.json	Create a Store JSApp.

jsapps

Method	Path	Description
GET	/jsapps/{code}.json	Retrieve a JSApp.
DELETE	/jsapps/{code}.json	Delete an existing JSApp.

apps

Method	Path	Description
GET	/apps/{code}/install_status.json	Retrieve an OauthApplication installation status.
GET	/apps/{code}/install_status_by_store_id.json	Retrieve an OauthApplication installation status for a specific Store.
GET	/apps/{code}/billing_cycle_dates.json	Retrieve billing cycle start and billing cycle end for an OauthApplication.
GET	/apps/{code}/billing_cycle_orders.json	Retrieve billing cycle orders for an OauthApplication.
GET	/apps/{code}/check_billing_cycle_order.json	Retrieve a billing cycle order information for an OauthApplication.

products.json

Method	Path	Description
GET	/products.json	Retrieve all Products.
POST	/products.json	Create a new Product.

products

Method	Path	Description
GET	/products/count.json	Count all Products.
GET	/products/after/{id}.json	Retrieves Products after the given id.
GET	/products/status/{status}.json	Retrieve Products filtered by status.
GET	/products/category/{category_id}.json	Retrieve Products filtered by category.
GET	/products/status/{status}/count.json	Count Products filtered by status.
GET	/products/category/{category_id}/count.json	Count Products filtered by category.
GET	/products/{id}/reviews.json	Retrieve all reviews for a specific Product.
GET	/products/reviews/{review_id}.json	Retrieve a single Product Review.
GET	/products/reviews.json	Retrieve all Product Reviews.
GET	/products/{id}.json	Retrieve a single Product.
PUT	/products/{id}.json	Modify an existing Product.
DELETE	/products/{id}.json	Delete an existing Product.
GET	/products/search.json	Retrieve a Product List from a query.
GET	/products/{id}/options.json	Retrieve all Product Options.
POST	/products/{id}/options.json	Create a new Product Option.
GET	/products/{id}/options/count.json	Count all Product Options.
GET	/products/{id}/options/{option_id}.json	Retrieve a single Product Option.
PUT	/products/{id}/options/{option_id}.json	Modify an existing Product Option.
DELETE	/products/{id}/options/{option_id}.json	Delete a Product Option.
GET	/products/{id}/options/{option_id}/values.json	Retrieve all Product Option Values.
POST	/products/{id}/options/{option_id}/values.json	Create a new Product Option Value.
GET

categories.json

Method	Path	Description
GET	/categories.json	Retrieve all Categories.
POST	/categories.json	Create a new Category.

categories

Method	Path	Description
GET	/categories/count.json	Count all Categories.
GET	/categories/{id}.json	Retrieve a single Category.
PUT	/categories/{id}.json	Modify an existing Category.
DELETE	/categories/{id}.json	Delete an existing Category.

orders.json

Method	Path	Description
GET	/orders.json	Retrieve all Orders.
POST	/orders.json	Create a new Order.

orders

Method	Path	Description
GET	/orders/count.json	Count all Orders.
GET	/orders/status/{status}.json	Retrieve orders filtered by status.
GET	/orders/{id}.json	Retrieve a single Order.
PUT	/orders/{id}.json	Modify an existing Order.
GET	/orders/search.json	Retrieve an Orders List from a query.
GET	/orders/after/{id}.json	Retrieve orders filtered by Order Id.
GET	/orders/{id}/history.json	Retrieve all Order History.
POST	/orders/{id}/history.json	Create a new Order History Entry.
GET	/orders/{id}/documents.json	Retrieve all Documents from an Order.
POST	/orders/{id}/documents.json	Create a new Order Document Entry.
PUT	/orders/{id}/documents/{public_id}.json	Update a Document from an Order.
DELETE	/orders/{id}/documents/{public_id}.json	Delete a Document from an Order.

fulfillments

Method	Path	Description
GET	/fulfillments/count.json	Count all Fulfillments.
POST	/fulfillments/rates.json	Rates for fulfillment.
GET	/fulfillments/{id}/label.json	Retrieve a presigned URL for the Fulfillment label
GET	/fulfillments/{id}.json	Retrieve a single Fulfillment.
PUT	/fulfillments/{id}.json	Modify an existing Fulfillment.

fulfillments.json

Method	Path	Description
GET	/fulfillments.json	Retrieve all Fulfillments.
POST	/fulfillments.json	Create a new Fulfillment.

order

Method	Path	Description
GET	/order/{id}/fulfillments.json	Retrieve the Fulfillments associated with the Order.

pages.json

Method	Path	Description
GET	/pages.json	Retrieve all Pages.
POST	/pages.json	Create a new Page.

pages

Method	Path	Description
GET	/pages/count.json	Count all Pages.
GET	/pages/{id}.json	Retrieve a single Page by id.
PUT	/pages/{id}.json	Update a Page.
DELETE	/pages/{id}.json	Delete an existing Page.
GET	/pages/{id}/images.json	Retrieve all Page Images.
POST	/pages/{id}/images.json	Create a new Page Image.
GET	/pages/{id}/images/count.json	Count all Page Images.
GET	/pages/{id}/images/{image_id}.json	Retrieve a single Page Image.
PUT	/pages/{id}/images/{image_id}.json	Update a Page Image url.
DELETE	/pages/{id}/images/{image_id}.json	Delete a Page Image.

customers.json

Method	Path	Description
GET	/customers.json	Retrieve all Customers.
POST	/customers.json	Create a new Customer.

customers

Method	Path	Description
GET	/customers/count.json	Count all Customers.
GET	/customers/email/{email}.json	Retrieve a single Customer by email.
GET	/customers/{id}/orders.json	Retrieve all orders of single Customer
GET	/customers/{id}/orders/status/{status}.json	Retrieve all orders of single Customer
GET	/customers/{id}.json	Retrieve a single Customer by id.
PUT	/customers/{id}.json	Update a new Customer.
DELETE	/customers/{id}.json	Delete an existing Customer.
GET	/customers/search.json	Retrieve a Customer List from a query.
GET	/customers/{id}/fields	Retrieves the Customer Additional Field of a Customer.
POST	/customers/{id}/fields	Adds Customer Additional Fields to a Customer.
GET	/customers/{id}/fields/{field_id}	Retrieve a single Customer Additional Field.
PUT	/customers/{id}/fields/{field_id}	Update a Customer Additional Field.
DELETE	/customers/{id}/fields/{field_id}	Delete a Customer Additional Field.

customer_categories.json

Method	Path	Description
GET	/customer_categories.json	Retrieve all Customer Categories.
POST	/customer_categories.json	Create a new CustomerCategory.

customer_categories

Method	Path	Description
GET	/customer_categories/{id}.json	Retrieve a single CustomerCategory.
PUT	/customer_categories/{id}.json	Update a CustomerCategory.
DELETE	/customer_categories/{id}.json	Delete an existing CustomerCategory.
GET	/customer_categories/{id}/customers.json	Retrieves the customers in a CustomerCategory.
POST	/customer_categories/{id}/customers.json	Adds Customers to a CustomerCategory.
DELETE	/customer_categories/{id}/customers/{customer_id}.json	Delete Customer from an existing CustomerCategory.

promotions.json

Method	Path	Description
GET	/promotions.json	Retrieve all Promotions.
POST	/promotions.json	Create a new Promotion.

promotions

Method	Path	Description
GET	/promotions/{id}.json	Retrieve a single Promotion.
PUT	/promotions/{id}.json	Update a Promotion.
DELETE	/promotions/{id}.json	Delete an existing Promotion.

payment_methods.json

Method	Path	Description
GET	/payment_methods.json	Retrieve all Store's Payment Methods.
POST	/payment_methods.json	Creates an External Payment Method.

payment_methods

Method	Path	Description
GET	/payment_methods/{id}.json	Retrieve a single Payment Method.

shipping_methods.json

Method	Path	Description
GET	/shipping_methods.json	Retrieve all Store's Shipping Methods.
POST	/shipping_methods.json	Creates a Shipping Method.

shipping_methods

Method	Path	Description
GET	/shipping_methods/{id}.json	Retrieve a single Shipping Method.
PUT	/shipping_methods/{id}.json	Update a Shipping Method.
DELETE	/shipping_methods/{id}.json	Delete an existing Shipping Method.

locations.json

Method	Path	Description
GET	/locations.json	Retrieve all Store's Locations
POST	/locations.json	Create a Pickup Location

locations

Method	Path	Description
GET	/locations/{id}.json	Retrieve a Store's Locations by ID
PUT	/locations/{id}.json	Update a Pickup Location
DELETE	/locations/{id}.json	Delete a Store's Locations by ID

custom_fields.json

Method	Path	Description
GET	/custom_fields.json	Retrieve all Store's Custom Fields.
POST	/custom_fields.json	Create a new Custom Field.

custom_fields

Method	Path	Description
GET	/custom_fields/{id}.json	Retrieve a single CustomField.
PUT	/custom_fields/{id}.json	Update a CustomField.
DELETE	/custom_fields/{id}.json	Delete an existing CustomField.
GET	/custom_fields/{id}/select_options.json	Retrieve all Store's Custom Fields.
POST	/custom_fields/{id}/select_options.json	Create a new Custom Field Select Option.
GET	/custom_fields/{id}/select_options/{custom_field_select_option_id}.json	Retrieve a single SelectOption from a CustomField.
PUT	/custom_fields/{id}/select_options/{custom_field_select_option_id}.json	Update a SelectOption from a CustomField.
DELETE	/custom_fields/{id}/select_options/{custom_field_select_option_id}.json	Delete an existing CustomFieldSelectOption.

checkout_custom_fields.json

Method	Path	Description
GET	/checkout_custom_fields.json	Retrieve all Checkout Custom Fields.
POST	/checkout_custom_fields.json	Create a new CheckoutCustomField.

checkout_custom_fields

Method	Path	Description
GET	/checkout_custom_fields/{id}.json	Retrieve a single CheckoutCustomField.
PUT	/checkout_custom_fields/{id}.json	Update a CheckoutCustomField.
DELETE	/checkout_custom_fields/{id}.json	Delete an existing CheckoutCustomField.

countries.json

Method	Path	Description
GET	/countries.json	Retrieve all Countries.

countries

Method	Path	Description
GET	/countries/{country_code}.json	Retrieve a single Country information.
GET	/countries/{country_code}/regions.json	Retrieve all Regions from a single Country.
GET	/countries/{country_code}/regions/{region_code}/municipalities.json	Retrieve all Municipalities from a single Region.
GET	/countries/{country_code}/regions/{region_code}.json	Retrieve a single Region information object.

taxes.json

Method	Path	Description
GET	/taxes.json	Retrieve all Taxes.
POST	/taxes.json	Create a new Tax.

taxes

Method	Path	Description
GET	/taxes/{id}.json	Retrieve a single Tax information.

partners

Method	Path	Description
GET	/partners/stores.json	Retrieve statistics.
GET	/partners/subscriptions.json	Retrieve subscriptions and transactions.

carts

Method	Path	Description
GET	/carts/{id}.json	Obtain information for a cart.

documents.json

Method	Path	Description
GET	/documents.json	Retrieve all Documents from a Store.

transaction_ledger

Method	Path	Description
GET	/transaction_ledger/balance.json	Store Balance

products_locations

Method	Path	Description
GET	/products_locations	Stock by Product and Location
PUT	/products_locations	Update Stock by Product and Location

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all info.json?" -> GET /store/info.json
• "List all languages.json?" -> GET /store/languages.json
• "List all hooks.json?" -> GET /hooks.json
• "Create a hooks.json?" -> POST /hooks.json
• "Get hook details?" -> GET /hooks/{id}.json
• "Update a hook?" -> PUT /hooks/{id}.json
• "Delete a hook?" -> DELETE /hooks/{id}.json
• "List all jsapps.json?" -> GET /jsapps.json
• "Create a jsapps.json?" -> POST /jsapps.json
• "Get jsapp details?" -> GET /jsapps/{code}.json
• "Delete a jsapp?" -> DELETE /jsapps/{code}.json
• "List all install_status.json?" -> GET /apps/{code}/install_status.json
• "List all install_status_by_store_id.json?" -> GET /apps/{code}/install_status_by_store_id.json
• "List all billing_cycle_dates.json?" -> GET /apps/{code}/billing_cycle_dates.json
• "List all billing_cycle_orders.json?" -> GET /apps/{code}/billing_cycle_orders.json
• "List all check_billing_cycle_order.json?" -> GET /apps/{code}/check_billing_cycle_order.json
• "List all products.json?" -> GET /products.json
• "Create a products.json?" -> POST /products.json
• "List all count.json?" -> GET /products/count.json
• "Get after details?" -> GET /products/after/{id}.json
• "Get status details?" -> GET /products/status/{status}.json
• "Get category details?" -> GET /products/category/{category_id}.json
• "List all count.json?" -> GET /products/status/{status}/count.json
• "List all count.json?" -> GET /products/category/{category_id}/count.json
• "List all reviews.json?" -> GET /products/{id}/reviews.json
• "Get review details?" -> GET /products/reviews/{review_id}.json
• "List all reviews.json?" -> GET /products/reviews.json
• "Get product details?" -> GET /products/{id}.json
• "Update a product?" -> PUT /products/{id}.json
• "Delete a product?" -> DELETE /products/{id}.json
• "Search search.json?" -> GET /products/search.json
• "List all options.json?" -> GET /products/{id}/options.json
• "Create a options.json?" -> POST /products/{id}/options.json
• "List all count.json?" -> GET /products/{id}/options/count.json
• "Get option details?" -> GET /products/{id}/options/{option_id}.json
• "Update a option?" -> PUT /products/{id}/options/{option_id}.json
• "Delete a option?" -> DELETE /products/{id}/options/{option_id}.json
• "List all values.json?" -> GET /products/{id}/options/{option_id}/values.json
• "Create a values.json?" -> POST /products/{id}/options/{option_id}/values.json

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP