Biz Edge Developers

Build on the system that runs the store.

The catalogue, stock, orders and payments behind every Biz Edge store, as clean JSON APIs. Connect a shop, an app or an integration to the same records the till uses, live.

endpoints
35
API live
1
over HTTPS
JSON
GET /v1/item/browse 200 · errorCode 0
curl https://storefrontapi.bizedgehq.com/v1/item/browse \
  -H "X-API-Key: $BIZEDGE_API_KEY"
{
  "errorCode": 0,
  "errorMessage": "",
  "data": {
    "page": 1, "total": 4,
    "items": [{
      "id": 797638,
      "name": "5 Alive Pulp",
      "price": 2300,
      "unit": "Bottle",
      "inStock": false
    }]
  }
}

APIs

Pick the API for what you're building

Each API has an interactive reference: read the endpoints, see real responses, and send requests from the page with your own key.

Storefront API

For shop and storefront developers

Live · v1

Run an online shop on a Biz Edge RetailPOS store: catalogue, stock, checkout, payment and order tracking.

https://storefrontapi.bizedgehq.com

35 endpoints in 10 sections

  • Storefront
  • Catalogue
  • Stock
  • Address
  • Branch
  • Shipping
  • Payment
  • Email Verification
  • Orders
  • Paystack

Get started

From key to first call in three steps

  1. 1

    Get your API key

    Biz Edge issues a key when your storefront or integration is set up. The key decides which company, branch and store every call works on, so there are no ids to pass.

    Keep it on your server. Never ship it in a browser or app.

  2. 2

    Make your first call

    Send the key in the X-API-Key header.

    curl https://storefrontapi.bizedgehq.com/v1/storefront/detail \
      -H "X-API-Key: $BIZEDGE_API_KEY"
  3. 3

    Check the errorCode

    An errorCode of 0 means it worked. Anything else is a failure with a readable errorMessage, and each API's reference lists its codes.

Conventions

How Biz Edge APIs behave

Learn these once and every reference on this site reads the same way.

One envelope for every response

Responses come back as HTTP 200, failures included, wrapped in the same three fields. Decide on errorCode, not on the HTTP status.

{
  "errorCode": -31,
  "errorMessage": "Item 999999999 not found",
  "data": null
}

One key, one store

The key carries the tenant. Requests never name a company or branch, so a key can't reach another store's data.

Rate limited per store

Each store has its own limit, shared by all its shoppers. Over the limit answers -51: wait the seconds in the Retry-After header, then retry.

Versioned paths

Every endpoint lives under /v1, so a later version can sit beside it without breaking the calls you make today.

Paged lists

Long lists, like the catalogue, take page and size and return the total, so a shop can page through any size of range.

Prefer Postman?

Every API comes with a ready-made Postman collection: requests, saved example responses and one variable to paste your key into.

Find the collections