Item Master Feed

Overview

The Item Master provides Radial with the client’s product information at the SKU level. Data drives the Radial ERP and WMS system and is the foundation for building the webstore database. Radial receives new items and changes to existing items in this file.

For additional context, see Item Service: Catalog and Product Information.

Notes:

Default Character Encoding: Unicode: UTF-8
Recipient Acknowledgment Required: Yes
Exchange Frequency: Client Specific
Production Mailbox Location: Client Specific
Test Mailbox Location: Client Specific
The filename combined with the mailbox determines the destination of the Item Master.

When you send an update for an item record, the new data overwrites the existing data for that item. Because the full item record is overwritten with each update, you must send the full set of information for each item, and not just the changed fields.

Schema

Item Master schema: ItemMaster-CommonIntegration.xsd

API Structure

Item Master element table: ItemMaster-CommonIntegration.xsd.html

The following table describes elements used for Store Fulfillment (standalone) and Dropship Manager. It does not list all of the elements used in ROM; see the Item Master element table for an explanation of those common elements.

							Occurs	Store Fulfillment	Dropship Manager	Radial Order Management	Description

M = Mandatory; C = Conditional; X = Not used


Field Name
ItemMaster							1
	MessageHeader						1				See sample data for default values
		Standard						M	M	M
		HeaderVersion						M	M	M
		VersionReleaseNumber						M	M	M
		SourceData					1
			SourceId					M	M	M
			SourceType					M	M	M
		DestinationData					1
			DestinationId					M	M	M
			DestinationType					M	M	M
		EventType
		MessageData					1
			MessageId					M	M	M	Unique value per file
			CorrelationId					M	M	M	Unique value per file
		CreateDateAndTime						M	M	M
	Item						1…n
		ItemId
			ClientItemId					M	M	M	Advertised SKU number; clients unique sku identifier
			GTIN				1…n
			@IdType
			@operation_type
			@UPCType
				IdNumber				C	C	C	UPC Code
			ManufacturerItemId					X	X	C
		BaseAttributes					1
			CatalogClass					X	X	M	See ROM Item Master element table for list
			IsDropShipped					X	M	M	Valid values are: true false
			ItemDescription					M	M	M	SKU Description
			ItemType					X	X	M	Describes type of SKU, such as merchandise, Gift Wrap, Gift Card, etc. See ROM Item Master element table documentation for list.
			ItemStatus					X	X	M	See ROM Item Master element table for list
			TaxCode					X	X	M	Vertex Tax Code
			Hierarchy				1				Hierarchy values are assigned by Radial
				DeptNumber				M	M	M
				DeptDescription				C	C	C
				SubDeptNumber				M	M	M
				SubDeptDescription				C	C	C
				ClassNumber				M	M	M
				ClassDescription				C	C	C
				SubClass				M	M	M
				SubClassDescription				C	C	C
		DropShipSupplierInformation					1
			SupplierPrefix					X	M	C	290 if Radial Paid; 350 if Client Paid
			SupplierName					X	M	C	Supplier name
			SupplierNumber					X	M	C	Radial Assigned Supplier Number
			SupplierPartNumber					X	M	C	Supplier's SKU unique identifier
		ExtendedAttributes					1
			Brand				1
				Name				X	X	C
				@lang				X	X	C
				Description				X	X	C
			ColorAttributes				1
				Color
						Code		C	C	C	Color Code
						@lang		C	C	C
						Description		C	C	C	Color Description
			CountryOfOrigin					C	C	C	Country of Origin
			ItemDimension				1
				Display
					Mass
					@unit_of_measure			X	X	C
						Weight		X	X	C
					Packaging
					@unit_of_measure
						Width		C	C	C
						Length		C	C	C
						Height		C	C	C
			Price					C	C	M
			SalesClass					X	X	M	See ROM Item Master element table for list
			SerialNumberType					C	C	C
			SizeAttributes				1
				Size
					Code			C	C	C	Size Code
				@lang				C	C	C
					Description			C	C	C	Size Description
			Style				1
				StyleID				M	M	C	Style ID
				StyleDescription				C	C	C	Style Description
			UnitCost					X	M	C	Supplier's cost for the SKU
		CustomAttributes					1
			Attribute				1..n
			@lang
			@operation_type
			@is_list
			@dt
			@name
				Value

