Get a canon region multiplier
Módulo Canon
GET/canon/region-multipliers/{region_code}canonRegionMultipliers.get
A cost multiplier for a region, with its ratification. Returns one canon region multiplier with its `ETag`. A canon region multiplier the caller may not see returns 404.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| region_code | RegionCode | Sí | Cost region code from `xpms.dim_region`.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$ |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: CanonRegionMultiplier
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| region_code | RegionCode | Sí | Cost region code from `xpms.dim_region`.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$ |
| cost_multiplier | number | Sí | Cost multiplier. |
| is_basis | boolean | Sí | True for the basis region the price bands were sourced in. |
{
"region_code": "NA-SE-MIA",
"cost_multiplier": 1,
"is_basis": false
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/region-multipliers/NA-SE-MIA" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonRegionMultipliers.get("NA-SE-MIA");response = xos.canon_region_multipliers.get("NA-SE-MIA")xos canon-region-multipliers get NA-SE-MIA