Shipping Eligibility Feed

Overview

This feed provides eligible shipping methods and shipping eligibility rules that are used to determine whether items can be shipped to destination regions. Along with the Shipping Charge Rule Feed, it enables ROM to support order modifications, made through the user interface, that impact shipping charges .

The feed contains the following key data points for each rule:

  • Rule Category (Eligibility, EligibilityOverride, Exclusion)
  • Rule Type (Item, ItemAttribute, Large Package, Volume)
  • Fulfillment Channel (SHIP_TO_HOME, STORE_PICKUP, SHIP_TO_STORE)
  • Shipping Regions

Notes:

Default Character Encoding: Unicode: UTF-8

Exchange Frequency: Client Specific

Production Mailbox Location: Client Specific

Test Mailbox Location: Client Specific

The filename combined with the mailbox allow Radial to determine the destination of the Facility Feed

FileName pattern: <ClientId>_<CatalogId>_ShippingEligibilityRule_<YYYYMMDDHHMMSS>.xml

File Name Example: TMSNA_21_ShippingEligibilityRule_20160727111831.xml

Schema

Shipping Eligibility Feed schema: ShippingEligibilityRules.xsd

Examples

ClosedEligibility_ItemAttribute

In this example, items with a fulfillment type of SHIP_TO_HOME and the freight class of "ABC" are eligible for shipping to the shipping region of "AL127". The ship methods ANY_STD and ANY_1DAY can be used.

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>EligibilitywithItemAttribute</RuleName>
   <RuleDescription>Eligibility with ItemAttribute</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>Eligibility</RuleCategory>
   <RuleType>ItemAttribute</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ItemAttributes>
    <ItemAttribute>
     <Attribute>FreightClass</Attribute>
     <Value>ABC</Value>
    </ItemAttribute>
   </ItemAttributes>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>Y</eligible_to_ship>
    <ShipMethods>
     <ShipMethod>ANY_STD</ShipMethod>
     <ShipMethod>ANY_1DAY</ShipMethod>
    </ShipMethods>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedEligibilityOverride_Item

In this example, an eligibility override rule is defined for three items (DEVw001BO, DEVw002BO, and DEVw002BO) with a fulfillment type of SHIP_TO_HOME. The items are eligible for shipping to the shipping region of AL127 and must use the eligible shipping methods from the override rule (ANY_STD, ANY_1DAY).

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>EligibilityOverridewithItem</RuleName>
   <RuleDescription>EligibilityOverride with Item</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>EligibilityOverride</RuleCategory>
   <RuleType>Item</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ClientItems>
    <Item>
     <ClientItemId>DEVw001BO</ClientItemId>
    </Item>
    <Item>
     <ClientItemId>DEVw002BO</ClientItemId>
    </Item>
    <Item>
     <ClientItemId>DEVw003BO</ClientItemId>
    </Item>   
   </ClientItems> 
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>Y</eligible_to_ship>
    <ShipMethods>
     <ShipMethod>ANY_STD</ShipMethod>
     <ShipMethod>ANY_1DAY</ShipMethod>
    </ShipMethods>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRules>

ClosedEligibilityOverride_ItemAttribute

In this example, an eligibility override rule is defined for items with a Hazardous Material Attribute value of ABC and fulfillment type of SHIP_TO_HOME. The items are eligible for shipping to the shipping region of AL127 and must use the eligible shipping methods from the override rule (ANY_STD, ANY_1DAY).

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>EligibilityOverridewithItemAttribute</RuleName>
   <RuleDescription>EligibilityOverride with ItemAttribute</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>EligibilityOverride</RuleCategory>
   <RuleType>ItemAttribute</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ItemAttributes>
    <ItemAttribute>
     <Attribute>hazardousMaterialCode</Attribute>
     <Value>ABC</Value>
    </ItemAttribute>
   </ItemAttributes>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>Y</eligible_to_ship>
    <ShipMethods>
     <ShipMethod>ANY_STD</ShipMethod>
     <ShipMethod>ANY_1DAY</ShipMethod>
    </ShipMethods>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedEligibilityOverride_LargePackage

In this example, an eligibility override is defined for items with fulfillment type SHIP_TO_HOME that require large packages. The items are eligible for shipping to the shipping region of AL127 and must use the eligible shipping methods from the override rule (ANY_STD, ANY_1DAY).

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>EligibilityOverridewithLargePackage</RuleName>
   <RuleDescription>EligibilityOverride with LargePackage</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>EligibilityOverride</RuleCategory>
   <RuleType>LargePackage</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>Y</eligible_to_ship>
    <ShipMethods>
     <ShipMethod>ANY_STD</ShipMethod>
     <ShipMethod>ANY_1DAY</ShipMethod>
    </ShipMethods>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedEligibilityOverride_Volume

