XML Import Format

From GarageSaleWiki

Jump to: navigation, search

GarageSale supports importing XML files in the format specified below. You can create files in this format to import listings from other sources into GarageSale. Use the 'Import Templates' command from the 'File' menu to import XML files.

Contents

File Layout

A single XML file can contain multiple listings descriptions. See below for the support item fields. Most fields are optional. If a listing property is not specified in the XML file, the default value you specified in GarageSale's preferences will be used instead.

Sample XML File

Here is a very simple sample XML file:

<?xml version="1.0"?>
 <items>
  <item>
    <title>My Listing Title</title>
    <description><![CDATA[ My <b> great </b> stuff. ]]></description>
    <startingBid>2.99</startingBid>
    <imageURL isGalleryImage="true">http://www.iwascoding.com/GarageSale/ListingDesigns/images/Packs/Pack24/Spooky.jpg</imageURL>
    <imageURL>http://www.iwascoding.com/GarageSale/ListingDesigns/images/Packs/Pack24/VintageCollage.jpg</imageURL>
     <domesticShippingService serviceFee="12.00" serviceAdditionalFee="2.00">UPS Ground</domesticShippingService>
     <internationalShippingService serviceFee="22.00">UPS Worldwide Express</internationalShippingService>
     <siteName>eBay USA</siteName>
     <design>Be A Star</design>
     <layout>thumb gallery</layout>
  </item>
 </items>

See below for a more complex example.


Supported Item Attributes

barcode

The barcode associated with the product listed. Should be either UPC, EAN, or ISBN. Not necessary if the listing is linked with a product from eBay's catalog.

bestOffer

Enable best offer for the listing.

bestOfferAutoAcceptPrice

All best offers from buyers above this value will be automatically accepted.

bestOfferAutoDeclinePrice

All best offers from buyers below this value will be automatically declined.

buyItNowPrice

Provide this field if you want your listing to carry a Buy It Now price. Not providing a starting bid for the same listing will make this a fixed price auction.

category

The id of the primary eBay category you want to post your item in.

category2

The id of the secondary eBay category you want to post your item in.

condition

The condition of the item. Must match the name of the condition on eBay and must be available in the selected category.

convertDescriptionToHTML

A boolean value ('true' or 'false') specifying wether GarageSale should convert the item's text formating to HTML when posting the listing to eBay.

customSpecific

You can use multiple 'customSpecific' elements to add a list of custom specifics (item attributes) to your listing. Each element must have a 'specificName' and a 'specificValue' child element.

description

The item's description.

design

The name of the GarageSale auction design you want to use.

designProperty

You can specify multiple 'designProperty' elements. Each element must have a 'propertyName' and a 'propertyValue' child element, matching a design property offered by the design. If no design is specified in the XML file, the default design will be used. Right now only string and multi-value properties can be specified through the XML file import.

domesticShippingService

The name of an domestic shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.

Field Attributes

serviceFee

The name of an domestic shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.

serviceAdditionalFee

The name of an domestic shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.


duration

The duration of the auction in days (e.g. 1,3,5,7 or 10). To specify duration for GTC items, specifiy 1000 for this value.

handlingTime

Your handling time for this item in days.

imageURL

(Can be specified multiple times for an item.)

An URL to an existing image file on your server. The specified URL will be added to your GarageSale template as an URL-based image and added to your auction when it is launched. Requires GarageSale 3.4 or later.

Field Attributes

isGalleryImage

An URL to an existing image file on your server. The specified URL will be added to your GarageSale template as an URL-based image and added to your auction when it is launched. Requires GarageSale 3.4 or later.


internationalShippingService

The name of an international shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.

Field Attributes

serviceFee

The name of an international shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.

serviceAdditionalFee

The name of an international shipping service. You can add a maximum of 3 services including the services specified in GarageSale's preferences.


layout

The name of the layout of the design you want to use.

location

The location of your item.

lotSize

Number of similar items included in a single listing. (GarageSale v6.6 and later)

packageDepth

The item's package depth in inches.

packageLength

The item's package length in inches.

packageOunces

The ounces of the item's shipping weigth. Use the packagePounds field to specify the pounds part of the weight.

packagePounds

The pounds part of the item's shipping weigth. Use the packageOunces field to specify the ounces part of the weight.

packageWidth

The item's package width in inches.

paymentInstructions

Optional payment instructions

privateAuction

A boolean value ('true' or 'false') specifying wether you want to list your item as private auction.

quantity

The item quantity you are selling. If ommitted, a quantity of 1 is assumed.

