curl -X GET "https://api.chariow.com/v1/store" \
-H "Authorization: Bearer sk_live_abc123xyz..."
const response = await fetch('https://api.chariow.com/v1/store', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_live_abc123xyz...',
'Content-Type': 'application/json'
}
});
const { data } = await response.json();
console.log(data);
<?php
$apiKey = 'sk_live_abc123xyz...';
$ch = curl_init('https://api.chariow.com/v1/store');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);
print_r($data);
import requests
api_key = 'sk_live_abc123xyz...'
response = requests.get(
'https://api.chariow.com/v1/store',
headers={
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
)
data = response.json()
print(data)
{
"data": {
"id": "store_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/store_abc123xyz/logo.png",
"url": "https://mystore.chariow.com",
"social_links": {
"telegram": null,
"instagram": "https://instagram.com/mystore",
"facebook": "https://facebook.com/mystore",
"x": "https://x.com/mystore",
"linkedin": null,
"youtube": null,
"tiktok": null,
"discord": null
},
"status": "active",
"stats": {
"total_customers": 1840,
"ratings": {
"total_ratings": 312,
"thumbs_up_count": 297,
"thumbs_up_percentage": "95%"
}
}
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Store
Get Store
Retrieve detailed information about your store
curl -X GET "https://api.chariow.com/v1/store" \
-H "Authorization: Bearer sk_live_abc123xyz..."
const response = await fetch('https://api.chariow.com/v1/store', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_live_abc123xyz...',
'Content-Type': 'application/json'
}
});
const { data } = await response.json();
console.log(data);
<?php
$apiKey = 'sk_live_abc123xyz...';
$ch = curl_init('https://api.chariow.com/v1/store');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);
print_r($data);
import requests
api_key = 'sk_live_abc123xyz...'
response = requests.get(
'https://api.chariow.com/v1/store',
headers={
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
)
data = response.json()
print(data)
{
"data": {
"id": "store_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/store_abc123xyz/logo.png",
"url": "https://mystore.chariow.com",
"social_links": {
"telegram": null,
"instagram": "https://instagram.com/mystore",
"facebook": "https://facebook.com/mystore",
"x": "https://x.com/mystore",
"linkedin": null,
"youtube": null,
"tiktok": null,
"discord": null
},
"status": "active",
"stats": {
"total_customers": 1840,
"ratings": {
"total_ratings": 312,
"thumbs_up_count": 297,
"thumbs_up_percentage": "95%"
}
}
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Retrieves information about the store associated with the authenticated API key, including branding, social links, status, and statistics.
Required scope:
store.read. A key without it receives a 403 error. See Authentication.Authentication
This endpoint requires authentication using a Store API key. Include your API key in theAuthorization header as a Bearer token.
Authorization: Bearer YOUR_API_KEY
Response
object
Store information object
Show properties
Show properties
string
required
Unique store identifier with
store_ prefix (e.g., store_abc123xyz)string
required
Store name, as plain text
string | null
Store description displayed on your storefront, as plain text
string | null
Full URL to the store logo image. Returns
null if no logo is set.string
required
Public URL of the store (custom domain or Chariow subdomain)
object
Social media links configured for the store. Each link is
null when not set.Show properties
Show properties
string | null
Telegram channel or group URL
string | null
Instagram profile URL
string | null
Facebook page URL
string | null
X (formerly Twitter) profile URL
string | null
LinkedIn profile or company page URL
string | null
YouTube channel URL
string | null
TikTok profile URL
string | null
Discord server invite URL
string
required
Current store status. Possible values:
active, under_review, suspended, archivedAppearance settings (theme, fonts, colours) are not returned by this endpoint.
Error Responses
Returned when the API key is missing or invalidOr:
{
"message": "API key is missing. Please provide a valid API key. Help: https://docs.chariow.com",
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
curl -X GET "https://api.chariow.com/v1/store" \
-H "Authorization: Bearer sk_live_abc123xyz..."
const response = await fetch('https://api.chariow.com/v1/store', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_live_abc123xyz...',
'Content-Type': 'application/json'
}
});
const { data } = await response.json();
console.log(data);
<?php
$apiKey = 'sk_live_abc123xyz...';
$ch = curl_init('https://api.chariow.com/v1/store');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);
print_r($data);
import requests
api_key = 'sk_live_abc123xyz...'
response = requests.get(
'https://api.chariow.com/v1/store',
headers={
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
)
data = response.json()
print(data)
{
"data": {
"id": "store_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/store_abc123xyz/logo.png",
"url": "https://mystore.chariow.com",
"social_links": {
"telegram": null,
"instagram": "https://instagram.com/mystore",
"facebook": "https://facebook.com/mystore",
"x": "https://x.com/mystore",
"linkedin": null,
"youtube": null,
"tiktok": null,
"discord": null
},
"status": "active",
"stats": {
"total_customers": 1840,
"ratings": {
"total_ratings": 312,
"thumbs_up_count": 297,
"thumbs_up_percentage": "95%"
}
}
}
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Was this page helpful?