borkoldocs

Getting Started

Quick start

The shortest path from an empty business to a working store taking its first order.

View as Markdown

This walkthrough takes a brand-new business from empty to selling: one product, working taxes and shipping, an API key for your storefront, and the first order landing on your dashboard. It assumes the Commerce module is enabled for your business; if the sidebar has no Webshop entry, ask your platform admin.

1. Create your first product

  1. In the sidebar, open Catalog → Products. On a fresh business the list says "No products yet".

  2. Click New product. The screen asks What are you selling?: pick Product (sold as is, optionally with options like size or color). Made to measure is only offered when the Configurator module is enabled.

  3. Type a Name and click Save. The product is created as a draft and its page opens.

  4. On the product page, fill in the essentials and click Save once for all of them:

    FieldWhereDescription
    PricePricingEntered in major units (e.g. 19.99 or 19,99); variants can override it.
    UnitPricingPiece unless you sell by weight, length, area, volume or time.
    SKUStock & shippingYour internal article number.
    Track stock / Stock quantityStock & shippingWith the Stock module, how many you have. Leave the quantity blank to sell without limits.
    StatusSidebarDraft, Active, or Archived. Only make it Active when it should be sellable.

    Options like Size with values S, M, L go in the Options & variants card; variants are generated there. The full tour is in Managing products.

The dashboard's Getting started checklist links here too via Create your first product.

2. Set up taxes and shipping

Before a storefront can check out, your business needs at least a tax class and a shipping method.

  1. Open Settings → Taxes. A new business already has Standaard 21%, Verlaagd 9% and Nultarief 0%; add your own with New tax class if you need one. One class is the default, which products use unless you pick another.
  2. Open Webshop → Settings → Shipping and add a method with New shipping method. Prices are in your shop currency; leave the free-shipping threshold empty if you don't offer free shipping.

Note: the dashboard's Getting started checklist item Configure taxes & shipping currently opens the Orders list, not these settings pages; use the sidebar path above.

Full details for taxes are in Taxes; shipping and the other store settings are in Store settings.

3. Create an API key for your storefront

Your storefront (website, app, or integration) talks to Borkol with an API key scoped to this business.

  1. Open Settings in the sidebar's WORKSPACE section and switch to the API Keys tab.
  2. In the Create key card, enter a key name (for example storefront) and select at least one scope pill. Scopes come from your enabled modules: tenant:read plus a :read and :write scope per module (e.g. commerce:read, commerce:write).
  3. Click Create. The plaintext token appears once, in a card titled "Copy this token now. Shown once."
  4. Copy the token and store it somewhere safe. It can never be viewed again; if you lose it, revoke the key and create a new one.

More on scopes and revoking in API keys. Whoever builds the storefront uses this token as described in the API reference under Authentication.

4. Watch the first order arrive

Once your storefront is live and a customer checks out:

  • The dashboard home shows the order in Recent orders, and the Revenue, Orders, and Orders this month cards update.
  • The full list lives under Webshop → Orders; click any row to open the order detail.
  • New orders start as pending_payment and move through paid, shipped, and completed (or cancelled / refunded).

If your integration should react to orders automatically instead of you refreshing the dashboard, add a webhook endpoint on the Webhooks tab in Settings; it can receive order.created and order.status_changed events as they happen.