Bolder API v1

⬇ Download this spec as YAML

The Bolder API is a hypermedia-driven REST API following the HAL (Hypertext Application Language) specification.

HAL conventions

Every response includes a _links object with related resources and actions. Links use the btc: CURIE namespace — for example btc:products expands to https://api.onbolder.com/docs/v1#products.

Non-GET actions (POST, PUT, DELETE) are described by links that carry a method property.

Templated links (e.g. pagination, filters) carry "templated": true and use RFC 6570 URI Templates.

Embedded sub-resources live in _embedded and follow the same HAL structure.

Paginated results

List endpoints return a paginated results envelope:

{
  "_links": {
    "self": { "href": "…?page=1" },
    "next": { "href": "…?page=2" },
    "last": { "href": "…?page=10" }
  },
  "total_items": 500,
  "per_page": 50,
  "page": 1,
  "_embedded": { "items": [ … ] }
}

Authentication

All requests require a Bearer access token obtained via OAuth 2.0.

Authorization: Bearer YOUR-ACCESS-TOKEN

See the Authentication section for the full list of supported OAuth 2.0 flows.

Root

Entry point that returns the authenticated user’s account and linked shops.

• GET
  Root endpoint/

Shops

Shops owned by the authenticated account.

• GET
  List shops/shops
• GET
  Shop details/shops/{id}

Products

Products catalogue management.

• GET
  List all products/products
• GET
  Product details/products/{id}
• DELETE
  Delete product/products/{id}
• POST
  Create product/shops/{shop_id}/products
• PUT
  Update product/shops/{shop_id}/products/{id}

Variants

Product variants (size, colour, etc.).

• GET
  Variant details/shops/{shop_id}/variants/{id}
• PUT
  Update variant/shops/{shop_id}/variants/{id}
• DELETE
  Delete variant/shops/{shop_id}/variants/{id}
• POST
  Create variant/products/{product_id}/variants

Product Images

Upload and delete product images.

• POST
  Upload product image/products/{product_id}/assets
• DELETE
  Delete product image/products/{product_id}/assets/{id}

Orders

Order management including creation, updates, and batch operations.

• GET
  List orders/shops/{shop_id}/orders
• POST
  Create order/shops/{shop_id}/orders
• GET
  Order details/shops/{shop_id}/orders/{code}
• PUT
  Update order/shops/{shop_id}/orders/{code}
• POST
  Batch update orders/shops/{shop_id}/orders/updaters

Contacts

Shop contacts (customers).

• GET
  List shop contacts/shops/{shop_id}/contacts

Webhooks

Subscribe to real-time event notifications via webhooks.

• GET
  Webhooks hub/hub/{shop_id}
• GET
  List subscriptions/hub/{shop_id}/subscriptions
• POST
  Subscribe/hub/{shop_id}/subscriptions
• DELETE
  Unsubscribe/hub/{shop_id}/subscriptions/{id}

Themes

Shop theme templates and static assets.

• GET
  Theme details/shops/{shop_id}/theme
• PUT
  Update theme settings/themes/{id}
• POST
  Create template/themes/{theme_id}/templates
• PUT
  Update template/themes/{theme_id}/templates/{id}
• DELETE
  Delete template/themes/{theme_id}/templates/{id}
• POST
  Upload theme asset/themes/{theme_id}/assets
• DELETE
  Delete theme asset/themes/{theme_id}/assets/{id}