Get a canon region multiplier
Canon module
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.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| region_code | RegionCode | Yes | Cost region code from `xpms.dim_region`.Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonRegionMultiplier
| Field | Type | Required | Description |
|---|---|---|---|
| region_code | RegionCode | Yes | Cost region code from `xpms.dim_region`.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$ |
| cost_multiplier | number | Yes | Cost multiplier. |
| is_basis | boolean | Yes | True for the basis region the price bands were sourced in. |
{
"region_code": "NA-SE-MIA",
"cost_multiplier": 1,
"is_basis": false
}Code samples
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