<!-- Source: https://docs.ibakepro.com/ -->

<HeroPattern />

# ibakepro API documentation

Use the ibakepro API to read your product catalog, create and read orders, customers and expenses, send shoppers to a hosted checkout, and get webhooks when things change. Each API key belongs to one ibakepro account. {{ className: 'lead' }}

<div className="not-prose mt-6 mb-16 flex gap-3">
  <Button href="/quickstart" arrow="right">
    <>Quickstart</>
  </Button>
  <Button href="/orders" variant="outline">
    <>Explore the orders API</>
  </Button>
</div>

## Endpoints {{ anchor: false }}

| Area | Endpoints | Scope |
|------|-----------|-------|
| Products | `GET /products`, `GET /products/{id}` | `products:read` |
| Product search | `POST /products/search-token` | `products:search` |
| Orders | `GET /orders`, `GET /orders/{id}`, `POST /orders`, `POST /orders/{id}/flags` | `orders:read`, `orders:write` |
| Customers | `GET /customers`, `GET /customers/{id}`, `POST /customers` | `customers:read`, `customers:write` |
| Expenses | `GET /expenses`, `GET /expenses/{id}`, `POST /expenses` | `expenses:read`, `expenses:write` |
| Checkout | `POST /checkout` | `checkout:write` |
| Availability | `GET /availability` | `reference:read` |
| Reference data | `GET /reference/{blocked-dates,custom-fields,event-categories,expense-categories,fulfillment-windows,payment-methods,time-slots}` | `reference:read` |
| Webhooks | `GET` and `POST /webhooks`; `GET`, `PATCH` and `DELETE /webhooks/{id}`; `POST /webhooks/{id}/test`; `POST /webhooks/{id}/rotate-secret`; `GET /webhooks/{id}/events` | `webhooks:manage` |

## What the API does not do {{ anchor: false }}

- **Products are read-only.** You manage the catalog in the ibakepro dashboard.
- **`GET /products` is not a full catalog export.** It returns only products that are active, shown on your storefront, and not deleted.
- **Orders can be created, read, and flagged for staff to review.** No endpoint updates, cancels, or deletes an order. After you create one, changes happen in the dashboard.
- **Customers and expenses can be created and read.** There is no `PATCH` or `DELETE`.
- **There are no payment endpoints.** You can [record payments when you create an order](/payments), but you cannot list, update, or refund a payment. Payment changes arrive as `payment.*` webhook events.
- **Stock levels, ingredients, and recipes are not available.**
- **`POST /checkout` does not create an order or take payment by itself.** It prices the cart and returns a hosted checkout URL to send the shopper to.

## Key types {{ anchor: false }}

A **secret key** (`ibp_sk_`) is for server-side code. It works on every endpoint its scopes allow.

A **publishable key** (`ibp_pk_`) is safe to put in browser code. It works only on the product, product search, availability, reference data, and checkout endpoints, which also send CORS headers. Any other endpoint rejects it with `403 publishable_key_not_allowed`. See [Authentication](/authentication) for details.

## Getting started {{ anchor: false }}

Create an API key in the ibakepro dashboard under **Settings > Integrations > Developers**, then send it as a `Bearer` token. Keys are regional: the region in the key (`ibp_sk_live_au_...`) must match the host you call (`au.api.ibakepro.com`), or the request returns `401 invalid_api_key`. The API is available on the Business plan; on other plans every request returns `403 plan_required`. {{ className: 'lead' }}

<div className="not-prose">
  <Button href="/authentication" variant="text" arrow="right">
    <>Learn about authentication</>
  </Button>
</div>

<Guides />

<Resources />
