Skip to main content

Listing Sync Listings

Status: Proposed A list of listings for a business location

idstring

Public facing name of the source

typestring

Possible values: [listingSyncListings]

Default value: listingSyncListings
attributes object
iconuri

Link to icon provided by Vendasta’s media service

Example: https://www.cdnstyles.com/static/images/icon32/sourceId-10090.png
popularitynumber

Popularity of the source relative to other sources

sourceTypeCodestring

The type of listing source.

unspecified - The listing source type is unknown

directory - An online listing directory

map - Sites that have an online map like MapQuest or Google Maps

social - Social networks like Facebook

aggregator - Publishers that push their listing information to other listing sources

app - Stand alone applications like Snapchat that are not GPS services

gps - These sources power GPS applications

syncStatusCodestring

The listing status provided by the listing sources.

unknown - Default error value, should never be used intentionally

synced - Listing data was submitted to the listing source, and the source responded that the data is good and in use

inProgress - Information has been sent to the listing source who is in the process of syncing the information to the listing.

syncingWithWarnings - The data has been updated by the listing but there are some warnings that many affect the values updated.

hasErrors - There was an error with the data we sent to the listing source causing updating all the information to fail.

syncDisabled - Updating information for this source has been disabled.

claimedByOthers - The listing source is rejecting our data because this listing has been claimed by another user/service.

doesNotSupportServiceAreaBusiness - This listing source does not support service area businesses.

submitted - The business profile information was successfully sent to the listing source. The listing source does not verify when the information was published.

manualUpdateOnly - This listing cannot be updated by Vendasta's platform with the current set of apps actived for this business. The listing must be updated with the listing source directly by the business.

notFound - The listing source does not have a listing for this business.

listingScorenumber

A score based on the status of your online source

maximumlistingScorenumber

The maximum score this source can attain

urluri

The online listing

syncingError object[]

Any errors stopping the business information from being updated by the listing source.

  • Array [
  • errorCodestring

    businessName streetAddress postalCode city wholeAddress - Error is not isolated to street address, city, etc. phoneNumber hoursOfOperation categories descriptionLong descriptionShort email paymentOptions photos website existingRelationship chainLocation unavailableReason - Superpages is unable to update this listing due to an issue with their database.

    errorDetailsstring

    Human readable details about the error

  • ]
  • syncingWarning object[]

    Any warnings reported while updating your information on the listing source.

  • Array [
  • warningCodestring

    businessName streetAddress postalCode phoneNumber wholeAddress - Error is not isolated to street address, city, etc. hoursOfOperation categories descriptionLong descriptionShort email photos website services

    warningDetailsstring

    Human readable details about the warning

  • ]
  • updatedAtdate

    The last time this source’s listing was checked by Vendasta’s independent listing verification system. This will be 1970-01-01T00:00:00Z if we have never verified the listing.

    streetAddress object

    Service area businesses will not have this field.

    For a physical location this physical address of the business. Vendasta’s platform supports multiple address lines but currently those are combined into a single street address in our listing verification system.

    Valuestring

    The street address on the listing

    Matchboolean

    Does the street address match the business’s street address in their Vendasta Business Profile

    city object

    For a service area business this will be the city the business services.

    For a physical location this will be the city that the business physically exists in.

    valuestring

    The city as it appears on the source listing

    matchboolean

    Does the city match the business’s street address in their Vendasta Business Profile

    region object

    For a service area business this will be the region that contains the city the business services.

    For a physical location this will be the region that the business physically exists in.

    Examples of regions are states, provinces, etc.

    valuestring

    The region as it appears on the source listing

    matchboolean

    Does the region match the business’s street address in their Vendasta Business Profile

    country object

    For a service area business this will be the country that contains the city the business services.

    For a physical location this will be the country that the business physically exists in.

    valuestring

    The country as it appears on the source listing

    matchboolean

    Does the country match the business’s street address in their Vendasta Business Profile

    postalCode object

    For a physical location this will be the postal code of the physical location of the business. In the USA this is the zip code

    valuestring

    The postal code as it appears on the source listing

    matchboolean

    Does the postal code match the business’s street address in their Vendasta Business Profile

    phoneNumber object

    The contact phone number for the business. This corresponds to the first phone number in the Vendasta business profile.

    This will not be the toll free, cell or fax number.

    valuestring

    The phone number as it appears on the listing.

    matchboolean

    Does the phone number match the business’s first phone number in their Vendasta Business Profile. Toll free, cell and fax numbers are not considered even if they are the only number on the business profile.

    website object

    The website of the business location.

    valuestring

    The website as it appears on the online listing.

    matchboolean

    Does the website match the business’s website in their Vendasta Business Profile

    accuracyStatusCodestring

    Indicates if Vendasta's independent accuracy reporting is available, found and whether or not it is active.

    unknown - Default error value, should never be used intentionally

    accurate - Listing was independently verified by Vendasta to be accurate

    inaccurate - Vendasta found at least one inaccuracy with the listing

    notAvailable - No Vendasta reporting is available for this source

    notFound - No listing was found for this source by Vendasta.

    Listing Sync Listings
    {
    "id": "string",
    "type": "listingSyncListings",
    "attributes": {
    "icon": "https://www.cdnstyles.com/static/images/icon32/sourceId-10090.png",
    "popularity": 0,
    "sourceTypeCode": "string",
    "syncStatusCode": "string",
    "listingScore": 0,
    "maximumlistingScore": 0,
    "url": "string",
    "syncingError": [
    {
    "errorCode": "string",
    "errorDetails": "string"
    }
    ],
    "syncingWarning": [
    {
    "warningCode": "string",
    "warningDetails": "string"
    }
    ],
    "updatedAt": "2024-07-29",
    "streetAddress": {
    "Value": "string",
    "Match": true
    },
    "city": {
    "value": "string",
    "match": true
    },
    "region": {
    "value": "string",
    "match": true
    },
    "country": {
    "value": "string",
    "match": true
    },
    "postalCode": {
    "value": "string",
    "match": true
    },
    "phoneNumber": {
    "value": "string",
    "match": true
    },
    "website": {
    "value": "string",
    "match": true
    },
    "accuracyStatusCode": "string"
    }
    }