Possible attributes include:
			DryIceWeight					C	C	X	DryIceWeight
			Freight					C	C	X	Freight Charge
			ShipAloneQty					C	C	X	1 = Ship alone; 0 = does not need to ship alone
			HostDescription					C	C	X	HostDescription
			VendorDescription					C	C	X	VendorDescription
			LeadDays					X	C	X	Vendor’s lead days for the item.
			Handling					X	C	X	Handling Charge

		EB2C					1
			ItemImageURLs				1…n
				@type				C	C	C
				@view				C	C	C
				@height				C	C	C
				@width				C	C	C
				ImageURL				C	C	C

* Store Fulfillment and Dropship Manager support both Main and Thumbnail Image URLS; refer to the following examples to see how this works.

Item Types

Item types include both physical and virtual items. They are defined by the ItemType element in the Item Master feed.

For an order to be completed correctly, the client’s item catalog must contain all physical and virtual items that may be sold on the webstore and that would be passed in the order message. The Order Management System consumes the list of items sent by the client and cannot add order lines.

The following table lists the most common ItemType values.

Item Type	Description
CUSTOM	Customization. A virtual item that represents a charge to the consumer to customize another item. The customization item includes a description of the customization options selected by the customer; for example, "Monogramming" or "Team jersey customization". Each type of customization offered to consumers must be defined as an individual item. A customization item is passed in the order message along with the item being customized.
DONATION	Donation. A virtual item that represents a consumer's donation to a charitable cause.
GC	Physical gift card. The gift card is fulfilled and then activated before the consumer receives the gift card in the shipment. Each option offered (such as choices of visual design or denominations) should be created as a separate item. The value of the gift card is always passed in the order line. Tthe client has the choice of creating a separate item for each possible dollar value of the gift card or by using one gift card SKU. If a single SKU is used for gift cards, then store reports generated at the SKU level provide less specific information about gift cards.
GIFTMESSAGE	This item contains a gift message.
GIFTWRAP	Gift wrap. A physical item representing gift wrap or a gift box. If multiple options (for example, choices of designs or colors of gift wrap or gift boxes) are offered, each option must be created as a separate item.
MERCH	A physical merchandise item, such as a shirt, a blender, or a coupon insert. At a typical store, the vast majority of items sold are Merch items.
OGC	Online gift certificate that is hosted and processed by Radial. OGCs are Radial's in-house product for gift certificates that don’t have a physical card associated with them, just a payment account number and PIN.
POSTSALEFULFILLMENT	Post-sale fulfillment. A virtual item classified separately from other virtual item types such as Donation or Warranty SKUs. These items are not fulfilled from a warehouse and should not be printed on a packing slip.
REFUNDGC	Refund Physical Gift Cards are used when refunding the value of a return or a price adjustment to the consumer when a physical gift card was used as a tender in the original sale. This item type would be used for accounting purposes to differentiate refunds from the original tender. This Item Type is optional. If not used, any refunds to the return order where a physical gift card was used reissue a GC item and not the RefundGC item.
REFUNDOGC	Refund online gift certificate. The "Refund" categorization is used for accounting purposes to differentiate refunds from the original tender.
REFUNDOGCFORCOD	Refund online gift certificate issued against a COD order.
REFUNDOGCFORCVS	Refund online gift certificate issued against a CVS order.
REFUNDVGC	Refund virtual gift cards. Used when refunding the value of a return or a price adjustment to the consumer when a virtual gift card was used as a tender in the original sale. This item type is used for accounting purposes to differentiate refunds from the original tender. It is optional to use this item type. If not used, any refunds to the return order where a virtual gift card was used reissue a VGC item and not the RefundVGC item
VGC	Virtual gift card. The gift card is not physically fulfilled, but is activated in the same way a physical gift card is. VGC is functionally similar to OGC, but processed by a third-party gift-card provider (for example, SVS or ValueLink).
WARRANTY	Product warranty. A virtual item representing a warranty purchased for another physical item on the order.
WARRANTYDEP	Dependent warranty. Can only be purchased with another item. Is not included in search results.
WARRANTYALONEDEP	Warranty item can be sold independently or with the purchase of another item. Is included in search results.
INSTALLSVCDEP	A type of installation service that can be purchased with another item. When searching, this item is not returned in the search results. This item cannot be purchased alone.
INSTALLSVCALONEDEP	A type of installation service that can be purchased independently or with another item. Is included in search results.

