You are viewing the technical documentation for Sharetribe. If you are looking for our no-code documentation, see our new help center.

Last updated

Listing extended data

Listing extended data allows you to use the powerful search engine in Sharetribe, as well as customise your listing information.

Table of Contents

Listings can have three types of extended data: public, private, and metadata. This article gives an overview of using these different extended data types.

Viewing and modifying listing extended data

Public data and metadata are visible to everyone – in other words, they are available when querying listings through the public listing endpoints in Marketplace API. Public data and metadata can be used, for instance, to distinguish different types of listings from each other, or to allow marketplace users to filter and search for specific features on a listing. Operators can use metadata to categorise listings to regular and premium, for instance.

On the other hand, listing private data is available through the ownListing endpoints in Marketplace API and listing endpoints in Integration API.

Private data can be used to allow the listing author to make private notes on the listing, since the information is not visible for the general marketplace audience.

The listing's author can modify the listing's public and private data through the ownListing create and update endpoints. An operator can modify all listing extended data, either through Integration API or in Sharetribe Console.

Search and filtering

How users search and filter listings is a vital part of their experience in your marketplace. A smooth search experience allows them to find the listings they’re interested in effortlessly, and the right filters help them narrow down results to a selection that best fits their needs. Extended data helps you build the custom search and filtering experience your marketplace needs.

Listings can be searched by keyword or location using Sharetribe’s powerful built-in search feature. In addition to this, you can use listing public extended data and metadata to create a variety of different types of filters; for example, a filter can be a slider with a range of values or a checkbox group. You can also specify how listings are prioritized and sorted in the results. Extended data is not available for search or sorting by default, which means you are in control of building your own, unique search experience.

When planning your search experience, think about the following questions: Do you want the extended data in any given field to be searchable? Do you want it to be a filter as well as a search parameter? What kind of filter should it be? Which extended data should be prioritized in search results?

Maybe your marketplace charges a membership fee, and you want listings from sellers in your highest subscription tier to be displayed first. Or perhaps your marketplace is for selling preowned clothing, and you want your users to be able to filter by size to find the best fit. The possibilities are numerous!

Different types of listings

A marketplace can have several types of listings – rentals and sales, events and facilities. Listing extended data is a powerful way to distinguish different listing types. Read more about the possibilities for different listing types in Sharetribe.