Skip to content

REST connections

Pull products from your own REST API, map the fields once and refresh by hand or every night.

Updated 23 September 2026

Why
A catalogue that is re-exported by hand goes stale.
How
Open /app/catalog?tab=connections and choose New connection; connections are for admins and owners.

Set one up

  1. Step 1.

    Enter the Name, Base URL and Endpoint path.

  2. Step 2.

    Pick the Authentication: Bearer token, Basic (user:pass) or Custom header with its Header name. The credential is stored encrypted and never shown again.

  3. Step 3.

    Pick the Pagination (below) and the Items path, such as data.items, or leave it empty when the response is the array.

  4. Step 4.

    Choose Test fetch. The first item appears as JSON under Sample item: map against what you see.

  5. Step 5.

    Fill the Field map from JSON path to field, including External ID, pick the Schedule (Manual or Daily) and choose Save connection.

PaginationWhat Kabaido sends
Single pageOne request.
Page numberA page parameter, advancing each request.
OffsetA row offset, advancing by the page size.

Paging stops at an empty or short page. Each request has a time limit and a sync reads a capped number of pages, a guard against a feed that never ends.

How records merge

A record whose external ID Kabaido already holds updates that product; any other is matched by SKU. Values are coerced against the schema exactly as on import. The connection card shows Live, Paused or Failing, the last run and how many items it synced.