FirmeooDevelopers
REST · v1
FIRMEOO PLATFORM API

Build services around your business.

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.

Authorization: Bearer frm_live_YOUR_STORE_KEY
Accept: application/json
Content-Type: application/json
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.
GEThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/health

Validate credentials and return the store identity and billing mode.

RESPONSE

{
    "ok": true,
    "store": "Example Hosting",
    "billing_mode": "reseller_wallet",
    "api_version": "1"
}

Product catalog

Fetch immediately before checkout. Prices already include Firmeoo's markup and the markup configured for this store.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/catalog

List products and current reseller prices.

RESPONSE

{
    "products": [
        {
            "code": "hosting-basic",
            "name": "Business Hosting",
            "type": "hosting",
            "period": "annual",
            "price": 119,
            "currency": "EUR"
        }
    ],
    "currency": "EUR"
}

Create an order

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.
POSThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/order

Create an order or request the Firmeoo checkout hand-off, depending on the store billing mode.

REQUEST

POST https://firmeoo.com/wp-json/firmeoo/v1/reseller-store/order
Authorization: Bearer frm_live_YOUR_STORE_KEY
Idempotency-Key: wc-order-4821

{
    "external_order_id": "4821",
    "product_code": "hosting-basic",
    "domain": "customer.example",
    "customer": {
        "email": "customer@example.com",
        "name": "Example Customer"
    }
}

RESPONSE

{
    "order_id": 1042,
    "service_id": 891,
    "status": "awaiting_provisioning"
}
HTTPMeaning
202Accepted for provisioning.
402Firmeoo checkout or reseller balance is required.
400Invalid request or unavailable product.
401/403Key or origin is unauthorized.

Customer services

Only services sold by the authenticated reseller are returned. Purchases made through other resellers remain private.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/services?customer_email=customer@example.com

List services for one customer in the current reseller context.

RESPONSE

{
    "services": [
        {
            "id": 891,
            "type": "hosting",
            "name": "Business Hosting",
            "domain": "customer.example",
            "status": "active",
            "renews_at": "2027-08-14 00:00:00"
        }
    ]
}
DOMAINS API

Search, price and register domains

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.
GEThttps://firmeoo.com/wp-json/firmeoo/v1/public/domains?page=1&per_page=50

List public domain extensions and current Firmeoo prices. Optional parameters: search and promotion. No key is required.

RESPONSE

{
    "domains": [
        {
            "code": "domain:.pl",
            "tld": ".pl",
            "name": ".PL domain",
            "period": "annual",
            "price": 3.21,
            "renewal_price": 12.5,
            "currency": "GBP",
            "promotion": true
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 50,
        "total": 180,
        "total_pages": 4
    }
}
GEThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/domain-search?q=yourbrand.pl

Authenticated availability search using prices assigned to the current reseller store.

POSThttps://firmeoo.com/wp-json/firmeoo/v1/reseller-store/order

Register the selected domain through Firmeoo routing. Upstream providers and credentials remain private.

REQUEST

POST https://firmeoo.com/wp-json/firmeoo/v1/reseller-store/order
Authorization: Bearer frm_live_YOUR_STORE_KEY
Idempotency-Key: domain-order-4822

{
    "external_order_id": "4822",
    "product_code": "domain:.pl",
    "domain": "yourbrand.pl",
    "customer": {
        "email": "customer@example.com",
        "name": "Example Customer"
    }
}
PUBLIC CATALOG

Doors API

Read-only product catalog. No key is required.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/doors

List active configurable door models.

RESPONSE

{
    "models": [
        {
            "code": "G 600\/48",
            "slug": "g-600-48",
            "currency": "GBP",
            "base_price_from": 822.24000000000001
        }
    ]
}
GEThttps://firmeoo.com/wp-json/firmeoo/v1/doors/{model-slug}

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.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/catalog/products?catalog=jewellery&page=1&per_page=24

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).

RESPONSE

{
    "products": [
        {
            "id": 4102,
            "sku": "FMOP14798AU",
            "name": "Long Cross Earrings",
            "catalog": "jewellery",
            "price": 79,
            "currency": "GBP",
            "stock_quantity": 12,
            "images": [
                "https://firmeoo.com/wp-content/uploads/example.jpg"
            ],
            "google": {
                "availability": "in_stock",
                "condition": "new",
                "gtin": "5900000000000",
                "google_product_category": "188"
            }
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 24,
        "total": 1930,
        "total_pages": 81
    }
}
GEThttps://firmeoo.com/wp-json/firmeoo/v1/catalog/products?catalog=clothing&category=t-shirts

Clothing catalog with brand, product type, colours, sizes and vegan, no-label, organic and recycled feature flags.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/catalog/products/{id-or-sku}

Get one complete product including Jewellery attributes or Clothing variants.

GEThttps://firmeoo.com/wp-json/firmeoo/v1/catalog/categories?catalog=clothing

Return the complete category tree for Jewellery, Clothing or both catalogs.

POSThttps://firmeoo.com/wp-json/firmeoo/v1/catalog/checkout

Create a short-lived Firmeoo checkout hand-off. Products, prices and stock are always revalidated on the server.

REQUEST

{
    "items": [
        {
            "product_id": 4102,
            "quantity": 1
        }
    ]
}

RESPONSE

{
    "checkout_url": "https://firmeoo.com/?firmeoo_catalog_checkout=TOKEN",
    "currency": "GBP",
    "total": 79,
    "expires_in": 1800
}
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 }
}
CodeRecommended action
missing_keySend the Authorization header.
invalid_keyReplace or regenerate the key.
origin_deniedConfigure the store origin in Firmeoo.
unknown_productRefresh the product catalog.
reseller_balance_lowAsk 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.