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

Merchant's 24-character tenant ID

x-fabric-request-id
string

Unique request ID

x-fabric-channel-id
string

An optional single sales channel ID.

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

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