System

Get comprehensive store information

Returns comprehensive store metadata and configuration in a single API call. Designed for LLMs and AI agents to quickly understand store context without making multiple API calls.

Purpose: This endpoint consolidates store metadata that would normally require 10+ separate API calls:

Store basic info (name, currencies, timezone)
Catalog overview (products, categories, collections, brands, specifications)
Pricing configuration (dynamic pricing, customer tiers, rules)
Active promotions (types, counts)
Payment methods (providers, configurations)
Shipping zones (delivery fees, free thresholds)
CMS content (posts, lookbooks)
Feature flags (enabled capabilities)

Use Cases:

AI agents understanding store capabilities before making recommendations
Admin dashboards showing store overview
Integration setup wizards checking store configuration
Mobile apps caching store metadata on startup
Third-party tools discovering available features

Performance:

Cached for 5 minutes (300 seconds)
Parallel data fetching for all sections
Optional section filtering to reduce payload size
Typical response time: 50-150ms (cached: 10-20ms)

Selective Loading: Use the sections parameter to request only specific data sections, reducing payload size by 50-80% when you don’t need all information.

Single-store only. This endpoint describes one store. A marketplace operator key has no single store here and receives 403 — use GET /v1/marketplace/info for the marketplace’s own information, or GET /v1/marketplace/info?store_id=<merchant> for one merchant within it.

GET

store

info

Get comprehensive store information

