Skip to content

Commit 64527c8

Browse files
committed
examples and org id fix
1 parent 6de07ec commit 64527c8

2 files changed

Lines changed: 28 additions & 11 deletions

File tree

docs/cli/custom-apis.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,29 +79,29 @@ The `type` column shows a human-readable API type based on the security scheme:
7979

8080
```bash
8181
# List all Custom API endpoints
82-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd
82+
b2c scapi custom status --tenant-id zzxy_prd
8383

8484
# Filter by status
85-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status active
86-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status not_registered
85+
b2c scapi custom status --tenant-id zzxy_prd --status active
86+
b2c scapi custom status --tenant-id zzxy_prd --status not_registered
8787

8888
# Group by API type (Admin/Shopper)
89-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --group-by type
89+
b2c scapi custom status --tenant-id zzxy_prd --group-by type
9090

9191
# Group by site
92-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --group-by site
92+
b2c scapi custom status --tenant-id zzxy_prd --group-by site
9393

9494
# Show extended columns
95-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --extended
95+
b2c scapi custom status --tenant-id zzxy_prd --extended
9696

9797
# Custom columns
98-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --columns type,apiName,status,sites
98+
b2c scapi custom status --tenant-id zzxy_prd --columns type,apiName,status,sites
9999

100100
# Debug failed registrations
101-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --status not_registered --columns type,apiName,endpointPath,errorReason
101+
b2c scapi custom status --tenant-id zzxy_prd --status not_registered --columns type,apiName,endpointPath,errorReason
102102

103103
# Output as JSON
104-
b2c scapi custom status --tenant-id f_ecom_zzxy_prd --json
104+
b2c scapi custom status --tenant-id zzxy_prd --json
105105
```
106106

107107
### Output
@@ -138,6 +138,23 @@ loyalty-info /points GET active
138138
wishlist /items POST not_registered
139139
```
140140

141+
Grouped by site:
142+
143+
```
144+
Site: RefArch
145+
Type API Name Path Method Status
146+
───────────────────────────────────────────────────────────
147+
Shopper loyalty-info /customers GET active
148+
Shopper loyalty-info /points GET active
149+
Admin inventory /stock GET active
150+
151+
Site: SiteGenesis
152+
Type API Name Path Method Status
153+
─────────────────────────────────────────────────
154+
Admin inventory /stock GET active
155+
Admin inventory /stock PUT active
156+
```
157+
141158
### Notes
142159

143160
- Endpoints are rolled up by site: if the same endpoint is active on multiple sites, the sites are combined into a comma-separated list (visible with `--extended` or `--columns sites`)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Use the `b2c` CLI plugin to manage SCAPI Custom API endpoints and check their re
1212
The `--tenant-id` flag is **required** for all commands. The tenant ID identifies your B2C Commerce instance.
1313

1414
**Important:** The tenant ID is NOT the same as the organization ID:
15-
- **Tenant ID**: `zzxy_prd` (used with this command)
16-
- **Organization ID**: `zzxy_prd` (used in SCAPI URLs, has `f_ecom_` prefix)
15+
- **Tenant ID**: `zzxy_prd` (used with commands that require `--tenant-id`)
16+
- **Organization ID**: `f_ecom_zzxy_prd` (used in SCAPI URLs, has `f_ecom_` prefix)
1717

1818
### Deriving Tenant ID from Hostname
1919

0 commit comments

Comments
 (0)