Connect a custom store

If your store isn't on Shopify or WooCommerce, connect it with the Custom option. A guided wizard maps your existing API to Synchronity — no code, no config files, and nothing to self-host. The connector is fully managed by Synchronity.

Before you start

Have these ready for your store's API:

• The base URL of your API (for example https://api.your-store.com).
• How it authenticates — an API key or a bearer token, and the header name it expects (the default is X-API-Key).
• For each operation below, the path Synchronity should call.

Step 1 — Start the wizard

1. In the merchant portal, open Storefronts and click Add Storefront.
2. Choose Custom E-commerce Site.
3. Enter a Store Name and click Continue. The setup wizard opens.

Step 2 — Connection

Tell Synchronity how to reach and authenticate with your API:

• Target API base URL — e.g. https://api.your-store.com.
• Auth type — API key or Bearer token.
• Auth header — the header your API expects (default X-API-Key).
• Secret — the key or token value. It's write-only: stored securely and never shown back.

Step 3 — Operations

Map each Synchronity operation to a path on your API. Five operations power v1 (cart operations are handled by Synchronity, so you don't map those):

Step 4 — Capabilities

Toggle which features your store supports (for example whether agents can run checkout). Agents only ever see the capabilities you enable here.

Step 5 — Go live

Run the built-in test, then activate. Once live, your store appears under Storefronts and agents can discover it with list_sites.

You can return to the wizard any time to adjust the mapping — open the store's details under Storefronts.

Prefer to self-host?

The wizard uses Synchronity's managed connector. If you'd rather run your own connector service or register the site over the API, see how connectors work.