Skip to content
Integrations

bisky REST API.

bisky has a REST API (v1) for retailers and platforms that want to connect directly.
REST API ↔ bisky
  • Products, names and imagesFrom REST API
  • Prices and stockOn a schedule
  • Arabic names and spellingsAdded by bisky
  • Order #7342 · $25.01To your orders API
Sync

What syncs, and where the order goes.

In · from REST API
REST API v1Riverside branch
POST /v1/products {"sku":"PRM-200","name":"Parmigiano Reggiano 200g","price":4.79,"stock":42}
Cleaned by bisky
Parmigiano Reggiano 200 gCheese · Hard$4.79
parmesanparmigianoبارميزان
In stock at Riverside · 42
Out · the confirmed order
Order #7342Pasta night for 4 · 9 items$25.01
  • Spaghetti$2.98
  • Passata$2.58
  • Garlic$0.99
  • + 4 more lines
{ }Webhook: order.confirmedTo your endpoint, signed
Setup

Connect in three steps.

  1. 01

    Get your API keys

    Your team issues keys for your own retailer account.

    sk_live_••••••••Connected
  2. 02

    Push your catalogue

    Products, branch prices and stock, then delta updates as they change.

    4,812products · 3 branches
  3. 03

    Receive orders

    Subscribe to webhooks or point bisky at your orders API.

    48/48tests on your productsLive
Developers

The API, in two calls.

Push products with an idempotency key. Receive each confirmed order as a signed webhook.

You sendproducts
POST /v1/products
 
Authorization: Bearer sk_live_••••
Idempotency-Key: 6f1c2e0a
 
{
"sku": "PRM-200",
"name": "Parmigiano Reggiano 200g",
"branch": "riverside", "price": 4.79, "stock": 42
}
You receivewebhook
POST https://your-store.example/bisky/orders
 
X-Bisky-Event: order.confirmed
X-Bisky-Signature: t=…,v1=…
 
{
"order": "7342",
"branch": "riverside",
"lines": 7, "items": 9,
"total": { "amount": 25.01, "currency": "USD" }
}

Illustrative shape. The full schema is in the API docs.

In your app

The shopper asks, the order reaches you.

The same chat and the same order: #7342 from Riverside, $25.01.

Northfield MarketShopping assistant0
Yesterday
Do you have fresh basil?
Yes. Fresh basil, one pot, $1.19 at Riverside.
And parmesan?
Parmigiano Reggiano 200 g, $4.79. In stock too.
Today
Hi! Ask me for anything from Northfield Market.
Pasta night for 4, bolognese
Sure. Bolognese for 4 from Riverside:
Ask for anything
Order #7342Goes to your orders API
FAQ

Integration questions.

Running something we do not list? Tell us what it is and we will scope the connector.

Write to hello@bisky.ai

Is there an OpenAPI document?

Yes. The API docs include the OpenAPI document for v1.

Can a platform manage many retailers through the API?

Yes. Each retailer is its own organisation, and partners manage theirs from a partner console. See For platforms.

Does the API place orders in our system?

Confirmed orders go to your orders API or arrive as webhook events. Nothing is ordered without the shopper's confirmation.

Book a demo

Connect your store and see it work.

We sync your catalogue and branches for the demo, then map how orders reach you.