reservePrice

The listing's reservice price.

siteName

The name of the eBay site you want to use for the listing. Site name have to be specified as displayed in GarageSale's Prefrences (English Version).

SKU

A user specified item number that will be posted to eBay.

startingBid

The listing's starting price. Specify this value if you want to list your items as regular option.

storeCategoryName

The name of the store category the item should be associated with. The specified category has to be downloaded in GarageSale.

storeCategory2Name

The name of a secondary store category the item should be associated with. The specified category has to be downloaded in GarageSale.

storeCategoryID

The identifier of the store category the item should be associated with. You can obtain the identifier by pressing the ALT-Key while opening the store category popup in GarageSale. The specified category has to be downloaded in GarageSale. (GarageSale v6.6 and later)

storeCategory2ID

The identifier of the secondary store category the item should be associated with. You can obtain the identifier by pressing the ALT-Key while opening the store category popup in GarageSale. The specified category has to be downloaded in GarageSale. (GarageSale v6.6 and later)

subTitle

The listing's subtitle.

title

The listing's title. This field is required.

variation

You can specify multiple 'variation' elements in your XML file. Each 'variation' element describes an item (e.g. a large T-Shirt in red) you are offering. Inside your 'variation' element, you can use the following child elements:'price', 'sku', 'quantity'. You must use either one or two pairs of 'attributeName' and 'attributeValue' elements to specify the primary and optionally the secondary attribute for your item. The 'sku' field must be unique among the variations in a listing. If you have an inventory product with a matching SKU setup, it will get automatically linked with your variation. See below for an example.

zipCode

The ZIP code of the item's location. Required if you want to enable location based search for your listing.


Complex XML Example using Variations

<?xml version="1.0"?> <items> <item> <title>My Listing Title</title> <description><![CDATA[ My <b> great </b> stuff. ]]></description> <startingBid>2.99</startingBid> <imageURL isGalleryImage="true">http://www.iwascoding.com/GarageSale/ListingDesigns/images/Packs/Pack24/Spooky.jpg</imageURL> <imageURL>http://www.iwascoding.com/GarageSale/ListingDesigns/images/Packs/Pack24/VintageCollage.jpg</imageURL> <domesticShippingService serviceFee="12.00" serviceAdditionalFee="2.00">UPS Ground</domesticShippingService> <internationalShippingService serviceFee="22.00">UPS Worldwide Express</internationalShippingService> <siteName>eBay USA</siteName> <design>Be A Star</design> <layout>thumb gallery</layout> <category>155193</category><!--Unisex T-Shirts--> <condition>New with tags</condition> <variation> <attributeName>Size</attributeName> <attributeValue>L</attributeValue> <attributeName>Color</attributeName> <attributeValue>Blue</attributeValue> <price>10.00</price> <sku>LARGE-BLUE</sku> <quantity>10</quantity> </variation> <variation> <attributeName>Size</attributeName> <attributeValue>M</attributeValue> <attributeName>Color</attributeName> <attributeValue>Blue</attributeValue> <price>10.00</price> <sku>MEDIUM-BLUE</sku> <quantity>10</quantity> </variation> <variation> <attributeName>Size</attributeName> <attributeValue>S</attributeValue> <attributeName>Color</attributeName> <attributeValue>Blue</attributeValue> <price>10.00</price> <sku>SMALL-BLUE</sku> <quantity>10</quantity> </variation> <variation> <attributeName>Size</attributeName> <attributeValue>L</attributeValue> <attributeName>Color</attributeName> <attributeValue>Red</attributeValue> <price>10.00</price> <sku>LARGE-RED</sku> <quantity>10</quantity> </variation> <variation> <attributeName>Size</attributeName> <attributeValue>M</attributeValue> <attributeName>Color</attributeName> <attributeValue>Red</attributeValue> <price>10.00</price> <sku>Medium-RED</sku> <quantity>10</quantity> </variation> <variation> <attributeName>Size</attributeName> <attributeValue>S</attributeValue> <attributeName>Color</attributeName> <attributeValue>Red</attributeValue> <price>10.00</price> <sku>Small-RED</sku> <quantity>10</quantity> </variation> <designProperty> <propertyName>Title and Subtitle Font</propertyName> <propertyValue>Arial</propertyValue> </designProperty> <designProperty> <propertyName>Custom Title:</propertyName> <propertyValue>This my super hot stuff!</propertyValue> </designProperty> 
<handlingTime>2</handlingTime>
</item> </items>

Personal tools