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)
{
"message": "success",
"data": {
"id": "str_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/str_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",
"appearance": {
"theme": {
"value": "modern",
"label": "Modern"
},
"font": {
"primary": {
"value": "inter",
"display_name": "Inter",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Inter"
},
"secondary": {
"value": "roboto",
"display_name": "Roboto",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Roboto"
}
},
"border_style": {
"value": "rounded",
"label": "Rounded"
},
"product_order": {
"value": "newest",
"label": "Newest First"
},
"color": {
"primary": {
"hex": "#3B82F6",
"rgb": "59, 130, 246"
},
"contrast": {
"hex": "#FFFFFF",
"rgb": "255, 255, 255"
}
},
"show_featured_products": true,
"show_purchase_button_on_product_card": true,
"show_recommended_products": true,
"products_per_row": 3,
"cta_animation_type": {
"value": "pulse",
"label": "Pulse"
}
}
},
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"data": [],
"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)
{
"message": "success",
"data": {
"id": "str_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/str_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",
"appearance": {
"theme": {
"value": "modern",
"label": "Modern"
},
"font": {
"primary": {
"value": "inter",
"display_name": "Inter",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Inter"
},
"secondary": {
"value": "roboto",
"display_name": "Roboto",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Roboto"
}
},
"border_style": {
"value": "rounded",
"label": "Rounded"
},
"product_order": {
"value": "newest",
"label": "Newest First"
},
"color": {
"primary": {
"hex": "#3B82F6",
"rgb": "59, 130, 246"
},
"contrast": {
"hex": "#FFFFFF",
"rgb": "255, 255, 255"
}
},
"show_featured_products": true,
"show_purchase_button_on_product_card": true,
"show_recommended_products": true,
"products_per_row": 3,
"cta_animation_type": {
"value": "pulse",
"label": "Pulse"
}
}
},
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"data": [],
"errors": []
}
Retrieves comprehensive information about the store associated with the authenticated API key, including branding, social links, status, and appearance settings.
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
string
Status message indicating success or failure
object
Store information object
Show properties
Show properties
string
required
Unique store identifier with
str_ prefix (e.g., str_abc123xyz)string
required
Store name
string
Store description displayed on your storefront
string
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
string
required
Current store status. Possible values:
active, suspended, pending_reviewobject
Store appearance and theme settings (only included when appearance settings are loaded)
Show properties
Show properties
object
object
object
Border styling configuration
object
Default product ordering preference
object
boolean
Whether to display featured products section
boolean
Whether to show purchase button on product cards
boolean
Whether to display recommended products
integer
Number of products displayed per row in grid layout
object
Call-to-action button animation settings
array
Array of error messages (empty on success)
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",
"data": [],
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"data": [],
"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)
{
"message": "success",
"data": {
"id": "str_abc123xyz",
"name": "My Digital Store",
"description": "A marketplace for premium digital products and courses",
"logo_url": "https://cdn.chariow.com/stores/str_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",
"appearance": {
"theme": {
"value": "modern",
"label": "Modern"
},
"font": {
"primary": {
"value": "inter",
"display_name": "Inter",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Inter"
},
"secondary": {
"value": "roboto",
"display_name": "Roboto",
"category": "sans-serif",
"url": "https://fonts.googleapis.com/css2?family=Roboto"
}
},
"border_style": {
"value": "rounded",
"label": "Rounded"
},
"product_order": {
"value": "newest",
"label": "Newest First"
},
"color": {
"primary": {
"hex": "#3B82F6",
"rgb": "59, 130, 246"
},
"contrast": {
"hex": "#FFFFFF",
"rgb": "255, 255, 255"
}
},
"show_featured_products": true,
"show_purchase_button_on_product_card": true,
"show_recommended_products": true,
"products_per_row": 3,
"cta_animation_type": {
"value": "pulse",
"label": "Pulse"
}
}
},
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"data": [],
"errors": []
}
Was this page helpful?
⌘I