Importing a collection via a Twise XML Feed

!! Feature under development

You can import a collection via a Twise XML feed. To add such a feed to your twise, go to Edit Twise -> Content -> Collections -> Settings -> Import feed and add the URL that points to the feed. The feed contents are going to be synced every 24 hours.

The XML feed should be of the formats shown in the examples below. In each feed, the <document> tag differs depending on the collection type. All fields unless specified otherwise are strings.

Product XML feed

Product document requirements:

Field	Required	Description
id	no	Product ID
title	yes	Product Title
url	yes	URL to product page
description	no	Product Description
category	no	ProductCategorytype
price_range	no	PriceRangetype
product_type	no	General product type
updated_at	no	ISO-formatted date
vendor	no	Vendor name
variants	yes	List of ProductVariant
tags	no	List of product tags.
media	no	List of image URLs.

ProductCategorytype:

Field	Required
full_name	yes
name	yes

PriceRangetype:

Field	Required	Description
min_variant_price.amount	yes	Decimal amount for the minimum price
min_variant_price.currency_code	yes	ISO 3-letter currency code
max_variant_price.amount	yes	Decimal amount for the maximum price
max_variant_price.currency_code	yes	ISO 3-letter currency code

ProductVarianttype:

Field	Required	Description
id	yes	Product Variant ID
available_for_sale	yes	Boolean if product variant is available for sale
title	yes	Product Variant title
price	no	Decimal amount for variant price
currency	no	ISO 3-letter currency code
image_url	no	Image URL
updated_at	no	ISO-formatted date

Example Products XML feed

<twise-feed version="1.0">
  <documents type="product">
    <document>
      <id>65f4a3b2c7d8e9f0a1b2c3d4</id>
      <title>Premium Wireless Headphones</title>
      <url>https://example.com/products/premium-wireless-headphones</url>
      <description>High-quality wireless headphones with noise cancellation and 30-hour battery life.</description>
      <category>
        <full_name>Electronics > Audio > Headphones</full_name>
        <name>Headphones</name>
      </category>
      <price_range>
        <min_variant_price>
          <amount>149.99</amount>
          <currency_code>USD</currency_code>
        </min_variant_price>
        <max_variant_price>
          <amount>199.99</amount>
          <currency_code>USD</currency_code>
        </max_variant_price>
      </price_range>
      <product_type>Audio Equipment</product_type>
      <updated_at>2023-09-15T14:30:45+00:00</updated_at>
      <vendor>SoundTech</vendor>
      <variants>
        <variant>
          <id>variant-001</id>
          <available_for_sale>true</available_for_sale>
          <title>Black</title>
          <price>149.99</price>
          <currency>USD</currency>
          <image_url>https://example.com/images/headphones-black.jpg</image_url>
          <updated_at>2023-09-10T09:15:30+00:00</updated_at>
        </variant>
        <variant>
          <id>variant-002</id>
          <available_for_sale>true</available_for_sale>
          <title>White</title>
          <price>149.99</price>
          <currency>USD</currency>
          <image_url>https://example.com/images/headphones-white.jpg</image_url>
          <updated_at>2023-09-10T09:15:30+00:00</updated_at>
        </variant>
        <variant>
          <id>variant-003</id>
          <available_for_sale>true</available_for_sale>
          <title>Limited Edition Gold</title>
          <price>199.99</price>
          <currency>USD</currency>
          <image_url>https://example.com/images/headphones-gold.jpg</image_url>
          <updated_at>2023-09-10T09:15:30+00:00</updated_at>
        </variant>
      </variants>
      <tags>
        <tag>wireless</tag>
        <tag>noise-cancellation</tag>
        <tag>premium</tag>
        <tag>bluetooth</tag>
      </tags>
      <media>
        <image>https://example.com/images/headphones-main.jpg</image>
        <image>https://example.com/images/headphones-lifestyle.jpg</image>
        <image>https://example.com/images/headphones-features.jpg</image>
      </media>
    </document>
  </documents>
</twise-feed>

Events XML Feed

Event document requirements:

Field	Required	Description
id	no	Event ID
title	yes	Event Title
description	yes	Event Description
url	no	URL to event page
venue	no	Event venue
phone_number	no	Contact phone number
contact_email	no	Contact email
address	no	Event address
city	no	Event city name
category	no	Event category
date_start	no	Event start time (ISO date string). Can specify date_startwithout date_endif it is not a date range.
date_end	no	Event end time (ISO date string)
price	no	Decimal amount for event ticket price
currency	no	ISO 3-letter currency code
media	no	List of image URLs

