Listing Schema

Each listing is represented by a JSON object containing detailed business information, including addresses, phone numbers, services and much more.

The amount of information provided differs between listings (ie, not all listings will have all fields populated). See the Optional column in the documentation below to know which fields are always going to be returned, and which fields may not be.

This section applies to the endpoints:

• Search
• Get by Listing ID

Note: Any undocumented properties are subject to change without notice and are used at your own risk.

Example

A fully-populated listing object in JSON will have the following structure:

{
    "id": "...",
    "name": "...",
    "shortDescriptor": "...",
    "mediumDescriptor": "...",
    "serviceNotes": "...",
    "detailsLink": "...",
    "pureMobileBusiness": "...",
    "priceQualifier": "...",
    "hasExposureProducts": "...",
    "businessLogo": {
        "url": "...",
        "altText": "..."
    },
    "businessInfo": {
        "legalId": "...",
        "abn": "...",
        "acn": "...",
        "numberOfEmployees": "...",
        "dateEstablished": "..."
    },
    "categories": [
        {
            "id": "...",
            "name": "...",
            "sensitive": "..."
        },
        ...
    ]
    "primaryContacts": [
        {
            "value": "...",
            "description": "...",
            "type": "..."
        },
        ...
    ],
    "secondaryContacts": { 
        "(groupName)": [
            {
                "type": "...",
                "value": "...",
                "description": "...",
            },
            ...
        ],
    ...
    },
    "orderedSecondaryContacts": [
        {
            "name": "(groupName)",
            "contacts": [ 
               {
                 "type": "...",
                 "value": "...",
                 "description": "..."
               },
               ...
             ]
        },
        ...
    ],
    "primaryAddress": {
        "addressLine": "...",
        "type": "...",
        "suburb": "...",
        "state": "...",
        "postcode": "...",
        "latitude": "...",
        "longitude": "...",
        "geoCodeGranularity": "...",
        "coordinates":{ ... }
    },
    "additionalAddresses": [  
        {
            "addressLine": "...",
            "type": "...",
            "suburb": "...",
            "state": "...",
            "postcode": "..."
        }
    ],
    "productKeywords": {
        "...": [
            "..."
        ]
    },
    "orderedProductKeywords": [
        {
            "label": "...",
            "values": [
                "..."
            ]
        }
    ],
    "imageGallery": [
        {
            "thumbnailUrl": "...",
            "largeUrl": "...",
            "altText": "..."
        }
    ],
    "externalLinks": [
        {
            "type": "...",
            "url": "...",
            "displayValue": "...",
            "label": "...",
            "description": "...",
            "logo": "..."
        }
    ],
    "tradingAliases": [
        "..."
    ],
    "reportingId": "...",
    "openingHours": {
        "...": {
            "status": "...",
            "times": [
                {
                    "open": "...",
                    "close": "..."
                },
                ...
            ]
        },
        ...
    },
    "distance": 5.622840714192739,
    "reviewSummaries": [
       {
          "namespace": "...",
          "reviewCount": "...",
          "businessPageUrl": "...",
          "averageRating": "...",
          "ratingImageUrl": "...",
          "ratingSmallImageUrl": "..."
       }
    ],
    "reviews": [
       {
          "namespace": "http://www.yelp.com.au",
          "text": "...",
          "reviewUrl": "...",
          "reviewTimestamp": "...",
          "reviewerName": "...",
          "reviewerAvatarUrl": "...",
          "rating": "...",
          "ratingImageUrl": "...",
          "ratingSmallImageUrl": "..."
      },
    ],
    "pois": {
        "results": [
          { … },
          { … },
          { … },
          { … },
          { … },
          { … },
          { … },
          { … },
          { … },
          { … }
        ],
        "totalResults": "..."
    }
}

Properties

businessLogo

The businessLogo field contains details relating to the logo of a business.

"businessLogo": [ 
    {
        "url": "...",
        "altText": "...",
    }
]

Each object can have the following properties:

businessInfo

The businessInfo field contains details relating to the operation of a business.

"businessInfo:{
    "legalId": "...",
    "abn": "...",
    "acn": "...",
    "numberOfEmployees": "...",
    "dateEstablished": "..."
}

Each object can have the following properties:

categories

The categories field shows how a listing has been categorised. Item list item represents one category that the business has been listed under.

"categories": [
    {
        "id": "...",
        "name": "...",
        "sensitive": "..."
    }
]

This field contains an array of each objects, where each object has the following properties:

primaryContacts

The primaryContacts field contains a list of the primary contacts for the business.

"primaryContacts": [ 
    {
        "type": "...",
        "value": "...",
        "description": "...",
    }
]

Each object in the array can have the following properties:

Possible values for the type property:

secondaryContacts

The secondaryContacts field contains a list of additional contacts for the business. These are identical in format as the primaryContacts, the only difference is that they are presented in logical groupings.

"secondaryContacts": {
    "(groupName)": [
        {
                "type": "...",
                "value": "...",
                "description": "...",
        }
    ]
}

We encourage you to use the new orderedSecondaryContacts in place of this field.

orderedSecondaryContacts

The orderedSecondaryContacts field contains a list of additional contacts for the business. They are presented in logical groupings.

"orderedSecondaryContacts": [
    {
       "name": "(groupName)",
       "contacts": [ 
          {
             "type": "...",
             "value": "...",
             "description": "..."
          },
          ...
        ]
     },
     ...
]

