Radial Integration | 2016

Working with Radial APIs > Feeds: Batch File APIs > Order Shipment Feed

Order Shipment Feed

Overview

The Order Shipment feed contains the fulfillment status for each line on an order (also known as an order-to-fulfill request, shipment request, invoice, or single ship-to-address order). The message allows the Warehouse Management System to update Radial Order Management and Inventory Management on the state of a particular order or orders. The message contains identifying information about the order and its items, as well as the specific state code for the line items. Depending on the state of the order, it may include cancel reason codes for canceled orders or shipment details such as tracking numbers for shipped orders.

Notes:

Schema

Order Shipment schema: OrderShipment.xsd

API Structure

Order Shipment element table: OrderShipment.xsd.html

Examples

ClosedGift Card Shipped 

<?xml version="1.0" encoding="UTF-8"?>
<OrderShipment>
   <MessageHeader>
      <Standard>GSI</Standard>
      <HeaderVersion>NGP1.1.0</HeaderVersion>
      <VersionReleaseNumber>NGP1.1.0</VersionReleaseNumber>
      <SourceData>
         <SourceId>TMSNA_DC001</SourceId>
         <SourceType>CLIENT</SourceType>
      </SourceData>
      <DestinationData>
         <DestinationId>GSI</DestinationId>
         <DestinationType>FH</DestinationType>
      </DestinationData>
      <EventType>OrderShipment</EventType>
      <MessageData>
         <MessageId>1380673</MessageId>
         <CorrelationId>12345678</CorrelationId>
      </MessageData>
      <CreateDateAndTime>2014-11-10T07:03:15-08:00</CreateDateAndTime>
   </MessageHeader>
   <OrderShipmentData>
      <OrderShipmentHeader>
         <ClientId>TMSNA</ClientId>
         <FacilityId>TMSNA_DC001</FacilityId>
         <ExternalFacilityId>MLDC_ECOM</ExternalFacilityId>
         <OMSOrderId>100009023690001</OMSOrderId>
         <CustomerOrderId>00025200026414</CustomerOrderId>
         <ExternalShipmentId>596874215369</ExternalShipmentId>
         <OrderShipDateTime>2014-11-10T00:00:00-08:00</OrderShipDateTime>
         <ExtendedAttributes>
            <Name>gsi_store_id</Name>
            <Description>GSI Store ID</Description>
            <Value>TMSUS</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>gsi_client_id</Name>
            <Description>GSI Client ID</Description>
            <Value>TMSNA</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>CatalogId</Name>
            <Description>GSI Catalog ID</Description>
            <Value>18</Value>
         </ExtendedAttributes>
      </OrderShipmentHeader>
      <OrderShipmentDetail>
         <LineNumber>1</LineNumber>
         <LineStatus>S</LineStatus>
         <ItemId>
            <ClientItemId>887170234400</ClientItemId>
         </ItemId>
         <QuantityShipped>1</QuantityShipped>
         <QuantityCancelled>0</QuantityCancelled>
         <QuantityBackordered>0</QuantityBackordered>
         <Shipment>
            <CartonId>98648699998</CartonId>
            <SerialNumberData>
               <SerialNumberSequence>1</SerialNumberSequence>
               <SerialNumber>KL92382399998</SerialNumber>
            </SerialNumberData>
            <Carrier>
               <Name>CR - US PRIORITY AIR MAIL</Name>
               <CarrierId>USPS</CarrierId>
               <CarrierServiceLevel>2 Day</CarrierServiceLevel>
               <TrackingId>1111110000655700279999</TrackingId>
            </Carrier>
         </Shipment>
      </OrderShipmentDetail>
   </OrderShipmentData>
</OrderShipment>

ClosedMerchandise Shipped 