ExtendedAttributes Elements

Within each item record, the ExtendedAttributes complex element encloses several attributes that describe the item's size, color, style, and other information. For successful processing, the elements within ExtendedAttributes must be listed in alphabetical order, as in the following simplified example.

<ExtendedAttributes>
      <AllowGiftMessage/>
      <Brand/>
      <ColorAttributes/>
      <CountryOfOrigin/>
      <HazardousMaterialCode/>
      <ItemDimension/>
      <MSRP/>
      <Price/>
      <SalesClass/>
      <SizeAttributes/>
      <Style/>
      <UnitCost/>
</ExtendedAttributes>

Dropship Required Elements

For items that are fulfilled by drop-ship, the item entry must include the elements listed in the following example.

<Item>
      <BaseAttributes>
             <IsDropShipped>true</IsDropShipped>
      </BaseAttributes>
      <DropShipSupplierInformation>
             <SupplierName>XXXXX</SupplierName>
             <SupplierNumber>XXXXX</SupplierNumber>
             <SupplierPartNumber>XXXXX</SupplierPartNumber>
      </DropShipSupplierInformation>
      <ExtendedAttributes>
             <UnitCost currency_code="CAD">33.6</UnitCost>
     </ExtendedAttributes>
</Item>

Custom Attributes

Custom attributes can be defined in the Item Master/Item/Custom Attributes element. You can use custom attributes to pass data elements that are not explicitly defined in the Item Master schema. Each custom attribute is specified in an <Attribute> element, with a name (Attribute@name) and a value (Attribute/Value), as shown in the following example.

    <CustomAttributes>
         <Attribute name="OriginalClient">
            <Value>TMSNA</Value>
         </Attribute>
      </CustomAttributes>

Custom Attributes for Order Brokering Service

The SourcingOverride and SourcingPreference custom attributes are used in connection with the Order Brokering Service (OBS). For clients using OBS, if an item on a line is defined with a SourcingOverride value, the line is routed to the network indicated by the item's SourcingOverride value. Possible values for SourcingOverride are StoreOnly or DCOnly.

<Attribute name="SourcingOverride" operation_type="Add" is_list="false" dt="string">
   <Value>DCOnly</Value>
</Attribute>

If an item on a line is defined with a SourcingPreference value, the line is routed to the network indicated by the value of the sourcingOverride flag if the indicated network has available inventory for the item on the line. If the indicated network can only partially fulfill the line, OBS will attempt to complete the line by splitting it: consuming all of the available inventory in the preferred network, assigning all or as much of the remaining quantity as possible to the other network solution. Possible values for SourcingPreference are DC or Store.

<Attribute name="SourcingPreference" operation_type="Add" is_list="false" dt="string">
   <Value>DC</Value>
</Attribute>


