Skip to main content
The Chariow API is a RESTful API that allows you to programmatically interact with your store. You can use it to retrieve products, manage customers, process sales, validate licenses, and more.

​
Base URL

All API requests should be made to: 
https://api.chariow.com/v1

​
Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header: 
Authorization: Bearer sk_live_your_api_key

Get your API key

Generate API keys in your store dashboard

​
Request Format

  • All requests should include Content-Type: application/json header for POST/PUT requests
  • Request bodies should be JSON encoded
  • Query parameters should be URL encoded

​
Response Format

All responses follow a consistent JSON structure: 
{
  "message": "success",
  "data": {
    // Response data
  },
  "errors": []
}

​
Pagination

List endpoints use cursor-based pagination: 
{
  "data": {
    "data": [...],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  }
}
Use the cursor query parameter to navigate pages: 
GET /v1/products?cursor=eyJpZCI6NTB9&per_page=20

​
Available Endpoints

Store

Retrieve store information

Products

List and retrieve products

Checkout

Initiate checkout sessions

Sales

Manage sales and orders

Customers

Customer management

Licenses

License key management

Discounts

Discount code management

Pulses

Webhook notification pulses

​
Rate Limits

Endpoint TypeLimit
All API requests10/min
Rate limits are applied per API key. See Rate Limits for more details.

​
Need Help?

Guides

Step-by-step tutorials

Support

Get help from our team

Community

Join the community