Marketplace

Get marketplace information

Returns information about a marketplace. Requires a marketplace operator key.

This endpoint has two modes:

No store_id — returns the marketplace’s own identity and branding: name, logo, primary color, tagline, contact details, and whether unified checkout and commission are enabled. Use this to render the marketplace’s storefront branding.
With ?store_id=<merchant> — returns the same comprehensive store information as GET /v1/store/info, but for that one merchant within the marketplace. Useful for a single-merchant “shop page” or for giving an AI agent context about one merchant. The merchant must be active in the marketplace, otherwise 404 is returned. Combine with sections to request only specific sections of that merchant’s information.

A single-store (non-operator) key receives 403; use GET /v1/store/info instead.

Caching: Responses may be cached for up to 5 minutes.

GET

marketplace

info

Get marketplace information

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

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

fetch('https://api.tybritelabs.com/v1/marketplace/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/marketplace/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/marketplace/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/marketplace/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

{
  "marketplace": true,
  "mode": "marketplace",
  "name": "Galactic Market",
  "logo_url": "https://cdn.example.com/marketplace-logo.png",
  "primary_color": "#3B82F6",
  "tagline": "Everything you need, from every merchant",
  "support_email": "support@galacticmarket.example.com",
  "description": "A curated marketplace of independent merchants.",
  "website": "https://galacticmarket.example.com",
  "phone": "+1-555-0100",
  "address": "123 Market Street, San Francisco, CA",
  "unified_checkout": true,
  "commission_enabled": true
}

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

store_id

string<uuid>

A merchant's store identifier. When provided, returns that merchant's comprehensive store information (same shape as GET /v1/store/info). Omit to return the marketplace's own identity and branding.

sections

string

Only used together with store_id. Comma-separated list of sections of the merchant's information to include. Omit to return all sections.

Available sections: catalog, pricing, promotions, payments, shipping, cms, features. The store section is always included.

Response

Marketplace identity and branding (no store_id), or a merchant's comprehensive store information (store_id provided).

Option 1
Option 2

Identity and branding for a marketplace as a whole, returned by GET /v1/marketplace/info when called with a marketplace operator key and no store_id. Use it to render the marketplace's own branding (name, logo, colors, contact details).

marketplace

boolean

required

Always true — confirms this is a marketplace.

Example:

true

mode

enum<string>

required

Always "marketplace".

Available options:

marketplace

name

string | null

Marketplace display name, or null if not set.

logo_url

string | null

URL of the marketplace logo, or null if not set.

primary_color

string | null

Marketplace primary brand color, or null if not set.

tagline

string | null

Short marketplace tagline, or null if not set.

support_email

string | null

Marketplace support email, or null if not set.

description

string | null

Description of the marketplace, or null if not set.

website

string | null

Marketplace website URL, or null if not set.

phone

string | null

Marketplace contact phone number, or null if not set.

address

string | null

Marketplace business address, or null if not set.

unified_checkout

boolean

Whether shoppers can check out a basket spanning multiple merchants in one payment.

commission_enabled

boolean

Whether commission is applied to marketplace sales.

Get marketplace information

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

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

fetch('https://api.tybritelabs.com/v1/marketplace/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/marketplace/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/marketplace/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.tybritelabs.com/v1/marketplace/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

{
  "marketplace": true,
  "mode": "marketplace",
  "name": "Galactic Market",
  "logo_url": "https://cdn.example.com/marketplace-logo.png",
  "primary_color": "#3B82F6",
  "tagline": "Everything you need, from every merchant",
  "support_email": "support@galacticmarket.example.com",
  "description": "A curated marketplace of independent merchants.",
  "website": "https://galacticmarket.example.com",
  "phone": "+1-555-0100",
  "address": "123 Market Street, San Francisco, CA",
  "unified_checkout": true,
  "commission_enabled": true
}

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 marketplace information

Authorizations

Query Parameters

Response