Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/jumpseller-com:jumpseller-com-stores-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Jumpseller Com Stores API
version: 1.0.0
x-logo:
url: https://api.jumpseller.com/images/jumpseller-logo-full.svg
altText: Jumpseller logo
href: /
description: 'Operations tagged Stores across 2 of this provider''s published API definitions: jumpseller-com-openapi-openapi.json, jumpseller-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.jumpseller.com/v1
tags:
- name: Stores
paths:
/store/info.json:
get:
tags:
- Stores
summary: Retrieve Store Information
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_store
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Store'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/store/info.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/store/info.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/store/info.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n 'https://api.jumpseller.com/v1/store/info.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/store/info.json', {\n method: 'GET',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: getStoreInfoJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
/store/languages.json:
get:
tags:
- Stores
summary: Retrieve Store Languages
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_store
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Language'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/store/languages.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/store/languages.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/store/languages.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n 'https://api.jumpseller.com/v1/store/languages.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/store/languages.json', {\n method: 'GET',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: getStoreLanguagesJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
/store/setup.json:
post:
tags:
- Stores
summary: Create a new store
description: Creates a new store owned by the authenticated account. Requires a paying subscription with at least 24 hours since first payment. Limited to 5 store creations per account per day. Returns the new store API credentials.
security:
- BasicAuthentication:
- store_setup
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_store_setup
requestBody:
description: Store setup parameters.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StoreSetupCreate'
responses:
'201':
description: Store created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/StoreSetupResponse'
'400':
description: Bad Request - invalid name or JSON body.
'402':
description: Payment Required - a paying subscription is required.
'429':
description: Too Many Requests - store creation limit exceeded (5 per day).
'403':
description: Forbidden - store creation is available 24 hours after first payment.
x-codeSamples:
- lang: Shell
label: cURL
source: 'curl -u XXXXX:YYYYY -X POST "https://api.jumpseller.com/v1/store/setup.json" -H "Content-Type: application/json" -d ''{"store": {"name": "My New Store", "country": "CL"}}'''
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.post(\n 'https://api.jumpseller.com/v1/store/setup.json',\n auth=('XXXXX', 'YYYYY'),\n json={'store': {'name': 'My New Store', 'country': 'CL'}}\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/store/setup.json', {\n method: 'POST',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ store: { name: 'My New Store', country: 'CL' } })\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: postStoreSetupJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
/transaction_ledger/balance.json:
get:
tags:
- Stores
summary: Retrieve Store Balance
security:
- BasicAuthentication:
- subscription
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_transaction_ledgers
parameters: []
responses:
'200':
description: Store Balance Information
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StoreBalance'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/transaction_ledger/balance.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/transaction_ledger/balance.json'';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);
curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;'
- lang: Ruby
label: Ruby
source: 'require ''net/http''
require ''json''
uri = URI(''https://api.jumpseller.com/v1/transaction_ledger/balance.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.get(\n 'https://api.jumpseller.com/v1/transaction_ledger/balance.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/transaction_ledger/balance.json', {\n method: 'GET',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n }\n});\n\nconst data = await response.json();\nconsole.log(data);"
description: Returns the current store balance. Requires subscription permission. This is the only public transaction ledger endpoint — other transaction ledger operations are internal.
operationId: getTransactionLedgerBalanceJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
components:
schemas:
Language:
type: object
properties:
code:
type: string
name:
type: string
StoreSetupResponse:
type: object
properties:
store:
type: object
properties:
code:
type: string
description: Store unique code (subdomain).
name:
type: string
description: Store name.
url:
type: string
description: Store storefront URL.
admin_url:
type: string
description: Store admin panel URL.
credentials:
type: object
properties:
login:
type: string
description: API login key for the new store.
authtoken:
type: string
description: API authentication token for the new store.
Store:
type: object
properties:
name:
type: string
description: Store Name
code:
type: string
description: Store Code
currency:
type: string
description: Store Currency
country:
type: string
description: Store Country
timezone:
type: string
description: Store Timezone
email:
type: string
description: Store Admin Email
hooks_token:
type: string
description: Store Hooks Auth token
url:
type: string
description: Store URL
logo:
type: string
description: Store Logo URL
weight_unit:
type: string
description: Store Weight Unit
subscription_status:
type: string
description: Subscription status
subscription_plan:
type: string
description: Subscription plan
fb_pixel_id:
type: string
description: Facebook Pixel Id
address:
$ref: '#/components/schemas/StoreAddress'
whatsapp_phone:
type: string
description: Store WhatsApp Phone
StoreBalance:
type: object
properties:
balance:
type: number
description: Store Balance
format: float
default: 0.0
currency:
type: string
description: Store Balance Currency
balance_formatted:
type: string
description: Store Balance Formatted
StoreAddress:
type: object
properties:
address:
type: string
description: Address of the Store's Address
city:
type: string
description: City of the Store's Address
postal:
type: string
description: Postal code of the Store's Address
region:
type: string
description: Region of the Store's Address
country:
type: string
description: Country of the Store's Address (ISO 3166-1 alpha-2)
region_code:
type: string
description: Region code of the Store's Address
country_code:
type: string
description: Country code of the Store's Address
StoreSetupCreate:
type: object
required:
- store
properties:
store:
type: object
required:
- name
properties:
name:
type: string
description: Store name (4-50 characters). Will be used to generate the store subdomain.
minLength: 4
maxLength: 50
country:
type: string
description: ISO 3166-1 alpha-2 country code. Defaults to the authenticated store's country.
example: CL
theme:
type: string
description: Theme code to apply. Uses default theme if omitted.
example: flavor
Store_2:
type: object
properties:
name:
type: string
description: Store Name
code:
type: string
description: Store Code
currency:
type: string
description: Store Currency (ISO 4217)
country:
type: string
description: Store Country (ISO 3166-1 alpha-2)
timezone:
type: string
description: Store Timezone
email:
type: string
description: Store contact email
hooks_token:
type: string
description: Secret that signs webhook deliveries. Returned only to OAuth apps with the `read_hooks` or `write_hooks` scope, and to accounts with full webhooks permission.
url:
type: string
description: Store storefront URL
subscription_plan:
type: string
description: Subscription plan
logo:
type:
- string
- 'null'
description: Store Logo URL
weight_unit:
type:
- string
- 'null'
description: Store Weight Unit
fb_pixel_id:
type:
- string
- 'null'
description: Facebook Pixel Id
whatsapp_phone:
type:
- string
- 'null'
description: Store WhatsApp Phone
mobile_app_version:
type:
- string
- 'null'
description: Latest version of the Jumpseller mobile app
subscription_status:
type: string
description: Subscription status
checkout_version:
type: string
description: Checkout version used by the Store
example: v2
address:
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/StoreAddress_2'
StoreAddress_2:
type: object
properties:
address:
type: string
description: Street address of the Store's Address
city:
type: string
description: City of the Store's Address
postal:
type: string
description: Postal code of the Store's Address
region:
type: string
description: Region name of the Store's Address
country:
type: string
description: Country name of the Store's Address
region_code:
type: string
description: Region code of the Store's Address
country_code:
type: string
description: Country code of the Store's Address (ISO 3166-1 alpha-2)
latitude:
type:
- number
- 'null'
format: float
description: Latitude of the Store's Address
longitude:
type:
- number
- 'null'
format: float
description: Longitude of the Store's Address
StoreSetupCreate_2:
type: object
required:
- store
properties:
store:
type: object
required:
- name
properties:
name:
type: string
maxLength: 200
description: Store name (up to 200 characters). The store code (subdomain) is generated from it and must be 4-50 characters long; a numeric suffix is added when the code is taken.
country:
type: string
description: ISO 3166-1 alpha-2 country code. Defaults to the authenticated store's country.
example: CL
theme:
type: string
description: Theme code to apply. Uses default theme if omitted.
example: flavor
securitySchemes:
BasicAuthentication:
type: http
scheme: basic
description: Basic authentication in the format of `login:authtoken` or `partner_code:auth_token`.
loginParameter:
type: apiKey
in: query
name: login
description: API OAuth login. Learn how to get yours [here](#section/Authentication).
authtokenParameter:
type: apiKey
in: query
name: authtoken
description: API OAuth token. Learn how to get yours [here](#section/Authentication).
auth_tokenParameter:
type: apiKey
in: query
name: auth_token
description: Partner authentication token.
OAuth2:
type: oauth2
description: OAuth 2.0 authorization code flow. Register your app at the Jumpseller Admin Panel to get client credentials. See https://jumpseller.com/support/oauth-2/ for details.
flows:
authorizationCode:
authorizationUrl: https://accounts.jumpseller.com/oauth/authorize
tokenUrl: https://accounts.jumpseller.com/oauth/token
refreshUrl: https://accounts.jumpseller.com/oauth/token
scopes:
read_products: Read products, variants, images, options, and custom fields
write_products: Create, update, and delete products
read_orders: Read orders, fulfillments, and order history
write_orders: Create, update, and refund orders
read_customers: Read customer accounts and groups
write_customers: Create, update, and delete customers
read_categories: Read product categories
write_categories: Create, update, and delete categories
read_store: Read store information and settings
write_store: Update store settings
read_settings: Read store configuration
write_settings: Update store configuration
read_shipping_methods: Read shipping methods and rates
write_shipping_methods: Create and update shipping methods
read_payment_methods: Read payment methods
write_payment_methods: Create and update payment methods
read_hooks: Read webhooks
write_hooks: Create, update, and delete webhooks
read_promotions: Read promotions and discounts
write_promotions: Create, update, and delete promotions
read_taxes: Read tax rules
write_taxes: Create and update tax rules
read_pages: Read store pages
write_pages: Create, update, and delete pages
read_countries: Read country information
write_countries: Update country settings
read_custom_fields: Read product custom fields
write_custom_fields: Create and update custom fields
read_checkout_custom_fields: Read checkout additional fields
write_checkout_custom_fields: Update checkout additional fields
read_customer_categories: Read customer categories
write_customer_categories: Create and update customer categories
read_jsapps: Read JavaScript apps
write_jsapps: Create, update, and delete JavaScript apps
read_apps: Read installed apps
read_fulfillments: Read fulfillment information
write_fulfillments: Create and update fulfillments
read_locations: Read warehouse locations
write_locations: Create and update locations
write_reviews: Manage product reviews
read_transaction_ledgers: Read store balance
write_store_setup: Create new stores via the store setup endpoint
x-refined-from:
- jumpseller-com-openapi-openapi.json
- jumpseller-com-openapi.json