iShip TDF API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| iShip |
AnyType |
Yes |
0 |
|
|
|
|
/iShip |
Root Element. Encapsulates message for Item Master. |
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/iShip/MessageHeader |
Encapsulates message Routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
1 |
|
/iShip/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 |
|
/iShip/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 |
|
/iShip/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 |
|
|
/iShip/MessageHeader/SourceData |
|
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/iShip/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 |
|
/iShip/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 |
|
|
/iShip/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving System. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/iShip/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 |
|
/iShip/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 |
|
/iShip/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 |
|
|
/iShip/MessageHeader/MessageData |
Encapsulates message identification information unique to the Radial Xchange. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
1 |
|
/iShip/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 |
|
/iShip/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 |
|
|
/iShip/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 |
|
|
/iShip/Item |
Item Level message |
| |
|
ItemId |
|
Yes |
0 |
1 |
1 |
|
|
/iShip/Item/ItemId |
Encapsulates the set of various references that can be used to identify an item/SKU. |
| |
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
|
/iShip/Item/ItemId/ClientItemId |
The retailer/client unique item ID or SKU used to identify this item. This item ID may not change or the new key is considered a new item. |
| |
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
|
/iShip/Item/ItemId/ClientAltItemId |
An Alternative item identifier provided by the client |
| |
|
|
ExtendedIDs |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/iShip/Item/ItemId/ExtendedIDs |
Allows for additional Item identifiers to be provided. |
| |
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Value |
|
Yes |
0 |
1 |
1 |
|
|
/iShip/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 |
|
|
/iShip/Item/ItemId/GTIN |
Global Trade Item Number also call 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 |
/iShip/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 |
|
|
/iShip/Item/ItemId/ManufacturerItemId |
The code assigned to the item by the manufacturer to uniquely identify the item. |
| |
|
BaseAttributes |
|
Yes |
0 |
1 |
1 |
|
|
/iShip/Item/BaseAttributes |
All BaseAttributes are required elements to establish and or update the item. |
| |
|
|
IPID |
String |
Yes |
0 |
1 |
1 |
0 |
32 |
/iShip/Item/BaseAttributes/IPID |
Internal control for grouping like items together. Used by the raiting process. Ignore by external client |
| |
|
|
ECCN |
String |
Yes |
0 |
1 |
1 |
0 |
32 |
/iShip/Item/BaseAttributes/ECCN |
: Export Classification Number; this lists required license classification in order to export from the United States. |
| |
|
|
ExportLicenseRequired |
String |
Yes |
0 |
1 |
1 |
0 |
4000 |
/iShip/Item/BaseAttributes/ExportLicenseRequired |
Is an export license required for selling |
| |
|
|
CountryOfOrigin |
|
Yes |
0 |
1 |
1 |
|
|
/iShip/Item/BaseAttributes/CountryOfOrigin |
Country of Origin/Manufacturing Country Code |
| |
|
HTSCodes |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/iShip/Item/HTSCodes |
|
| |
|
|
@mfn_duty_rate |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@destination_country |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@restricted |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
HTSCode |
String |
Yes |
1..n |
1 |
-1 |
|
|
/iShip/Item/HTSCodes/HTSCode |
|
| |
|
CustomAttributes |
|
No |
0 |
0 |
1 |
|
|
/iShip/Item/CustomAttributes |
CustomAttributes are name/value paris. A locale is included for the value. |
| |
|
|
Attribute |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/iShip/Item/CustomAttributes/Attribute |
|
| |
|
|
@lang |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@is_list |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@dt |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
@name |
|
Yes |
0 |
|
|
|
|
|
|
| |
@operation_type |
|
Yes |
0 |
|
|
|
|
|
|
| |
@catalog_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
@gsi_client_id |
|
Yes |
0 |
|
|
|
|
|
|
| |
|
|
|
Value |
String |
Yes |
1..n |
1 |
-1 |
1 |
|
/iShip/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 |