Transcription
Active Catalogue Attributes GuideThis guide presents the qXML names and descriptions and format requirements for the 750 data attributes supported by OpenText Active Catalogue. It also lists the Catalogue UI displayname and the GS1/VICS attribute name of an attribute when applicable.August 2018
OpenText Active CatalogueAttributes GuideRev.: 11 July 2018This documentation has been created for software version 16.10.It is also valid for subsequent software versions as long as no new document version is shipped with theproduct or is published at https://knowledge.opentext.com.Product Support: U.S.A—1-800-334-2255 or email cataloguesupport@opentext.comOpen Text Corporation275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1Tel: 1-519-888-7111Toll Free Canada/USA: 1-800-499-6544 International: 800-4996-5440Fax: 1-519-888-0677For more information, visit https://www.opentext.comCopyright 2018 Open Text. All Rights Reserved.Trademarks owned by Open Text.DisclaimerNo Warranties and Limitation of LiabilityEvery effort has been made to ensure the accuracy of the features and techniques presented in thispublication. However, Open Text Corporation and its affiliates accept no responsibility and offer no warrantywhether expressed or implied for the accuracy of this publication.iiOpenText Active Catalogue Attributes Guide
ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1Audience . . . . . . . . . . . . . . . . . .Conventions Used In This Guide . .Accessing Product Documentation.Related Documentation . . . .Installing Acrobat Reader . . .Retailers and Vendors . . . . . . . . .Contacting Technical Support . . . .12223331 Attribute Requirements, Validations, and RulesGeneral Attribute Requirements . . . . . . . . . .General qXML Rules. . . . . . . . . . . . . . .Attribute Format . . . . . . . . . . . . . . . . .Basic GTIN Attribute Validations and Rules . .Private Values . . . . . . . . . . . . . . . . . . .Multiline Data Attributes. . . . . . . . . . . .Associated Multiline Data Attributes . . .Derived Attributes . . . . . . . . . . . . . . . .4.4.5.5.5.6.6. 14.1616161717181818.192020202 Compliance ChecksItem Maintenance Compatibility . . . . . . . . . . . . .GTIN Rules . . . . . . . . . . . . . . . . . . . . . . . .Prepack Code Rules . . . . . . . . . . . . . . . . . .GMA Compliance . . . . . . . . . . . . . . . . . . . . . . . .Color and Size Codes and Descriptions RulesPrefix Validation . . . . . . . . . . . . . . . . . . . . . . . .Product Description Uniqueness . . . . . . . . . . . . .Product Description Rules. . . . . . . . . . . . . .3 Using the Attribute TablesOverview . . . . . . . . . . .Data Type RequirementsField Length . . . . .Character Type . . .4 Account and Contact AttributesAccount and Contact Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Catalogue Organization - Selection Code, Product, and GTIN AttributesSelection Code and Product Attributes. . . . . . . . . . . .Description and Extended Description Attributes. . . . .Maintain Descriptions and Extended DescriptionsExport Documents . . . . . . . . . . . . . . . . . . . . . .26272727iii
CONTENTSqXML Responses . . . . . . .GTIN Attributes. . . . . . . . . . . .Item Number and Item NumberComponent Attributes . . . . . . .Type Parameters . . . . . .282929306 GDSN AttributesGDSN Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32GDSN Optional Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 Logistics AttributesCommon Logistics Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Extended Logistics Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 Media AttributesMedia. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609 Nutrition and Nutritional Supplements AttributesNutrition Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Nutritional Supplements Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7410 Pet Food AttributesPet Food Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8811 Pharmaceutical AttributesPharmaceutical Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9012 Retail AttributesCommon Retail Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Extended Retail Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10013 System-Generated and Derived AttributesSystem-Generated Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Derived Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119A Unit of Measure (UOM) CodesMiscellaneous UOMs . . . . . . . . . . . . . . . . . . . . . .Weight UOMs . . . . . . . . . . . . . . . . . . . . . . . . . . .Length, Width, Height, Depth, and Diameter UOMsVolume UOMs . . . . . . . . . . . . . . . . . . . . . . . . . . .122124124126B Packaging CodesPackaging Configuration Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Packaging Material Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Packaging Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128ivOpenText Active Catalogue Attributes Guide
CONTENTSC Country, State, and Province CodesCountry Codes . . . . . . . . . . . . . . . . .Target Market Subdivision CodesU.S. State Codes . . . . . . . . . . . . . . . .Canadian Province Codes . . . . . . . . . .Advertised Origin Codes. . . . . . . . . . . . . . . . . . . . . . .Bag Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Band Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Barcode Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Beauty Area of Use Codes . . . . . . . . . . . . . . . . . . . . .Beauty Treatment Specialty Codes . . . . . . . . . . . . . . .Bedding Size Codes . . . . . . . . . . . . . . . . . . . . . . . . . .Bedding Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Bill Logo Application Codes. . . . . . . . . . . . . . . . . . . . .Boot Shaft Type Codes . . . . . . . . . . . . . . . . . . . . . . .Bracelet Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Closure Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Coat/Jacket Type Codes. . . . . . . . . . . . . . . . . . . . . . .Collar Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Colorization Values . . . . . . . . . . . . . . . . . . . . . . . . . .Conference Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Consumer Lifestage Codes . . . . . . . . . . . . . . . . . . . . .Cookware Type Codes . . . . . . . . . . . . . . . . . . . . . . . .Cuff Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Dinnerware Category Codes . . . . . . . . . . . . . . . . . . . .Dress Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Earring Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . .Eyewear Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Fast Moving Consumer Goods (FMCG) Values . . . . . . .Fill Material Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Finish Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Flatware Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Formulation Codes . . . . . . . . . . . . . . . . . . . . . . . . . .Fur Animal Name Codes. . . . . . . . . . . . . . . . . . . . . . .Fur Treatment Codes. . . . . . . . . . . . . . . . . . . . . . . . .Gauge Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Gender Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Gender By Age Values . . . . . . . . . . . . . . . . . . . . . . . .Gold Karat Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Hat Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Headwear Bill Type Codes . . . . . . . . . . . . . . . . . . . . .Headwear Crown Codes . . . . . . . . . . . . . . . . . . . . . .Headwear Fit Codes . . . . . . . . . . . . . . . . . . . . . . . . .Heel Height Range Codes . . . . . . . . . . . . . . . . . . . . .Heel Material Codes . . . . . . . . . . . . . . . . . . . . . . . . .Heel Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Holiday/Event Codes . . . . . . . . . . . . . . . . . . . . . . . . 3164164165165165166167167167168168168169D Currency CodesE Miscellaneous Codes and ValuesOpenText Active Catalogue Attributes Guidev
CONTENTSHosiery/Sock Type Codes. . . . . . . . . . . . . . . . . . . . . .Item Care Instructions Codes . . . . . . . . . . . . . . . . . .Jewelry Sets Codes . . . . . . . . . . . . . . . . . . . . . . . . . .Jewelry Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Knit Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .League Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Leg Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Length Description Codes . . . . . . . . . . . . . . . . . . . . .Lined Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Lining Material Codes . . . . . . . . . . . . . . . . . . . . . . . .Logistics Maximum Pressure UOM Codes . . . . . . . . . . .Metal Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Metal Composition Codes . . . . . . . . . . . . . . . . . . . . . .Necklace Type Codes. . . . . . . . . . . . . . . . . . . . . . . . .Neckwear Type Codes . . . . . . . . . . . . . . . . . . . . . . . .Number of Settings Codes . . . . . . . . . . . . . . . . . . . . .Occasion Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . .Occasion List Codes. . . . . . . . . . . . . . . . . . . . . . . . . .Organic Status Codes . . . . . . . . . . . . . . . . . . . . . . . .Outsole Type Codes . . . . . . . . . . . . . . . . . . . . . . . . .Packaging and Pallet Terms and Conditions Codes . . . .Pallet Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Pants/Shorts Type Codes . . . . . . . . . . . . . . . . . . . . . .Prepack Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Primary Detail Application Codes. . . . . . . . . . . . . . . . .Primary Detail Placement Codes . . . . . . . . . . . . . . . . .Primary Detail Size Codes. . . . . . . . . . . . . . . . . . . . . .Primary Detail Type Codes . . . . . . . . . . . . . . . . . . . . .Primary Motif Theme Codes . . . . . . . . . . . . . . . . . . . .Recycle Type Codes. . . . . . . . . . . . . . . . . . . . . . . . . .Ring Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Rug Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Scent Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Seams Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Seasonal Availability Codes . . . . . . . . . . . . . . . . . . . .Secondary Detail Application Codes. . . . . . . . . . . . . . .Secondary Detail Placement Codes . . . . . . . . . . . . . . .Secondary Detail Size Codes. . . . . . . . . . . . . . . . . . . .Secondary Detail Type Codes . . . . . . . . . . . . . . . . . . .Secondary Motif Theme Codes . . . . . . . . . . . . . . . . . .Selling Channel Codes . . . . . . . . . . . . . . . . . . . . . . . .Shape Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Shoe Style Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Shoe Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Skin Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Skirt Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Sleeve Length Codes . . . . . . . . . . . . . . . . . . . . . . . . .Sole Type Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .Special Embellishment Codes . . . . . . . . . . . . . . . . . . .SPF Rating Codes . . . . . . . . . . . . . . . . . . . . . . . . . . .Sport Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Stone Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Sweater/Pullover Type Codes . . . . . . . . . . . . . . . . . . .Tableware Type Codes. . . . . . . . . . . . . . . . . . . . . . . 2194194196196197OpenText Active Catalogue Attributes Guide
CONTENTSThird Detail Application Codes . . .Third Detail Placement Codes . . . .Third Detail Size Codes . . . . . . . .Third Detail Type Codes. . . . . . . .Third Motif Theme Codes . . . . . . .Tire Segment Values . . . . . . . . . .Tire Speed Rating Codes . . . . . . .Toe Shape Codes . . . . . . . . . . . .Towel Type Codes . . . . . . . . . . . .Transport Handling Codes . . . . . .Transport Method Codes . . . . . . .Waist Rise Codes. . . . . . . . . . . . .Waistband Type Codes . . . . . . . .Water Repellent Codes . . . . . . . .Watch Case Shape Codes. . . . . . .197198199199199200200201201202202203203204204F Special Characters In qXMLAlphanumeric Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Numeric Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207OpenText Active Catalogue Attributes Guidevii
IntroductionThis guide presents the qXML names and descriptions and format requirements forthe 750 data attributes supported by OpenText Active Catalogue. It also lists theCatalogue UI display name and the GS1/VICS attribute name of an attribute whenapplicable. Use this guide to perform the following tasks: Construct, send, receive, and interpret qXML documents Work in the Error Processing facility of the browser interfaceUse this guide in combination with the OpenText Active Catalogue qXML ReferenceGuide to work with qXML documents. qXML is OpenText’s proprietaryimplementation of XML (Extensible Markup Language).Note: OpenText system-generated attributes such as PRODUCT COUNT appearin response documents and subscription data exports but are not listed in thisguide because they are maintained internally at OpenText.This document includes the following: Specifications for data attributes used in qXML documents to reference Account,Selection Code, Product, GTIN (Global Trade Item Number), media, and othercatalogue informationAppendices of acceptable values for a variety of data
Catalogue. Data attributes contain specific information about an account, GTIN, Product, or other element in a catalogue. They can be maintained using any interface. This guide presents the information necessary to work with data attributes in qXML documents. Topics include:
