# Jumpseller API API

> Jumpseller API API on Apizie: 142 endpoints (Retrieve all Categories., Create a new Category., Count all Categories., Retrieve a single Category., …) returned as clean JSON through one API key. 142 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/ecommerce:jumpseller/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:jumpseller`
- Category: E-commerce
- Status: live
- Source: https://jumpseller.com
- Page: https://zieapi.vercel.app/api/ecommerce/jumpseller
- OpenAPI: https://zieapi.vercel.app/api/ecommerce/jumpseller/openapi.json

# Endpoint Structure All URLs are in the format: ```text https://api.jumpseller.com/v1/path.json?login=XXXXXX&authtoken=storetoken ``` The path is prefixed by the API version and the URL takes as parameters the login…

## Endpoints

### Retrieve all Categories.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-categories-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Create a new Category.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-categories-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Count all Categories.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-categories-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Category.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Category |

### Modify an existing Category.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Category |
| body | object | yes | JSON request body |

### Delete an existing Category.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Category |

### Retrieve all Checkout Custom Fields.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-checkout-custom-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new CheckoutCustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-checkout-custom-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve a single CheckoutCustomField.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-checkout-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CheckoutCustomField |

### Update a CheckoutCustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-checkout-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CheckoutCustomField |
| body | object | yes | JSON request body |

### Delete an existing CheckoutCustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-checkout-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CheckoutCustomField |

### Retrieve all Countries.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-countries-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Country information.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-countries-country-code-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| country_code | string | yes | ISO3166 Country Code |

### Retrieve all Regions from a single Country.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-countries-country-code-regions-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| country_code | string | yes | ISO3166 Country Code |

### Retrieve a single Region information object.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-countries-country-code-regions-region-code-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| country_code | string | yes | ISO3166 Country Code |
| region_code | string | yes | Region Code |

### Retrieve all Store's Custom Fields.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-custom-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Create a new Custom Field.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-custom-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve a single CustomField.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |

### Update a CustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |
| body | object | yes | JSON request body |

### Delete an existing CustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-custom-fields-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |

### Retrieve all Store's Custom Fields.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-custom-fields-id-select-options-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |

### Create a new Custom Field Select Option.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-custom-fields-id-select-options-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | string | yes | Automatically added |
| body | object | yes | JSON request body |

### Retrieve a single SelectOption from a CustomField.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-custom-fields-id-select-options-custom-field-select-opti`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |
| custom_field_select_option_id | integer | yes | Id of the CustomFieldSelectOption |

### Update a SelectOption from a CustomField.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-custom-fields-id-select-options-custom-field-select-opti`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |
| custom_field_select_option_id | integer | yes | Id of the CustomFieldSelectOption |
| body | object | yes | JSON request body |

### Delete an existing CustomFieldSelectOption.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-custom-fields-id-select-options-custom-field-select-o`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomField |
| custom_field_select_option_id | integer | yes | Id of the CustomFieldSelectOption |

### Retrieve all Customer Categories.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customer-categories-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new CustomerCategory.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-customer-categories-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve a single CustomerCategory.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customer-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |

### Update a CustomerCategory.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-customer-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |
| body | object | yes | JSON request body |

### Delete an existing CustomerCategory.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-customer-categories-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |

### Retrieves the customers in a CustomerCategory.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customer-categories-id-customers-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |

### Adds Customers to a CustomerCategory.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-customer-categories-id-customers-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |
| body | object | yes | JSON request body |

### Delete Customers from an existing CustomerCategory.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-customer-categories-id-customers-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the CustomerCategory |
| body | object | yes | JSON request body |

### Retrieve all Customers.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new Customer.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-customers-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Count all Customers.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Customer by email.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-email-email-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| email | string | yes | Email of the Customer |

### Retrieve a single Customer by id.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |

### Update a new Customer.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-customers-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |
| body | object | yes | JSON request body |

### Delete an existing Customer.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-customers-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |

### Retrieves the Customer Additional Field of a Customer.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-id-fields`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |

### Adds Customer Additional Fields to a Customer.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-customers-id-fields`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |
| body | object | yes | JSON request body |

### Retrieve a single Customer Additional Field.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-customers-id-fields-field-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |
| field_id | integer | yes | Id of the Customer Additional Field |

### Update a Customer Additional Field.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-customers-id-fields-field-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |
| field_id | integer | yes | Id of the Customer Additional Field |
| body | object | yes | JSON request body |

### Delete a Customer Additional Field.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-customers-id-fields-field-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Customer |
| field_id | integer | yes | Id of the Customer Additional Field |

### Retrieve all Fulfillments.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-fulfillments-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Count all Fulfillments.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-fulfillments-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Fulfillment.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-fulfillments-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Fulfillment |

### Retrieve all Hooks.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-hooks-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new Hook.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-hooks-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve a single Hook.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-hooks-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Hook |

### Update a Hook.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-hooks-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Hook |
| body | object | yes | JSON request body |

### Delete an existing Hook.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-hooks-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Hook |

### Retrieve all the Store's JSApps.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-jsapps-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Create a Store JSApp.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-jsapps-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve a JSApp.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-jsapps-code-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| code | string | yes | Code of the App |

### Delete an existing JSApp.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-jsapps-code-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| code | string | yes | Code of the App |

### Retrieve the Fulfillments associated with the Order.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-order-id-fulfillments-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Order |

### Retrieve all Orders.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new Order.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-orders-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Retrieve orders filtered by Order Id.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-after-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Order |

### Count all Orders.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve orders filtered by status.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-status-status-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| status | string | yes | Status of the Order used as filter |

### Retrieve a single Order.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Order |

### Modify an existing Order.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-orders-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Order |
| body | object | yes | JSON request body |

### Retrieve all Order History.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-orders-id-history-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Order |

### Create a new Order History Entry.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-orders-id-history-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the OrderHistory |
| body | object | yes | JSON request body |

### Retrieve all Pages.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-pages-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |

### Create a new Page.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-pages-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| body | object | yes | JSON request body |

### Count all Pages.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-pages-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Page by id.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-pages-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Page |

### Update a Page.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-pages-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Page |
| body | object | yes | JSON request body |

### Delete an existing Page.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-pages-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Page |

### Retrieve statistics.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-partners-stores-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| partner_code | string | yes | Partner code. |
| auth_token | string | yes | Partner authentication token. |
| page | integer | no | List page |
| from | string | yes | Statistics start date. Should be in format 'Y-m-d'. |
| to | string | yes | Statistics end date. Should be in format 'Y-m-d'. |

### Retrieve all Store's Payment Methods.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-payment-methods-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a single Payment Method.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-payment-methods-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Payment Method |

### Retrieve all Products.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| limit | integer | no | List restriction |
| page | integer | no | List page |
| locale | string | no | Locale code of the translation |

### Create a new Product.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| body | object | yes | JSON request body |

### Retrieves Products after the given id.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-after-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| locale | string | no | Locale code of the translation |

### Retrieve Products filtered by category.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-category-category-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| category_id | integer | yes | Category ID of the Product used as filter |

### Count Products filtered by category.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-category-category-id-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| category_id | integer | yes | Category ID of the Product used as filter |

### Count all Products.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |

### Retrieve a Product List from a query.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-search-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| query | string | yes | Text to query for the Product |
| fields | string | no | Comma separated values of the fields to query for the Product |

### Retrieve Products filtered by status.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-status-status-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| status | string | yes | Status of the Product used as filter |

### Count Products filtered by status.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-status-status-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| status | string | yes | Status of the Product used as filter |

### Retrieve a single Product.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| locale | string | no | Locale code of the translation |
| id | integer | yes | ID of the Product |

### Modify an existing Product.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-products-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| locale | string | no | Locale code of the translation |
| body | object | yes | JSON request body |

### Delete an existing Product.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |

### Retrieve all Product Attachments.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-attachments-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Create a new Product Attachment.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-attachments-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

### Count all Product Attachments.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-attachments-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Retrieve a single Product Attachment.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-attachments-attachment-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| attachment_id | integer | yes | Id of the Product Attachment |

### Delete a Product Attachment.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-attachments-attachment-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| attachment_id | integer | yes | Id of the Product Attachment |

### Retrieve all Product DigitalProducts.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-digital-products-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Create a new Product DigitalProduct.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-digital-products-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

### Count all Product DigitalProducts.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-digital-products-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Retrieve a single Product DigitalProduct.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-digital-products-digital-product-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| digital_product_id | integer | yes | Id of the Product DigitalProduct |

### Delete a Product DigitalProduct.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-digital-products-digital-product-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| digital_product_id | integer | yes | Id of the Product DigitalProduct |

### Retrieve all Product Custom Fields
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |

### Add an existing Custom Field to a Product.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-fields-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

### Count all Product Custom Fields.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-fields-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Retrieve all Product Images.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-images-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Create a new Product Image.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-images-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

### Count all Product Images.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-images-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Retrieve a single Product Image.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-images-image-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| image_id | integer | yes | Id of the Product Image |

### Delete a Product Image.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-images-image-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| image_id | integer | yes | Id of the Product Image |

### Retrieve all Product Options.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Create a new Product Option.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-options-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

### Count all Product Options.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Retrieve a single Product Option.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-option-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |

### Modify an existing Product Option.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-products-id-options-option-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |
| body | object | yes | JSON request body |

### Delete a Product Option.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-options-option-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |

### Retrieve all Product Option Values.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-option-id-values-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |
| option_id | integer | yes | ID of the Product Option |

### Create a new Product Option Value.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-options-option-id-values-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |
| body | object | yes | JSON request body |

### Count all Product Option Values.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-option-id-values-count-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |
| option_id | integer | yes | ID of the Product Option |

### Retrieve a single Product Option Value.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-options-option-id-values-value-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |
| value_id | integer | yes | ID of the Product Option Value |

### Modify an existing Product Option Value.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/put-products-id-options-option-id-values-value-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |
| value_id | integer | yes | Id of the Product Option Value |
| body | object | yes | JSON request body |

### Delete a Product Option Value.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/delete-products-id-options-option-id-values-value-id-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| option_id | integer | yes | Id of the Product Option |
| value_id | integer | yes | ID of the Product Option Value |

### Retrieve all Product Variants.
`GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-products-id-variants-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | ID of the Product |

### Create a new Product Variant.
`POST https://zieapi.vercel.app/v1/ecommerce:jumpseller/post-products-id-variants-json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| login | string | yes | API OAuth login. |
| authtoken | string | yes | API OAuth token. |
| id | integer | yes | Id of the Product |
| body | object | yes | JSON request body |

…and 22 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-categories-json" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Jumpseller API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/ecommerce:jumpseller/get-categories-json with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Jumpseller API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Jumpseller API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:jumpseller.

### What is the status of the Jumpseller API API?
Live: works with just an Apizie key