Product feed field types

This is a technical breakdown of our product feed format.

An understanding of data feeds is assumed in this article.

Data Types

Our data feeds contains 5 different data types.

  1. String
  2. Integer
  3. Bool
  4. Decimal
  5. Timestamp

Excel Breakdown

The following rules apply:

  • Comma delimited
  • Fields that may contain commas are contained within double quotes
  • The file will open with Microsoft Excel by default, but can be read like any normal text file as well.

Column Mapping in Excel (.csv)

Field Name Description Data Type Maximum Length

id

The item sku

String

5

md5

An md5 hash of the item data.

It only changes if any of the item data changes.

String

32

title

The item title

String

150

description

The item description

String

2000

type

Type of item. Possible Values: import, premium item, floor display, dump display, half pallet, starter pallet, pdq

String

45

brand

Brand name of item.

String

100

colors

Comma delimited list of item colors.

String

250

materials

Comma delimited list of item materials.

String

250

attributes

Comma delimited list of item attributes.

String

250

upc

The item's universal product code

String

13

inventory

The number of items in stock.

Integer

5

is_closeout

A boolean value where 0 means the item is not a closeout and 1 means the item is a closeout.

Bool

1

category

Item Category

String

65

subcategory

Item subcategory

String

65

image_small

Location on the web where the small item photo can be retrieved.

String

127

image_medium

Location on the web where the medium item photo can be retrieved.

String

127

image_large

Location on the web where the large item photo can be retrieved.

String

127

item_weight

The weight of each item (by piece)

Decimal

8

modified

A timestamp representing the last time the item was updated

Timestamp

10

tier_pack_1

The pack size (number of pieces) in the first price tier. If there is no first price tier this field will be 0.

Integer

4

tier_price_1

The price (per pack) for tier 1

Decimal

8

tier_pack_2

The pack size (number of pieces) in the second price tier. If there is no second price tier this field will be 0.

Integer

4

tier_price_2

The price (per pack) for tier 2

decimal

8

tier_pack_3

The pack size (number of pieces) in the third price tier. If there is no third price tier this field will be 0.

Integer

4

tier_price_3

The price (per pack) for tier 3

Decimal

8

tier_pack_4

The pack size (number of pieces) in the fourth price tier. If there is no fourth price tier this field will be 0.

Integer

4

tier_price_4

The price (per pack) for tier 4

Decimal

8

case_pack

The pack size (number of pieces) in the case pack.

Integer

4

case_pack_price

The price (per pack) for a case pack

Decimal

8

on_sale

0 means the item is not on sale, 1 means the item is on sale.

Bool

1

sale_begins

Unix Timestamp of when the sale begins.

Timestamp

20

sale_ends

Unix Timestamp of when the sale ends.

Timestamp

20

XML Breakdown

<?xml version="1.0" encoding="utf-8"; ?>
<catalog>
    <meta>
    <customer_id>X00000</customer_id>
    <feed_name>Feed Example</feed_name>
    <feed_url>http://mywebsite.com</feed_url>
    <published>1274266675</published>
    <product_count>3200</product_count>
    </meta>
    <products>
        <item>
            <id>AA124</id>
            <md5>a4b48c255c63794cb53bddcd63c9529b</md5>
            <title>patriotic dog leash</title>
            <description>44 1/2 inch patriotic dog leash</description>
            <type>import</type>
            <brand>duke's</brand>
            <colors>white,blue,red</colors>
            <materials>metal,plastic,nylon</materials>
            <attributes>assorted sizes</attributes>
            <upc>731015074020</upc>
            <inventory>1200</inventory>
            <is_closeout>0</is_closeout>
            <category>pet supplies</category>
            <subcategory>harness/leash/collar/chain</subcategory>
            <images>
                <image size="small">http://cdn.koleimports.com/images/3x4/small/a/a/AA125.jpg</image>
                <image size="medium">http://cdn.koleimports.com/images/3x4/medium/a/a/AA125.jpg</image>
                <image size="large">http://cdn.koleimports.com/images/3x4/large/a/a/AA125.jpg</image>
            </images>
            <item_weight>0.117</item_weight>
            <modified>2011-03-15</modified>
            <pricing>
                <tier>
                    <pack>24</pack>
                    <price>26.64</price>
                </tier>
                <tier>
                    <pack>48</pack>
                    <price>43.2</price>
                </tier>
                <tier>
                    <pack>72</pack>
                    <price>59.76</price>
                </tier>
                <tier>
                    <pack>96</pack>
                    <price>75.84</price>
                </tier>
                <case>
                    <pack>144</pack>
                    <price>99.36</price>
                </case>
            </pricing>
            <sale>
                <on_sale>0</on_sale>
                <sale_begins>2011-03-15</sale_begins>
                <sale_ends>2011-03-17</sale_ends>
            </sale>
        </item>
    </products>
