jumpseller-api — quality + safety report

---
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 | /products/{id}/options/{option_id}/values/count.json | Count all Product Option Values. |
| GET | /products/{id}/options/{option_id}/values/{value_id}.json | Retrieve a single Product Option Value. |
| PUT | /products/{id}/options/{option_id}/values/{value_id}.json | Modify an existing Product Option Value. |
| DELETE | /products/{id}/options/{option_id}/values/{value_id}.json | Delete a Product Option Value. |
| GET | /products/{id}/variants/{variant_id}.json | Retrieve a single Product Variant. |
| PUT | /products/{id}/variants/{variant_id}.json | Modify an existing Product Variant. |
| GET | /products/{id}/variants.json | Retrieve all Product Variants. |
| POST | /products/{id}/variants.json | Create a new Product Variant. |
| GET | /products/{id}/variants/count.json | Count all Product Variants. |
| GET | /products/{id}/images.json | Retrieve all Product Images. |
| POST | /products/{id}/images.json | Create a new Product Image. |
| PUT | /products/{product_id}/images/{image_id}.json | Update a Product Image position. |
| GET | /products/{id}/images/count.json | Count all Product Images. |
| GET | /products/{id}/images/{image_id}.json | Retrieve a single Product Image. |
| DELETE | /products/{id}/images/{image_id}.json | Delete a Product Image. |
| GET | /products/{id}/attachments.json | Retrieve all Product Attachments. |
| POST | /products/{id}/attachments.json | Create a new Product Attachment. |
| GET | /products/{id}/attachments/count.json | Count all Product Attachments. |
| GET | /products/{id}/attachments/{attachment_id}.json | Retrieve a single Product Attachment. |
| DELETE | /products/{id}/attachments/{attachment_id}.json | Delete a Product Attachment. |
| GET | /products/{id}/digital_products.json | Retrieve all Product DigitalProducts. |
| POST | /products/{id}/digital_products.json | Create a new Product DigitalProduct. |
| GET | /products/{id}/digital_products/count.json | Count all Product DigitalProducts. |
| GET | /products/{id}/digital_products/{digital_product_id}.json | Retrieve a single Product DigitalProduct. |
| DELETE | /products/{id}/digital_products/{digital_product_id}.json | Delete a Product DigitalProduct. |
| GET | /products/{id}/fields.json | Retrieve all Product Custom Fields |
| POST | /products/{id}/fields.json | Add an existing Custom Field to a Product. |
| GET | /products/{id}/fields/count.json | Count all Product Custom Fields. |
| PUT | /products/{product_id}/fields/{field_id}.json | Update value of Product Custom Field |
| DELETE | /products/{product_id}/fields/{field_id}.json | Delete value of Product Custom Field |

### 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_

… (truncated)