Location details object definition and links to validations

Properties

Parent	Name	Type	Input
$.	locationDetails	object
locationDetails	partnersLocationId	string
locationDetails	displayNames[]	array
locationDetails	categories[]	array
locationDetails	locationStatus	object
locationDetails	brandId	string
locationDetails	displayPoint	object
locationDetails	mainAddress	object
locationDetails	openingHoursByDay[]	array
locationDetails	phoneNumbers[]	array
locationDetails	urls[]	array
locationDetails	accessPoints[]	array
locationDetails	actionLinkDetails	object
locationDetails	callToAction	string
locationDetails	confidenceLevel	number
locationDetails	geometry	string
locationDetails	internalNicknames[]	array
locationDetails	locationAttributes[]	array
locationDetails	locationDescriptions[]	array
locationDetails	locationKeywords	object
locationDetails	partnersLocationVersion	string
locationDetails	paymentMethods[]	array
locationDetails	serviceHours[]	array
locationDetails	specialHours[]	array
locationDetails	storeCode	string

JSON Data Samples

Location Satisfying Minimal Data Requirements

{
  "locationDetails": {
    "partnersLocationId": "123456",
    "displayNames": [
      {
        "name": "Malibu Ice Cream",
        "locale": "en-US",
        "primary": true
      }
    ],
    "mainAddress": {
      "fullAddress": "Den Texstraat 16, Amsterdam, 1017 ZA, NL",
      "locale": "en"
    },
    "categories": [ "dining.dessert_shop.ice_cream_shop" ],
    "locationStatus": {
      "status": "OPEN"
    }
  }
}

JSON Data Sample - With Recommended Properties

