curl -X GET "https://api.chariow.com/v1/store" \
-H "Authorization: Bearer sk_live_abc123xyz..."
{
"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": []
}
Store
Get Store
Retrieve detailed information about your store
curl -X GET "https://api.chariow.com/v1/store" \
-H "Authorization: Bearer sk_live_abc123xyz..."
{
"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": []
}
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
Status message indicating success or failure
Store information object
Show properties
Show properties
Unique store identifier with
str_ prefix (e.g., str_abc123xyz)Store name
Store description displayed on your storefront
Full URL to the store logo image. Returns
null if no logo is set.Public URL of the store (custom domain or Chariow subdomain)
Social media links configured for the store
Show properties
Show properties
Telegram channel or group URL
Instagram profile URL
Facebook page URL
X (formerly Twitter) profile URL
LinkedIn profile or company page URL
YouTube channel URL
TikTok profile URL
Discord server invite URL
Current store status. Possible values:
active, suspended, pending_reviewStore appearance and theme settings (only included when appearance settings are loaded)
Show properties
Show properties
Border styling configuration
Default product ordering preference
Whether to display featured products section
Whether to show purchase button on product cards
Whether to display recommended products
Number of products displayed per row in grid layout
Call-to-action button animation settings
Array of error messages (empty on success)
Error Responses
401 Unauthorized
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..."
{
"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": []
}
Was this page helpful?
⌘I