> ## Documentation Index
> Fetch the complete documentation index at: https://chariow.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Store

> Retrieve detailed information about your store

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 the `Authorization` header as a Bearer token.

```
Authorization: Bearer YOUR_API_KEY
```

## Response

<ResponseField name="message" type="string">
  Status message indicating success or failure
</ResponseField>

<ResponseField name="data" type="object">
  Store information object

  <Expandable title="properties">
    <ResponseField name="id" type="string" required>
      Unique store identifier with `str_` prefix (e.g., `str_abc123xyz`)
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Store name
    </ResponseField>

    <ResponseField name="description" type="string">
      Store description displayed on your storefront
    </ResponseField>

    <ResponseField name="logo_url" type="string">
      Full URL to the store logo image. Returns `null` if no logo is set.
    </ResponseField>

    <ResponseField name="url" type="string" required>
      Public URL of the store (custom domain or Chariow subdomain)
    </ResponseField>

    <ResponseField name="social_links" type="object">
      Social media links configured for the store

      <Expandable title="properties">
        <ResponseField name="telegram" type="string">
          Telegram channel or group URL
        </ResponseField>

        <ResponseField name="instagram" type="string">
          Instagram profile URL
        </ResponseField>

        <ResponseField name="facebook" type="string">
          Facebook page URL
        </ResponseField>

        <ResponseField name="x" type="string">
          X (formerly Twitter) profile URL
        </ResponseField>

        <ResponseField name="linkedin" type="string">
          LinkedIn profile or company page URL
        </ResponseField>

        <ResponseField name="youtube" type="string">
          YouTube channel URL
        </ResponseField>

        <ResponseField name="tiktok" type="string">
          TikTok profile URL
        </ResponseField>

        <ResponseField name="discord" type="string">
          Discord server invite URL
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="string" required>
      Current store status. Possible values: `active`, `suspended`, `pending_review`
    </ResponseField>

    <ResponseField name="appearance" type="object">
      Store appearance and theme settings (only included when appearance settings are loaded)

      <Expandable title="properties">
        <ResponseField name="theme" type="object">
          Selected theme configuration

          <Expandable title="properties">
            <ResponseField name="value" type="string">
              Theme identifier value
            </ResponseField>

            <ResponseField name="label" type="string">
              Human-readable theme name
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="font" type="object">
          Font configuration for the store

          <Expandable title="properties">
            <ResponseField name="primary" type="object">
              Primary font settings
            </ResponseField>

            <ResponseField name="secondary" type="object">
              Secondary font settings
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="border_style" type="object">
          Border styling configuration
        </ResponseField>

        <ResponseField name="product_order" type="object">
          Default product ordering preference
        </ResponseField>

        <ResponseField name="color" type="object">
          Colour scheme configuration

          <Expandable title="properties">
            <ResponseField name="primary" type="object">
              Primary brand colour in HEX and RGB formats
            </ResponseField>

            <ResponseField name="contrast" type="object">
              Contrast colour for text readability
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="show_featured_products" type="boolean">
          Whether to display featured products section
        </ResponseField>

        <ResponseField name="show_purchase_button_on_product_card" type="boolean">
          Whether to show purchase button on product cards
        </ResponseField>

        <ResponseField name="show_recommended_products" type="boolean">
          Whether to display recommended products
        </ResponseField>

        <ResponseField name="products_per_row" type="integer">
          Number of products displayed per row in grid layout
        </ResponseField>

        <ResponseField name="cta_animation_type" type="object">
          Call-to-action button animation settings
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="errors" type="array">
  Array of error messages (empty on success)
</ResponseField>

## Error Responses

<ResponseField name="401 Unauthorized">
  Returned when the API key is missing or invalid

  ```json theme={null}
  {
    "message": "API key is missing. Please provide a valid API key. Help: https://docs.chariow.com",
    "data": [],
    "errors": []
  }
  ```

  Or:

  ```json theme={null}
  {
    "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
    "data": [],
    "errors": []
  }
  ```
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.chariow.com/v1/store" \
    -H "Authorization: Bearer sk_live_abc123xyz..."
  ```

  ```javascript JavaScript theme={null}
  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 PHP theme={null}
  <?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);
  ```

  ```python Python theme={null}
  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)
  ```
</RequestExample>

<ResponseExample>
  ```json Success Response (200) theme={null}
  {
    "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": []
  }
  ```

  ```json Unauthenticated Response (401) theme={null}
  {
    "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
    "data": [],
    "errors": []
  }
  ```
</ResponseExample>