Skip to main content

Dashboard Setup

This document explains where merchants create stores, sub-merchants, and API keys before starting an integration.

Dashboard:

https://merchant.thyris.cloud/app/merchant-services

Merchant Account​

A merchant account is the top-level business account. A merchant must exist before stores, API keys, catalog products, MCP, UCP, or webhooks can be used.

Merchant accounts are normally created during onboarding or by the Thyris team. After login, users with access to more than one merchant will see an account selector.

Roles:

RoleWhat It Can Usually Do
ownerManage merchant settings, team, stores, API keys, and sub-merchants.
adminManage operational settings and integrations.
memberWork with store/catalog areas depending on merchant configuration.
viewerRead-only access where enabled.

For integration setup, use an owner or admin user.

Create A Store​

A store is the unit that owns catalog products, carts, orders, webhooks, and store-specific integrations.

Steps:

  1. Sign in to the Merchant Dashboard.
  2. Select the merchant account.
  3. Open Stores.
  4. Click Create Store.
  5. Fill the required fields.
  6. Click Create Store.

Store fields:

FieldRequiredNotes
NameYesDisplay name for the store.
URLNoPublic store URL, for example https://store.example.com.
DescriptionNoShort store description.
Logo URLNoPublic logo image URL.
TypeYesE-Commerce, Travel, or Generic. Defaults to E-Commerce.
CategoryNoStore category such as Fashion, Electronics, Beauty, etc.
CurrencyYesCurrently USD, EUR, or TRY.
LanguageYesStore language. Defaults to English.

After the store is created, open the store or call GET /api/v1/catalog/stores with an API key to get the storeId.

Find Store IDs​

The easiest API-safe way to find store IDs is:

curl "https://merchant.thyris.cloud/api/v1/catalog/stores" \
-H "Authorization: Bearer tr_live_your_key_here"

Response:

{
"success": true,
"data": [
{
"id": "store_uuid",
"name": "Main Store",
"slug": "main-store",
"merchantId": "merchant_uuid",
"currency": "USD",
"language": "en"
}
]
}

Use id as storeId in product, cart, order, webhook, UCP, and MCP requests.

Create A Sub-Merchant​

Sub-merchants are child merchant accounts under a main merchant. Use them for branches, subsidiaries, regional sellers, marketplace sellers, or separate business units.

Steps:

  1. Sign in as an owner of the main merchant.
  2. Open the account selector.
  3. Click Create Sub-merchant.
  4. Enter the sub-merchant name.
  5. Create stores under the sub-merchant if needed.

Sub-merchant stores can be included in integrations only when the API key scope allows them.

Create An API Key​

API keys are created from the merchant's Developers page.

Steps:

  1. Sign in to the Merchant Dashboard.
  2. Select the merchant account.
  3. Open Developers.
  4. Click Create New Key.
  5. Enter a key name, for example Production ERP Sync.
  6. Choose the access scope.
  7. Select stores if the chosen scope requires it.
  8. Choose a lifetime in minutes, hours, days, months, or years, or choose Never.
  9. Click create.
  10. Copy the generated key immediately.

The full key is shown only once. If it is lost, create a new key and revoke the old one. The Developers page is dedicated to API key management; the former Integration Sources section has been removed.

The key table shows scopes as plain text, uses a three-dot menu for Revoke/Delete, displays expiration and revocation dates in English, and does not add a decorative key icon to each row. Reopening Create New Key starts a fresh form and never reuses the previously generated secret screen.

Key format:

tr_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API Key Types​

Dashboard LabelAPI ScopeBest ForStore Access
Merchant stores onlymerchantMain merchant ERP/PIM sync, dashboard-owned storesStores owned directly by the selected merchant. Does not include sub-merchants.
Single storestoreOne store integration, one agency/vendor, least-privilege setupExactly one selected store.
Merchant + sub-merchantsmerchant_networkMarketplace, franchise, or merchant group syncMain merchant stores and all sub-merchant stores.
Custom storescustomSelective rollout, partial migration, vendor-limited accessOnly the selected stores, including accessible sub-merchant stores when selected.

Which Key Type Should I Use?​

Use this rule of thumb:

ScenarioRecommended Key
A single commerce platform/commerce platform store syncs only itselfSingle store
A central ERP syncs all stores of the main merchantMerchant stores only
A marketplace operator syncs main merchant and seller/sub-merchant storesMerchant + sub-merchants
A migration starts with two pilot storesCustom stores
An AI/MCP client should only see one storeSingle store
A customer support tool should read a selected set of storesCustom stores

Prefer the narrowest key that supports the integration.

What Each Key Can Access​

OperationMerchantStoreMerchant NetworkCustom
List storesMain merchant storesSelected storeMain + sub-merchant storesSelected stores
Product read/writeMain merchant storesSelected storeMain + sub-merchant storesSelected stores
Cart create/listMain merchant storesSelected storeMain + sub-merchant storesSelected stores
Order create/list/updateMain merchant storesSelected storeMain + sub-merchant storesSelected stores
Inbound webhook product syncMain merchant storesSelected storeMain + sub-merchant storesSelected stores
MCP catalog toolsMain merchant storesSelected storeMain + sub-merchant storesSelected stores
UCP catalog endpointsMain merchant storesSelected storeMain + sub-merchant storesSelected stores

Scope is enforced server-side. If a request includes a storeId outside the key's scope, the API returns 403.

Revoke Or Rotate A Key​

Use key rotation when a key is exposed, shared with the wrong party, or no longer needed.

Steps:

  1. Open Developers.
  2. Find the key.
  3. Create a replacement key if the integration must continue.
  4. Deploy the replacement key to the integration.
  5. Revoke the old key.
  6. Confirm the old key returns 401.

Revocation records the revocation date and cannot be undone. A key, active or expired, must be revoked before permanent deletion. For multiple keys, select rows and use Bulk Actions: revoke applies to the non-revoked keys in the selection, and delete is available only when every selected key is already revoked.

Large Table And Image Management​

  • Catalog Products, Procurement Inventory, and Procurement Suppliers tables support checkbox selection and bulk deletion. Bulk Actions is unavailable until at least one row is selected.
  • Product and procurement inventory detail forms accept an optional ordered image gallery. A record may have no images, one legacy imageUrl, or up to 20 imageUrls; the first gallery item is the primary image.
  • Destructive table actions use the dashboard's standard confirmation popup. Native browser alert/confirm banners are not used.

Setup Checklist​

  • Merchant account exists.
  • Integrating user has owner or admin access.
  • Store exists.
  • Store ID is known.
  • API key is created with the correct scope.
  • API key was copied and stored securely.
  • GET /api/v1/catalog/stores returns the expected stores.
  • Postman environment has baseUrl, apiKey, and storeId set.