curl -X GET "https://api.chariow.com/v1/products?per_page=20&type=course" \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/products?per_page=20&type=course', {
headers: {
'Authorization': 'Bearer sk_live_YOUR_API_KEY'
}
});
const { data, pagination } = await response.json();
const published = data.filter(product => product.status === 'published');
$ch = curl_init('https://api.chariow.com/v1/products?per_page=20&type=course');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/products',
params={'per_page': 20, 'type': 'course'},
headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()
{
"data": [
{
"id": "prd_abc123",
"name": "Premium Web Development Course",
"slug": "premium-web-dev-course",
"description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
"type": "course",
"category": {
"value": "education_and_learning",
"label": "Education and Learning"
},
"status": "published",
"is_free": false,
"pictures": {
"thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
"cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
},
"pricing": {
"type": "one_time",
"current_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"price": {
"value": 149,
"formatted": "$149.00",
"short": "149",
"currency": "USD"
},
"effective": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"sale_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"minimum_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"suggested_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"price_off": "34%",
"tracking": {
"currency": "USD",
"value": 99
}
},
"has_variant_pricing": false,
"quantity": null,
"settings": {
"is_shipping_address_required": false
},
"rating": {
"total_ratings": {
"value": 245,
"formatted": "245",
"short": "245",
"short_plus": "245+"
},
"thumbs_up_count": 236,
"thumbs_up_percentage": "96%"
},
"on_sale_until": "2025-02-28T23:59:59.000000Z",
"sales_count": {
"value": 1250,
"formatted": "1,250",
"short": "1K",
"short_plus": "1K+"
},
"seo": null,
"custom_cta_text": {
"value": null,
"label": null
},
"fields": null,
"store": null,
"bundle": null,
"coaching": null
}
],
"pagination": {
"count": 1,
"path": "https://api.chariow.com/v1/products",
"per_page": 20,
"next_cursor": null,
"next_page_url": null,
"prev_cursor": null,
"prev_page_url": null,
"has_more_pages": false,
"has_pages": false
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Products
List Products
Retrieve the products of your store
curl -X GET "https://api.chariow.com/v1/products?per_page=20&type=course" \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/products?per_page=20&type=course', {
headers: {
'Authorization': 'Bearer sk_live_YOUR_API_KEY'
}
});
const { data, pagination } = await response.json();
const published = data.filter(product => product.status === 'published');
$ch = curl_init('https://api.chariow.com/v1/products?per_page=20&type=course');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/products',
params={'per_page': 20, 'type': 'course'},
headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()
{
"data": [
{
"id": "prd_abc123",
"name": "Premium Web Development Course",
"slug": "premium-web-dev-course",
"description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
"type": "course",
"category": {
"value": "education_and_learning",
"label": "Education and Learning"
},
"status": "published",
"is_free": false,
"pictures": {
"thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
"cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
},
"pricing": {
"type": "one_time",
"current_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"price": {
"value": 149,
"formatted": "$149.00",
"short": "149",
"currency": "USD"
},
"effective": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"sale_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"minimum_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"suggested_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"price_off": "34%",
"tracking": {
"currency": "USD",
"value": 99
}
},
"has_variant_pricing": false,
"quantity": null,
"settings": {
"is_shipping_address_required": false
},
"rating": {
"total_ratings": {
"value": 245,
"formatted": "245",
"short": "245",
"short_plus": "245+"
},
"thumbs_up_count": 236,
"thumbs_up_percentage": "96%"
},
"on_sale_until": "2025-02-28T23:59:59.000000Z",
"sales_count": {
"value": 1250,
"formatted": "1,250",
"short": "1K",
"short_plus": "1K+"
},
"seo": null,
"custom_cta_text": {
"value": null,
"label": null
},
"fields": null,
"store": null,
"bundle": null,
"coaching": null
}
],
"pagination": {
"count": 1,
"path": "https://api.chariow.com/v1/products",
"per_page": 20,
"next_cursor": null,
"next_page_url": null,
"prev_cursor": null,
"prev_page_url": null,
"has_more_pages": false,
"has_pages": false
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Retrieves a cursor-paginated list of the products in your store, newest first. Products are returned whatever their status (
published, draft or suspended): check status before showing a product to buyers. Supports optional filtering by category, type, or search term.
Required scope:
products.read. A key without it receives a 403 error. See Authentication.Query Parameters
integer
default:"10"
Number of products to return per page (maximum 100)
string
Cursor for pagination. Use the
next_cursor from the previous response to fetch the next page.string
Search products by public ID, name, slug, category or type
string
Filter by product category. Available values:
creative_arts, technology, business_and_finance, personal_development, education_and_learning, entertainment, health_and_wellness, literature_and_publishing, media_and_communication, miscellaneousstring
Filter by product type. Available values:
downloadable, service, course, license, bundle, coachingResponse
The list is returned at the top level of the body, without themessage and errors fields used by error responses.
array
Array of product objects, newest first. Each product has the same fields as the Get Product response, including
status, sales_count and quantity.object
Cursor pagination metadata
Show pagination object
Show pagination object
integer
Number of items on this page
string
Base URL of the endpoint
integer
Page size used for this request
string | null
Cursor for the next page, or
null if there are no more pagesstring | null
Full URL of the next page, or
nullstring | null
Cursor for the previous page, or
null on the first pagestring | null
Full URL of the previous page, or
nullboolean
Whether there are more items to fetch
boolean
Whether the results span more than one page
curl -X GET "https://api.chariow.com/v1/products?per_page=20&type=course" \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"
const response = await fetch('https://api.chariow.com/v1/products?per_page=20&type=course', {
headers: {
'Authorization': 'Bearer sk_live_YOUR_API_KEY'
}
});
const { data, pagination } = await response.json();
const published = data.filter(product => product.status === 'published');
$ch = curl_init('https://api.chariow.com/v1/products?per_page=20&type=course');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/products',
params={'per_page': 20, 'type': 'course'},
headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()
{
"data": [
{
"id": "prd_abc123",
"name": "Premium Web Development Course",
"slug": "premium-web-dev-course",
"description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
"type": "course",
"category": {
"value": "education_and_learning",
"label": "Education and Learning"
},
"status": "published",
"is_free": false,
"pictures": {
"thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
"cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
},
"pricing": {
"type": "one_time",
"current_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"price": {
"value": 149,
"formatted": "$149.00",
"short": "149",
"currency": "USD"
},
"effective": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"sale_price": {
"value": 99,
"formatted": "$99.00",
"short": "99",
"currency": "USD"
},
"minimum_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"suggested_price": {
"value": 0,
"formatted": "$0.00",
"short": "0",
"currency": "USD"
},
"price_off": "34%",
"tracking": {
"currency": "USD",
"value": 99
}
},
"has_variant_pricing": false,
"quantity": null,
"settings": {
"is_shipping_address_required": false
},
"rating": {
"total_ratings": {
"value": 245,
"formatted": "245",
"short": "245",
"short_plus": "245+"
},
"thumbs_up_count": 236,
"thumbs_up_percentage": "96%"
},
"on_sale_until": "2025-02-28T23:59:59.000000Z",
"sales_count": {
"value": 1250,
"formatted": "1,250",
"short": "1K",
"short_plus": "1K+"
},
"seo": null,
"custom_cta_text": {
"value": null,
"label": null
},
"fields": null,
"store": null,
"bundle": null,
"coaching": null
}
],
"pagination": {
"count": 1,
"path": "https://api.chariow.com/v1/products",
"per_page": 20,
"next_cursor": null,
"next_page_url": null,
"prev_cursor": null,
"prev_page_url": null,
"has_more_pages": false,
"has_pages": false
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Was this page helpful?