Item Master Feed

Overview

The Item Master provides Radial with the client’s product information at the SKU level. Data drives theRadial 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.

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
Filename Format: ClientId_CatalogId_ItemMaster_yyyymmddhhmmss_counter.xml
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.

Note: The exception to this behavior is Custom Attributes; see the following Custom Attributes section for information on how they work.

Schema

Type definitions and other details: CommonTypes.xsd

Item Master schema: ItemMaster-CommonIntegration.xsd

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

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.

Extended Attributes 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.

Copy this code sample.


<ExtendedAttributes>
      <AllowGiftMessage/>
      <Brand/>
      <ColorAttributes/>
      <CountryOfOrigin/>
      <HazardousMaterialCode/>
      <IspEligible/%gt;
      <ItemDimension/>
      <MSRP/>
      <Price/>
      <SalesClass/>
      <SfsEligible/>
      <SizeAttributes/>
      <StsEligible/>
      <Style/>
      <UnitCost/>
</ExtendedAttributes>

If you are implementing omnichannel capabilities, the following extended attributes are available to specify an item's eligibility for the omnichannel fulfillment types.

There is an ASSOCIATE_DELIVERY_ELIGIBLE attribute, but it is a custom attribute, not an extended attribute. See Custom Attributes.

Attribute Name	Description
IspEligible	Specifies whether the item is eligible for In-Store Pickup.
StsEligible	Specifies whether the item eligible for Ship-to Store; that is, whether the item is eligible to be fulfilled by a warehouse, store, or dropship vendor and then shipped to the designated store for customer pickup.
SfsEligible	Specifies if this item is eligible for Ship-from Store; that is, if the item is eligible to be fulfilled at stores and shipped to the customer’s designated address.

Dropship Required Elements

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

Copy this code sample.


<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.

Copy this code sample.

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

Unless you want to update, add, or delete specific attributes, you don’t need to send custom attributes when you send an update for an item . This is how custom attribute updates work:

If you send a custom attribute when you send an update for an item record:
- If the attribute does not exist, it is added.
- If the attribute exists, it is updated.
If you do not send an existing custom attribute when you send an update for an item, the attribute is not deleted and remains unchanged.
To delete a custom attribute, you must explicitly specify the delete operation for the attribute. Note: You have the option to specify an Add, Update, or Delete operation for each custom attribute; however, an operation is not required.

The following table lists the custom attributes used to modify existing orders and create new orders.

Custom Attribute Name	Description
MinOrderableQuantity	Minimum quantity that must be purchased of this item in a single order.
MaxOrderableQuantity	Maximum quantity that may be purchased of this item in a single order.
FreightClass	Dictates how (Scac and Service) and where (destination region) the product is eligible to ship.
DimensionalWeight	The “weight” used to calculate the shipping cost of bulky, lightweight packages.
DimensionalWeightUOM	Dimensional Weight Unit of Measure (for example, LBS).
ShippingChargeOverride	Item Override Shipping Charge (per unit charge).
ShippingSurchargeOverride	Item Override Shipping Surcharge (per unit surcharge).
EligibleToModify	Specifies whether the item quantity can be modified when an existing order is modified.
ProductID	Product ID that is displayed on the product page on the client site and on the ROM UI on the Item Search screen.
ProductTitle	Product title that is displayed on the product page on the client site and on the ROM UI on the Item Search screen.
ASSOCIATE_DELIVERY_ELIGIBLE	Specifies whether the item is eligible for same-day delivery by a store associate.

Item Master Feed

Overview

Schema

Item Types

Extended Attributes Elements

Dropship Required Elements

Custom Attributes

Item Master Examples

Various Item Types: ROM Implementation

Customization Item

Item Type: ROM plus Store Fulfillment Implementation

Item Type: Store Fulfillment

Item Type: Store Fulfillment with Dropship Manager

Donation Item

Gift Wrap Item

MERCH Item

MERCH Item - Omnichannel Eligibility

MERCH: Endless Aisle

MERCH: Item Dimensions

Package Type: Polybag

Physical Gift Card

PostSaleFulfillment Item

Refund Physical Gift Card

Refund Virtual Gift Card

Virtual Gift Card