Jumpseller Pickup Locations API
The Pickup Locations API from Jumpseller — 2 operation(s) for pickup locations.
Work with this as data
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/jumpseller-com:jumpseller-com-pickup-locations-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 Specification
openapi: 3.2.0
info:
title: Jumpseller Com Pickup Locations API
version: 1.0.0
x-logo:
url: https://api.jumpseller.com/images/jumpseller-logo-full.svg
altText: Jumpseller logo
href: /
description: 'Operations tagged Pickup Locations 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: Pickup Locations
paths:
/locations.json:
get:
tags:
- Pickup Locations
summary: Retrieve all Store's Locations
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_store
parameters: []
responses:
'200':
description: An array of Pickup Locations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PickupLocation'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/locations.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/locations.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/locations.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/locations.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/locations.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: getLocationsJson
x-operation-id-source: derived
post:
tags:
- Pickup Locations
summary: Create a Pickup Location
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_store
parameters: []
requestBody:
description: Location parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationCreateFields'
required: true
responses:
'200':
description: An array of Pickup Locations
content:
application/json:
schema:
$ref: '#/components/schemas/PickupLocation'
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -u XXXXX:YYYYY -X POST \"https://api.jumpseller.com/v1/locations.json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"My Example\", \"main\": true, \"email\": \"customer@example.com\", \"pickup_point\": true, \"postal\": \"example\", \"address\": \"example\", \"city\": \"example\", \"country\": \"US\", \"Region\": \"example\"}'"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/locations.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'']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''POST'');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''name'' => ''My Example'', ''main'' => true, ''email'' => ''customer@example.com'', ''pickup_point'' => true, ''postal'' => ''example'', ''address'' => ''example'', ''city'' => ''example'', ''country'' => ''US'', ''Region'' => ''example'']));
$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/locations.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
request.body = { name: ''My Example'', main: true, email: ''customer@example.com'', pickup_point: true, postal: ''example'', address: ''example'', city: ''example'', country: ''US'', Region: ''example'' }.to_json
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.post(\n 'https://api.jumpseller.com/v1/locations.json',\n auth=('XXXXX', 'YYYYY'),\n json={'name': 'My Example', 'main': True, 'email': 'customer@example.com', 'pickup_point': True, 'postal': 'example', 'address': 'example', 'city': 'example', 'country': 'US', 'Region': 'example'}\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/locations.json', {\n method: 'POST',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\"name\": \"My Example\", \"main\": true, \"email\": \"customer@example.com\", \"pickup_point\": true, \"postal\": \"example\", \"address\": \"example\", \"city\": \"example\", \"country\": \"US\", \"Region\": \"example\"})\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: postLocationsJson
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
/locations/{id}.json:
get:
tags:
- Pickup Locations
summary: Retrieve a Store's Locations by ID
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- read_store
parameters:
- $ref: '#/components/parameters/ProductIDParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PickupLocation'
'404':
description: Location not found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/locations/123.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/locations/123.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/locations/123.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/locations/123.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/locations/123.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: getLocations{id}Json
x-operation-id-source: derived
put:
tags:
- Pickup Locations
summary: Update a Pickup Location
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_store
parameters:
- $ref: '#/components/parameters/ProductIDParam'
requestBody:
description: Location parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationCreateFields'
required: true
responses:
'200':
description: An array of Pickup Locations
content:
application/json:
schema:
$ref: '#/components/schemas/PickupLocation'
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -u XXXXX:YYYYY -X PUT \"https://api.jumpseller.com/v1/locations/123.json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"My Example\", \"main\": true, \"email\": \"customer@example.com\", \"pickup_point\": true, \"postal\": \"example\", \"address\": \"example\", \"city\": \"example\", \"country\": \"US\", \"Region\": \"example\"}'"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/locations/123.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'']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''PUT'');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''name'' => ''My Example'', ''main'' => true, ''email'' => ''customer@example.com'', ''pickup_point'' => true, ''postal'' => ''example'', ''address'' => ''example'', ''city'' => ''example'', ''country'' => ''US'', ''Region'' => ''example'']));
$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/locations/123.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request.basic_auth(''XXXXX'', ''YYYYY'')
request[''Content-Type''] = ''application/json''
request.body = { name: ''My Example'', main: true, email: ''customer@example.com'', pickup_point: true, postal: ''example'', address: ''example'', city: ''example'', country: ''US'', Region: ''example'' }.to_json
response = http.request(request)
puts JSON.parse(response.body)'
- lang: Python
label: Python
source: "import requests\n\nresponse = requests.put(\n 'https://api.jumpseller.com/v1/locations/123.json',\n auth=('XXXXX', 'YYYYY'),\n json={'name': 'My Example', 'main': True, 'email': 'customer@example.com', 'pickup_point': True, 'postal': 'example', 'address': 'example', 'city': 'example', 'country': 'US', 'Region': 'example'}\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/locations/123.json', {\n method: 'PUT',\n headers: {\n 'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\"name\": \"My Example\", \"main\": true, \"email\": \"customer@example.com\", \"pickup_point\": true, \"postal\": \"example\", \"address\": \"example\", \"city\": \"example\", \"country\": \"US\", \"Region\": \"example\"})\n});\n\nconst data = await response.json();\nconsole.log(data);"
operationId: putLocations{id}Json
x-operation-id-source: derived
delete:
tags:
- Pickup Locations
summary: Delete a Store's Locations by ID
security:
- BasicAuthentication:
- assets
- loginParameter: []
authtokenParameter: []
- OAuth2:
- write_store
parameters:
- $ref: '#/components/parameters/ProductIDParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'404':
description: Location Not Found.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
x-codeSamples:
- lang: Shell
label: cURL
source: curl -u XXXXX:YYYYY -X DELETE "https://api.jumpseller.com/v1/locations/123.json"
- lang: PHP
label: PHP
source: '<?php
$login = ''XXXXX'';
$authtoken = ''YYYYY'';
$url = ''https://api.jumpseller.com/v1/locations/123.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/locations/123.json'')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.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.delete(\n 'https://api.jumpseller.com/v1/locations/123.json',\n auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
- lang: JavaScript
label: JavaScript
source: "const response = await fetch('https://api.jumpseller.com/v1/locations/123.json', {\n method: 'DELETE',\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: deleteLocations{id}Json
x-operation-id-source: derived
servers:
- url: https://api.jumpseller.com/v1
components:
schemas:
PickupLocation:
type: object
properties:
location:
$ref: '#/components/schemas/PickupLocationFields'
PickupLocationFields:
type: object
properties:
id:
type: integer
description: Unique identifier of the Pickup Location
format: int32
name:
type: string
description: Name of the Pickup Location
email:
type: string
description: Email of the Pickup Location
active:
type: boolean
description: If Pickup Location is active
main:
type: boolean
description: If Pickup Location is the main one
pickup_point:
type: boolean
description: If Pickup Location is a pickup point
is_stock_origin:
type: boolean
description: If Pickup Location is a stock origin
location_address:
$ref: '#/components/schemas/PickupLocationAddress'
LocationCreateFields:
required:
- name
- email
- address
- city
- country
type: object
properties:
name:
type: string
description: Name of the location
main:
type: boolean
description: Is the main location
email:
type: string
description: Email for the location
pickup_point:
type: boolean
description: Is a pickup_point
postal:
type: string
description: Postal code of the location
address:
type: string
description: Address of the location
city:
type: string
description: City of the location
country:
type: string
description: Country of the location
Region:
type: string
description: Region of the location
NotFound:
type: object
properties:
message:
type: string
PickupLocationAddress:
type: object
properties:
id:
type: integer
description: Unique identifier of the Pickup Location Address
format: int32
name:
type: string
description: Name of the Pickup Location Address
surname:
type: string
description: Surname of the Pickup Location Address
address:
type: string
description: Address of the Pickup Location
street_number:
type: string
description: Street Number of the Pickup Location Address
complement:
type: string
description: Complement of the Pickup Location Address
city:
type: string
description: City of the Pickup Location Address
postal:
type: string
description: Postal of the Pickup Location Address
country:
type: string
description: Country code of the Pickup Location Address
region:
type: string
description: Region code of the Pickup Location Address
type:
type: string
description: Type of the Pickup Location Address
taxid:
type: string
description: Tax ID of the Pickup Location Address
taxid_type:
type: string
description: Tax Id Type of the Pickup Location Address
default:
type: boolean
description: If address is default
region_format:
type: string
description: Region Format of the Pickup Location Address
municipality:
type: string
description: Municipality Type of the Pickup Location Address
latitude:
type: number
description: Latitude of the Pickup Location Address
format: float
longitude:
type: number
description: Longitude of the Pickup Location Address
format: float
MessageObject:
type: object
properties:
message:
type: string
PickupLocationUpdateFields:
required:
- name
- email
- address
- city
- country
type: object
properties:
name:
type: string
description: Name of the location
email:
type: string
description: Email for the location
description:
type: string
description: Description of the location
instructions:
type: string
description: Pickup instructions
pickup_point:
type: boolean
description: Is a pickup point
is_stock_origin:
type: boolean
description: Is a stock origin. Kept as is when omitted.
address:
type: string
description: Street address of the Location
complement:
type: string
description: Address complement
city:
type: string
description: City of the Location
postal:
type: string
description: Postal code of the Location
country:
type: string
description: Country code of the Location (ISO 3166-1 alpha-2)
region:
type: string
description: Region code of the Location
municipality:
type: string
description: Municipality code of the Location
latitude:
type: number
format: float
description: Latitude of the Location
longitude:
type: number
format: float
description: Longitude of the Location
LocationCreateFields_2:
required:
- name
- email
- main
- pickup_point
- address
- city
- country
type: object
properties:
name:
type: string
description: Name of the location
email:
type: string
description: Email for the location
main:
type: boolean
description: Is the main location
pickup_point:
type: boolean
description: Is a pickup point
is_stock_origin:
type: boolean
description: Is a stock origin
address:
type: string
description: Street address of the Location
complement:
type: string
description: Address complement
city:
type: string
description: City of the Location
postal:
type: string
description: Postal code of the Location
country:
type: string
description: Country code of the Location (ISO 3166-1 alpha-2)
region:
type: string
description: Region code of the Location
municipality:
type: string
description: Municipality code of the Location
latitude:
type: number
format: float
description: Latitude of the Location
longitude:
type: number
format: float
description: Longitude of the Location
BadParams:
type: object
properties:
message:
type: string
parameters:
ProductIDParam:
name: id
in: path
description: Id of the Product
required: true
schema:
type: integer
format: int32
LocationIDParam:
name: id
in: path
description: Id of the location
required: true
schema:
type: integer
format: int32
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