One stable API surface for commerce, hosting, domains, communication and every service added to Firmeoo.
Base URLhttps://firmeoo.com/wp-json/firmeoo/v1
GETTING STARTED
Authentication
Never use your Firmeoo e-mail or password in an integration. Generate a revocable, domain-scoped Bearer key under Settings → API. The complete secret is displayed once.
Keep the key server-side. Never embed it in public JavaScript, mobile apps or repositories. Keys are revocable and limited to the configured store and allowed origin.
Conventions
01
Versioned routes
Stable endpoints begin with /firmeoo/v1/. Breaking changes receive a new version.
02
JSON over HTTPS
Requests and responses use UTF-8 JSON and HTTPS only.
03
Idempotent orders
Every order needs a unique Idempotency-Key, preventing duplicate charges and services.
04
Money
Decimal amounts always include an ISO currency code.
COMMERCE API
Server Commerce API
Connect an independent reseller shop to Firmeoo. Fetch assigned prices, submit orders and display only services sold by that reseller.
01Create store key
02Fetch catalog
03Submit order
04Read services
Each store uses either Firmeoo checkout or reseller wallet billing. The mode is returned by the health endpoint.
Submit after checkout confirmation. Customers are matched globally by e-mail; a technical service account is created when needed.
Billing flow: in reseller_wallet mode, a successful request debits the reseller balance and returns HTTP 202. In firmeoo_checkout mode, the endpoint currently returns HTTP 402 with checkout_required, amount and currency; use that response to start the Firmeoo payment flow before provisioning.
Public endpoints provide a provider-neutral list of supported extensions, current retail prices and live availability. A store key is required to access reseller pricing and submit an order.
Prices can change. Refresh the catalog immediately before checkout and before renewal. Registration availability is authoritative only when the order is accepted.
Get complete model data: thermal variants, colors, glazing, locks, sides, images and price modifiers.
PUBLIC PRODUCT CATALOG
Jewellery & Clothing API
White-label product feed for external stores. Source costs and supplier details are never returned. Responses include Firmeoo retail prices, stock, local media, categories, variants and Google Merchant attributes.
Paginated Jewellery catalog. Use catalog=clothing for apparel or catalog=all for both. Optional parameters: search, category, brand and orderby (newest, name, price_asc, price_desc).
Google Merchant ready: every product contains a google object with identifiers, availability, condition, category, image links and a formatted GBP price. Generate the final Merchant feed on the external shop so product links use that shop's own domain.
TENANT APIS
Widget APIs
Store, Gallery, Video, Reviews, Booking and File widgets use tenant-specific keys generated inside the corresponding Firmeoo module. They are separate from Server Commerce keys.
Store
Products and checkout under Web → Store → Widgets.
Media
Gallery, Video and Reviews JSON feeds.
Booking
Services, availability and booking creation.
Files
Secure customer uploads scoped to a tenant.
Product feeds
Firmeoo stores can generate Google Merchant Center XML feeds. The URL appears inside the Store module and is intended for scheduled merchant-platform retrieval.
Errors
Errors use a consistent REST envelope. Always use the HTTP status as the authoritative result.
{
"code": "reseller_balance_low",
"message": "The service is temporarily unavailable.",
"data": { "status": 402, "required": 119.00 }
}
Code
Recommended action
missing_key
Send the Authorization header.
invalid_key
Replace or regenerate the key.
origin_denied
Configure the store origin in Firmeoo.
unknown_product
Refresh the product catalog.
reseller_balance_low
Ask the reseller to top up their Firmeoo balance.
Changelog
16 AUG 2026
Public Domains API
Added the public extension and price catalog, live availability documentation and the authenticated domain-order flow.
14 AUG 2026
Server Commerce API v1
Store authentication, catalog, idempotent order submission and reseller-scoped services.
PUBLIC API
Doors catalog
Model listing and configurator details remain available without authentication.