{
  "locationDetails": {
    "partnersLocationId": "loc-789012",
    "brandId": "brand-456",
    "displayNames": [
      {
        "name": "Dunkin' Donuts",
        "locale": "en-US",
        "primary": true
      }
    ],
    "displayPoint": {
      "coordinates": {
        "latitude": "42.361145",
        "longitude": "-71.057083"
      },
      "source": "MANUALLY_PLACED"
    },
    "categories": [
      "dining.coffee_shop",
      "dining.bakery"
    ],
    "locationStatus": {
      "status": "OPEN"
    },
    "openingHoursByDay": [
      {
        "day": "MONDAY",
        "times": [
          {
            "startTime": "05:00",
            "endTime": "21:00"
          }
        ]
      },
      {
        "day": "TUESDAY",
        "times": [
          {
            "startTime": "05:00",
            "endTime": "21:00"
          }
        ]
      },
      {
        "day": "WEDNESDAY",
        "times": [
          {
            "startTime": "05:00",
            "endTime": "21:00"
          }
        ]
      },
      {
        "day": "THURSDAY",
        "times": [
          {
            "startTime": "05:00",
            "endTime": "21:00"
          }
        ]
      },
      {
        "day": "FRIDAY",
        "times": [
          {
            "startTime": "05:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "SATURDAY",
        "times": [
          {
            "startTime": "06:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "SUNDAY",
        "times": [
          {
            "startTime": "06:00",
            "endTime": "20:00"
          }
        ]
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "+16175551234",
        "type": "VOICE",
        "primary": true
      }
    ],
    "urls": [
      {
        "url": "https://www.dunkindonuts.com",
        "type": "HOMEPAGE"
      },
      {
        "url": "https://apps.apple.com/us/app/dunkin/id1056813463",
        "type": "IOS_APP"
      }
    ]
  }
}

Location - Full Example

{
  "locationDetails": {
    "partnersLocationId": "rest-345678",
    "partnersLocationVersion": "v2.1",
    "brandId": "brand-789",
    "displayNames": [
      {
        "name": "Southerleigh Fine Dining",
        "locale": "en-US",
        "primary": true,
        "pronunciation": "south-er-lee"
      }
    ],
    "mainAddress": {
      "fullAddress": "136 E Grayson St, San Antonio, TX 78215",
      "structuredAddress": {
        "unit": "Suite 100",
        "fullThoroughfare": "136 E Grayson St",
        "thoroughfare": "E Grayson St",
        "subThoroughfare": "136",
        "locality": "San Antonio",
        "administrativeArea": "Texas",
        "countryCode": "US",
        "postCode": "78215"
      },
      "locale": "en"
    },
    "categories": [
      "dining.restaurant.american_cuisine",
      "dining.restaurant.steakhouse"
    ],
    "locationStatus": {
      "status": "OPEN"
    },
    "openingHoursByDay": [
      {
        "day": "MONDAY",
        "times": [
          {
            "startTime": "11:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "TUESDAY",
        "times": [
          {
            "startTime": "11:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "WEDNESDAY",
        "times": [
          {
            "startTime": "11:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "THURSDAY",
        "times": [
          {
            "startTime": "11:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "FRIDAY",
        "times": [
          {
            "startTime": "11:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "SATURDAY",
        "times": [
          {
            "startTime": "10:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "SUNDAY",
        "times": [
          {
            "startTime": "10:00",
            "endTime": "21:00"
          }
        ]
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "+12102231234",
        "type": "VOICE",
        "primary": true
      },
      {
        "phoneNumber": "+12102235678",
        "type": "FAX",
        "primary": false
      }
    ],
    "urls": [
      {
        "url": "https://southerleighfinedining.com",
        "type": "HOMEPAGE"
      },
      {
        "url": "https://www.facebook.com/southerleigh",
        "type": "FACEBOOK"
      },
      {
        "url": "https://www.instagram.com/southerleigh",
        "type": "INSTAGRAM"
      }
    ],
    "accessPoints": [
      {
        "coordinates": {
          "latitude": "29.442821",
          "longitude": "-98.479456"
        },
        "navigation": "DRIVING",
        "source": "MANUALLY_PLACED"
      },
      {
        "coordinates": {
          "latitude": "29.442901",
          "longitude": "-98.479321"
        },
        "navigation": "WALKING",
        "source": "MANUALLY_PLACED"
      }
    ],
    "actionLinkDetails": {
      "quicklinks": [
        {
          "category": "quicklinks.restaurant_reservation",
          "quicklinkUrl": "https://www.opentable.com/southerleigh",
          "appStoreUrl": "https://apps.apple.com/us/app/opentable/id296581815",
          "relationship": "AUTHORIZED"
        },
        {
          "category": "quicklinks.restaurant_view_menu",
          "quicklinkUrl": "https://southerleighfinedining.com/menu",
          "relationship": "OWNER"
        }
      ]
    },
    "callToAction": "VIEW_MENU",
    "locationAttributes": [
      {
        "name": "crossbusiness.dining.outdoor_seating",
        "value": "true"
      },
      {
        "name": "crossbusiness.accessibility.wheelchair_accessible",
        "value": "true"
      },
      {
        "name": "crossbusiness.services.delivery",
        "value": "false"
      }
    ],
    "locationDescriptions": [
      {
        "type": "ABOUT",
        "descriptions": [
          {
            "text": "Southerleigh Fine Dining offers an upscale dining experience featuring locally-sourced ingredients and craft cocktails in a beautifully restored historic building.",
            "locale": "en"
          }
        ]
      }
    ],
    "locationKeywords": {
      "products": [
        {
          "keyword": "Craft Cocktails",
          "locale": "en-US"
        },
        {
          "keyword": "Local Beer",
          "locale": "en-US"
        }
      ],
      "services": [
        {
          "keyword": "Private Dining",
          "locale": "en-US"
        },
        {
          "keyword": "Catering",
          "locale": "en-US"
        }
      ]
    },
    "paymentMethods": [
      "AMERICAN_EXPRESS",
      "CASH",
      "MASTERCARD",
      "VISA"
    ],
    "specialHours": [
      {
        "hoursByDay": [
          {
            "day": "THURSDAY",
            "times": [
              {
                "startTime": "11:00",
                "endTime": "15:00"
              }
            ]
          }
        ],
        "startDate": "2026-11-28",
        "endDate": "2026-11-28",
        "closed": false,
        "descriptions": [
          {
            "text": "Thanksgiving - Limited Hours",
            "locale": "en-US"
          }
        ]
      }
    ],
    "internalNicknames": [
      {
        "name": "Pearl District Location",
        "locale": "en"
      }
    ],
    "storeCode": "SDL-001",
    "confidenceLevel": 0.95
  }
}

Related

Name	Reference
API	Link