Skip to main content

Metadata

Overview​

Metadata provides supporting information about a resource. Metadata may be used by partners, if needed, and presented in editing or documentation generation tools for convenience.

  • Metadata MAY list more than one metadata code
  • Metadata MAY accompany a resource possessing any state

Metadata Properties​

Metadata is configured to meet the data requirements of each code. A code is mandatory in all metadata. Refer to a metadata code's description for specific data requirements.

NameTypeDescription
$..metadata[].codestringIdentifies the "type" of metadata. Refer to Metadata Codes
$..metadata[].messagestringMessage related to the metadata
$..metadata[].detailsobjectDetails related to the metadata
$..metadata[].fieldsarrayList of fields

Metadata Codes​

CodeMessage
APPLE_OVERRIDE__LOCATION_NAMEPlace card will display different name for your location
APPLE_OVERRIDE__LOCATION_STATUSPlace card will display different location status
APPLE_OVERRIDE__OPENING_HOURS_ADDEDPlace card opening hours added for your location
APPLE_OVERRIDE__OPENING_HOURS_CHANGEDPlace card will display different opening hours for your location
APPLE_OVERRIDE__OPENING_HOURS_REMOVEDPlace card opening hours removed for your location
APPLE_OVERRIDE__SERVICE_HOURS_ADDEDPlace card service hours added for your location
APPLE_OVERRIDE__SERVICE_HOURS_CHANGEDPlace card will display different service hours for your location
APPLE_OVERRIDE__SERVICE_HOURS_REMOVEDPlace card service hours removed for your location
APPLE_OVERRIDE__SPECIAL_HOURS_ADDEDPlace card special hours added for your location
APPLE_OVERRIDE__SPECIAL_HOURS_CHANGEDPlace card will display different special hours for your location
APPLE_OVERRIDE__SPECIAL_HOURS_REMOVEDPlace card special hours removed for your location
COPY__LOCATION_PRIMARY_CATEGORY_TO_BRANDLocation primary category copied to brand
OVERRIDE__LOCATION_PRIMARY_DISPLAY_NAMEBrand's locations are expected to display brand's primary display name
POI_SUPPRESSEDPOI suppressed in Apple Maps. Location will not be published while POI remains suppressed
REMOVE__FLEXIBLE_ACTION_LINK_FROM_LOCATIONFlexible action link removed from location

Apple Override​

Code describes an event where a decision is taken to change information displayed on a location's place card. Code may be returned by the following API:

Resource TypeGetGet by ID
Location✓✓
Location Metadata Example

In this example, the metadata provides details about the name that is used on the place card.

{
  "orgId": "9467895078742654934",
  "id": "9467895078742654921",
  "createdDate": "2026-10-01T17:22:19.00Z",
  "updatedDate": "2026-10-05T10:11:23.00Z",
  "state": "PUBLISHED",
  "etag": "4d891a34-ddc8-11ec-a7a0-f7f6c418993d",
  "placeCardUrl": "https://maps.apple.com/place?auid=7378763904743701439",
  "locationDetails": {
    /* other location details */
    "displayNames": [
      {
        "name": "Florida Field",
        "locale": "en",
        "primary": true
      },
      {
        "name": "The Swamp",
        "locale": "en",
        "primary": false
      }
    ]
  },
  "metadata": [
    {
      "code": "APPLE_OVERRIDE__LOCATION_NAME",
      "message": "Place card will display different name for your location",
      "fields": [
        {
          "field": "$.locationDetails.displayNames",
          "value": {
            "displayNames": [
              {
                "name": "Ben Hill Griffin Stadium",
                "locale": "en",
                "primary": true
              }
            ]
          }
        }
      ],
      "appleOverrideId": "9467895078742654533"
    }
  ]
}

Copy Location Primary Category to Brand​

Code describes an event in which a location's primary category is added to the associated brand. Code may be returned for this resource type and by the following API:

Resource TypeGetGet by ID
Brand✓✓

Event is limited to location owners.

