Waylo Commerce

Introduction

What the Waylo Commerce API covers and how to call it.

Waylo Commerce is an open-source B2B commerce platform built on Medusa. It ships its B2B features (companies, employees, roles, B2B settings) as Medusa plugins, and each plugin adds its own API routes.

The Store API and Admin API references cover the routes Waylo Commerce adds. Core commerce routes (products, carts, orders, customers) are Medusa's own. Waylo Commerce runs them as Medusa ships them, plus company checkout rules added to carts through workflow hooks. They are in the Core Store API and Core Admin API, built from Medusa's published spec for the release the backend runs. Both include the auth routes; Authentication explains which credentials each API needs.

Two APIs

APIBase pathUsed by
Store API/storeStorefronts and buyer-facing apps, acting as a signed-in customer
Admin API/adminThe admin dashboard and connected services, acting as a merchant

Base URL

Every Waylo Commerce tenant runs on its own host, so there is no shared base URL. Use the URL of your backend. Local development runs on http://localhost:9000.

The Send button on each endpoint page calls your backend straight from the browser. Enter your backend URL in the server field. Your backend must allow this site's origin in STORE_CORS or ADMIN_CORS, or the browser blocks the request. Do this on a development backend only, never in production. Use curl or your own client against production.

Before you start

  • Authentication: which credentials each route needs.
  • Errors: the error body and the company error codes.
  • B2B features: companies, roles, signup, checkout rules, and settings.

The API contract lives in the repo under docs/specs/openapi. This site is built from it, so it never drifts from the spec.

On this page