<ItemMaster>
   <Item operation_type="Change" gsi_client_id="TMSNA" catalog_id="21">
      <ItemId>
         <ClientItemId>843953242895</ClientItemId>
      </ItemId>
      <BaseAttributes>
         <CatalogClass>always</CatalogClass>
         <IsDropShipped>false</IsDropShipped> 
         <ItemDescription>Physical Gift Card</ItemDescription>
         /*ItemType = "GC"*/ 
         <ItemType>GC</ItemType> 
         <ItemStatus>Active</ItemStatus>
         <TaxCode>61900</TaxCode>
         <Hierarchy>
            <DeptNumber>800</DeptNumber>
            <DeptDescription>800</DeptDescription>
            <SubDeptNumber>150</SubDeptNumber>
            <SubDeptDescription>OTHER</SubDeptDescription>
            <ClassNumber>260</ClassNumber>
            <ClassDescription>MKT</ClassDescription>
            <SubClass>370</SubClass>
            <SubClassDescription>OTHER</SubClassDescription>
         </Hierarchy>
      </BaseAttributes>
      <ExtendedAttributes>
         <AllowGiftMessage>true</AllowGiftMessage>
         <Brand>
            <Name>Generic TMS</Name>
         </Brand>
         <ColorAttributes>
            <Color>
               <Code>NA</Code>
               <Description>Not Applicable</Description>
            </Color>
         </ColorAttributes>
         <CountryOfOrigin>US</CountryOfOrigin>
         /*GiftCardTenderCode is required for physical and virtual gift cards. 
         Radial provides you the correct value.*/
         <GiftCardTenderCode>SP</GiftCardTenderCode> 
         <ItemDimension>
            <Shipping>
               <Mass unit_of_measure="lb">
                  <Weight>0.25</Weight>
               </Mass>
               <Packaging unit_of_measure="cm">
                  <Width>7</Width>
                  <Length>9</Length>
                  <Height>0.5</Height>
               </Packaging>
            </Shipping>
         </ItemDimension>
         <MayShipExpedite>true</MayShipExpedite>
         <MayShipInternational>true</MayShipInternational>
         <MayShipUSPS>true</MayShipUSPS>
         <SafetyStock>0</SafetyStock>
         /*SalesClass is used for gift cards the same 
           way as for any other physical item.*/
         <SalesClass>stock</SalesClass>  
         /*SerialNumberType must be "GC"*/
         <SerialNumberType>GC</SerialNumberType>
         <ShipWindowMinHour>24</ShipWindowMinHour>
         <ShipWindowMaxHour>24</ShipWindowMaxHour>
         <SizeAttributes>
            <Size>
               <Code>NA</Code>
               <Description>NOT APPLICABLE</Description>
            </Size>
         </SizeAttributes>
         <SplitToOne>true</SplitToOne>
      </ExtendedAttributes>
      <CustomAttributes>
         /*MinGCAmount is the minimum value that a gift card may be sold for.*/
         <Attribute name="MinGCAmount"> 
            <Value>25</Value>
         </Attribute>
         /*MaxGCAmount is the maximum value that a gift card may be sold for.*/
         <Attribute name="MaxGCAmount"> 
            <Value>1000</Value>
         </Attribute>
      </CustomAttributes>
   </Item>
</ItemMaster>

PostSaleFulfillment Item

Refund Physical Gift Card

Copy this code sample.


