Get variant
Returns the stored variant with the store's listing for it overlaid — non-empty listing fields replace the catalog values and the currency is forced to…
GET /v1/commerce/store/{storeid}/variant/{key}
| Address | https://api.hanzo.ai/v1/commerce/store/{storeid}/variant/{key} |
| Method | GET |
| Operation | get_commerce_store_by_storeid_variant_by_key |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the stored variant with the store's listing for it overlaid — non-empty listing fields replace the catalog values and the currency is forced to the store's own — which is what makes per-storefront pricing of a shared variant possible. The overlay is keyed by the variant's ID, never by its slug or SKU. An unknown store or key is 404. 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 variant get <storeid> <key>import { Configuration, CommerceApi } from 'hanzoai';
const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCommerceStoreByStoreidVariantByKey({ 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_variant_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.GetCommerceStoreByStoreidVariantByKey(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_variant_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).getCommerceStoreByStoreidVariantByKey();curl https://api.hanzo.ai/v1/commerce/store/<storeid>/variant/<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?