Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

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: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Catalogue reads, plus the actions a shopper takes for themselves
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): state-changing POST calls require a secret key, for store and marketplace keys alike; GET /v1/auth/me accepts either key
  • 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)
  • Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
  • All other write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Limited publishable keys: A publishable key can be limited to the products that carry one tag (for example starter:jewellery), created from the store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.

  • Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice. A product outside the slice answers 404, as if it did not exist.
  • A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line, a review, a promotion calculation, a storefront event) answers 403 with the error code out_of_scope, and nothing is written or reserved. An order is refused as a whole.
  • A route that carries no slice behaviour is not available to the key: it answers 403 with endpoint_not_allowed.
  • Orders placed through such a key record the tag on the order's attribution as key_scope.
  • Secret keys and connected-app keys cannot be limited.
  • Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.

Headers

x-auth-token
string
required

The signed-in shopper's session token, obtained when the shopper logs in. Must resolve to the customer in the {id} path parameter.

x-external-auth
string

Bring-your-own-auth assertion for stores that manage authentication in an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, SSO). Resolves the shopper whose data requests are managed.

Format: <base64url(JSON)>.<base64url(HMAC-SHA256(JSON))> where the JSON is { "external_id": "...", "iat": <unix>, "exp": <unix> } and the HMAC is keyed on the store's hmac_secret. Claim lifetime capped at 300 seconds. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.

x-idp-token
string

A raw token from the store's own identity provider (e.g. a Firebase ID token). Galactic Core forwards it to the store's configured Auth verifier, which validates it against the provider and returns the identity; resolves the shopper whose data requests are managed.

Use this when the store wants Galactic Core to verify tokens on its behalf rather than signing an assertion itself. Verification is fail-closed: if the verifier rejects the token or is unreachable, the request is unauthenticated (401). Requires an Auth verifier to be configured for the store. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.

Idempotency-Key
string

A key of up to 255 characters; a retry with the same key returns the request it created.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

The shopper's customer id.

Body

application/json
kind
enum<string>
required
Available options:
export,
erasure
confirm
boolean

Required, and must be true, when kind is erasure. Not accepted with export.

Response

An open request of this kind already exists (or the Idempotency-Key was used before); it is returned unchanged.

data_request
object
required

A shopper's request for a copy of their data (export) or for the deletion of their account and the personal data the store holds about them (erasure). The store decides how requests are handled: either each request waits for the store to approve or decline it, or it completes as soon as it is made.

created
boolean
required

False when an open request of this kind already existed and was returned instead.