Get a canon region

Módulo Canon

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.

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

canonRegions.get: 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: CanonRegion

canonRegions.get: CanonRegion
Campo	Tipo	Obligatorio	Descripción
region_code	RegionCode	Sí	Cost region code from `xpms.dim_region`.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$
name	string	Sí	Region name.Restricciones: length 1 to 200
jurisdiction_id	JurisdictionId	Sí	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
currency_code	string	Sí	Currency of the region.Restricciones: pattern ^[A-Z]{3}$
note	string \| null	Sí	Note from the Bible.Restricciones: length 1 to 20000

{
  "region_code": "NA-SE-MIA",
  "name": "Miami and South Florida",
  "jurisdiction_id": "US-FL",
  "currency_code": "USD",
  "note": "Basis region."
}

Ejemplos de código

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