GDS Retail Item Object
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/Read | Field/Write | DataType | Description |
| 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) | |
| f805 | date/time | Date and Time UTC that record was created | |
| f806 | string | 's' | Fieldpine 'C' category encoding. |
| f807 | string | 's' | Fieldpine 'R' category encoding. |
| f808 | Number | 'E' | Industry code for industry wide part code held in f809. 1=Electronics |
| f809 | string | '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 |
| Field/Read | Field/Write | DataType | Description |
| f1000 | Low Price. Expected lower price range for this item. This is an indication only. | ||
| f1001 | High Price. Expected upper price range for this item. This is an indication only. | ||
| f1002 | Retail Price. The expected retail price of this item. This is an indication only. | ||
| f1003 | Cost Price. The typical cost price of this item. This is an indication only. |
| Field/Read | Field/Write | DataType | Description |
| f4,000,0NN | Retailer Specific categorisation #NN, where NN can range from 01 to 99 inclusive. |
| Field/Read | Field/Write | DataType | Description | ||||||||||||||||||||||||
| f201 | Relative 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 | ||||||||||||||||||||||||||
| f202 | Shoe Size (for footwear) | ||||||||||||||||||||||||||
| f203 | Shoe Size Country standard | ||||||||||||||||||||||||||
| f204 | Paper Size, A1, A2 etc. | ||||||||||||||||||||||||||
| f205 | Bra Size | ||||||||||||||||||||||||||
| f206 | Weight, 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) | |||||||||||||||||||||||||
| f208 | Clothing 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.
| |||||||||||||||||||||||||
| f882 | Blade Size, (See Chainsaw) |
| Field/Read | Field/Write | DataType | Description |
| 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. | |
| f600 | Made from List | ||
| f700 | Design Shape | ||
| f881 | Motive 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. | |
| Field/Read | Field/Write | DataType | Description |
| 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 |
Some of these attributes are more suitable for the supplier, but fields are reserved on the product to hold this information also.
| Field/Read | Field/Write | DataType | Description |
| 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 |
| Field/Read | Field/Write | DataType | Description | ||||||||||||||||
| 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 | |||||||||||||||||||
| f2100 | N/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:
| ||||||||||||||||
| f2101 | Date/Time UTC | Date/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. | |||||||||||||||||
| f2105 | Date/Time UTC | Valid 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. | |||||||||||||||||
| f2106 | Date/Time UTC | Valid 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:
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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. | |||||||||||||||||
| Field/Read | Field/Write | DataType | Description |
| 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. |
Information detailing human attributes this item is designed for
| Field/Read | Field/Write | DataType | Description |
| 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. |
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.