In this example, an eligibility override is defined for items with a volume of five cubic inches and a fulfillment type of SHIP_TO_HOME. The items are eligible to be shipped to the shipping region of AL127 and must use the eligible shipping methods from the override rule (ANY_STD, ANY_1DAY).

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>EligibilityOverridewithVolume</RuleName>
   <RuleDescription>EligibilityOverride with Volume</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>EligibilityOverride</RuleCategory>
   <RuleType>Volume</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <Volume>
    <Threshold>5</Threshold>
    <UOM>Cubicinch</UOM>
    <Operator>EQ</Operator>
   </Volume>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>Y</eligible_to_ship>
    <ShipMethods>
     <ShipMethod>ANY_STD</ShipMethod>
     <ShipMethod>ANY_1DAY</ShipMethod>
    </ShipMethods>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedExclusion_Item

This example shows an item-based exclusion rule. Three items (DEVw001BO, DEVw002BO, and DEVw002BO) with a fulfillment type of SHIP_TO_HOME are not eligible for shipping to the AL127 shipping region.

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>ExclusionwithItem</RuleName>
   <RuleDescription>Exclusion with Item</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>Exclusion</RuleCategory>
   <RuleType>Item</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ClientItems>
    <Item>
     <ClientItemId>DEVw001BO</ClientItemId>
    </Item>
    <Item>
     <ClientItemId>DEVw002BO</ClientItemId>
    </Item>
    <Item>
     <ClientItemId>DEVw003BO</ClientItemId>
    </Item>   
   </ClientItems> 
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>N</eligible_to_ship>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedExclusion_ItemAttribute

This example defines an exclusion rule for items based on item attribute, fulfillment type, and shipping region. Items with the Hazardous Material Attribute value of ABC and a fulfillment type of SHIP_TO_HOME are not eligible for shipping to the AL127 shipping region.

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>ExclusionwithItemAttribute</RuleName>
   <RuleDescription>Exclusion with ItemAttribute</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>Exclusion</RuleCategory>
   <RuleType>ItemAttribute</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ItemAttributes>
    <ItemAttribute>
     <Attribute>hazardousMaterialCode</Attribute>
     <Value>ABC</Value>
    </ItemAttribute>
   </ItemAttributes>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>N</eligible_to_ship>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedExclusion_LargePackage

This example defined an exclusion rule for items that require large packages.

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>LargePackagewithLargePackage</RuleName>
   <RuleDescription>LargePackage with LargePackage</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>Exclusion</RuleCategory>
   <RuleType>LargePackage</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>N</eligible_to_ship>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>

ClosedExclusion_Volume

This example defines an exclusion rule for items based on the item's volume, fulfillment type, and shipping region. Items with the volume of five cubic inches and fulfillment type of SHIP_TO_HOME are not eligible for shipping to the AL127 shipping region.

Copy this code sample. 
<?xml version="1.0" encoding="UTF-8"?>
<ShippingEligibilityRules>
 <MessageHeader>
  <Standard>GSI</Standard>
  <HeaderVersion>5.21</HeaderVersion>
  <VersionReleaseNumber>5.21</VersionReleaseNumber>
  <SourceData>
   <SourceId>TMSNA</SourceId>
   <SourceType>CLIENT</SourceType>
  </SourceData>
  <DestinationData>
   <DestinationId>GSI</DestinationId>
   <DestinationType>PH</DestinationType>
  </DestinationData>
  <EventType>ShippingEligibilityRule</EventType>
  <MessageData>
   <MessageId>2016060110000041</MessageId>
   <CorrelationId>2016060110000041</CorrelationId>
  </MessageData>
  <CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
 </MessageHeader>
 <ShippingEligibility>
  <RuleMode>FS</RuleMode>
  <store_id>SMTUS</store_id>
  <client_id>SMTNA</client_id>
  <catalog_id>25</catalog_id>
  <ShippingEligibilityRule>
   <RuleID>127</RuleID>
   <RuleName>VolumewithVolume</RuleName>
   <RuleDescription>Volume with Volume</RuleDescription>
   <EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
   <EffectiveEndDate>2016-06-10T00:00:00-04:00</EffectiveEndDate>
   <RuleCategory>Exclusion</RuleCategory>
   <RuleType>Volume</RuleType>
   <FulfillmentChannel>SHIP_TO_HOME</FulfillmentChannel>
   <Status>ACTIVE</Status>
   <ShippingRegions>
    <RegionCode>AL127</RegionCode>
   </ShippingRegions>
   <Volume>
    <Threshold>5</Threshold>
    <UOM>Cubicinch</UOM>
    <Operator>EQ</Operator>
   </Volume>
   <ShippingEligibilityRuleAction>
    <eligible_to_ship>N</eligible_to_ship>
   </ShippingEligibilityRuleAction>
  </ShippingEligibilityRule> 
 </ShippingEligibility> 
</ShippingEligibilityRule>