POST
/
location-geographies
/
actions
/
find-shipping-zone
Find Shipping Zone
curl --request POST \
  --url https://api.fabric.inc/v3/location-geographies/actions/find-shipping-zone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "city": "San Francisco",
  "region": "North America",
  "postalCode": 94008,
  "countryCode": "US",
  "attributes": {
    "key": "value"
  }
}'
{
  "geographyName": "US_Geo_PostalCode",
  "zoneName": "US_LOCATIONS",
  "preferredNetwork": "ShipToHome",
  "associatedNetworks": [
    "<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.

Body

application/json

Find shipping zone request

​
countryCode
string
required

ISO 3166-1 alpha-2 based country code

Example:

"US"

​
city
string

City for which location will be searched

Example:

"San Francisco"

​
region
string

Region where inventory is managed

Example:

"North America"

​
postalCode
string

Postal code from where nearby locations are to be searched

Example:

94008

​
attributes
object

Custom attributes for more specific data

Example:
{ "key": "value" }

Response

Created

Response object returned when retrieving shipping zone information for a given geography. Includes the assigned zone, preferred delivery network, and associated networks.

​
geographyName
string

The name of the geographic area or grouping used for zone assignment (for example, based on postal codes or regions).

Example:

"US_Geo_PostalCode"

​
zoneName
string

The name of the shipping zone assigned to the specified geography.

Example:

"US_LOCATIONS"

​
preferredNetwork
string

The primary delivery network recommended for shipments to this zone.

Example:

"ShipToHome"

​
associatedNetworks
string[]

A list of all delivery networks that are available or eligible for shipping to this zone.