POST
/
location
/
geography
/
search
curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/location/geography/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "limit": 10,
  "offset": 0,
  "sortBy": "updatedAt",
  "sortDirection": "desc",
  "filter": {
    "postalCode": "94008",
    "city": "San Francisco",
    "state": "California",
    "country": "United States",
    "radius": 100,
    "radiusUnit": "MILE",
    "services": {
      "isCurbsidePickUp": false
    }
  }
}'
{
  "count": 100,
  "limit": 10,
  "offset": 1,
  "locations": [
    {
      "distance": 100,
      "name": "Mise En Place, Inc.",
      "address": {
        "addressLine1": "2800 Ashcraft Court",
        "addressLine2": "Fairview road",
        "addressLine3": "N 9 1/2 street",
        "addressLine4": "Coronado school",
        "city": "Coronado",
        "state": "California",
        "country": "USA",
        "postalCode": 92118,
        "type": "2800 Ashcraft Court",
        "contact": [
          {
            "type": "Residence",
            "email": "mark@email.com",
            "phone": [
              {
                "number": "555-555-5555",
                "type": "mobile"
              }
            ],
            "name": {
              "first": "John",
              "middle": "Mark",
              "last": "Doe"
            }
          }
        ]
      },
      "services": {
        "isCurbsidePickUp": false
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

NearByLocation request model

​
filter
object
required

NearByLocation request model

​
limit
integer
default:
10

Number of records returned on a single page

​
offset
integer
default:
0

Number of records skipped before filtering records

​
sortBy
string
default:
updatedAt

Item property on which data needed to be sorted on.

​
sortDirection
enum<string>
default:
desc

Direction of sorting i.e ascending or descending

Available options:
asc,
desc

Response

200
application/json
OK

NearByLocation response model

​
count
integer

Total number of inventory locations within the given radius

​
limit
integer

Number of records returned on a single page

​
offset
integer

Number of records skipped before filtering records

​
locations
object[]

locations

Was this page helpful?

Delete specific locationOverview