Quick Start

This guide will help you make your first API request to Chariow in under 5 minutes.

Prerequisites

Before you begin, you’ll need:

A Chariow account with an active store

An API key from your store settings

Step 1: Get Your API Key

Go to app.chariow.com and sign in to your account.

Navigate to API Settings

Click on Settings → API Keys in your store dashboard.

Create a new API key

Click Create API Key, give it a name (e.g., “Development”), choose its scopes, and copy the generated key.

Your API key will only be shown once. Make sure to copy and store it securely.

This guide calls three endpoints, so the key needs the store.read, products.read and checkout.write scopes. If you do not choose any scopes, the key receives every scope your team role allows. See Authentication.

Step 2: Make Your First Request

Let’s verify your API key by fetching your store information:

curl -X GET "https://api.chariow.com/v1/store" \
  -H "Authorization: Bearer sk_live_your_api_key_here"

const response = await fetch('https://api.chariow.com/v1/store', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key_here'
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.chariow.com/v1/store',
    headers={'Authorization': 'Bearer sk_live_your_api_key_here'}
)

print(response.json())

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chariow.com/v1/store');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));

You should receive a response like this:

Response

{
  "data": {
    "id": "store_abc123xyz",
    "name": "My Awesome Store",
    "description": "Selling digital products",
    "logo_url": "https://cdn.chariow.com/stores/logo.png",
    "url": "https://mystore.chariow.com",
    "status": "active"
  }
}

Step 3: List Your Products

Now let’s fetch your published products:

curl -X GET "https://api.chariow.com/v1/products" \
  -H "Authorization: Bearer sk_live_your_api_key_here"

const response = await fetch('https://api.chariow.com/v1/products', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key_here'
  }
});

const data = await response.json();
console.log(data);

Step 4: Initiate a Checkout

Create a checkout session to process a sale:

curl -X POST "https://api.chariow.com/v1/checkout" \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prd_abc123",
    "email": "customer@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": {
      "number": "1234567890",
      "country_code": "US"
    }
  }'

const response = await fetch('https://api.chariow.com/v1/checkout', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    product_id: 'prd_abc123',
    email: 'customer@example.com',
    first_name: 'John',
    last_name: 'Doe',
    phone: {
      number: '1234567890',
      country_code: 'US'
    }
  })
});

const data = await response.json();
console.log(data);

What’s Next?

Authentication

Learn more about API authentication

Products Guide

Learn how to work with products

Checkout Guide

Master the checkout flow

Pulses

Set up real-time notifications

Introduction

Guides

MCP Integration

n8n Integration

Resources

Prerequisites

Step 1: Get Your API Key

Step 2: Make Your First Request

Step 3: List Your Products

Step 4: Initiate a Checkout

What’s Next?

Authentication

Products Guide

Checkout Guide

Pulses

​Prerequisites

​Step 1: Get Your API Key

​Step 2: Make Your First Request

​Step 3: List Your Products

​Step 4: Initiate a Checkout

​What’s Next?

Authentication

Products Guide

Checkout Guide

Pulses

Prerequisites

Step 1: Get Your API Key

Step 2: Make Your First Request

Step 3: List Your Products

Step 4: Initiate a Checkout

What’s Next?