Example Events XML feed

<twise-feed version="1.0">
  <documents type="event">
    <document>
      <id>event-001</id>
      <title>Music Festival 2023</title>
      <description>A grand music festival featuring top artists from around the world.</description>
      <url>https://example.com/events/music-festival-2023</url>
      <venue>Central Park</venue>
      <phone_number>[phone]</phone_number>
      <contact_email>[e-mail]</contact_email>
      <address>123 Main St, New York, NY</address>
      <city>New York</city>
      <category>Music</category>
      <date_start>2023-11-01T18:00:00+00:00</date_start>
      <date_end>2023-11-03T23:00:00+00:00</date_end>
      <price>99.99</price>
      <currency>USD</currency>
      <media>
        <image>https://example.com/images/music-festival.jpg</image>
      </media>
    </document>
    <document>
      <id>event-002</id>
      <title>Art Exhibition</title>
      <description>An exhibition showcasing contemporary art from emerging artists.</description>
      <url>https://example.com/events/art-exhibition</url>
      <venue>Art Gallery</venue>
      <phone_number>+0987654321</phone_number>
      <contact_email>[e-mail]</contact_email>
      <address>456 Art St, San Francisco, CA</address>
      <city>San Francisco</city>
      <category>Art</category>
      <date_start>2023-12-05T10:00:00+00:00</date_start>
      <date_end>2023-12-20T18:00:00+00:00</date_end>
      <price>20.00</price>
      <currency>USD</currency>
      <media>
        <image>https://example.com/images/art-exhibition.jpg</image>
      </media>
    </document>
    <!-- Add more documents as needed -->
  </documents>
</twise-feed>

Villas XML feed

Villadocument requirements:

Field	Required	Description
id	no	Villa ID
title	yes	Villa Title
url	yes	URL to villa page
description	yes	Villa Description
address	no	Address
city	no	City
region	no	Region
country	no	Country
latitude	no	Latitude ('float' type)
longitude	no	Longitude ('float' type)
neighborhood	no	Neighborhood
view_type	no	Villa view type (e.g. 'oceanfront', 'beachview', etc.)
guests	no	Number of guests
rooms	no	Number of bedrooms
bathrooms	no	Number of bathrooms
price	no	Decimal amount for villa nightly rate
currency	no	ISO 3-letter currency code
features	no	List of villa features
media	no	List of image URLs

Example Villas XML feed

<twise-feed version="1.0">
  <documents type="villa">
    <document>
      <id>villa-001</id>
      <title>Luxury Beachfront Villa</title>
      <url>https://example.com/villas/luxury-beachfront-villa</url>
      <description>A stunning beachfront villa with breathtaking ocean views and modern amenities.</description>
      <address>123 Ocean Drive</address>
      <city>Miami</city>
      <region>Florida</region>
      <country>USA</country>
      <latitude>25.7617</latitude>
      <longitude>-80.1918</longitude>
      <neighborhood>South Beach</neighborhood>
      <view_type>Ocean</view_type>
      <guests>10</guests>
      <rooms>5</rooms>
      <bathrooms>4.5</bathrooms>
      <price>1500.00</price>
      <currency>USD</currency>
      <features>
        <feature>Private Pool</feature>
        <feature>Wi-Fi</feature>
        <feature>Gym</feature>
      </features>
      <media>
        <image>https://example.com/images/villa-beachfront.jpg</image>
        <image>https://example.com/images/villa-interior.jpg</image>
      </media>
    </document>
    <document>
      <id>villa-002</id>
      <title>Mountain Retreat Villa</title>
      <url>https://example.com/villas/mountain-retreat-villa</url>
      <description>A cozy villa nestled in the mountains, perfect for a peaceful getaway.</description>
      <address>456 Mountain Road</address>
      <city>Aspen</city>
      <region>Colorado</region>
      <country>USA</country>
      <latitude>39.1911</latitude>
      <longitude>-106.8175</longitude>
      <neighborhood>Snowmass</neighborhood>
      <view_type>Mountain</view_type>
      <guests>8</guests>
      <rooms>4</rooms>
      <bathrooms>3.0</bathrooms>
      <price>1200.00</price>
      <currency>USD</currency>
      <features>
        <feature>Fireplace</feature>
        <feature>Hot Tub</feature>
        <feature>Hiking Trails</feature>
      </features>
      <media>
        <image>https://example.com/images/villa-mountain.jpg</image>
        <image>https://example.com/images/villa-livingroom.jpg</image>
      </media>
    </document>
    <!-- Add more documents as needed -->
  </documents>
</twise-feed>