GET
/
location-geographies
/
{geographyId}
Get Geography by ID
curl --request GET \
  --url https://api.fabric.inc/v3/location-geographies/{geographyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "geographyId": "9372919a8219e8",
  "version": 2,
  "geographyName": "US_Geo_PostalCode",
  "description": "Specific geography for US Zones",
  "type": "PostalCode",
  "values": [
    "<string>"
  ],
  "associatedZone": "US_Zone",
  "linkedNetworks": [
    "<string>"
  ],
  "createdAt": "2022-07-11T15:03:14.642Z",
  "updatedAt": "2022-07-11T15:03:14.642Z",
  "resourceId": "<string>",
  "subResourceId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-request-id
string

Unique request ID

​
x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13.

Path Parameters

​
geographyId
string
required

System-generated unique ID to identify the geography

Response

Geography

Response object representing a defined geography entity used for zone assignment, network linking, or rule application.

​
version
integer
required

Version number indicating how many times this geography record has been updated.

Example:

2

​
geographyName
string
required

Human-readable name used to identify the geography.

Example:

"US_Geo_PostalCode"

​
type
string
required

The classification type of the geography, such as PostalCode, State, or Country.

Example:

"PostalCode"

​
geographyId
string

System-generated unique identifier for the geography.

Example:

"9372919a8219e8"

​
description
string

A detailed description of the purpose or scope of the geography.

Example:

"Specific geography for US Zones"

​
values
string[]

A list of geographic values covered by this geography. For example, a list of postal codes or region codes.

​
associatedZone
string

The name of the shipping zone associated with this geography.

Example:

"US_Zone"

​
linkedNetworks
string[]

A list of fulfillment or carrier networks that are linked to this geography.

​
createdAt
string<date-time>

Timestamp indicating when the geography record was created, in ISO 8601 UTC format.

Example:

"2022-07-11T15:03:14.642Z"

​
updatedAt
string<date-time>

Timestamp indicating when the geography record was last updated, in ISO 8601 UTC format.

Example:

"2022-07-11T15:03:14.642Z"

​
resourceId
string

Identifier for the primary resource linked to the geography, if applicable.

​
subResourceId
string

Identifier for the secondary or child resource linked to the geography, if applicable.