Skip to main content

Webround APIs

Never invent endpoints, parameters, or schemas. Before writing any API call, fetch the relevant page from https://docs.webround.com and read it.

Key concept: draft = store​

A draft and its linked store always share the same ID. Wherever an API requires storeId, use the draftId. They are the same value.

API systems​

Core API​

Host: core-api.webround.com
Versioning: none
Auth: Firebase JWT (required on all endpoints)
Exception: uploading assets (images, videos) to a store accepts either a Firebase JWT or a Webround Commerce API key with asset:create permission.

Use the Core API for file uploads. The Commerce API does not support file uploads.

Commerce API​

Host: commerce-api.webround.com
Auth: Firebase JWT or Webround Commerce API key (supported on all endpoints)
Required headers: store-id, user-id

user-id must be the Firebase UID of the authenticated user.

  • With JWT: the UID must match the token exactly (owner or registered collaborator).
  • With API key: owner's or any registered collaborator's Firebase UID is accepted.

The Commerce API also serves store customers (visitors, buyers). Store customers authenticate with email and password and receive a JWT. No API keys or other mechanisms exist for them. Endpoints like orders, wishlist, and saved addresses require a valid store customer JWT.

Do not use the Commerce API for file uploads — use the Core API instead.

Catalog API​

Host: catalog-api.webround.com
Auth: none
Required headers: store-id

Public read-only catalog system. No authentication required.

Checkout API​

Host: checkout-api.webround.com
Auth: Firebase JWT (authenticated user) or guest checkout flow
No API keys. No other auth mechanisms.

Handles the full checkout flow and Stripe payment validation. Guest checkout is supported natively.

Auth summary​

SystemFirebase JWTAPI KeyStore Customer JWTPublic
Core API✅ required✅ (asset upload only)❌❌
Commerce API✅✅✅ (customer endpoints)❌
Catalog API❌❌❌✅
Checkout API✅❌❌✅ (guest)