POST
/
location
/
geography
/
search
Get near by locations within the radius
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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

NearByLocation request model

Response

200
application/json

OK

NearByLocation response model