curl --request GET \
  --url https://api.tybritelabs.com/v1/store/info \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.tybritelabs.com/v1/store/info"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tybritelabs.com/v1/store/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tybritelabs.com/v1/store/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tybritelabs.com/v1/store/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/store/info")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/store/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "store": {
    "store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
    "name": "Galactic Test Store",
    "default_currency": "USD",
    "currencies": [
      "USD",
      "GBP",
      "EUR"
    ],
    "timezone": "America/New_York",
    "created_at": "2026-06-19T19:59:48.799138+00:00",
    "commerce_model": "retail"
  },
  "catalog": {
    "products": {
      "total": 53,
      "has_variants": 13,
      "simple_products": 40,
      "active": 53,
      "inactive": 0,
      "featured": 1,
      "with_images": 13,
      "low_stock": 0
    },
    "collections": {
      "total": 3,
      "names": [
        "Featured",
        "New Arrivals",
        "Best Sellers"
      ],
      "list": [
        {
          "id": "45e28d12-9381-45f6-98bb-cb3a34c0a215",
          "name": "Featured",
          "slug": "featured",
          "type": "featured_collections",
          "show_on_homepage": true,
          "display_priority": 0,
          "image": "https://cdn.example.com/collections/featured-desktop.jpg",
          "image_mobile": "https://cdn.example.com/collections/featured-mobile.jpg"
        },
        {
          "id": "e9810818-5051-4b74-a53b-2ff843b4f435",
          "name": "New Arrivals",
          "slug": "new-arrivals",
          "type": "new_arrivals",
          "show_on_homepage": true,
          "display_priority": 1,
          "image": null,
          "image_mobile": null
        }
      ]
    },
    "taxonomy": {
      "categories": {
        "total": 23,
        "list": [
          {
            "id": "49f084e5-9ded-429c-aeb7-5918a2234953",
            "name": "Laptops",
            "image": "https://images.unsplash.com/photo-1496181133206-80ce9b88a853?w=800&q=80",
            "product_count": 2
          }
        ]
      },
      "subcategories": {
        "total": 14,
        "list": [
          {
            "id": "6dbda630-ad89-4659-a5ef-3b0aae0dba7b",
            "name": "Keyboards",
            "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3?w=800&q=80",
            "category": "Electronics",
            "category_id": "7bf671dd-f49e-492c-b89f-a2892931f88f",
            "parent_id": "9c8f0a1b-1111-2222-3333-444455556666",
            "parent_name": "Computer Peripherals",
            "children": [],
            "product_count": 1
          }
        ]
      }
    },
    "specifications": {
      "total": 6,
      "types": [
        "brand",
        "color",
        "model",
        "product_type",
        "storage_type"
      ]
    },
    "brands": {
      "total": 18,
      "list": [
        "Apple",
        "Samsung",
        "Dell",
        "Sony",
        "Pulsewave",
        "Trailhead",
        "Lumitech",
        "Hearthstone",
        "Northwind"
      ]
    }
  },
  "pricing": {
    "has_dynamic_pricing": true,
    "features": {
      "customer_tiers": false,
      "customer_segments": false,
      "volume_discounts": false,
      "location_based": false,
      "time_based": false
    },
    "customer_tiers": [],
    "pricing_rules": {
      "total": 1,
      "active": 1
    }
  },
  "promotions": {
    "total": 3,
    "active": 3,
    "types": {
      "percentage_discount": 1,
      "fixed_discount": 1,
      "bogo": 0,
      "bundle": 1,
      "free_shipping": 0
    }
  },
  "payments": {
    "providers": [
      "cash",
      "stripe"
    ],
    "methods": [
      {
        "name": "cash",
        "display_name": "Cash on Delivery",
        "type": "manual"
      },
      {
        "name": "stripe",
        "display_name": "Stripe",
        "type": "redirect"
      }
    ]
  },
  "shipping": {
    "zones": {
      "total": 4,
      "list": [
        {
          "name": "Local (within 10 km)",
          "type": "distance_tier",
          "delivery_fee": 5.99,
          "free_threshold": 75
        },
        {
          "name": "Metro (10–50 km)",
          "type": "distance_tier",
          "delivery_fee": 9.99,
          "free_threshold": 150
        },
        {
          "name": "Regional (50–500 km)",
          "type": "distance_tier",
          "delivery_fee": 14.99,
          "free_threshold": 250
        },
        {
          "name": "National (500 km+)",
          "type": "distance_tier",
          "delivery_fee": 24.99,
          "free_threshold": 400
        }
      ]
    },
    "has_free_shipping_threshold": true
  },
  "cms": {
    "posts": {
      "total": 2,
      "published": 2,
      "draft": 0
    },
    "lookbooks": {
      "total": 1,
      "published": 1
    }
  },
  "features": {
    "ai_recommendations": false,
    "semantic_search": false,
    "multi_currency": true,
    "dynamic_pricing": false,
    "cms": true,
    "lookbooks": true,
    "returns": true,
    "collections": true,
    "gift_cards": true,
    "promotions": true,
    "messaging": true,
    "specifications": true,
    "feature_status": {
      "ai_recommendations": "awaiting_data",
      "semantic_search": "awaiting_data",
      "multi_currency": "available",
      "dynamic_pricing": "awaiting_data",
      "cms": "available",
      "lookbooks": "available",
      "returns": "available",
      "collections": "available",
      "gift_cards": "available",
      "promotions": "available",
      "messaging": "available",
      "specifications": "available"
    }
  }
}

Authorizations

Authorization

string

header

required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
Full read/write access to all endpoints
⚠️ NEVER expose in client-side code or public repositories
Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
Read-only access (GET requests only, plus POST semantic search)
✅ Safe for client-side JavaScript, mobile apps, and public code
Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

