Embeddable Item Object


An embeddable item is a read-only, unified representation of a site's content, such as a bookable service, event, product, blog post, or store category, that you can embed in rich content or link to. Each item has common fields, such as title, image, pageUrl, and path, and a details object specific to its itemType.

Properties
idstringmaxLength 100

Item ID. This is the ID of the source entity in its Wix app. Depending on itemType, it's a Wix Bookings service ID, a Wix Events event ID, a Wix Stores product ID, a Wix Blog post ID, or a Wix Stores category ID.

Not always a GUID.

For PRODUCT and STORE_CATEGORY, the ID depends on the site's Wix Stores catalog version.


imageImage

Item image: the main service image for BOOKING, the main event image for EVENT, the main media image for PRODUCT, the cover image for BLOG_POST, and the category image for STORE_CATEGORY.

Not returned when the item has no image.


itemTypestring

Item type. Determines which details object is returned.


One Of

blogPostDetailsBlogPostDetails

Blog post details. Returned only when itemType is BLOG_POST.


bookingDetailsBookingDetails

Bookable service details. Returned only when itemType is BOOKING.


eventDetailsEventDetails

Event details. Returned only when itemType is EVENT.


productDetailsProductDetails

Product details. Returned only when itemType is PRODUCT.


storeCategoryDetailsStoreCategoryDetails

Store category details. Returned only when itemType is STORE_CATEGORY.


pageUrlstringformat WEB_URL

URL of the item's page.

For BOOKING, EVENT, and PRODUCT, this is a Wix link (https://www.wix.app/...) that redirects to the item's page on the live site and keeps working when the site's domain changes. For BLOG_POST and STORE_CATEGORY, this is the absolute URL of the page on the site, built from the site's base URL and path.

Empty when the item has no page on the site.


pathstringmaxLength 2000

Path of the item's page, relative to the site's base URL. For example, /post/my-post. On free sites the base URL includes the site-name prefix, for example https://user.wixsite.com/my-site.

To build a full URL, join the site's base URL with this path. Store path instead of an absolute URL when a link must keep working after the site's domain changes.

Empty when the item has no page on the site, for example a store category without a slug.


pricingDataPricingData

Item pricing. For a single price, minValue and maxValue are equal. For a free bookable service, no prices are returned.

Returned only for BOOKING, EVENT, and PRODUCT items.


titlestringmaxLength 300

Item title. For example, a service name, product name, or blog post title.

Did this help?