Yext Publisher Listings APIInstall

Summary

Submit or update an order for a Yext listing location by sending detailed location information including identification, address, contact, hours, and other business attributes to the Yext Publisher Listings API.

Inputs

• Yext Id — Yext's unique identifier for the location.
• Partner Id — The location's ID assigned by you, present unless Yext is issuing an ORDER request for a new location.
• Name — The display name of the listing.
• Address — Structured address details for the location, provided as JSON.
• Geomodifier — Additional descriptor for location placement, e.g., mall name or landmark.
• Phones — JSON list of one MAIN phone number and optionally other types.
• Categories — JSON list of business categories ordered by relevance.
• Description — Detailed textual description of the location, HTML-escaped by the publisher.
• Emails — JSON list of emails associated with the listing.
• Geodata — JSON geolocation data specifying exact physical coordinates of the location.
• Hours — JSON structured business hours including intervals and holiday hours.
• Access Hours — JSON specifying entity access hours and reopen dates with daily intervals.
• Brunch Hours — JSON daily brunch hours and holiday brunch hours.
• Delivery Hours — JSON daily delivery hours and holiday delivery hours.
• Drive Through Hours — JSON daily drive-through hours and holiday drives-through hours.
• Happy Hours — JSON daily happy hours and holiday happy hours.
• Kitchen Hours — JSON daily kitchen hours and holiday kitchen hours.
• Online Service Hours — JSON daily online service hours and holiday online service hours.
• Pickup Hours — JSON daily pickup hours and holiday pickup hours.
• Senior Hours — JSON daily senior hours and holiday senior hours.
• Takeout Hours — JSON daily takeout hours and holiday takeout hours.
• Images — JSON list of photos for the location such as storefront or logo images.
• Videos — JSON list of YouTube videos associated with the business.
• Featured Message — JSON object containing the location's featured message.
• Payment Options — JSON list of accepted payment methods at the location.
• Urls — JSON list of the location's URLs like website or reservation page.
• Twitter Handle — Location’s Twitter username without the '@' symbol.
• Facebook Page Url — Full URL to the location’s Facebook Page.
• Instagram Handle — Instagram username for the entity without the leading '@'.
• Attribution — JSON listing attribution information indicating source or partner.
• Keywords — JSON keywords for search optimization representing the business.
• Lists — JSON describing Enhanced Content Lists (ECLs) associated with the location.
• Closed — Boolean indicating if the location is closed; defaults to false.
• Close Date — Date string (YYYY-MM-DD) marking the last open day, may be future.
• Reopen Date — Date string (YYYY-MM-DD) marking when a temporarily closed store reopens.
• Pickup And Delivery Options — JSON specifying pickup and delivery options available at the location.
• Specialties — JSON list of location specialties, e.g., Pizza.
• Brands — JSON list of brands sold by the location.
• Products — JSON list of products or product groups provided at the location.
• Services — JSON list of services the location offers.
• Year Established — Year when the location opened.
• Associations — JSON list of association memberships relevant to the location.
• Languages — JSON list of languages spoken at the location.
• Frequently Asked Questions — JSON list of FAQs about the business.
• Black Owned Business — Boolean to indicate if the business is black-owned.
• Price Range — Price range category for the business, e.g., $, $$, $$$, $$$$.
• Neighborhood — Neighborhood name of the business location.

Output shape

a single record representing the API response for the listing order submission

The operation sends a JSON body containing the provided listing fields to Yext Publisher Listings API and returns the API's JSON response. Supports batching, timeout, proxy, and SSL options configured in node settings.

Examples

Example 1: Create or update a listing order

Provide required and optional listing details (e.g., yextId, name, address, hours) to submit an order for updating or adding a location in Yext listings database.