GDS Retail Item Object
Middle East & Asia Globe
Blue Marble
World Map

Goto: Documentation Home

This object defines a retail product as might be commonly found in a retail store. While any item could be found in a retail store, the intent of this group is only to maintain typical objects such as shoes or bread and not items such as Oil Tanker.

Goto: Identity | Size | Secondary Attributes | Food Attributes | Supply Chain Attributes | E-Commerce

Some of these fields are retailer highly retailer specific, such that they would not be expected in a generic product defintion. This fields are highlighted like this

Identity Fields

Field/ReadField/WriteDataTypeDescription
f800's'Name of Item (English)
f801's'A URL to retrieve a typical image of this item. This URL is expected to be from the Chart Generator, allow clients to control output size. See also f810
f802's'Primary barcode. Single main barcode for this item.
f803?Reserved for barcode symbology of f802
f804's'Fieldpine Product Id. Used when this product entry refers to a single product. (Reserved for Fieldpine, NYI)
f805date/timeDate and Time UTC that record was created
f806string's'Fieldpine 'C' category encoding.
f807string's'Fieldpine 'R' category encoding.
f808Number'E'Industry code for industry wide part code held in f809.
1=Electronics
f809string's'Industry wide classification code for this item. Some industries, such electronic parts, have generic part codes that are used. (eg. The IN4004 diode, BC107 transistor) Often these part codes are originally defined by one manufacturer and adopted widely.
f810's'A pipe seperated list of absolute URLs to retrieve a typical image of this item.
f811's'Manufacturers part code, or products that have a single master manufacturer

Pricing Fields

Field/ReadField/WriteDataTypeDescription
f1000Low Price. Expected lower price range for this item. This is an indication only.
f1001High Price. Expected upper price range for this item. This is an indication only.
f1002Retail Price. The expected retail price of this item. This is an indication only.
f1003Cost Price. The typical cost price of this item. This is an indication only.

Categorisation Fields

Field/ReadField/WriteDataTypeDescription
f4,000,0NNRetailer Specific categorisation #NN, where NN can range from 01 to 99 inclusive.

Size/Volume Fields

Field/ReadField/WriteDataTypeDescription
f201Relative size. Scale 0-100 where 100 is largest. Large is 60, Medium is 50. Small is 40. Size is relative to the natural group. For example tins of food are sized relative to a typical tin of food. See also f211
f202Shoe Size (for footwear)
f203Shoe Size Country standard
f204Paper Size, A1, A2 etc.
f205Bra Size
f206Weight, in Grams
f207's'Dimensions in mm of a 3 dimensional bounding box. Height|Width|Depth. eg 1200|200|300 (1.2m high, 20cm wide, 30cm deep)
f208Clothing Size (S, M, L, XL, XXL etc)
f209's'Pipe seperated list of common packaging sizes for non unit items. For example carrots may be commonly sold in 500gm and 1Kg bags, in which case this field would contain "500|1000"
f210's'User size information entered in free form text. eg "Adult, 5pk" or "Large"
f211'E'AboutSize. Describes the approximate physical size of the item in general terms. This is numerically encoded taken from the following.
ValueSize Description (about the size of a..)
8Microscopic
16Tablet, pill, medication
24Matchbox
32One Hand
40Two Hands
48Shoe Box
56Microwave
64Washing Machine
72Car
80House
88Ship
This value is intentionally a judgement call on size rather than an exact measure.
f882Blade Size, (See Chainsaw)

Secondary Attributes Fields

