Skip to main content

Endpoint reference

Endpoint reference pages are generated from static/openapi.json. Run npm run generate after editing the specification.

The API surface covers integration identity and usage, processed orders, merchant customers, merchant loyalty templates, and customer loyalty state.

Top-level Loyalty Cards, Rewards, and Vouchers endpoints return merchant templates. Customer Loyalty Cards, Customer Rewards, and Customer Vouchers endpoints are nested under /customers/{customerId} and return customer-owned instances.