Skip to main content

Getting Started

SportsEngine Commerce powers add-on offers during youth sports registration: quotes, carts, checkout, and post-purchase fulfillment.

Pick the path that matches what you are building. All HTTP APIs live under /v3/commerce/.

Choose your path​

You are…Start here
Embedding a shopping experience in a registration or checkout pageEmbeddable Store
Calling quotes, catalog eligibility, or cart APIs from a backendShopper API
Managing products, bundles, and catalogs in SportsEngine HQHQ Product Management
Debugging fulfillment, DLQs, or replaying failed ordersOperators

Embeddable Store​

Use the web component when the host page should render offers, cart, and continue-to-checkout with minimal custom UI.

  • Drop in <sales-channels-element> and pass participant context.
  • The component handles SportsEngine login and calls Commerce APIs for you.
  • After the shopper is ready to pay, handle the continue event and send them through your financial platform (Clare checkout).

Next: Installation

Shopper API​

Use the HTTP APIs when you need a custom backend or cannot embed the store component.

  • Request quotes and qualifying catalogs, then add items to a Clare cart identified by guestKey.
  • Send a SportsEngine bearer token on each request unless the endpoint is marked public.

Next: Authentication · Shopper API reference

HQ Product Management (PMUI)​

Merchant catalog administration is not an se-commerce-api HTTP surface. Organization admins create products, bundles, and catalogs in HQ Product Management, which writes to Clare.

See the Commerce system map for how PMUI, Clare, and this API fit together.

Operators​

Post-checkout work is event-driven (SQS/SNS). There is no public marketplace HTTP API.

Shopper journey​

Whether you embed the store or call the Shopper API, the purchase path is the same.

  1. Quote / catalog eligibility — The host app (or embeddable store) sends participant and registration context. Shopper APIs return qualifying catalogs and priced quotes for add-on offers.
  2. Add items to cart — Selected offers are added to a Clare cart. Cart endpoints require a guestKey query parameter in addition to a bearer token.
  3. guestKey — A unique id for the shopper's Clare cart session. The embeddable store can accept an existing key or provision one. Pass the same key through checkout so payment applies to that cart.
  4. Clare checkout — Payment runs in Clare (SportsEngine checkout, or GoMotion via POST /integrator/motion/payments). se-commerce-api does not capture the charge.
  5. Fulfillment — When the sale group is paid, Clare publishes sale_group_paid_v2. se-commerce purchases quotes and submits vendor orders. See Marketplace Fulfillment.

Access levels​

OpenID Connect is available so users can sign in and verify identity. Current access levels:

  • Shopper — Browse products, manage a cart, and begin checkout.
  • Vendor Admin — Manage products, pricing, inventory, and order fulfillment.
  • Merchant Admin — Organization-level storefront configuration (HQ / Clare; not se-commerce-api). See Embeddable Store.

Existing SportsEngine customers can onboard companies and users without additional identity setup. See Authentication.