List shops
Returns shops belonging to the authenticated account.
GET
/shopsAuthorization
AuthorizationBearer token (JWT) · headerrequiredQuery parameters
qstringSearch shops by name or subdomain.
seller_idintegerFilter 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.
statusstringFilter by shop status.
default: "all"
Allowed:
activeinactiveallpageintegermin 1 · default: 1
per_pageintegermin 1 · max 200 · default: 20
Responses
200Paginated list of shops
total_itemsintegerper_pageintegerpageinteger_linksHalLinks_classstring[]_embeddedobjectShow propertiesHide properties
shopsShop[]Show propertiesHide properties
Array of
Shop_linksHalLinksidintegerseller_idintegeraccount_idintegernamestringsubdomainstringurlstringdescriptionstringlocalestringcurrency_codestringtimezonestringasset_countintegerproduct_countsobjectShow propertiesHide properties
visibleintegerblockedintegerhiddenintegerproducts_use_variant_pricesbooleancreated_onstring<date-time>updated_onstring<date-time>Request
curl -X GET "https://api.onbolder.com/v2/shops" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://api.onbolder.com/v2/shops", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"https://api.onbolder.com/v2/shops",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
)Response
{
"_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"
}
}
}
]
}
}