Read-only API credentials and endpoints
This section documents API key creation, authentication, rate limits, list parameters and every supplied GET endpoint.
Create a POS API key
Create a POS API keyName the credential, select read scopes and optionally set expiry.
Open guide →GuideCopy the one-time API secret
Copy the one-time API secretStore the full secret immediately because it is not shown again.
Open guide →GuideUnderstand the bpos_ API secret format
Understand the bpos_ API secret formatUse the bpos_ prefix and generated hexadecimal secret.
Open guide →GuideUnderstand stored API key hashes
Understand stored API key hashesKnow the database stores prefix/hash rather than the full credential.
Open guide →GuideChoose API key expiry
Choose API key expirySet an optional datetime after which authentication fails.
Open guide →GuideGrant catalogue:read
Grant catalogue:readAllow product list and product detail reads.
Open guide →GuideGrant inventory:read
Grant inventory:readAllow stock list reads.
Open guide →GuideGrant orders:read
Grant orders:readAllow order list and detail reads.
Open guide →GuideUnderstand reports:read in version 1.0.0
Understand reports:read in version 1.0.0Know the scope is selectable but no reports endpoint is routed.
Open guide →GuideAuthenticate with a Bearer token
Authenticate with a Bearer tokenSend Authorization: Bearer {secret}.
Open guide →GuideUnderstand API rate limits
Understand API rate limitsUse 600 requests/hour per key+IP for business endpoints and 120/hour/IP for health.
Open guide →GuideUnderstand API pagination
Understand API paginationUse limit 1–100 and non-negative offset.
Open guide →GuideCall the API health endpoint
Call the API health endpointGET /britixo-pos/api/v1/health without a business scope.
Open guide →GuideList products through the API
List products through the APIGET /britixo-pos/api/v1/products with catalogue:read.
Open guide →GuideFilter API products
Filter API productsUse supported query/status/pagination values exposed by the controller/model.
Open guide →GuideGet one product through the API
Get one product through the APIGET /britixo-pos/api/v1/products/{id} with catalogue:read.
Open guide →GuideList orders through the API
List orders through the APIGET /britixo-pos/api/v1/orders with orders:read.
Open guide →GuideFilter API orders
Filter API ordersUse supported status/channel/search/pagination filters.
Open guide →GuideGet one order through the API
Get one order through the APIGET /britixo-pos/api/v1/orders/{reference} with orders:read.
Open guide →GuideList stock through the API
List stock through the APIGET /britixo-pos/api/v1/stock with inventory:read.
Open guide →GuideUnderstand API tenant isolation
Understand API tenant isolationKnow all returned records are restricted to the authenticated tenant.
Open guide →GuideUnderstand API JSON and cache headers
Understand API JSON and cache headersHandle structured JSON and no-store/security headers.
Open guide →GuideHandle an API missing-token response
Handle an API missing-token responseSupply a valid Bearer credential.
Open guide →GuideHandle an invalid, revoked or expired API key
Handle an invalid, revoked or expired API keyReplace or reactivate integration credentials through authorised settings.
Open guide →GuideHandle an API scope-denied response
Handle an API scope-denied responseGrant only the required read scope or use another key.
Open guide →GuideHandle an API record-not-found response
Handle an API record-not-found responseVerify tenant and identifier.
Open guide →GuideHandle an API validation response
Handle an API validation responseCorrect limit, offset or filter values.
Open guide →GuideHandle an API rate-limit response
Handle an API rate-limit responseBack off until the current rate window expires.
Open guide →GuideRevoke an API key
Revoke an API keyUse Settings to invalidate a credential immediately.
Open guide →GuideReview API key last-used information
Review API key last-used informationUse prefix, scopes and last_used_at for credential governance.
Open guide →GuideUnderstand API write limitations
Understand API write limitationsKnow there are no create/update/delete routes in version 1.0.0.
Open guide →GuideRun the API integration checklist
Run the API integration checklistVerify HTTPS, secret storage, scopes, expiry, pagination, rate handling and revocation.
Open guide →