<ItemMaster>
   <Item operation_type="Change" gsi_client_id="TMSNA" catalog_id="21">
      <ItemId>
         <ClientItemId>843953242895</ClientItemId>
      </ItemId>
      <BaseAttributes>
         <CatalogClass>always</CatalogClass>
         <IsDropShipped>false</IsDropShipped> 
         <ItemDescription>Refund Physical Gift Card</ItemDescription>
         /*ItemType = "RefundGC"*/
         <ItemType>RefundGC</ItemType> 
         <ItemStatus>Active</ItemStatus>
         <TaxCode>61900</TaxCode>
         <Hierarchy>
            <DeptNumber>800</DeptNumber>
            <DeptDescription>800</DeptDescription>
            <SubDeptNumber>150</SubDeptNumber>
            <SubDeptDescription>OTHER</SubDeptDescription>
            <ClassNumber>260</ClassNumber>
            <ClassDescription>MKT</ClassDescription>
            <SubClass>370</SubClass>
            <SubClassDescription>OTHER</SubClassDescription>
         </Hierarchy>
      </BaseAttributes>
      <ExtendedAttributes>
         <AllowGiftMessage>true</AllowGiftMessage>
         <Brand>
            <Name>Generic TMS</Name>
         </Brand>
         <ColorAttributes>
            <Color>
               <Code>NA</Code>
               <Description>Not Applicable</Description>
            </Color>
         </ColorAttributes>
         <CountryOfOrigin>US</CountryOfOrigin>
         /*GiftCardTenderCode is required for physical and virtual gift cards. 
         Radial provides you the correct value.*/
         <GiftCardTenderCode>SP</GiftCardTenderCode> 
         <ItemDimension>
            <Shipping>
               <Mass unit_of_measure="lb">
                  <Weight>0.25</Weight>
               </Mass>
               <Packaging unit_of_measure="cm">
                  <Width>7</Width>
                  <Length>9</Length>
                  <Height>0.5</Height>
               </Packaging>
            </Shipping>
         </ItemDimension>
         <MayShipExpedite>true</MayShipExpedite>
         <MayShipInternational>true</MayShipInternational>
         <MayShipUSPS>true</MayShipUSPS>
         <SafetyStock>0</SafetyStock>
         /*SalesClass is used the same way for gift cards 
          as it does for any other physical item.*/
         <SalesClass>stock</SalesClass> 
         /*SerialNumberType must be "GC"*/
         <SerialNumberType>GC</SerialNumberType> 
         <ShipWindowMinHour>24</ShipWindowMinHour>
         <ShipWindowMaxHour>24</ShipWindowMaxHour>
         <SizeAttributes>
            <Size>
               <Code>NA</Code>
               <Description>NOT APPLICABLE</Description>
            </Size>
         </SizeAttributes>
         <SplitToOne>true</SplitToOne>
      </ExtendedAttributes>
      <CustomAttributes>
         /*MinGCAmount is the minimum value that a gift card may be sold for.*/
         <Attribute name="MinGCAmount"> 
            <Value>25</Value>
         </Attribute>
         /*MaxGCAmount is the maximum value that a gift card may be sold for.*/
         <Attribute name="MaxGCAmount"> 
            <Value>1000</Value>
         </Attribute>
      </CustomAttributes>
   </Item>
</ItemMaster>

Refund Virtual Gift Card

Copy this code sample.

