POST
/
locations
/
geography-search

Authorizations

Authorization
string
headerrequired

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.

Query Parameters

offset
integer
default: 0

Number of records to skip before returning all records. Default is 0 when no value is specified.

limit
integer
default: 10

Maximum number of records per page

Required range: 1 < x < 100

Body

application/json

Criteria to search geo location

filters
object[]
required
origin
object
required

Geo search origin. Must include postalCode OR (city and region).

Response

200 - application/json

Location geo search response

data
object[]
pagination
object

An object containing the pagination response data.

Was this page helpful?

Getting Started with LocationsCreate a location