Content Feed API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| ContentMaster |
AnyType |
Yes |
0 |
|
|
|
|
/ContentMaster |
Root Element. Encapsulates message for Content Master. |
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/MessageHeader |
Encapsulates message Routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
|
/ContentMaster/MessageHeader/SourceData |
|
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
|
/ContentMaster/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving System. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
|
/ContentMaster/MessageHeader/MessageData |
Encapsulates message identification information unique to the Radial Xchange. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/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 |
|
/ContentMaster/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 |
|
|
/ContentMaster/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. |
| |
|
Content |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content |
Content to describe the Style or Product. |
| |
|
|
UniqueID |
|
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/UniqueID |
Item, Style, or Slice (e.g., color or size variation) for this Product or Item. A Style may reference a group of items.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
StyleID |
String |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/StyleID |
For style level content, the style ID is a duplicate of UniqueID. For Item Level content, StyleID is reference information stored as a custom attribute.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ProductLinks |
AnyType |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ProductLinks |
List of related products. Includes support of any number of relationship types. |
| |
|
|
|
ProductLink |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content/ProductLinks/ProductLink |
This list of links is used to create a new list or replace an existing list of links. |
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@position |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@link_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
LinkToUniqueID |
|
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/ProductLinks/ProductLink/LinkToUniqueID |
The Unique ID used to for this link. This Item or Style must exist when the feed is received.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CategoryLinks |
AnyType |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/CategoryLinks |
Establish links to categories. |
| |
|
|
|
CategoryLink |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content/CategoryLinks/CategoryLink |
|
| |
|
|
|
@import_mode |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@default |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@catalog_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
Name |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/Content/CategoryLinks/CategoryLink/Name |
Name of the category (catalog) to link this product.
Allowable Values: Text string
Required: Yes
Length: 132
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
BaseAttributes |
|
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/BaseAttributes |
Required attributes when adding or updating the product. |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Title |
String |
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content/BaseAttributes/Title |
Title for product/style. Required for base locale. Localized.
Allowable Values: Text string
Required: Yes
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
|
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes |
These are known attributes commonly defined. Some may contain data restrictions. |
| |
|
|
|
ColorAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/ColorAttributes |
|
| |
|
|
|
|
Color |
|
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content/ExtendedAttributes/ColorAttributes/Color |
|
| |
|
|
|
|
|
|
Code |
String |
Yes |
0 |
1 |
1 |
1 |
|
/ContentMaster/Content/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 |
|
|
/ContentMaster/Content/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 |
|
|
/ContentMaster/Content/ExtendedAttributes/ColorAttributes/Color/Sequence |
|
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
DisplayCountryOfOrigin |
String |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/DisplayCountryOfOrigin |
A country in which goods were completely derived or manufactured. Used for display purpose only.
Allowable Values: Text string.
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
FabricContent |
String |
No |
1..n |
0 |
-1 |
|
|
/ContentMaster/Content/ExtendedAttributes/FabricContent |
Description of materials used in style fabric.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftWrap |
String |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/GiftWrap |
Spedifies if this item can be gift wrapped.
Allowable Values:
true - product can be gift wrapped
false - product cannot be gift wrapped
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
LongDescription |
String |
No |
1..n |
0 |
-1 |
|
|
/ContentMaster/Content/ExtendedAttributes/LongDescription |
A long description of the style or product.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
SearchKeywords |
String |
No |
1..n |
0 |
-1 |
|
|
/ContentMaster/Content/ExtendedAttributes/SearchKeywords |
Contains the search terms you want to associate with this product.
Allowable Values: Text string. Enter keywords associated with this product. Separate keywords with a pipe ( | ) character. Multi-word keywords are supported.
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
ShortDescription |
String |
No |
1..n |
0 |
-1 |
|
|
/ContentMaster/Content/ExtendedAttributes/ShortDescription |
A short description of the style or product.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftCard |
AnyType |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/GiftCard |
|
| |
|
|
|
|
Digital |
Boolean |
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/GiftCard/Digital |
True or False indicator if this gift card is digital. Digital is electronic, no physical object. |
| |
|
|
|
|
MessageMaxLength |
|
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/GiftCard/MessageMaxLength |
Maximum length of a message inlcuded with the gift card. |
| |
|
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
CardFacingDisplayName |
String |
Yes |
0 |
1 |
1 |
|
|
/ContentMaster/Content/ExtendedAttributes/GiftCard/CardFacingDisplayName |
Text description of the label applied to the selection field for the gift card. Example: the web page may show "Gift Card Facing". |
| |
|
|
CustomAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/ContentMaster/Content/CustomAttributes |
Allow 0 or more custom attributes. Spelling and case important. Names are defined during the design phase to be included on a page or used on a site. |
| |
|
|
|
Attribute |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/ContentMaster/Content/CustomAttributes/Attribute |
|
| |
|
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@is_list |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@dt |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
@catalog_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
@gsi_store_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
@varattrib_01 |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
@gsi_client_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
|
Value |
String |
Yes |
1..n |
1 |
-1 |
1 |
|
/ContentMaster/Content/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 |