Field/ReadField/WriteDataTypeDescription
f300's'Primary Color of item. This is the color a typical person would call the item.
f301's'Secondary Color of item. This color is reserved to mean special things for certain items.
f400'E'Brand Id#. This is the primary key of this brand to the known brands data. Zero means "no link", as sometimes brand text can be supplied without the underlying brand link.
f401's'Brand Name. The actual textual description of the brand.
f600Made from List
f700Design Shape
f881Motive Power. Coded Value. Not all items support all possible values. Petrol=1 Electric=2
f890's'Preferred background color for this item. This provides a color triple (in HTML #RRGGBB format) that can be used for this product.

Food Attribute Fields

Field/ReadField/WriteDataTypeDescription
f3000'E'Gluten Free Indicator
f3001'E'Organic Indicator
f3002'E'Diary Free Indicator
f3003'E'Low Sugar Indicator
f3004'E'Vegan Indicator
f3005'E'Low Salt Indicator
f3006'E'Yeast Free Indicator
f3007'E'Low Fat Indicator
f3008'E'Raw/Unprocessed Indicator
f3009'E'Kosher Indicator
f3010'E'Edible Indicator, set to 1 for edible products

Supply Chain Attribute Fields

Some of these attributes are more suitable for the supplier, but fields are reserved on the product to hold this information also.
Field/ReadField/WriteDataTypeDescription
f4000'E'Fair Trade Indicator
f4001'E'Out of Season Indicator. Set to indicate that a seasonal product is currently out of season.
f4100'E'Country of Manufacture (GDS Country Codes)
f4164'E'Made in New Zealand Indicator

E-Commerce Fields

Field/ReadField/WriteDataTypeDescription
f2007's'German. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
f2009's'English. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
f2010's'Spanish. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
f2012's'French. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
f2022's'Portuguese. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
f2034's'Mandarin. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
 
f2507's'German. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
f2509's'English. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
f2510's'Spanish. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
f2512's'French. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
f2522's'Portuguese. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
f2534's'Mandarin. Descriptive text of item. Longer and more detailed than f2000. Typical use is on a full item description page
 
f3507's'German. Keywords for product search
f3509's'English. Keywords for product search
f3510's'Spanish. Keywords for product search
f3512's'French. Keywords for product search
f3522's'Portuguese. Keywords for product search
f3534's'Mandarin. Keywords for product search
Stock Level Information
f2100N/A'E'Mode of Stock Control for this item. Defining how an E-Commerce site should treat stock and inventory levels. This is a coded number with the meanings defined below:
ValueDescription
0Undefined
1An externally agreed method that is handled outside the rules in this document
2Always available. Stock levels may or may not be provided, however this item is almost certainly available and can be freely sold
3Unavailable for sale at this time. (But with implication that it can be sourced, as items that can never be sold/sourced are removed from the database)
4Dynamic Levels. The levels provided in f2101/f2102 are reasonably accurate and updated as frequently as possible.
0Undefined
0Undefined
f2101Date/Time UTCDate/Time that stock level information was last updated.
f2102'E'Stock level in measurement units as at the time in f2101
f2103'E'Maximum purchase quantity per sale. If not specified or specified as zero, then no implicit limits exist.
f2104's'E-Commerce site category. This provides a general grouping of items into groups. Retailers are free to specify whatever they wish in this field.
f2105Date/Time UTCValid Start time. Information provided on this item is not to be processed until after Valid Start Time. If no value is supplied then item is immediately visible.
f2106Date/Time UTCValid End time. Information provided should not be displayed after this time. If no value is supplied then item may be constantly used.
f2107'E'Promotional level. Technically this is a value between 0 and 100 (inclusive), with 1 being the highest rank and 100 being the lowest. The following values are defined for clarity:
ValueDescription
5Promote Heavily, front page of web site etc
10Promote Strongly.
50Neutral
60Additional variation, more detail etc. Typically marked for items that are variations of a more main product with a higher promotional level. (This does not mean they are only variants however)
90Available if really required, but not common product line
The value of "0" is reserved for retailer specific default, which can be interpreted by the E-Commerce site in an externally agreed manner.
f2108'E'Special indicator. Used by Websites to indicate product should be marked on special or other agreed purpose.
f2109'E'Out of Stock indicator. This indicator is manually set as an override to indicate to web sites that this product should be considered out of stock, regardless of any other stock level indication.
f2110'E'Only available instore indicator. Used to indicate to websites that this product should be marked in-store purchase only
f2111'E'Delivery Charge indicator. A coded value indicating levels of delivery charge.
ValueDescription
0Not specified, default rules apply
1Free delivery in local area
2Free delivery within state/county
3Free delivery nationwide
4Free delivery worldwide
5No physical delivery involved (also implies 'free')
f2112'E'New Product indicator. Used by Websites to indicate this is considered a "new" product for this retailer. The exact meaning and duration of "new" is left to the individual retailer to decide.
f2202's'URL of reference image(s). Media Keystring formats.

Other Attribute Fields

Field/ReadField/WriteDataTypeDescription
f5000'E'/'s'Lens Type (sunglasses)
f5001'E'Non-tangible Indicator, set to 1 for abstract products that do not physically exist or you could not realistically expect to touch
f5002'E'One-off Indicator, set to 1 for original products that will not be repeated, such as original artwork or jewelry.

Human Target Attribute Fields

Information detailing human attributes this item is designed for

Field/ReadField/WriteDataTypeDescription
f20000'E'/'s'Face Shape. Face shape(s) this product works best with. Can be a pipe seperated list if multiple values are present
f20001'E'/'s'Hair style Hair style(s) this product works best with. Can be a pipe seperated list if multiple values are present
f20002'B'Designed for gender. M=Male, F=Female, T=Transexual, A=Any, may also be in lowercase, indicating a lower strength suggestion. "F" is Female, while "f" is mostly female. The value must be one of the following values: A,F,M,T,f,m,t.

Region Specific Management

The base definition of a GDS Item is based around an English speaking model. This is not suitable for all countries and languages, so additional information must be provided to handle region specific information and language variations. Language and region are different concepts, it is valid to have Portuguese language variants displayed inside the USA (predominatly English/Spanish)

Pricing.
Fields 3,000,000 to 3,009,999 are reserved for individual country retail prices as would normally be stored in f1002. eg. Australia price is stored in 3,000,000 + 43 (Australian country code)
Fields 3,010,000 to 3,019,999 are reserved for individual country cost prices as would normally be stored in f1003. eg. Australia price is stored in 3,010,000 + 43 (Australian country code)

Product Specific Information

Sunglasses