Overview
The Shipping Charge Rule feed enables clients to send shipping configurations that enable ROM to calculate shipping charges when new orders are created or existing orders are modified through the ROM user interface.
The feed includes the following key data points for each rule:
- Charge Category
- Charge Name
- Shipping Charge Plan
- Rule Name
- Shipping Method
- Surcharge Type (applicable for a Surcharge category only)
- Ship Charge
The following table describes the categories and types of shipping charge rules.
Shipping |
Value Based |
The shipping charge is based on the total amount of the order. |
Quantity/Unit Based |
The shipping charge is based on the total number of items in the order. |
Weight Based |
The shipping charge is based on the weight of the order. |
Flat |
The shipping charge is a flat rate, regardless of the contents, size, or weight of the order. |
Item Override |
The shipping charge override for specified items based on a shipping method. The override charge can also be based on region. |
Surcharge |
Import with Item Attributes |
The shipping surcharge is based on specific item attributes and ship method. This type of surcharge can also be based on region.
|
Import with item IDs |
The shipping surcharge for specific items based on a ship method. This type of surcharge can be also based on region.
|
The following table describes types of surcharge rules and shipping charge plans that must be used for each surcharge type.
AdditionalHandling
|
The additional handling surcharge is a flat amount, which is based on
a ship method and any additional handling that the order requires.
|
Flat
|
ItemAttribute
|
The shipping surcharge is based on specific item attributes and ship
method
|
ItemAttributeSurcharge
|
ItemID
|
The shipping surcharge for specific items based on a ship
method.
|
ItemSurcharge
|
LargePackage
|
The Large Package surcharge is a flat amount, which is based on the
size of a package and a ship method
|
Flat
|
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>_ShippingChargeRule_<YYYYMMDDHHMMSS>.xml
File Name Example: TMSNA_21_ShippingChargeRule_20160727111831.xml
Schema
Shipping Change Rule Feed schema: ShippingChargeRules.xsd
Examples
The following examples show how a feed could be constructed for each of the categories and types in the previous table. The charges in most of the examples apply to orders in Region AL127 with a shipping method of ANY_STD.
In this example, the shipping charge is based on the total value, or amount, of the order. It specifies two tiers of shipping charge:
- For orders from $1.00 through $15.00, the shipping charge is $10.00.
- For orders from $16.00 through $100.00, the shipping charge is $15.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule store_id="SMTUS" client_id="SMTNA" catalog_id="25">
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>129</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Value Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingValueBasedRule1</RuleName>
<Sequence>1</Sequence>>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ShippingChargePlan plan_type="Value" pln_type_unit="USD">
<ShipCharge>
<StartThreshold>1</StartThreshold>
<EndThreshold>15</EndThreshold>
<FixedCharge>10</FixedCharge>
</ShipCharge>
<ShipCharge>
<StartThreshold>16</StartThreshold>
<EndThreshold>100</EndThreshold>
<FixedCharge>15</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In
this example, the shipping charge is based on the of items in the order. It specifies two tiers of shipping charge:
- For orders from 1 to 10 items, the shipping charge is $10.00.
- For orders from 11 to 100 items, the shipping charge is $15.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<MessageHeader>
<Standard>GSI</Standard>
<HeaderVersion>5.21</HeaderVersion>
<VersionReleaseNumber>5.21</VersionReleaseNumber>
<SourceData>
<SourceId>SMTNA</SourceId>
<SourceType>CLIENT</SourceType>
</SourceData>
<DestinationData>
<DestinationId>GSI</DestinationId>
<DestinationType>PH</DestinationType>
</DestinationData>
<EventType>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>124</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Unit Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingUnitBasedRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ShippingChargePlan plan_type="Unit" plan_type_unit="EACH">
<ShipCharge>
<StartThreshold>1</StartThreshold>
<EndThreshold>10</EndThreshold>
<FixedCharge>10</FixedCharge>
</ShipCharge>
<ShipCharge>
<StartThreshold>11</StartThreshold>
<EndThreshold>100</EndThreshold>
<FixedCharge>15</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In
this example, the shipping charge is based on the weight of the order. It specifies two tiers of shipping charge:
- For orders from 0 through 5 pounds, the shipping charge is $5.00.
- For orders from 6 to 10 pounds, the shipping charge is $10.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>127</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Total Weight Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingWtBasedRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ShippingChargePlan plan_type="Weight" plan_type_unit="LBS">
<ShipCharge>
<StartThreshold>0</StartThreshold>
<EndThreshold>5</EndThreshold>
<FixedCharge>5</FixedCharge>
</ShipCharge>
<ShipCharge>
<StartThreshold>6</StartThreshold>
<EndThreshold>10</EndThreshold>
<FixedCharge>10</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In
this example, the shipping charge is based on a flat or fixed rate. Every order, regardless of value, weight, number of items, and so on, has a shipping charge of $5.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>123</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Flat Rate</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingFlatRule1</RuleName>
<Sequence>1</Sequence>>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ShippingChargePlan plan_type="Flat">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, a specific item has a fixed shipping charge, regardless of weight, number of items, and so on. Here, the item with the ID DEVw001B0 has a fixed shipping charge of $5.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>125</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Item Fixed Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingItemFixedChargedBasedRule1</RuleName>
<Sequence>1</Sequence>>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ClientItems>
<Item>
<ClientItemId>DEVw001BO</ClientItemId>
</Item>
</ClientItems>
<ShippingChargePlan plan_type="ItemOverride">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, three items - DEVw001B0, DEVw002B0, and DEVw003B0 - have a fixed shipping charge of $5.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>126</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Item Fixed Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingItemFixedChargedBasedRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
</ShippingRegions>
<ClientItems>
<Item>
<ClientItemId>DEVw001BO</ClientItemId>
</Item>
<Item>
<ClientItemId>DEVw002BO</ClientItemId>
</Item>
<Item>
<ClientItemId>DEVw003BO</ClientItemId>
</Item>
</ClientItems>
<ShippingChargePlan plan_type="ItemOverride">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In
this example, three regions have the same shipping charge, which is based on the weight of the order. It specifies two tiers of shipping charge:
For orders from 0 through 5 pounds, the shipping charge is $5.00.
For orders from 6 to 10 pounds, the shipping charge is $10.00.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Shipping</ChargeCategory>
<RuleNumber>128</RuleNumber>
<ChargeName>Shipping1</ChargeName>
<RuleDescription>TMS Shipping Total Weight Based</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingWtBasedRule1</RuleName>
<Sequence>1</Sequence>>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingRegions>
<RegionCode>AL127</RegionCode>
<RegionCode>AL128</RegionCode>
<RegionCode>AL129</RegionCode>
</ShippingRegions>
<ShippingChargePlan plan_type="Weight" pln_type_unit="LBS">
<ShipCharge>
<StartThreshold>0</StartThreshold>
<EndThreshold>5</EndThreshold>
<FixedCharge>5</FixedCharge>
</ShipCharge>
<ShipCharge>
<StartThreshold>6</StartThreshold>
<EndThreshold>10</EndThreshold>
<FixedCharge>10</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, a flat surcharge of $5.00 is applied to orders that require additional handling.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Surcharge</ChargeCategory>
<RuleNumber>130</RuleNumber>
<Surchargetype>AdditionalHandling</Surchargetype>
<ChargeName>AdditionalHandling</ChargeName>
<RuleDescription>TMS Shipping Flat Rate</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingFlatRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingChargePlan plan_type="Flat">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, a flat surcharge of $5.00 is applied to any order that has an item attribute indicating that it is eligible for in-store pickup.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Surcharge</ChargeCategory>
<RuleNumber>131</RuleNumber>
<Surchargetype>ItemAttribute</Surchargetype>
<ChargeName>ItemAttribute</ChargeName>
<RuleDescription>TMS Shipping Flat Rate</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingFlatRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ItemAttributes>
<ItemAttribute>
<Attribute>ISPUEligible</Attribute>
<Value>Y</Value>
</ItemAttribute>
</ItemAttributes>
<ShippingChargePlan plan_type="ItemAttributeSurcharge">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, a flat surcharge of $5.00 is applied to any order that has an item ID of DEVw001B0.
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule store_id="SMTUS" client_id="SMTNA" catalog_id="25">
<ChargeCategory>Surcharge</ChargeCategory>
<RuleNumber>132</RuleNumber>
<Surchargetype>ItemID</Surchargetype>
<ChargeName>Import</ChargeName>
<RuleDescription>TMS Shipping Flat Rate</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingFlatRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ClientItems>
<Item>
<ClientItemId>DEVw001BO</ClientItemId>
</Item>
</ClientItems>
<ShippingChargePlan plan_type="ItemSurcharge">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>
In this example, a flat surcharge of $5.00 is applied to orders that require large packages. The client defines the dimensions of a "large package".
Copy this code sample.
<?xml version="1.0" encoding="UTF-8"?>
<ShippingChargeRules>
<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>ShippingChargeRule</EventType>
<MessageData>
<MessageId>2016060110000041</MessageId>
<CorrelationId>2016060110000041</CorrelationId>
</MessageData>
<CreateDateAndTime>2016-06-01T09:49:55Z</CreateDateAndTime>
</MessageHeader>
<ShippingCharge>
<RuleMode>FS</RuleMode>
<store_id>SMTUS</store_id>
<client_id>SMTNA</client_id>
<catalog_id>25</catalog_id>
<ShippingChargeRule>
<ChargeCategory>Surcharge</ChargeCategory>
<RuleNumber>133</RuleNumber>
<Surchargetype>LargePackage</Surchargetype>
<ChargeName>LargePackage</ChargeName>
<RuleDescription>TMS LargePackage Shipping Surcharge Rule</RuleDescription>
<Currency>USD</Currency>
<EffectiveStartDate>2016-06-10T00:00:00-04:00</EffectiveStartDate>
<RuleName>ShippingSurchargeWtBasedRule1</RuleName>
<Sequence>1</Sequence>
<ShipMethod>ANY_STD</ShipMethod>
<ShippingChargePlan plan_type="Flat">
<ShipCharge>
<FixedCharge>5</FixedCharge>
</ShipCharge>
</ShippingChargePlan>
</ShippingChargeRule>
</ShippingCharge>
</ShippingChargeRules>