Authentication endpoints (/v1/auth/*): Secret key required
Payment verification (POST /v1/payments/verify): Secret key required
AI Recommendations (POST /v1/recommendations): Secret key required
Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
All write operations: Secret key required
All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Query Parameters

sections

string

Comma-separated list of sections to include in the response. Omit to return all sections.

Available Sections:

catalog - Products, categories, collections, brands, specifications
pricing - Dynamic pricing configuration and rules
promotions - Active promotions and types
payments - Payment providers and methods
shipping - Delivery zones and fees
cms - CMS posts and lookbooks
features - Feature flags and capabilities

Note: The store section is always included regardless of this parameter.

Examples:

sections=catalog,features - Only catalog and features
sections=payments,shipping - Only payment and shipping info
Omit parameter - All sections included

Payload Size Reduction:

Full response: ~15-25KB
catalog only: ~8-12KB (50% reduction)
features,payments: ~2-3KB (85% reduction)

SDK Usage:

Example:

"catalog,features"

cache

boolean

default:true

Control cache behavior. Set to false to bypass cache and fetch fresh data.

Default: true (use cache if available)

Cache Duration: 5 minutes (300 seconds)

When to Bypass Cache:

After updating store configuration
After adding/removing products or categories
After changing payment or shipping settings
When you need real-time data

Cache Headers:

X-Cache: HIT - Response served from cache
X-Cache: MISS - Response fetched from database
Cache-Control: public, max-age=300 - Browser/CDN caching

SDK Usage:

Response

Store information retrieved successfully

store

object

required

Basic store information (always included)

Show child attributes

catalog

object

Catalog overview (optional, included when requested)

Show child attributes

pricing

object

Pricing configuration (optional, included when requested)

Show child attributes

promotions

object

Promotions overview (optional, included when requested)

Show child attributes

payments

object

Payment configuration (optional, included when requested)

Show child attributes

shipping

object

Shipping configuration (optional, included when requested)

Show child attributes

cms

object

CMS content overview (optional, included when requested)

Show child attributes

features

object

Feature flags (optional, included when requested). Each flag is a boolean answering "should the storefront show this capability right now?" — use them to decide which UI to render.

What true / false mean. A flag is true only when the capability is BOTH available to the store AND has data/config to surface. false is deliberately broad — it can mean any of: the store's plan doesn't include the feature, the plan includes it but it isn't set up/has no data yet, or both. A false flag therefore does NOT tell you why it's off; treat it simply as "don't render this yet."

Two kinds of flag:

Plan-gated — ai_recommendations, semantic_search, multi_currency, dynamic_pricing, cms, lookbooks, returns. true requires the store's plan to include the feature AND it to be configured. By plan: Starter includes none of these; Growth adds content pages/lookbooks (cms, lookbooks) and returns; Premium and Enterprise add smart search & recommendations (ai_recommendations, semantic_search), dynamic_pricing, and multi_currency.
Data-presence (every plan) — gift_cards, promotions, messaging, specifications, collections. Not plan-gated at all; true simply means the store currently has at least one of that item (e.g. gift_cards: true = the store has issued one or more gift cards). false means none exist yet, not that the feature is forbidden.

Show child attributes

marketplace

object

Indicates whether this store is part of a marketplace, so a storefront can adapt its experience accordingly.

Show child attributes

Health check

List products with filtering and pagination

Get comprehensive store information

curl --request GET \
  --url https://api.tybritelabs.com/v1/store/info \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.tybritelabs.com/v1/store/info"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tybritelabs.com/v1/store/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tybritelabs.com/v1/store/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tybritelabs.com/v1/store/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/store/info")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/store/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "store": {
    "store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
    "name": "Galactic Test Store",
    "default_currency": "USD",
    "currencies": [
      "USD",
      "GBP",
      "EUR"
    ],
    "timezone": "America/New_York",
    "created_at": "2026-06-19T19:59:48.799138+00:00",
    "commerce_model": "retail"
  },
  "catalog": {
    "products": {
      "total": 53,
      "has_variants": 13,
      "simple_products": 40,
      "active": 53,
      "inactive": 0,
      "featured": 1,
      "with_images": 13,
      "low_stock": 0
    },
    "collections": {
      "total": 3,
      "names": [
        "Featured",
        "New Arrivals",
        "Best Sellers"
      ],
      "list": [
        {
          "id": "45e28d12-9381-45f6-98bb-cb3a34c0a215",
          "name": "Featured",
          "slug": "featured",
          "type": "featured_collections",
          "show_on_homepage": true,
          "display_priority": 0,
          "image": "https://cdn.example.com/collections/featured-desktop.jpg",
          "image_mobile": "https://cdn.example.com/collections/featured-mobile.jpg"
        },
        {
          "id": "e9810818-5051-4b74-a53b-2ff843b4f435",
          "name": "New Arrivals",
          "slug": "new-arrivals",
          "type": "new_arrivals",
          "show_on_homepage": true,
          "display_priority": 1,
          "image": null,
          "image_mobile": null
        }
      ]
    },
    "taxonomy": {
      "categories": {
        "total": 23,
        "list": [
          {
            "id": "49f084e5-9ded-429c-aeb7-5918a2234953",
            "name": "Laptops",
            "image": "https://images.unsplash.com/photo-1496181133206-80ce9b88a853?w=800&q=80",
            "product_count": 2
          }
        ]
      },
      "subcategories": {
        "total": 14,
        "list": [
          {
            "id": "6dbda630-ad89-4659-a5ef-3b0aae0dba7b",
            "name": "Keyboards",
            "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3?w=800&q=80",
            "category": "Electronics",
            "category_id": "7bf671dd-f49e-492c-b89f-a2892931f88f",
            "parent_id": "9c8f0a1b-1111-2222-3333-444455556666",
            "parent_name": "Computer Peripherals",
            "children": [],
            "product_count": 1
          }
        ]
      }
    },
    "specifications": {
      "total": 6,
      "types": [
        "brand",
        "color",
        "model",
        "product_type",
        "storage_type"
      ]
    },
    "brands": {
      "total": 18,
      "list": [
        "Apple",
        "Samsung",
        "Dell",
        "Sony",
        "Pulsewave",
        "Trailhead",
        "Lumitech",
        "Hearthstone",
        "Northwind"
      ]
    }
  },
  "pricing": {
    "has_dynamic_pricing": true,
    "features": {
      "customer_tiers": false,
      "customer_segments": false,
      "volume_discounts": false,
      "location_based": false,
      "time_based": false
    },
    "customer_tiers": [],
    "pricing_rules": {
      "total": 1,
      "active": 1
    }
  },
  "promotions": {
    "total": 3,
    "active": 3,
    "types": {
      "percentage_discount": 1,
      "fixed_discount": 1,
      "bogo": 0,
      "bundle": 1,
      "free_shipping": 0
    }
  },
  "payments": {
    "providers": [
      "cash",
      "stripe"
    ],
    "methods": [
      {
        "name": "cash",
        "display_name": "Cash on Delivery",
        "type": "manual"
      },
      {
        "name": "stripe",
        "display_name": "Stripe",
        "type": "redirect"
      }
    ]
  },
  "shipping": {
    "zones": {
      "total": 4,
      "list": [
        {
          "name": "Local (within 10 km)",
          "type": "distance_tier",
          "delivery_fee": 5.99,
          "free_threshold": 75
        },
        {
          "name": "Metro (10–50 km)",
          "type": "distance_tier",
          "delivery_fee": 9.99,
          "free_threshold": 150
        },
        {
          "name": "Regional (50–500 km)",
          "type": "distance_tier",
          "delivery_fee": 14.99,
          "free_threshold": 250
        },
        {
          "name": "National (500 km+)",
          "type": "distance_tier",
          "delivery_fee": 24.99,
          "free_threshold": 400
        }
      ]
    },
    "has_free_shipping_threshold": true
  },
  "cms": {
    "posts": {
      "total": 2,
      "published": 2,
      "draft": 0
    },
    "lookbooks": {
      "total": 1,
      "published": 1
    }
  },
  "features": {
    "ai_recommendations": false,
    "semantic_search": false,
    "multi_currency": true,
    "dynamic_pricing": false,
    "cms": true,
    "lookbooks": true,
    "returns": true,
    "collections": true,
    "gift_cards": true,
    "promotions": true,
    "messaging": true,
    "specifications": true,
    "feature_status": {
      "ai_recommendations": "awaiting_data",
      "semantic_search": "awaiting_data",
      "multi_currency": "available",
      "dynamic_pricing": "awaiting_data",
      "cms": "available",
      "lookbooks": "available",
      "returns": "available",
      "collections": "available",
      "gift_cards": "available",
      "promotions": "available",
      "messaging": "available",
      "specifications": "available"
    }
  }
}

Reference

System

Products

Taxonomy

Orders

Payments

Cart & Wishlist

Marketplace

Recommendations

Discovery

Events

Tax

Analytics

Search

Authentication

Customers

Gift Cards

Promotions

CMS

Pricing

Messaging

Shipping

GC Connect

Reviews

Returns

Disputes

B2B

Webhooks

Ingestion

Sandbox

Get comprehensive store information

Authorizations

Query Parameters

Response