Authentication Required: You’ll need a valid access token to test
endpoints. Get your token from the
Authentication guide.
How to Use the Playground
- Select an endpoint from the navigation menu (see “OpenAPI Endpoints” section)
- Fill in parameters - Path parameters, query parameters, request body
- Add your access token - In the “Authorization” header
- Click “Send” - Test the endpoint and view the response
- View response - See status code, headers, and response body
Available Endpoints
The interactive playground is available for all endpoints in the OpenAPI specification:Transactions
Start interactions and send transactions
Import Catalog
Import products, categories, and promotions
Coupons
Search and validate coupons
Loyalty
Manage loyalty cards and points
Widgets & CFS
Customer-facing screen and widgets
Settings
Company and location settings
Authentication
OAuth2 token endpoints
Need Help?
Quick Start Guide
Get started with your first API call
Environments
View available API environments