Get a canon region
Canon module
GET/canon/regions/{region_code}canonRegions.get
A cost region. Only ratified multipliers answer; others refuse. Returns one canon region with its `ETag`. A canon region 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: CanonRegion
| Field | Type | Required | Description |
|---|---|---|---|
| region_code | RegionCode | Yes | Cost region code from `xpms.dim_region`.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$ |
| name | string | Yes | Region name.Constraints: length 1 to 200 |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| currency_code | string | Yes | Currency of the region.Constraints: pattern ^[A-Z]{3}$ |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"region_code": "NA-SE-MIA",
"name": "Miami and South Florida",
"jurisdiction_id": "US-FL",
"currency_code": "USD",
"note": "Basis region."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/regions/NA-SE-MIA" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonRegions.get("NA-SE-MIA");response = xos.canon_regions.get("NA-SE-MIA")xos canon-regions get NA-SE-MIA