Brand Metadata Example
  • dining.dessert_shop.ice_cream_shop.milkshake_bar is added as additional category
  • Metadata identifies the index position of a value that was added
{
  "orgId": "9467895078742654934",
  "id": "9467895078742654921",
  "createdDate": "2026-10-01T17:22:19.00Z",
  "updatedDate": "2026-10-05T10:11:23.00Z",
  "state": "PUBLISHED",
  "etag": "4d891a34-ddc8-11ec-a7a0-f7f6c418993d",
  "brandDetails": {
    "partnersBrandId": "456456",
    "partnersBrandVersion": "PBV01",
    "countryCodes": [
      "US"
    ],
    "displayNames": [
      {
        "name": "Organization Name",
        "locale": "en",
        "primary": true
      }
    ],
    "categories": [
      "dining.dessert_shop.ice_cream_shop",
      "dining.dessert_shop.ice_cream_shop.gelato_shop",
      "dining.dessert_shop.ice_cream_shop.milkshake_bar"
      
    ],
    "urls": [
      {
        "url": "http://example.com",
        "type": "HOMEPAGE"
      },
      {
        "url": "https://apps.apple.com/us/app/organization-delivery/id284910350",
        "type": "IOS_APP"
      }
    ],
    "ownershipType": "BRAND_OWNER"
  },
  "metadata": [
    {
      "code": "COPY__LOCATION_PRIMARY_CATEGORY_TO_BRAND",
      "message": "Location primary category copied to brand",
      "fields": [
        {
            "field": "$.brandDetails.categories[2]",
            "value": "dining.dessert_shop.ice_cream_shop.milkshake_bar"
        }
      ]
    }
  ]
}

Override Location Primary Display Name​

Code describes an event when it is determined that a location's primary display name is not expected to be displayed on the Apple Maps place card. Instead, the associated brand's primary display name is expected to be displayed. Code may be returned for these resource types and by the following API:

Resource TypeGetGet by ID
Brand✓✓

Event is limited to location owners.

Brand Metadata Example
{
  "orgId": "9467895078742654934",
  "id": "9467895078742654937",
  "createdDate": "2026-02-28T17:22:19.00Z",
  "updatedDate": "2026-02-28T17:22:19.00Z",
  "state": "PUBLISHED",
  "etag": "d6278c74-de63-11ef-9cd2-0242ac120002",
  "brandDetails": {
    "partnersBrandId": "123456",
    "partnersBrandVersion": "PBV01",
    "countryCodes": [
      "US"
    ],
    "displayNames": [
      {
        "name": "Eddie V's Prime Seafood",
        "locale": "en",
        "primary": true
      }
    ],
    "categories": [
      "dining.restaurant.steakhouse",
      "dining.restaurant.steakhouse.chop_house"
    ],
    "urls": [
      {
        "url": "https://www.eddiev.com/home",
        "type": "HOMEPAGE"
      }
    ],
    "ownershipType": "BRAND_OWNER"
  },
  "metadata": [
    {
      "code": "OVERRIDE__LOCATION_PRIMARY_DISPLAY_NAME",
      "message": "Brand's locations are expected to display brand's primary display name"
    }
  ]
}

POI Suppressed​

Resource TypeGetGet by ID
Location✓✓
Location Metadata Example
{
  "orgId": "9467895078742654934",
  "id": "9467895078742654921",
  "createdDate": "2026-02-01T17:22:19.00Z",
  "updatedDate": "2026-02-05T10:11:23.00Z",
  "state": "REJECTED",
  "etag": "4d891a34-ddc8-11ec-a7a0-f7f6c418993d",
  "locationDetails": {
    /* location details */
  },
  "metadata": [
    {
      "code": "POI_SUPPRESSED",
      "message": "POI suppressed in Apple Maps. Location will not be published while POI remains suppressed"
    }
  ]
}

Code describes an event in which a periodic reevaluation of a flexible action link (FAL) is completed. A decision is taken to remove a place card's call-to-action dependency upon a FAL in order to clear an exception condition. Code may be returned by the following API:

Resource TypeGetGet by ID
Location✓✓
Location Metadata Example

In this example, the metadata identifies the action link that has been removed from the list (index 1).

{
  "orgId": "9467895078742654934",
  "id": "9467895078742654921",
  "createdDate": "2026-10-01T17:22:19.00Z",
  "updatedDate": "2026-10-05T10:11:23.00Z",
  "state": "PUBLISHED",
  "etag": "4d891a34-ddc8-11ec-a7a0-f7f6c418993d",
  "placeCardUrl": "https://maps.apple.com/place?auid=7378763904743701432",
  "locationDetails": {
    /* other location details */
    "actionLinkDetails": {
      "quicklinks": [
        {
          "category": "quicklinks.restaurant_view_menu",
          "quicklinkUrl": "https://southerleighfinedining.com/menu",
          "relationship": "OWNER"
        }
      ]
    }
  },
  "metadata": [
    {
      "code": "REMOVE__FLEXIBLE_ACTION_LINK_FROM_LOCATION",
      "message": "Flexible action link removed from location",
      "fields": [
        {
          "field": "$.locationDetails.actionLinkDetails.quicklinks[0]",
          "value": {
            "quicklinkUrl": "https://southerleighfinedining.com/menu",
            "category": "quicklinks.restaurant_view_menu",
            "relationship": "OWNER"
          }
        }
      ]
    }
  ]
}
Copyright © 2026 Apple Inc. All rights reserved.