Get listing
Looks the key up in the store's listing map first and, failing that, matches it against each listing's slug and then its SKU — so a storefront holding…
GET /v1/commerce/store/{storeid}/listing/{key}
| Address | https://api.hanzo.ai/v1/commerce/store/{storeid}/listing/{key} |
| Method | GET |
| Operation | get_commerce_store_by_storeid_listing_by_key |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Looks the key up in the store's listing map first and, failing that, matches it against each listing's slug and then its SKU — so a storefront holding only a product's URL slug can still resolve the override. That fallback is unique to the listing reads; the item overlay routes match by id alone. A key matching none of the three is 404, as is a store id outside the caller org's namespace. Readable with an admin token or the anonymous published storefront key.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
storeid | path | string | yes | |
key | path | string | yes |
Response
The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.
Examples
hanzo commerce store listing get <storeid> <key>import { Configuration, CommerceApi } from 'hanzoai';
const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCommerceStoreByStoreidListingByKey({ storeid: 'storeid', key: 'key' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CommerceApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CommerceApi(client).get_commerce_store_by_storeid_listing_by_key(storeid='storeid', key='key')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CommerceAPI.GetCommerceStoreByStoreidListingByKey(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, commerce_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = commerce_api::get_commerce_store_by_storeid_listing_by_key(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CommerceApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CommerceApi(client).getCommerceStoreByStoreidListingByKey();curl https://api.hanzo.ai/v1/commerce/store/<storeid>/listing/<key> \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches commerce through the commerce tool, which names its 215 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list___commerce_deposits"
}
}
}'How is this guide?