Item Master API Structure
|
| Field Name |
DataType |
Required |
Instances |
Min Usage |
Max Usage |
Min Length |
Max Length |
XPath |
Documentation |
| ItemMaster |
AnyType |
Yes |
0 |
|
|
|
|
/ItemMaster |
Root Element. Encapsulates message for Item Master. |
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/Standard |
Code identifying the schema controlling agency, for example, GSI.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
HeaderVersion |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/HeaderVersion |
Version of the message being used. Each new version whole number represents a significant change from a previous whole version and reflects a need for upgrades. For example, a change from Version 1.X to 2.X represents a substantial change in the framework and would be a recommended upgrade point. A change in the number after the decimal represents a minor upgrade/modification to the framework.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
VersionReleaseNumber |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/VersionReleaseNumber |
Release number within the current message header version number.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/MessageHeader/SourceData |
|
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/SourceData/SourceId |
Unique identifier of the System that originated the message. The SourceId is a unique identifier provided by the initiator of the message. For those messages originating from an Order Management System (OMS), it would be the unique OMS identifier. For those messages originating from a Warehouse Management System (WMS), it would be the unique WMS identifier.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
SourceType |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/SourceData/SourceType |
The descriptive category/name/code used to define the system that originated the message.
Allowable Values:
OMS = Order Management System
WMS = Warehouse Management System
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
DestinationData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving System. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/DestinationData/DestinationId |
Unique identifier of the System that is the intended recipient of the message. There can be multiple DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
DestinationType |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/DestinationData/DestinationType |
The descriptive category used to define the system that is the intended recipient of the message.
Allowable Values:
OMS = Order Management System,
WMS = Warehouse Management System,
FH= Fulfillment Hub.
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
EventType |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/EventType |
The name of the event to which the message pertains.
Allowable Values: Varies depending on the feed, for example InventoryStatus
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore. |
| |
|
MessageData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/MessageHeader/MessageData |
Encapsulates message identification information unique to the Radial Xchange. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/MessageHeader/MessageData/MessageId |
Globally unique identifier for each Message. The Message ID is populated from the Source system and must be a global identifier for Radial Xchange.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: In cases when the Product Hub or Fulfillment Hub originates the message, this field is the unique Business Process ID (BPID).
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
1 |
|
/ItemMaster/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier Radial Xchange Message to which this message relates.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
CreateDateAndTime |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source.
Allowable Values: ISO 8601 standard with offset from UTC in xsd:datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00.
Required: Yes
Length: Follows ISO 8601 standard with offset from UTC.
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore. |
| |
Item |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item |
Item Level message |
| |
|
ItemId |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ItemId |
Encapsulates the set of various references that can be used to identify an item/SKU. |
| |
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ItemId/ClientItemId |
The unique SKU-level identifier for the item. This is the retailer/client unique item ID or SKU. This is the primary key for the Item Master.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: This item ID may not change or the new key is considered a new item. StoreNet currently supports the length upto 30 Chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ItemId/ClientAltItemId |
An alternative item identifier provided by the client. The use of this field varies depending on the client and Radial reporting needs.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedIDs |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ItemId/ExtendedIDs |
Allows for additional Item identifiers to be provided. These IDs are not configured to automatically pass thru across all consumer systems. It needs to be coordinated with all potential consumer system before the data is sent by client. |
| |
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Value |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ItemId/ExtendedIDs/Value |
The value associated with the attribute.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
GTIN |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ItemId/GTIN |
Global Trade Item Number also called UPC in the US, IAN (formerly EAN) in Europe, and JAN in Japan. |
| |
|
|
@IdType |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@UPCType |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
IdNumber |
String |
Yes |
0 |
1 |
1 |
1 |
18 |
/ItemMaster/Item/ItemId/GTIN/IdNumber |
The actual value of the ID.
Allowable Values: Text string
Required: Yes
Length: 18
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 14 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ManufacturerItemId |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ItemId/ManufacturerItemId |
The code assigned to the item by the manufacturer to uniquely identify the item.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
BaseAttributes |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes |
All BaseAttributes are required elements to establish and or update the item. |
| |
|
|
CatalogClass |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/BaseAttributes/CatalogClass |
Specifies how an item displays in a catalog.
Allowable Values:
always - always display the item
nosale - never display the item
regular - use web store rules to determine if the item is displayed
Required: Yes
Length: 15
Default Value: regular
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
IsDropShipped |
Boolean |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/IsDropShipped |
Specifies if this item can be fulfilled using a drop shipper.
Allowable Values:
false - item cannot be fulfulled using a drop shipper
true - item can be fulfilled using a drop shipper
Required: Yes
Length: TBD
Default Value: false
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ItemDescription |
String |
Yes |
0 |
1 |
1 |
1 |
120 |
/ItemMaster/Item/BaseAttributes/ItemDescription |
Short description of the item used in the OMS and WMS in the catalog�s base language. Stores having group sales must send a meaningful item description in the item master since the content feed is not loaded into OMS.
Allowable Values: Text string
Required: Yes
Length: 120
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 100 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ItemType |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/BaseAttributes/ItemType |
Specifies the type of item. Not restricted by the schema.
Allowable Values:
- Custom - Customization SKUs. A virtual item that represents a charge to the consumer to customize an item as well as a description of the customization options selected by the customer.
- Donation - Donation SKU. A virtual item that represents a consumer's donation to a charitable cause.
- GC - Physical Gift Cards.
- GiftMessage - This item is a Gift Message.
- GiftWrap - Physical Gift Wrap.
- Merch - A typical physically-fulfilled item.
- OGC - Online Gift Certificates that are hosted/processed by Radial. They are our in-house product for gift certificates that don�t have a physical card associated with them (only a payment account number and PIN).
PostSaleFulfillment - Post-sale fulfillment SKU. A virtual item that needs to be classified separately from other virtual sku types such as Donation or Warranty SKUs.
- RefundOGC - Refund Online Gift Certificate. 'Refund' 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. 'Refund' used for accounting purposes to differentiate Refunds from the original tender.
- VGC - Functionally similar to OGC�s except they are processed by a 3rd-party gift-card provider (ex: SVS or ValueLink).
- Warranty - Product warranty. A virtual item representing a warranty purchased for another physical item on the order.
- WarrantyDep - This item is a dependent warranty. May only be purchased with another item. Is not included in search results.
- WarrantyAloneAndDep - Warranty item may be sold independently or with the purchase of another item. Is included in search results.
- InstallSvcDep - This item is a type of installation service that maybe purchase with another item. When searching this item is not returned in the search results. This item may not be purchased alone.
- InstallSvcAloneAndDep - this item is a type of installation service that maybe purchased independently or with another item. When searching this item may be in the results.
Required: Yes
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ItemStatus |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/BaseAttributes/ItemStatus |
Indicates an item's availabliity.
Allowable Values:
- Active
- Inactive (item is not displayed in catalog)
- Discontinued
Required: Yes
Length: 15
Default Value: active
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
TaxCode |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/BaseAttributes/TaxCode |
The Radial-assigned tax group to which the item belongs.
Allowable Values: Text string
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
Hierarchy |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/Hierarchy |
Encapsulates the merchandise structure for the item. Primarily used for reporting. The hierarchy is client-defined. One example of use, by an apparel company might be as follows:
Department = client name
SubDepartment = Male, Female
Class = If the SubDepartment is "Femaile", possible classes might be "blouses", "pants", "shoes" "accessories", etc. |
| |
|
|
|
DeptNumber |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/Hierarchy/DeptNumber |
Product Hierarchy Level 1 (Dept).
Allowable Values: Integer
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 3 chars.
Aliases: N/A
Offering: Exchange Platform, Webstore. |
| |
|
|
|
DeptDescription |
String |
No |
0 |
0 |
1 |
0 |
25 |
/ItemMaster/Item/BaseAttributes/Hierarchy/DeptDescription |
Product Hierarchy Level 1 description.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore
Offering: Magento, Interfaces and Tools |
| |
|
|
|
SubDeptNumber |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/Hierarchy/SubDeptNumber |
Product Hierarchy Level 2 (Sub-Dept).
Allowable Values: Integer
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 3 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
SubDeptDescription |
String |
No |
0 |
0 |
1 |
0 |
25 |
/ItemMaster/Item/BaseAttributes/Hierarchy/SubDeptDescription |
Product Hierarchy Level 2 description.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
|
ClassNumber |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/Hierarchy/ClassNumber |
Product Hierarchy Level 3 (Class).
Allowable Values: Integer
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 3 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
ClassDescription |
String |
No |
0 |
0 |
1 |
0 |
25 |
/ItemMaster/Item/BaseAttributes/Hierarchy/ClassDescription |
Product Hierarchy Level 3 description.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
SubClass |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BaseAttributes/Hierarchy/SubClass |
SubClass code.
Allowable Values: Integer
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 3 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
SubClassDescription |
String |
No |
0 |
0 |
1 |
0 |
25 |
/ItemMaster/Item/BaseAttributes/Hierarchy/SubClassDescription |
SubClass description.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
BundleContents |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/BundleContents |
Determines items included if this is a bundle product. |
| |
|
|
BundleItems |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/BundleContents/BundleItems |
Each Bundleitems element contains an itemID and an action used to modify a bundle. There is one BundleItems occurrence for each product in a bundle. |
| |
|
|
|
ItemID |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BundleContents/BundleItems/ItemID |
The client or vendor ID for the item to be included in the bundle.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@catalog_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
@ship_together |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Quantity |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/BundleContents/BundleItems/Quantity |
How many of the Item ID is in the bundle.
Allowable Values: Integer
Required: Yes
Length: TBD
Default Value: 1
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools
Offering: Exchange Platform, Webstore |
| |
|
DropShipSupplierInformation |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/DropShipSupplierInformation |
If this item is fulfilled by a Drop Shipper then Supplier Number, Supplier Name, and Supplier Part Number are required. Without the three values, the FILE will be rejected. |
| |
|
|
SupplierPrefix |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/DropShipSupplierInformation/SupplierPrefix |
DropShip Supplier Prefix which indicates if the PO for this Item is Client Paid (e.g. 350) or Radial Paid (e.g. 290).
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SupplierName |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/DropShipSupplierInformation/SupplierName |
Name of the Drop Ship Supplier fulfilling the item.
Allowable Values: Text string
Required: Yes
Length: 462
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
SupplierNumber |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/DropShipSupplierInformation/SupplierNumber |
Unique Radial-assigned code for this supplier.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: VendorNet and StoreNet can only support upto 10 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
SupplierPartNumber |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/DropShipSupplierInformation/SupplierPartNumber |
ID or SKU used by Supplier to identify this item.
Allowable Values:
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
ExtendedAttributes |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes |
ExtendedAttributes are named attributes most with known default values. None are required. Some may have required elements in the group if the group is included. |
| |
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
ItemTitle |
String |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemTitle |
ItemTitle to support Multi-Locale for StoreNet
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
IspEligible |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/IspEligible |
Required for StoreNet |
| |
|
|
InventoryCheckEligible |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/InventoryCheckEligible |
Required for StoreNet |
| |
|
|
IspReserveEligible |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/IspReserveEligible |
Required for StoreNet |
| |
|
|
StsEligible |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/StsEligible |
Required for StoreNet |
| |
|
|
SfsEligible |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SfsEligible |
Required for StoreNet |
| |
|
|
SubscriptionAttributes |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes |
Will be used for subcription like magazines etc |
| |
|
|
|
SubscriptionEligible |
Boolean |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes/SubscriptionEligible |
Defines if the item is eligible for subscription or not. allowed values are true or false. |
| |
|
|
|
SubscriptionType |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes/SubscriptionType |
Allowed values - Fixed and Recurring. The Fixed subscription is tied very much to a SKU where the frequency and max duration is very much fixed and can't be altered by customer during checkout. Recurring is open ended where customer can select a frequency at which the item needs to be subscribed. |
| |
|
|
|
SubscriptionFrequency |
String |
No |
0 |
0 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes/SubscriptionFrequency |
Defines a frequency at which the item needs to be subscribed. e.g. weekly, monthly, bi-weekly, daily. This can't be altered for fixed subscription. This can be a comma separated list or single value depending on how the web store is configured. |
| |
|
|
|
MaxSubscriptionInterval |
String |
No |
0 |
0 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes/MaxSubscriptionInterval |
This defines the max duration for a fixed subscription. e.g. 1 year. |
| |
|
|
|
SubscriptionStartDate |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SubscriptionAttributes/SubscriptionStartDate |
Not Supported currently, for future use only. This would enable the future start date of any susbcription, currently the subscription start as sonn as it is selected. |
| |
|
|
AllowGiftMessage |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/AllowGiftMessage |
If this flag is false the customer cannot add a gift message to the item.
Allowable Values: Boolean.
Required: No
Length: TBD
Default Value: true
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
Brand |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Brand |
Encapsulates the selling name and description used to identify a product for advertising purposes. |
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Brand/Name |
The selling and promotional name used to identify a product for advertising and name recognition purposes.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 30 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Description |
String |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Brand/Description |
Short Description of the selling and promotional name used to identify a product for advertising and name recognition purposes.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
Buyer |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Buyer |
Encapsulates the information related to the individual/organization responsible for the procurement of the merchandise. |
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Buyer/Name |
The name of the individual/organization responsible for the procurement of the merchandise within the purchase order.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
BuyerId |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Buyer/BuyerId |
Specifies the individual/organization responsible for the purchase of the merchandise in the purchase order message.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
ColorAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ColorAttributes |
Item color or colors. Localized. Repeat per Language. |
| |
|
|
|
Color |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ColorAttributes/Color |
StoreNet and VendorNet can only support upto 10 chars for Color Code and 20 chars for Color Description. |
| |
|
|
|
|
|
Code |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/ColorAttributes/Color/Code |
Identifies unique color variant for the item.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: OMS 40 character limit
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Description |
String |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ColorAttributes/Color/Description |
Description of unique color variant for the item.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
|
|
|
Sequence |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ColorAttributes/Color/Sequence |
|
| |
|
|
CompanionFlag |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/CompanionFlag |
Specifies if the item is a companion or can be shipped alone.
Allowable Values:
Yes - this item may ship alone.
No - this item is canceled if not shipped with companion,
Maybe - other factors decide.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
CountryOfOrigin |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/CountryOfOrigin |
A country in which goods were completely derived or manufactured.
Allowable Values: Text string
Required: No for domestic shipments but yes for international shipments.
Length: 2
Default Value: blank
Restrictions: Follow the ISO 3166 two letter/alpha format. http://www.iso.org/iso/country_codes.htm
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
FulfillmentOverride |
String |
No |
0 |
0 |
1 |
0 |
40 |
/ItemMaster/Item/ExtendedAttributes/FulfillmentOverride |
Ability to control the fulfillment of an item. This allows clients to override the fulfillment sourcing for any given item. for e.g. "StoreOnly", "WarehouseOnly", "DC001Only."
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: Needs to be pre-agreed on the values before sending on item master.
Aliases: N/A
Offering: SOMS, Interfaces and Tools |
| |
|
|
GiftCardFacing |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/GiftCardFacing |
A free text description of the facing or style this gift card represents.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
GiftCardTenderCode |
String |
No |
0 |
0 |
1 |
0 |
3 |
/ItemMaster/Item/ExtendedAttributes/GiftCardTenderCode |
Type of gift card to be used for activation.
Allowable Values:
SD TRU DIGITAL GIFT CARD
SP SVS Physical Gift Card
ST SmartClixx Gift Card Canada
SV SVS Virtual Gift Card
SX SmartClixx Gift Card
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
MaxGCAmount |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MaxGCAmount |
MaxGCAmount which is mandatory if the Item is Gift Item.
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
HazardousMaterialCode |
String |
No |
0 |
0 |
1 |
0 |
4 |
/ItemMaster/Item/ExtendedAttributes/HazardousMaterialCode |
Indicates if the item is considered hazardous material.
Offering: Magento, SOMS, Interfaces and Tools. VendorNet and StoreNet only support the boolean flag if an item is Hazardous or not. Any value sent in item would be considered as Hazardous in case of VendorNet and StoreNet. |
| |
|
|
IsEligibleForInstallationService |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/IsEligibleForInstallationService |
Specifies if this item is eligible for an installation service.
Allowable Values: Boolean
true - item is eligible for an installation service
false - item is not eligible for an installation service
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
IsEligibleForWarranty |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/IsEligibleForWarranty |
Specifies if this item is eligible for a warranty purchase.
Allowable Values: Boolean
true - item is eligible for a warranty purchase
false - item is not eligible for a warranty purchase
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
IsHiddenProduct |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/IsHiddenProduct |
Indicates that a product is not included in displays or in emails.
Allowable Values: Boolean
true - item is included in displays and emails
false - item is not included in displays and emails
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
ItemDimension |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension |
Encapsulates the dimensional information used to describe the physical measurements of an item. |
| |
|
|
|
Display |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display |
Dimension for displaying on the page or store. |
| |
|
|
|
|
Mass |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Mass |
Weight of item used for Display. |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Weight |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Mass/Weight |
The numeric part of the item's weight. Used with the unit of measure.
Allowable Values: Deciman
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet requires the weight for all SFS eligible products. StoreNet and VendorNet can only support a single UOM per catalog for all items.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
Packaging |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Packaging |
Item dimensions within a package. |
| |
|
|
|
|
|
Width |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Packaging/Width |
The item's width, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
|
Length |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Packaging/Length |
The item's length, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Height |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Display/Packaging/Height |
The item's height, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
Shipping |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping |
Dimensions for shipping the item. |
| |
|
|
|
|
Mass |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Mass |
Weight of item used for shipping. |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Weight |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Mass/Weight |
The numeric part of the item's weight. Used with the unit of measure.
Allowable Values: Deciman
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet requires the weight for all SFS eligible products. StoreNet and VendorNet can only support a single UOM per catalog for all items.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
Packaging |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Packaging |
Item dimensions within a package. |
| |
|
|
|
|
|
Width |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Packaging/Width |
The item's width, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
|
Length |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Packaging/Length |
The item's length, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Height |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Shipping/Packaging/Height |
The item's height, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
Carton |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton |
Dimensions of a carton of the item. |
| |
|
|
|
|
Mass |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Mass |
Weight of a carton of the item. |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Weight |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Mass/Weight |
The numeric part of the item's weight. Used with the unit of measure.
Allowable Values: Deciman
Required: Yes
Length: TBD
Default Value: blank
Restrictions: StoreNet requires the weight for all SFS eligible products. StoreNet and VendorNet can only support a single UOM per catalog for all items.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
Packaging |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Packaging |
Item dimensions within a carton package. |
| |
|
|
|
|
|
Width |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Packaging/Width |
The item's width, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
|
Length |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Packaging/Length |
The item's length, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
|
@unit_of_measure |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Height |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ItemDimension/Carton/Packaging/Height |
The item's height, made using the unit of measure.
Allowable Values: Decimal
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
CartonType |
String |
No |
0 |
0 |
1 |
0 |
100 |
/ItemMaster/Item/ExtendedAttributes/ItemDimension/CartonType |
Used in combination with Ship Group to determine how the order is released by the OMS. CartonType is determined on a per client basis.
Allowable Values: Text string
Required: No
Length: 100
Default blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
LotTrackingIndicator |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/LotTrackingIndicator |
Indicates if the item's lot assignment is required to be tracked.
Allowable Values: Boolean
True = Yes
False = No.
Required: No
Length: TBD
Default Value: False
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
LTLFreightCost |
Decimal |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/LTLFreightCost |
LTL freight cost for the item.
Allowable Values: Decimal
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
ManufacturingDate |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ManufacturingDate |
The date which the item was built/assembled by the manufacturer.
Allowable Values: ISO 8601 standard with offset from UTC in xsd:datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00.
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
Manufacturer |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Manufacturer |
Encapsulates information related to the individual/organization that built/assembled the item. |
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Manufacturer/Name |
Company Name of the Manufacturer.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
|
ManufacturerId |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Manufacturer/ManufacturerId |
A unique identifier to denote the Item Manufacturer.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
MarketPlaceAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MarketPlaceAttributes |
Known and custom attributes used by and for Market Place Integration. Named elements are stored as name@type. Type is the attribute of MarketPlace. |
| |
|
|
|
MarketPlace |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MarketPlaceAttributes/MarketPlace |
An individual Market Place identified by mp_name that the attributes are associated with. |
| |
|
|
|
|
Attribute |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MarketPlaceAttributes/MarketPlace/Attribute |
|
| |
|
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
@is_list |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
@dt |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@eligible |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
|
Value |
String |
Yes |
1..n |
1 |
-1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/MarketPlaceAttributes/MarketPlace/Attribute/Value |
The value for this custom attribute. Repeat ONLY if is_list is true.
Allowable Values: Text string
Required: Yes
Length: 4000
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 100 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
MayShipExpedite |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MayShipExpedite |
Specifies if the vendor can ship expedited shipments.
Allowable Values: Boolean
false - do not offer overnight or 2-day shipment method on the webstore.
true - offer overnight or 2-day shipment method on the webstore
Required: No
Length: TBD
Default Value: true
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
MayShipInternational |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MayShipInternational |
Currently we have only US vendors but we should also consider international vendors. For international vendors, a US address is an international shipping address. This must be discussed directly with the vendors.
Allowable Values: Boolean
false - do not offer international shipping.
true - offer international shipping
Required: No
Length: TBD
Default Value: true
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
MayShipUSPS |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MayShipUSPS |
Specifies if this item can be shipped via US Postal Service? Default is true.
Allowable Values: Boolean
false - do not offer US Postal Service shipping.
true - offer US Postal Service shipping
Required: No
Length: TBD
Default Value: true
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
MSRP |
Decimal |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/MSRP |
The list price of the item. Used for displaying was/is pricing in the web store.
Allowable Values: Decimal
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
Price |
Decimal |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Price |
Price item is sold at, pre promotions. Price changes are controlled using the Pricing Feed. WARNING - Sending in a CHANGE will cause a price event override.
Allowable Values: Decimal
Required: Required if and only if client has one store and this is a new item.
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
SafetyStock |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SafetyStock |
Not supported. |
| |
|
|
SalesClass |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SalesClass |
Based on inventory availablity, determines product display behavior for the item in the web store.
Allowable Values:
stock - Item is cartable if inventory is available and street date has passed.
AdvanceOrderOpen - Inventory is not checked for add to cart.
AdvanceOrderLimited - Item is cartable if inventory is available regardless of street date.
backOrderLimited - works as AdvanceOrderLimited for Webstore and AdvanceOrderOpen for OMS. In other words, Item when there is no inventory then Webstore doesn't take any new order but all orders captured in OMS will be backordered.
Required: No
Length: 25
Default Value: stock
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
SerialNumberType |
String |
No |
0 |
0 |
1 |
0 |
2 |
/ItemMaster/Item/ExtendedAttributes/SerialNumberType |
Type of serial number to be scanned.
Allowable Values: Text string. Examples:
blank � no serial number
GC � gift card
EC � electronic serial number
Required: No
Length: 2
Default Value: blank
Restrictions: VendorNet and StoreNet only support the boolean flag if an item needs to be captured for serial number or not. Any value sent in item would be considered as 'Y' in case of VendorNet and StoreNet.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ServiceIndicator |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ServiceIndicator |
Identifies if the item is a service, for example, clothing embroidery, product monogramming, hemming, etc.
Allowable Values: Boolean
true - item is a service
false - item is not a service
Required: No
Length: TBD
Default Value: false
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
SetInfiniteInventory |
String |
No |
0 |
0 |
1 |
0 |
1 |
/ItemMaster/Item/ExtendedAttributes/SetInfiniteInventory |
Ability to set the infinite inventory for any particular item, this is mainly used for items like warranties, virtual items, gift cards , customizations or any other service items.
Allowable Values: Y/N
Required: No
Length: 1
Default Value: N
Restrictions: N/A
Aliases: N/A
Offering: SOMS, Interfaces and Tools |
| |
|
|
ShipGroup |
String |
No |
0 |
0 |
1 |
0 |
20 |
/ItemMaster/Item/ExtendedAttributes/ShipGroup |
Items with the same ShipGroup name can be shipped together.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ShipWindowMinHour |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ShipWindowMinHour |
Minimum number of hours before the item may ship.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
ShipWindowMaxHour |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/ShipWindowMaxHour |
Maximum number of hours before the item may ship.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
SizeAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SizeAttributes |
Item size. Localized. Repeat per Language. |
| |
|
|
|
Size |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SizeAttributes/Size |
StoreNet and VendorNet can only support upto 10 chars for Size Code and 20 chars for Size Description. |
| |
|
|
|
|
Code |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/SizeAttributes/Size/Code |
Allowable Values: Text string.
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
Description |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/SizeAttributes/Size/Description |
Allowable Values: Text string.
Required: Yes
Length: 255
Default Value: blank
Restrictions: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
SplitToOne |
Boolean |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/SplitToOne |
Triggers OMS to split a line item with multiple quantity into multiple individual line items with a quantity each of 1. Usually used for electronics with serial numbers and for gift cards.
Allowable Values: Boolean
true - split line item into multiple lines
false - do not split line item into multiple lines
Required: No
Length: TBD
Default Value: false
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
|
StreetDate |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/StreetDate |
Earliest date the OMS will allocate the product.
Allowable Values: Date
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
Style |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Style |
Encapsulation of Style ID and Description. |
| |
|
|
|
StyleID |
|
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Style/StyleID |
A code that identifies the specific appearance type or variety in which an item is available.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
|
StyleDescription |
String |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Style/StyleDescription |
A short description or title of the style for the item.
Allowable Values: Text string
Required: No
Length: 255
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 100 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
|
Supplier |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Supplier |
Encapsulates the information related to the agency providing the goods or materials. |
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Supplier/Name |
The name of the individual/organization responsible for providing/supplying the merchandise identified within the purchase order.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
SupplierId |
String |
No |
0 |
0 |
1 |
0 |
50 |
/ItemMaster/Item/ExtendedAttributes/Supplier/SupplierId |
Specifies the individual/organization that acts as a source for merchandise and services offered for sale, or for supplies and services consumed by the buyer and/or client.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
SupplierPartNumber |
String |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Supplier/SupplierPartNumber |
Specifies Buyer and/or Client assigned SupplierPartNumber
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
Surcharges |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Surcharges |
Encapsulates information about fees and surcharges. |
| |
|
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@currency_code |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Charge |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Surcharges/Charge |
Amount/Values of the surcharge. |
| |
|
|
@currency_code |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
UnitCost |
Decimal |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/UnitCost |
Encapsulates the information necessary to determine the individual cost per unit of measure for the merchandise.
Offering: Magento, Interfaces and Tools |
| |
|
|
Warranty |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Warranty |
Used when item is a warranty type. |
| |
|
|
|
Code |
String |
No |
0 |
0 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/Warranty/Code |
Warranty Code (Need additional description) |
| |
|
|
|
PriceProvider |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ItemMaster/Item/ExtendedAttributes/Warranty/PriceProvider |
Determines the cost calucaltion. Valid values are FixedPrice, PriceRange, and Precentage.
Allowable Values:
- FixedPrice is the value provided in the Pricing Event feed.
- Precentage is used to calacute the value based on the item this warranty relates to in the cart.
- PriceRange is for a warranty based on the value of the cart.
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
TimePeriod |
String |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Warranty/TimePeriod |
The warranty time period says how long a warranty protects your product.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Type |
String |
No |
1..n |
0 |
-1 |
|
|
/ItemMaster/Item/ExtendedAttributes/Warranty/Type |
The warranty type (product warranty, manufacturer's warranty or service plan).
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Magento, Interfaces and Tools |
| |
|
CustomAttributes |
|
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/CustomAttributes |
CustomAttributes are name/value pairs. A locale is included for the value. |
| |
|
|
Attribute |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/CustomAttributes/Attribute |
|
| |
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@is_list |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@dt |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Value |
String |
Yes |
1..n |
1 |
-1 |
1 |
|
/ItemMaster/Item/CustomAttributes/Attribute/Value |
The value for this custom attribute. Repeat ONLY if is_list is true.
Allowable Values: Text string
Required: Yes
Length: 4000
Default Value: blank
Restrictions: StoreNet and VendorNet can only support upto 100 chars.
Aliases: N/A
Offering: Magento, SOMS, Interfaces and Tools |
| |
|
EB2C |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/EB2C |
Used by Exchange Platform clients only. Encapsulates required URLs and information. |
| |
|
|
ItemImageURLs |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/EB2C/ItemImageURLs |
Encapsulate Item Image URLs. |
| |
|
|
|
@type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@view |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@height |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@width |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
ImageURL |
|
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/EB2C/ItemImageURLs/ImageURL |
|
| |
|
|
ItemURLs |
AnyType |
No |
0 |
0 |
1 |
|
|
/ItemMaster/Item/EB2C/ItemURLs |
Encapsulate Item URLs. An Item URL provides a link to a family, product, or cart page. |
| |
|
|
|
@type |
|
Yes |
0 |
|
|
|
|
|
|
| |
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
@catalog_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
@gsi_client_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
ItemURL |
|
Yes |
1..n |
1 |
-1 |
|
|
/ItemMaster/Item/EB2C/ItemURLs/ItemURL |
|