<?xml version="1.0" encoding="UTF-8"?>
<OrderShipment>
   <MessageHeader>
      <Standard>GSI</Standard>
      <HeaderVersion>NGP1.1.0</HeaderVersion>
      <VersionReleaseNumber>NGP1.1.0</VersionReleaseNumber>
      <SourceData>
         <SourceId>TMSNA_DC001</SourceId>
         <SourceType>CLIENT</SourceType>
      </SourceData>
      <DestinationData>
         <DestinationId>GSI</DestinationId>
         <DestinationType>FH</DestinationType>
      </DestinationData>
      <EventType>OrderShipment</EventType>
      <MessageData>
         <MessageId>1380673</MessageId>
         <CorrelationId>12345678</CorrelationId>
      </MessageData>
      <CreateDateAndTime>2014-11-10T07:03:15-08:00</CreateDateAndTime>
   </MessageHeader>
   <OrderShipmentData>
      <OrderShipmentHeader>
         <ClientId>TMSNA</ClientId>
         <FacilityId>TMSNA_DC001</FacilityId>
         <ExternalFacilityId>EXTE_ECOM</ExternalFacilityId>
         <OMSOrderId>100009023690001</OMSOrderId>
         <CustomerOrderId>00038200026414</CustomerOrderId>
         <ExternalShipmentId>596874215369</ExternalShipmentId>
         <OrderShipDateTime>2014-11-10T00:00:00-08:00</OrderShipDateTime>
         <ExtendedAttributes>
            <Name>gsi_store_id</Name>
            <Description>GSI Store ID</Description>
            <Value>TMSUS</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>gsi_client_id</Name>
            <Description>GSI Client ID</Description>
            <Value>TMSNA</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>CatalogId</Name>
            <Description>GSI Catalog ID</Description>
            <Value>21</Value>
         </ExtendedAttributes>
      </OrderShipmentHeader>
      <OrderShipmentDetail>
         <LineNumber>1</LineNumber>
         <LineStatus>S</LineStatus>
         <ItemId>
            <ClientItemId>987170234409</ClientItemId>
         </ItemId>
         <QuantityShipped>1</QuantityShipped>
         <QuantityCancelled>0</QuantityCancelled>
         <QuantityBackordered>0</QuantityBackordered>
         <Shipment>
            <CartonId>99648618998</CartonId>
            <Carrier>
               <Name>CR - US PRIORITY AIR MAIL</Name>
               <CarrierId>USPS</CarrierId>
               <CarrierServiceLevel>2 Day</CarrierServiceLevel>
               <TrackingId>1111110000655700211111</TrackingId>
            </Carrier>
         </Shipment>
      </OrderShipmentDetail>
   </OrderShipmentData>
</OrderShipment>

ClosedMerchandise Canceled 

<?xml version="1.0" encoding="UTF-8"?>
<OrderShipment>
   <MessageHeader>
      <Standard>GSI</Standard>
      <HeaderVersion>NGP1.1.0</HeaderVersion>
      <VersionReleaseNumber>NGP1.1.0</VersionReleaseNumber>
      <SourceData>
         <SourceId>TMSNA_DC001</SourceId>
         <SourceType>CLIENT</SourceType>
      </SourceData>
      <DestinationData>
         <DestinationId>GSI</DestinationId>
         <DestinationType>FH</DestinationType>
      </DestinationData>
      <EventType>OrderShipment</EventType>
      <MessageData>
         <MessageId>1380673</MessageId>
         <CorrelationId>12345678</CorrelationId>
      </MessageData>
      <CreateDateAndTime>2014-11-10T07:03:15-08:00</CreateDateAndTime>
   </MessageHeader>
   <OrderShipmentData>
      <OrderShipmentHeader>
         <ClientId>TMSNA</ClientId>
         <FacilityId>TMSNA_DC001</FacilityId>
         <ExternalFacilityId>MLDC_ECOM</ExternalFacilityId>
         <OMSOrderId>100009023690001</OMSOrderId>
         <CustomerOrderId>00025200026414</CustomerOrderId>
         <OrderShipDateTime>2014-11-10T00:00:00-08:00</OrderShipDateTime>
         <ExtendedAttributes>
            <Name>gsi_store_id</Name>
            <Description>GSI Store ID</Description>
            <Value>TMSUS</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>gsi_client_id</Name>
            <Description>GSI Client ID</Description>
            <Value>TMSNA</Value>
         </ExtendedAttributes>
         <ExtendedAttributes>
            <Name>CatalogId</Name>
            <Description>GSI Catalog ID</Description>
            <Value>18</Value>
         </ExtendedAttributes>
      </OrderShipmentHeader>
      <OrderShipmentDetail>
         <LineNumber>2</LineNumber>
         <LineStatus>X</LineStatus>
         <CancelReasonCode>CN</CancelReasonCode>
         <ItemId>
            <ClientItemId>456048099</ClientItemId>
         </ItemId>
         <QuantityShipped>0</QuantityShipped>
         <QuantityCancelled>1</QuantityCancelled>
         <QuantityBackordered>0</QuantityBackordered>
         <Shipment/>
      </OrderShipmentDetail>
   </OrderShipmentData>
</OrderShipment>

Data Keys

Cancel Reason Code

Description

AH

Invalid Shipping Address

CN

Cancel Generic

COD

COD AutoCancel

CVS

CVS AutoCancel

ID

Cancel - Inventory Discrepancy

OTH

Other

TC

Out of Stock - Timing

ZRN

No Reason

 

ISO Standard Description
Country – ISO 3166-1 2 Letter Country Standard
Currency – ISO 4217 Currency Standard
Time – ISO 8601 Date Time Standard

 

Line Status

Description

BO

BackOrdered

S

Shipped

X

Cancelled

 

Copyright © 2017 Radial. All rights reserved.