API Introduction - Chariow Developers

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 YOUR_API_KEY

Each API key carries scopes, and every endpoint requires at least one of them. A key without the required scope receives a 403 response that lists the missing scopes. See Authentication for the scope each endpoint requires.

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

A single resource is wrapped in data: {"data": {...}}.
A list returns data (an array) and pagination at the top level.
An error returns message and errors. Validation (422), authentication (401), missing scope (403) and not found (404) errors also carry an empty data array.
activate and revoke on licences also return a message next to data.

Pagination

List endpoints use cursor-based pagination:

{
  "data": [...],
  "pagination": {
    "count": 10,
    "path": "https://api.chariow.com/v1/products",
    "per_page": 10,
    "next_cursor": "eyJpZCI6NTB9",
    "next_page_url": "https://api.chariow.com/v1/products?cursor=eyJpZCI6NTB9",
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": true,
    "has_pages": 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

Affiliates

Retrieve affiliates and send invitations

Rate Limits

Endpoint Type	Limit
All endpoints except checkout	100/min per API key
`POST /checkout`	100/min per API key, counted separately

See Rate Limits for more details.

Need Help?

Guides

Step-by-step tutorials

Support

Get help from our team

Community

Join the community

​Base URL

​Authentication