Shops owned by the authenticated account. A shop is the customer-facing storefront that belongs to a seller. Settings, admins, shipping tables, payment methods, exchange rates, and other shop-level configuration are anchored to a specific shop.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/bootic-shops-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: Bolder API v2 Shops API
version: '2.0'
description: '## Getting Started
The Bolder API provides programmatic access to your Bolder Shop data through a
hypermedia-driven REST interface.'
contact:
name: Bolder API Support
url: https://www.onbolder.com
servers:
- url: https://api.onbolder.com/v2
description: Production
security:
- bearerAuth: []
tags:
- name: Shops
description: 'Shops owned by the authenticated account. A shop is the customer-facing storefront
that belongs to a seller. Settings, admins, shipping tables, payment methods,
exchange rates, and other shop-level configuration are anchored to a specific shop.'
paths:
/events:
get:
tags:
- Shops
summary: List events
description: 'Returns events across the account.
Optionally filter by `shop_id` or `seller_id` query parameter.'
operationId: listEventsFlattened
parameters:
- name: shop_id
in: query
schema:
type: integer
description: Filter by shop ID
- name: seller_id
in: query
schema:
type: integer
description: Filter by seller ID
- name: page
in: query
schema:
type: integer
default: 1
- name: per_page
in: query
schema:
type: integer
default: 30
- name: topic
in: query
schema:
type: string
description: Filter by event topic
responses:
'200':
description: Events list
/exchange_rates:
get:
tags:
- Shops
summary: List exchange rates
description: 'Returns exchange rates across the account.
Optionally filter by `shop_id` or `seller_id` query parameter.'
operationId: listExchangeRatesFlattened
parameters:
- name: shop_id
in: query
schema:
type: integer
description: Filter by shop ID
- name: seller_id
in: query
schema:
type: integer
description: Filter by seller ID
responses:
'200':
description: Exchange rates list
/payment_methods:
get:
tags:
- Shops
summary: List payment methods
description: 'Returns payment methods across the account.
Optionally filter by `shop_id` or `seller_id` query parameter.'
operationId: listPaymentMethodsFlattened
parameters:
- name: shop_id
in: query
schema:
type: integer
description: Filter by shop ID
- name: seller_id
in: query
schema:
type: integer
description: Filter by seller ID
- name: page
in: query
schema:
type: integer
default: 1
- name: per_page
in: query
schema:
type: integer
default: 30
responses:
'200':
description: Payment methods list
/shipping_tables:
get:
tags:
- Shops
summary: List shipping tables
description: 'Returns shipping tables across the account.
Optionally filter by `shop_id` or `seller_id` query parameter.'
operationId: listShippingTablesFlattened
parameters:
- name: shop_id
in: query
schema:
type: integer
description: Filter by shop ID
- name: seller_id
in: query
schema:
type: integer
description: Filter by seller ID
- name: page
in: query
schema:
type: integer
default: 1
- name: per_page
in: query
schema:
type: integer
default: 30
responses:
'200':
description: Shipping tables list
/shipping_tables/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: integer
get:
tags:
- Shops
summary: Get a shipping table
operationId: getShippingTableFlattened
responses:
'200':
description: Shipping table details
/shops:
get:
tags:
- Shops
summary: List shops
description: Returns shops belonging to the authenticated account.
operationId: listShops
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops\"\n"
parameters:
- name: q
in: query
schema:
type: string
description: Search shops by name or subdomain.
example: mystore
- name: seller_id
in: query
schema:
type: integer
description: 'Filter to shops owned by a specific seller. Useful for enumerating all shops of a seller that owns more than one — see the seller''s `shops:list` link.
'
example: 5
- name: status
in: query
schema:
type: string
enum:
- active
- inactive
- all
default: all
description: Filter by shop status.
example: active
- name: page
in: query
schema:
type: integer
default: 1
minimum: 1
example: 1
- name: per_page
in: query
schema:
type: integer
default: 20
minimum: 1
maximum: 200
example: 20
responses:
'200':
description: Paginated list of shops
content:
application/json:
schema:
$ref: '#/components/schemas/ShopList'
example:
_class:
- results
- shops
total_items: 1
per_page: 20
page: 1
_links:
self:
href: https://api.onbolder.com/v2/shops
_embedded:
items:
- id: 1
name: My Store
subdomain: mystore
url: https://mystore.onbolder.com
status: active
currency: USD
_links:
self:
href: https://api.onbolder.com/v2/shops/1
/shops/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: integer
get:
tags:
- Shops
summary: Get a shop
operationId: getShop
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1\"\n"
responses:
'200':
description: Shop entity
content:
application/json:
schema:
$ref: '#/components/schemas/Shop'
example:
id: 1
seller_id: 5
account_id: 10
name: My Store
subdomain: mystore
url: mystore.onbolder.com
locale: en
currency_code: USD
_links:
self:
href: https://api.onbolder.com/v2/shops/1
products:list:
href: https://api.onbolder.com/v2/products?shop_id=1
orders:list:
href: https://api.onbolder.com/v2/orders?shop_id=1
customers:list:
href: https://api.onbolder.com/v2/customers?shop_id=1
hub:subscriptions:
href: https://api.onbolder.com/v2/sellers/5/webhooks
'403':
description: Access denied
'404':
description: Shop not found
/shops/{id}/settings:
parameters:
- name: id
in: path
required: true
schema:
type: integer
get:
tags:
- Shops
summary: Get shop settings
operationId: getShopSettings
responses:
'200':
description: Shop with settings
content:
application/json:
schema:
$ref: '#/components/schemas/Shop'
example:
id: 1
name: My Store
subdomain: mystore
currency: USD
country: US
tax_rate: 0.21
shipping_zones:
- domestic
- international
payment_methods:
- credit_card
- paypal
_links:
self:
href: https://api.onbolder.com/v2/shops/1/settings
/shops/{shop_id}/admins:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List shop admins
description: Returns admin users for the given shop.
operationId: listShopAdmins
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/admins\"\n"
responses:
'200':
description: List of admins
content:
application/json:
example:
_class:
- results
- admins
total_items: 2
_embedded:
items:
- id: 10
email: admin@myshop.com
name: Admin User
role: owner
last_logged_on: '2024-06-20T14:00:00Z'
'403':
description: Access denied
/shops/{shop_id}/admins/{id}:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
- name: id
in: path
required: true
schema:
type: integer
example: 10
get:
tags:
- Shops
summary: Get a shop admin
operationId: getShopAdmin
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/admins/10\"\n"
responses:
'200':
description: Admin entity
content:
application/json:
example:
id: 10
email: admin@myshop.com
name: Admin User
role: owner
last_logged_on: '2024-06-20T14:00:00Z'
'404':
description: Admin not found
/shops/{shop_id}/events:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List shop events
description: Returns the event log for this shop (webhook delivery history, order events, etc).
operationId: listShopEvents
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/events\"\n"
parameters:
- name: topic
in: query
schema:
type: string
description: Filter by event topic (e.g. `orders.created`).
example: orders.created
- name: page
in: query
schema:
type: integer
default: 1
- name: per_page
in: query
schema:
type: integer
default: 20
responses:
'200':
description: Paginated event list
content:
application/json:
schema:
type: object
properties:
_embedded:
type: object
properties:
items:
type: array
items:
type: object
description: 'There is no `id` field — `sequence` is the event''s identifier.
'
properties:
sequence:
type: integer
type:
type: string
topic:
type: string
item_type:
type: string
item_id:
type: integer
item_name:
type: string
scope:
type: string
payload:
type: object
user_id:
type: integer
user_name:
type: string
app_name:
type: string
created_on:
type: string
format: date-time
example:
_class:
- results
- events
total_items: 42
_embedded:
items:
- sequence: 1001
type: order
topic: orders.created
item_type: Order
item_id: 5001
item_name: ORD-5001
scope: shop
payload: {}
created_on: '2024-06-15T09:45:00Z'
/shops/{shop_id}/payment_methods:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List payment methods
description: Returns the payment methods configured for the shop.
operationId: listPaymentMethods
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/payment_methods\"\n"
responses:
'200':
description: Payment methods list
content:
application/json:
example:
_class:
- results
- paymentMethods
total_items: 2
_embedded:
items:
- id: 3
type: webpay_rest_payment_method
title: Webpay Plus (Rest)
active: true
- id: 7
type: bank_transfer_payment_method
title: Transferencia bancaria
active: true
/shops/{shop_id}/exchange_rates:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List exchange rates
description: Returns current USD exchange rates for supported currencies.
operationId: listExchangeRates
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/exchange_rates\"\n"
responses:
'200':
description: Exchange rates
content:
application/json:
example:
_class:
- results
- exchangeRates
_embedded:
items:
- from: USD
to: CLP
rate: 950.5
updated_at: '2024-06-15T00:00:00Z'
- from: USD
to: ARS
rate: 890.0
updated_at: '2024-06-15T00:00:00Z'
/shops/{shop_id}/order_tags:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List order tags
description: Returns all tags currently applied to orders in this shop.
operationId: listOrderTags
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/order_tags\"\n"
responses:
'200':
description: Order tags list
content:
application/json:
example:
_class:
- results
- tags
_embedded:
items:
- name: urgent
- name: gift
/shops/{shop_id}/shipping_tables:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: List shipping tables
description: Returns shipping rate tables configured for the shop.
operationId: listShippingTables
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/shipping_tables\"\n"
responses:
'200':
description: Shipping tables list
content:
application/json:
example:
_class:
- results
- shippingTables
total_items: 1
_embedded:
items:
- id: 1
name: Standard Domestic
currency: USD
/shops/{shop_id}/shipping_tables/{id}:
parameters:
- name: shop_id
in: path
required: true
schema:
type: integer
example: 1
- name: id
in: path
required: true
schema:
type: integer
example: 1
get:
tags:
- Shops
summary: Get a shipping table
operationId: getShippingTable
x-codeSamples:
- lang: Shell
label: cURL
source: "curl -s -H \"Authorization: Bearer $BOLDER_TOKEN\" \\\n \"https://api.onbolder.com/v2/shops/1/shipping_tables/1\"\n"
responses:
'200':
description: Shipping table with rates
content:
application/json:
example:
id: 1
name: Standard Domestic
currency: USD
rows:
- from_weight: 0
to_weight: 1000
price: 5.99
components:
schemas:
Pagination:
type: object
properties:
total_items:
type: integer
example: 42
per_page:
type: integer
example: 20
page:
type: integer
example: 1
Shop:
type: object
properties:
_links:
$ref: '#/components/schemas/HalLinks'
id:
type: integer
seller_id:
type: integer
account_id:
type: integer
name:
type: string
subdomain:
type: string
url:
type: string
description:
type: string
locale:
type: string
currency_code:
type: string
timezone:
type: string
asset_count:
type: integer
product_counts:
type: object
properties:
visible:
type: integer
blocked:
type: integer
hidden:
type: integer
products_use_variant_prices:
type: boolean
created_on:
type: string
format: date-time
updated_on:
type: string
format: date-time
HalLinks:
type: object
additionalProperties:
oneOf:
- $ref: '#/components/schemas/HalLink'
- type: array
items:
$ref: '#/components/schemas/HalLink'
ShopList:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
_links:
$ref: '#/components/schemas/HalLinks'
_class:
type: array
items:
type: string
example:
- results
- shops
_embedded:
type: object
properties:
shops:
type: array
items:
$ref: '#/components/schemas/Shop'
HalLink:
type: object
required:
- href
properties:
href:
type: string
templated:
type: boolean
method:
type: string
enum:
- get
- post
- put
- patch
- delete
title:
type: string
type:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.onbolder.com/oauth/token
scopes:
products.read: View products, variants and collections
products.write: Create and update products
orders.read: View orders
orders.write: Create and update orders
customers.read: View customer profiles
customers.write: Update customer profiles
shops.read: View shop configuration
shops.write: Update shop configuration
hub.read: View content (posts, pages)
hub.write: Create and update content
store.read: View themes and assets
store.write: Manage themes and assets
sellers.read: View seller information
batches.read: View batch job status
batches.write: Create and run batch jobs
authorizationCode:
authorizationUrl: https://auth.onbolder.com/oauth/authorize
tokenUrl: https://auth.onbolder.com/oauth/token
scopes:
products.read: View products, variants and collections
products.write: Create and update products
orders.read: View orders
orders.write: Create and update orders
customers.read: View customer profiles
customers.write: Update customer profiles
shops.read: View shop configuration
shops.write: Update shop configuration
hub.read: View content (posts, pages)
hub.write: Create and update content
store.read: View themes and assets
store.write: Manage themes and assets
sellers.read: View seller information
batches.read: View batch job status
batches.write: Create and run batch jobs