<ItemMaster>
   <Item operation_type="Add" gsi_client_id="TMSNA" catalog_id="21">
      <ItemId>
         <ClientItemId>843953242895</ClientItemId>
      </ItemId>
      <BaseAttributes>
         <CatalogClass>always</CatalogClass>
         <IsDropShipped>false</IsDropShipped> 
         <ItemDescription>Refund Virtual Gift Card</ItemDescription>
         /*ItemType = "RefundVGC"*/
         <ItemType>RefundVGC</ItemType> 
         <ItemStatus>Active</ItemStatus>
         <TaxCode>61900</TaxCode>
         /*Hierarchy values are client-specific.*/
         <Hierarchy> 
            <DeptNumber>800</DeptNumber>
            <DeptDescription>800</DeptDescription>
            <SubDeptNumber>150</SubDeptNumber>
            <SubDeptDescription>OTHER</SubDeptDescription>
            <ClassNumber>260</ClassNumber>
            <ClassDescription>MKT</ClassDescription>
            <SubClass>370</SubClass>
            <SubClassDescription>OTHER</SubClassDescription>
         </Hierarchy>
      </BaseAttributes>
      <ExtendedAttributes>
         <AllowGiftMessage>true</AllowGiftMessage>
         <Brand>
            <Name>Generic TMS</Name>
         </Brand>
         <ColorAttributes>
            <Color>
               <Code>NA</Code>
               <Description>Not Applicable</Description>
            </Color>
         </ColorAttributes>
         <CountryOfOrigin>US</CountryOfOrigin>
         /*GiftCardTenderCode is required for physical and virtual gift cards. 
         Radial provides you the correct value.*/
         <GiftCardTenderCode>SP</GiftCardTenderCode> 
         /*Dimensions are irrelevant for virtual gift cards.*/
         <ItemDimension> 
            <Shipping>
               <Mass unit_of_measure="lb">
                  <Weight>0.25</Weight>
               </Mass>
               <Packaging unit_of_measure="cm">
                  <Width>7</Width>
                  <Length>9</Length>
                  <Height>0.5</Height>
               </Packaging>
            </Shipping>
         </ItemDimension>
         <MayShipExpedite>true</MayShipExpedite>
         <MayShipInternational>true</MayShipInternational>
         <MayShipUSPS>true</MayShipUSPS>
         <SafetyStock>0</SafetyStock>
         /*SalesClass must be advanceOrderOpen for virtual gift cards.*/
         <SalesClass>advanceOrderOpen</SalesClass> 
         /*SerialNumberType must be "GC"*/
         <SerialNumberType>GC</SerialNumberType> 
         <ShipWindowMinHour>24</ShipWindowMinHour>
         <ShipWindowMaxHour>24</ShipWindowMaxHour>
         <SizeAttributes>
            <Size>
               <Code>NA</Code>
               <Description>NOT APPLICABLE</Description>
            </Size>
         </SizeAttributes>
         <SplitToOne>true</SplitToOne>
      </ExtendedAttributes>
      <CustomAttributes>
         /*MinGCAmount is the minimum value that a gift card may be sold for.*/
         <Attribute name="MinGCAmount"> 
            <Value>25</Value>
         </Attribute>
         /*MaxGCAmount is the maximum value that a gift card may be sold for.*/
         <Attribute name="MaxGCAmount"> 
            <Value>1000</Value>
         </Attribute>
      </CustomAttributes>
   </Item>
</ItemMaster>

Virtual Gift Card

Data Keys

Source or Destination Type	Description
GSI	Radial
PH	Product Hub
OMS	Order Management System
MMS	Merchandise Management System

Operation Type	Description
Add	Add a piece of information.
Change	Modify or update an existing piece of information.
Delete	Remove a piece of information.

Import Mode	Description
Update	Modify an ixisting piece of data or add a new one.
Delete	Remove a piece of data.
Replace	Used to replace ALL data in the section. Example - Category Links, replace removes ALL category links and replaces with links for the current feed.

UOM	Description
a	are
acre	acre
bu	bushel
cc	cubic centimeter
cg	centigram
cl	centiliter
cm	centimeter
cm2	square centimeter
dag	dekagram
dal	dekaliter
dam	decameter
dg	decigram
dl	deciliter
dm	decimeter
dm3	cubic decimeter
dr	dram
fldr	fluid dram
floz	fluid ounce
ft	foot
ft2	square foot
g	gram
gal	gallon
gi	gill
gr	grain
ha	hectare
hg	hectogram
hl	hectoliter
hm	hectometer
in	inch
in2	square inch
kg	kilogram
kl	kiloliter
km	kilometer
km2	square kilometer
l	liter
lb	pound
m	meter
m3	cubic meter
mg	milligram
mi	mile
mi2	square mile
min	minim
ml	milliliter
mm	millimeter
oz	ounce
pk	peck
pt	pint
qt	quart
rd	rod
rd2	square rod
s	scruple
t	metric ton
ton	ton
yd	yard
yd2	square yard

Item Master Feed

Overview

Schema

API Structure

Item Types

ExtendedAttributes Elements

Dropship Required Elements

Custom Attributes

Custom Attributes for Order Brokering Service

Item Master Examples

Various Item Types: ROM Implementation

Customization Item

Item Type: ROM plus Store Fulfillment Implementation

Item Type: Store Fulfillment Standalone

Item Type: Store Fulfillment with Dropship Manager

Item Type: Dropship Manager

Donation Item

Gift Wrap Item

MERCH Item

Physical Gift Card

PostSaleFulfillment Item

Refund Physical Gift Card

Refund Virtual Gift Card

Virtual Gift Card

Data Keys