notes about tenant

Author: clavery

plugins/b2c-cli/skills/b2c-scapi-custom/SKILL.md

@@ -7,46 +7,66 @@ description: Salesforce B2C Commerce Custom API endpoint management Skill
 
 Use the `b2c` CLI plugin to manage SCAPI Custom API endpoints and check their registration status.
 
+## Required: Tenant ID
+
+The `--tenant-id` flag is **required** for all commands. The tenant ID identifies your B2C Commerce instance.
+
+**Important:** The tenant ID is NOT the same as the organization ID:
+- **Tenant ID**: `zzxy_prd` (used with this command)
+- **Organization ID**: `zzxy_prd` (used in SCAPI URLs, has `f_ecom_` prefix)
+
+### Deriving Tenant ID from Hostname
+
+For sandbox instances, you can derive the tenant ID from the hostname by replacing hyphens with underscores:
+
+| Hostname | Tenant ID |
+|----------|-----------|
+| `zzpq-013.dx.commercecloud.salesforce.com` | `zzpq_013` |
+| `zzxy-001.dx.commercecloud.salesforce.com` | `zzxy_001` |
+| `abcd-dev.dx.commercecloud.salesforce.com` | `abcd_dev` |
+
+For production instances, use your realm and instance identifier (e.g., `zzxy_prd`).
+
 ## Examples
 
 ### Get Custom API Endpoint Status
 
 ```bash
 # list all Custom API endpoints for an organization
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd
+b2c scapi custom status --tenant-id zzxy_prd
 
 # list with JSON output
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --json
+b2c scapi custom status --tenant-id zzxy_prd --json
 ```
 
 ### Filter by Status
 
 ```bash
 # list only active endpoints
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status active
+b2c scapi custom status --tenant-id zzxy_prd --status active
 
 # list only endpoints that failed to register
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status not_registered
+b2c scapi custom status --tenant-id zzxy_prd --status not_registered
 ```
 
 ### Group by Type or Site
 
 ```bash
 # group endpoints by API type (Admin vs Shopper)
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --group-by type
+b2c scapi custom status --tenant-id zzxy_prd --group-by type
 
 # group endpoints by site
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --group-by site
+b2c scapi custom status --tenant-id zzxy_prd --group-by site
 ```
 
 ### Customize Output Columns
 
 ```bash
 # show extended columns (includes error reasons, sites, etc.)
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --extended
+b2c scapi custom status --tenant-id zzxy_prd --extended
 
 # select specific columns to display
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --columns type,apiName,status,sites
+b2c scapi custom status --tenant-id zzxy_prd --columns type,apiName,status,sites
 
 # available columns: type, apiName, apiVersion, cartridgeName, endpointPath, httpMethod, status, sites, securityScheme, operationId, schemaFile, implementationScript, errorReason, id
 ```
@@ -55,13 +75,13 @@ b2c scapi custom status --tenant-id f_ecom_zzxy_prd --columns type,apiName,statu
 
 ```bash
 # quickly find and diagnose failed Custom API registrations
-b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status not_registered --columns type,apiName,endpointPath,errorReason
+b2c scapi custom status --tenant-id zzxy_prd --status not_registered --columns type,apiName,endpointPath,errorReason
 ```
 
 ### Configuration
 
 The tenant ID and short code can be set via environment variables:
-- `SFCC_TENANT_ID`: Organization/tenant ID
+- `SFCC_TENANT_ID`: Tenant ID (e.g., `zzxy_prd`, not the organization ID)
 - `SFCC_SHORTCODE`: SCAPI short code
 
 ### More Commands