Skip to main content

API Reference

Welcome to the SimpleCheckout API Reference! This section provides comprehensive, interactive documentation for all our REST API endpoints.

About the API​

The SimpleCheckout API is organized around REST principles. Our API accepts and returns JSON-encoded request bodies and responses, uses standard HTTP response codes, and supports authentication via API keys.

Base URL​

https://api.simplecheckout.ai/v0

Authentication​

Most endpoints require authentication using an API key. See the Authentication guide for details on obtaining and using your API keys.

Available APIs​

SimpleCheckout API​

Manage your customers, carts, checkouts, and products. This API provides all the endpoints you need to integrate SimpleCheckout into your application.

Endpoints include:

  • Cart and checkout management
  • Product search
  • Customer CRUD operations
  • Address management
  • Payment method management
  • Customer account credentials (for login sources)

Browse SimpleCheckout API Reference →

Interactive Documentation​

Each endpoint in this reference includes:

  • Request/Response Examples - See exactly what data to send and expect back
  • Try It Out - Test API calls directly from the documentation
  • Schema Details - Full type definitions and field descriptions
  • Authentication Requirements - Clear indication of required auth type

Need Help?​

  • Check out our Guides for step-by-step integration tutorials
  • Review the Authentication guide for API key setup
  • Visit our GitHub for code samples
  • Join our Discord community for support

API Versioning​

The current API version is v1.0. The version is included in the base URL path (/v0). We maintain backwards compatibility and will notify you of any breaking changes well in advance.