</catalog>

XML Element Index

Element Name Description Data Type Maximum Length Child Elements

catalog

Root Element

n/a

n/a

# of children: 2

  • meta
  • products

meta

Child of catalog. Includes data describing the feed.

n/a

n/a

# of children: 5

  • customer_id
  • feed_name
  • feed_description
  • published
  • product_count

customer_id

Child of meta. Kole Imports customer ID.

String

6

none

feed_name

Child of meta. The name of the feed.

String

65

none

feed_description

Child of meta. Description of the feed.

String

127

none

published

Child of meta. A unix timestamp of the published date.

Unix Timestamp

n/a

none

product_count

Child of meta. Number of items that exist in the feed.

Integer

n/a

none

products

Child of catalog. Includes all of the items.

n/a

n/a

# of children: 1 - many

  • item

item

Child of products. Includes all item specific information.

n/a

n/a

# of children: 19

  • id
  • md5
  • title
  • description
  • type
  • brand
  • colors
  • materials
  • attributes
  • upc
  • inventory
  • is_closeout
  • category
  • subcategory
  • images
  • item_weight
  • modified
  • pricing
  • sale

id

Child of item. The item sku.

String

5

none

md5

Child of item. An md5 hash of the item data. It only changes if any of the item data changes.

String

32

none

title

Child of item. Item title.

String

150

none

description

Child of item. Item description.

String

2000

none

type

Child of item. Type of item. Possible Values: import, premium item, floor display, dump display, half pallet, starter pallet, pdq

String

45

none

brand

Child of item. Brand name of item.

String

100

none

colors

Child of item. Comma delimited list of item colors.

String

250

none

materials

Child of item. Comma delimited list of item materials.

String

250

none

attributes

Child of item. Comma delimited list of item attributes.

String

250

none

upc

Child of item. UPC code for item.

String

13

none

inventory

Child of item. The number of items in stock.

Integer

5

none

is_closeout

Child of item. A boolean value where 0 means the item is not a closeout and 1 means the item is a closeout.

Bool

1

none

category

Child of item. Item category.

String

65

none

subcategory

Child of item. Item subcategory.

String

65

none

images

Child of item. Includes all of the associated images and thumbnails for the item.

n/a

n/a

# of children: 3

  • image

image

Child of images. Includes image attributes and the url of the image.

n/a

n/a

# of children: 2

  • size (attribute)
  • url (text)

size

Attribute of image. Size of the image.

string

10

none

url

Text node of image. The url where the image can be found.

string

100

none

item_weight

Child of item. The weight of each item (by piece)

Decimal

8

none

modified

Child of item. A timestamp representing the last time the item was updated

Timestamp

10

none

pricing

Child of item. Holds the pricing information.

n/a

n/a

# of children: 1 - Many (always contains case)

  • tier
  • case

tier

Child of pricing. Represents a price tier.

n/a

n/a

# of children: 2

  • pack
  • price

case

Child of pricing. Represents the case pack price tier.

n/a

n/a

# of children: 2

  • pack
  • price

pack

Child of tier and case. Represents the number of items in the tier.

Integer

4

none

price

Child of tier and case. Represents the price for the in the tier.

Decimal

8

none

sale

Child of item. Holds sale information about the item.

n/a

n/a

# of children: 1

  • on_sale

on_sale

Child of sale. 0 means the item is not on sale, 1 means the item is on sale.

Bool

1

none

Recent Discussions

19 Aug, 2017 08:19 PM
18 Aug, 2017 03:35 PM
18 Aug, 2017 03:22 AM
16 Aug, 2017 11:58 AM
16 Aug, 2017 01:31 AM