API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| OrderShipment |
AnyType |
Yes |
0 |
|
|
|
|
/OrderShipment |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrderShipment/MessageHeader/Standard |
Code identifying the schema controlling agency. |
| |
|
HeaderVersion |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrderShipment/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. |
| |
|
VersionReleaseNumber |
String |
Yes |
0 |
1 |
1 |
|
15 |
/OrderShipment/MessageHeader/VersionReleaseNumber |
Release number within the current message header version number. |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system. |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrderShipment/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. |
| |
|
|
SourceType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrderShipment/MessageHeader/SourceData/SourceType |
The descriptive category/name/code used to define the system that originated the message. OMS = Order Management System, WMS = Warehouse Management System. |
| |
|
DestinationData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrderShipment/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrderShipment/MessageHeader/DestinationData/DestinationId |
Unique identifier of the System that is the intended recipient of the message. There can be more than one DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems. |
| |
|
|
DestinationType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrderShipment/MessageHeader/DestinationData/DestinationType |
The descriptive category used to define the system that is the intended recipient of the message. OMS = Order Management System, WMS = Warehouse Management System. |
| |
|
EventType |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrderShipment/MessageHeader/EventType |
The name of the event to which the message pertains. |
| |
|
MessageData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/MessageHeader/MessageData |
Encapsulates message identification information. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrderShipment/MessageHeader/MessageData/MessageId |
Globally unique identifier for each message. The MessageId will be populated from the source system. |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrderShipment/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier message to which this message relates. |
| |
|
CreateDateAndTime |
|
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source. Follows ISO 8601 standard with offset from UTC. |
| |
OrderShipmentData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrderShipment/OrderShipmentData |
Data structure containing all order shipment data. For multiple order shipments, this section is repeated within the message. |
| |
|
OrderShipmentHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentHeader |
Header level information. |
| |
|
|
ClientId |
String |
No |
0 |
0 |
1 |
|
32 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ClientId |
The identifier provided by Radial for an individual or organization. |
| |
|
|
FacilityId |
String |
Yes |
0 |
1 |
1 |
|
32 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/FacilityId |
Unique identifier assigned to the facility housing the goods. Typically a distribution center or physical warehouse. |
| |
|
|
ExternalFacilityId |
String |
No |
0 |
0 |
1 |
|
32 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExternalFacilityId |
The unique identifier that maps to what an external client/facility uses to identify their facility. |
| |
|
|
OMSOrderId |
|
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentHeader/OMSOrderId |
The OMS OrderId created internally by the OMS. The OMS Order ID is a combination of the 12-digit OMS order number and the 3-digit release sequence. |
| |
|
|
CustomerOrderId |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/CustomerOrderId |
The Order ID that is visible to the consumer, typically this is known as the web order ID. |
| |
|
|
TaxInvoiceType |
String |
No |
0 |
0 |
1 |
|
15 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/TaxInvoiceType |
Tax Type. Ex, VAT. |
| |
|
|
TaxInvoiceId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/TaxInvoiceId |
If a VAT invoice is sent with the shipment, this is the VAT invoice ID. Typically the base VAT invoice ID is supplied in the OrdersToFulfill feed (ex 8765445) and the appended counter (-001 or -002) is included by the warehouse when an order shipment is split. If the order is not split, then no appended value is included. |
| |
|
|
ExternalShipmentId |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExternalShipmentId |
A third-party fulfillers shipment identifier. |
| |
|
|
OrderShipDateTime |
|
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentHeader/OrderShipDateTime |
The date and time in which the order was shipped from the facility or cancelled at facility. This is required in case of order shipments. Follows ISO 8601 standard with offset from UTC in xsd datetime format. |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentHeader/ExtendedAttributes/Value |
The specific value of the additional attribute. |
| |
|
OrderShipmentDetail |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail |
Detailed shipment information. |
| |
|
|
LineNumber |
|
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/LineNumber |
The line number in the order. |
| |
|
|
LineStatus |
String |
Yes |
0 |
1 |
1 |
|
2 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/LineStatus |
The status of the line.
Allowable Values:
B0 - Back ordered
S - Shipped
X - Cancelled
T - Multiple Tracking for same line when split shipment happens wihout knowledge of the actual quantity in each box
Required: Yes
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CancelReasonCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/CancelReasonCode |
The facility-supplied cancel reason code for items that are cancelled. |
| |
|
|
ItemId |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId |
Structure containing information on the shipped item. |
| |
|
|
|
GsiCatalogId |
String |
No |
0 |
0 |
1 |
|
4 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/GsiCatalogId |
This Radial-assigned value specifies to which catalog an item belongs. An item may belong to only one catalog. Used to cross category link products.
Allowable Values: Text string
Required: Yes either at standard element level or thru extended attributes.
Length: 4
Restrictions: The catalog ID must exist in the Radial system. |
| |
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ClientItemId |
The retailer's/client's/partner's SKU number or unique item identifier. (Partner Item Number) |
| |
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/OMSItemId |
The Order Management Systems internally assigned SKU or unique item identifier. |
| |
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ClientAltItemId |
An Alternative item identifier provided by the client. Typically used for reference information only and not to identify/locate an item. |
| |
|
|
|
ReplacementItemId |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ReplacementItemId |
Structure containing information on the item used as a replacement. |
| |
|
|
|
|
GsiCatalogId |
String |
No |
0 |
0 |
1 |
|
4 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ReplacementItemId/GsiCatalogId |
This Radial-assigned value specifies to which catalog an item belongs. An item may belong to only one catalog. Used to cross category link products.
Allowable Values: Text string
Required: Yes either at standard element level or thru extended attributes.
Length: 4
Restrictions: The catalog ID must exist in the Radial system. |
| |
|
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ReplacementItemId/ClientItemId |
The retailer's/client's/partner's SKU number or unique item identifier. (Partner Item Number) |
| |
|
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ReplacementItemId/OMSItemId |
The Order Management Systems internally assigned SKU or unique item identifier. |
| |
|
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ReplacementItemId/ClientAltItemId |
An Alternative item identifier provided by the client. Typically used for reference information only and not to identify/locate an item. |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ItemId/ExtendedAttributes/Value |
The specific value of the additional attribute. |
| |
|
|
QuantityShipped |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/QuantityShipped |
The number of items shipped. |
| |
|
|
QuantityCancelled |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/QuantityCancelled |
The number of items cancelled from the order. |
| |
|
|
QuantityBackordered |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/QuantityBackordered |
The number of items placed on backorder. |
| |
|
|
PricePaidInStore |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/PricePaidInStore |
|
| |
|
|
StoreAddress |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress |
Encapsulates the store address. |
| |
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/CompanyName |
|
| |
|
|
|
AddressLine1 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/AddressLine1 |
|
| |
|
|
|
AddressLine2 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/AddressLine2 |
|
| |
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/AddressLine3 |
|
| |
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/City |
|
| |
|
|
|
StateOrProvince |
String |
No |
0 |
0 |
1 |
|
35 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/StateOrProvince |
|
| |
|
|
|
CountyOrLocality |
String |
No |
0 |
0 |
1 |
|
20 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/CountyOrLocality |
|
| |
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/CountryCode |
|
| |
|
|
|
PostalCode |
String |
No |
0 |
0 |
1 |
|
35 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/StoreAddress/PostalCode |
|
| |
|
|
Shipment |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment |
Shipment related data. |
| |
|
|
|
CartonId |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/CartonId |
The carton number of the shipment. |
| |
|
|
|
SerialNumberData |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/SerialNumberData |
Gift card serial number information. |
| |
|
|
|
|
SerialNumberSequence |
String |
No |
0 |
0 |
1 |
|
4 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/SerialNumberData/SerialNumberSequence |
The sequence number of the gift card. |
| |
|
|
|
|
SerialNumber |
String |
No |
0 |
0 |
1 |
|
120 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/SerialNumberData/SerialNumber |
The unique serial number of the gift card. |
| |
|
|
|
|
GiftCardId |
String |
No |
0 |
0 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/SerialNumberData/GiftCardId |
The unique card number of the gift card. |
| |
|
|
|
PromiseReceiptDate |
|
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/PromiseReceiptDate |
The Expected date of when the merchandise contained in the order shipment confirmation will be received by the consumer. For example, 2009-03-31. |
| |
|
|
|
Carrier |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier |
Carrier Data |
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier/Name |
The name of the company responsible for the transportation of goods from the source location to the destination location. |
| |
|
|
|
|
CarrierId |
String |
Yes |
0 |
1 |
1 |
|
4 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier/CarrierId |
The unique reference for the external party that transports merchandise and/or supply items from their source to the destination and from the destination back to their source. (Carrier Code) |
| |
|
|
|
|
CarrierServiceLevel |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier/CarrierServiceLevel |
The method which the goods will be shipped to the destination facility. (Carrier Mode) |
| |
|
|
|
|
TrackingId |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier/TrackingId |
The tracking number assigned by the carrier. |
| |
|
|
|
|
TrackingBoxNumber |
String |
No |
0 |
0 |
1 |
|
3 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/Carrier/TrackingBoxNumber |
The number of boxes to be delivered. |
| |
|
|
|
ActualFreightCharge |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ActualFreightCharge |
Freight charge on the shipment. |
| |
|
|
|
|
Amount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ActualFreightCharge/Amount |
Numeric amount of the freight. |
| |
|
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ActualFreightCharge/CurrencyCode |
ISO 4217 Standard Currency Code. http://www.iso.org/iso/support/currency_codes_list-1.htm |
| |
|
|
|
ContainerType |
String |
No |
0 |
0 |
1 |
|
6 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerType |
The type of container used in the shipment. |
| |
|
|
|
ContainerLength |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerLength |
The length of the container. |
| |
|
|
|
ContainerLengthUOM |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerLengthUOM |
Unit of measure of the length. |
| |
|
|
|
ContainerWidth |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerWidth |
Width of the container. |
| |
|
|
|
ContainerWidthUOM |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerWidthUOM |
Unit of measure of the width. |
| |
|
|
|
ContainerHeight |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerHeight |
Height of the container. |
| |
|
|
|
ContainerHeightUOM |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerHeightUOM |
Unit of measure of the height. |
| |
|
|
|
ContainerGrossWeight |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerGrossWeight |
Weight of the container. |
| |
|
|
|
ContainerGrossWeightUOM |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/Shipment/ContainerGrossWeightUOM |
Unit of measure of the container weight. |
| |
|
|
LotId |
String |
No |
0 |
0 |
1 |
|
40 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/LotId |
An identifier for a batch or group of items. The identification of this grouping normally comes from the manufacturer and normally applies to items that are dependent on matching of colors or detailed tracking requirements. |
| |
|
|
FirstAvailableDate |
|
No |
0 |
0 |
1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/FirstAvailableDate |
Date when the item will be available to ship in WMS in case of Line Status is "BO".
Allowable Values: ISO 8601 standard with offset from UTC in 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: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/OrderShipment/OrderShipmentData/OrderShipmentDetail/ExtendedAttributes/Value |
The specific value of the additional attribute. |