primaryAddress

The primaryAddress property contains details of the business's main address.

"primaryAddress": {
    "type": "...",
    "addressLine": "...",
    "suburb": "...",
    "state": "...",
    "postcode": "...",
    "latitude": "...",
    "longitude": "...",
    "geoCodeGranularity": "...",
    "coordinates": {
       "centre":{
          "longitude": ...,
          "latitude": ...
       },
       "street": {
          "longitude": ...,
          "latitude": ...
       }
    }
}

Object properties:

Possible values for the type property:

Possible values for the geoCodeGranularity property:

productKeywords

This is deprecated but will continue to be supported; please use orderedProductKeywords.

The productKeywords property contains a number of words and phrases associated with the listing.

"productKeywords": {
    "(field)": [
        "(value)",
        ...
    ]
}

Product keywords are keywords related to a business such as 'Cash', to indicate a payment method, or '24-hour', to indicate opening hours. Product keywords are categorised in to fields (eg, 'Payment Method' and 'Opening Hours'). Note that the field names and values are free-text and don't adhere to any particular rules, and may change over time.

Each field is represented by a property, where the name of the property is the field name and the children are the keyword values.

We encourage you to use the new orderedProductKeywords in place of this field.

orderedProductKeywords

The orderedProductKeywords property contains a list of words and phrases associated with the listing.

"orderedProductKeywords": [
    {
        "label": "(field)",
        "values": [
            "(value)",
            ...
        ]
    },
    ...
]

Product keywords are keywords related to a business such as 'Cash', to indicate a payment method, or '24-hour', to indicate opening hours. Product keywords are categorised in to fields (eg, 'Payment Method' and 'Opening Hours'). Note that the field names and values are free-text and don't adhere to any particular rules, and may change over time.

Each list item contains the following properties:

The fields and values are the same as the those available on the Yellow Pages website when you refine a search (see the 'Refine By:' field on the Yellow Pages search page).

imageGallery

The imageGallery property can contain links to a number of images provided by the advertiser.

"imageGallery": [
    {
        "thumbnailUrl": "...",
        "largeUrl": "...",
        "altText": "..."
    }
]

Each gallery item is a JSON object with the following properties:

externalLinks

The externalLinks property can contain additional links related to the listing. For example, may contain links to Trading Post advertisements.

"externalLinks": [
    {
        "type": "...",
        "url": "...",
        "displayValue": "...",
        "label": "...",
        "description": "...",
        "logo": "..."
    }
]

Each item is a JSON object with the following properties:

openingHours

The openingHours property contains the hours the business is open each day.

"openingHours": {
    "...": {
        "status": "...",
        "times": [
            {
                "open": "...",
                "close": "..."
            },
            ...
        ]
    },
    ...
}

This field is a JSON object with properties representing the days:

• monday
• tuesday
• wednesday
• thrusday
• friday
• saturday
• sunday
• publicHolidays

If any day is omitted, the opening ours for that day are unknown (it does not that imply the business is closed).

Each day is again an object, containing a status and (optionally) a list of periods during which the business is open. For example, a business may be open in the morning, closed for lunch and open in the afternoon. In this case, there would be two items in the times property.

Note: Currently, the times property will contain at most two periods. However this may change in the future.

The following table lists the values for the status property.

The following table shows the structure of each times item.

Review Summaries

The reviewSummaries property contains summary information about the reviews that others have posted about this business.

 "reviewSummaries": [
     {
       "namespace": "http://www.yelp.com.au",
       "reviewCount": 5,
       "businessPageUrl": "http://www.yelp.com.au/biz/draculas-carlton-2",
       "averageRating": 3.5,
       "ratingImageUrl": "http://s3-media3.ak.yelpcdn.com/assets/2/www/img/5ef3eb3cb162/ico/stars/stars_3_half.png",
       "ratingSmallImageUrl": "http://s3-media3.ak.yelpcdn.com/assets/2/www/img/2e909d5d3536/ico/stars/stars_small_3_half.png"
     }
 ]

Each item is a JSON object with the following properties:

Reviews

The reviews property contains an array of JSON objects representing the review.

 "reviews": [
    {
        "namespace": "http://www.yelp.com.au",
        "text": "Well, my night at Dracula's wasn't half as painful as I thought it would be! ...",
        "reviewUrl": "http://www.yelp.com.au/biz/draculas-carlton-2#hrid:gGpUJN1cCItli6Dx0tl6Rg",
        "reviewTimestamp": "2011-11-08T20:00:37.000+1100",
        "reviewerName": "John S",
        "reviewerAvatarUrl": "http://s3-media1.ak.yelpcdn.com/photo/not_existence/link.jpg",
        "rating": 4,
        "ratingImageUrl": "http://www.yellowpages.com.au/ui/standard/yelp_4stars.png",
        "ratingSmallImageUrl": "http://www.yellowpages.com.au/ui/standard/yelp_4stars_small.png"
    }
 ]

Each review can have the following properties:

pois

The pois property contains points of interest (POI), such as railway stations, car parks, ATMs, which are located within 5km of the business. pois are available on the getByListingId endpoint when includePois=true is provided

"pois": {
    "results": [
      { … },
      { … },
      { … },
      { … },
      { … },
      { … },
      { … },
      { … },
      { … },
      { … }
    ],
    "totalResults": "..."
}

Object properties: