Create a shipping template
You can create shipping templates to manage your ship settings for more precise delivery.
To create shipping templates, use Create Shipping Template API. Make the API call to POST v3/settings/shipping/templates.
After you create the shipping template, you can associate item SKUs with that template. See Add an item SKU to a shipping template in the Items guide.
View shipping template samples
We provide several sample shipping templates for various shipping scenarios. To view samples, see Payload Samples in Create Shipping Templates API Reference.
| Note: Each template description corresponds to a template sample. See all Payload Samples in Create Shipping Templates API Reference. |
|---|
Samples for shipping template creation
The sample shipping template in the API Reference section provides instructions for creating one.
Sample Request Body:
Template 1
{ "name": "Template 1", "type": "CUSTOM", "rateModelType": "PER_SHIPMENT_PRICING", "shippingMethods": [ { "shipMethod": "EXPRESS", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 6, "currency": "CAD" }, "chargePerItem": { "amount": 4, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2003", "regionName": "Greater Montreal" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 3, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3017", "regionName": "Urban Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 8, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3019", "regionName": "Rural Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3025", "regionName": "Eastern Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3023", "regionName": "Rural Quebec" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2005", "regionName": "Urban British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3005", "regionName": "Rural British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 8, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 6, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2002", "regionName": "Greater Toronto - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2004", "regionName": "Greater Montreal - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2010", "regionName": "Rest of Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 8, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 6, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3026", "regionName": "Eastern Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 5, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 3, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2006", "regionName": "Urban British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 1, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } } ] }, { "shipMethod": "STANDARD", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2003", "regionName": "Greater Montreal" } ], "addressTypes": [ "STREET" ], "transitTime": 5, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3017", "regionName": "Urban Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 8, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3019", "regionName": "Rural Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3025", "regionName": "Eastern Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3023", "regionName": "Rural Quebec" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2005", "regionName": "Urban British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3005", "regionName": "Rural British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 8, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 6, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2002", "regionName": "Greater Toronto - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2004", "regionName": "Greater Montreal - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2010", "regionName": "Rest of Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 8, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 6, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3026", "regionName": "Eastern Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 5, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 3, "currency": "CAD" }, "chargePerItem": { "amount": 3, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2006", "regionName": "Urban British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 1, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } } ] } ]
}
Template 2
This samples provides for the scenario with 10 Regions + 10 Regions PO Box.
{ "name": "Template 2", "type": "CUSTOM", "rateModelType": "TIERED_PRICING", "shippingMethods": [ { "shipMethod": "EXPRESS", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": -1, "shipCharge": { "amount": 3, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2003", "regionName": "Greater Montreal" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 5, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 3, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 4, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3017", "regionName": "Urban Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 6, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3019", "regionName": "Rural Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 5, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 8, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3025", "regionName": "Eastern Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3023", "regionName": "Rural Quebec" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2005", "regionName": "Urban British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3005", "regionName": "Rural British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 8, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2002", "regionName": "Greater Toronto - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 1, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 3, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2004", "regionName": "Greater Montreal - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2010", "regionName": "Rest of Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 5, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 8, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 5, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3026", "regionName": "Eastern Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 5, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 1, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 3, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2006", "regionName": "Urban British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 6, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] } ] }, { "shipMethod": "STANDARD", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2003", "regionName": "Greater Montreal" } ], "addressTypes": [ "STREET" ], "transitTime": 5, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 1, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 3, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3017", "regionName": "Urban Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 6, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3019", "regionName": "Rural Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3025", "regionName": "Eastern Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3023", "regionName": "Rural Quebec" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2005", "regionName": "Urban British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": -1, "shipCharge": { "amount": 1, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3005", "regionName": "Rural British Columbia" } ], "addressTypes": [ "STREET" ], "transitTime": 8, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" } ], "addressTypes": [ "STREET" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 1, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 2, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2002", "regionName": "Greater Toronto - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 4, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2004", "regionName": "Greater Montreal - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2010", "regionName": "Rest of Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 5, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 8, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3026", "regionName": "Eastern Canada - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 5, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 3, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 4, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 3, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 4, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "2006", "regionName": "Urban British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 4, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 6, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 6, "minTransitTime": 4, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 10.06, "maxLimit": -1, "shipCharge": { "amount": 8, "currency": "CAD" } }, { "minLimit": 0, "maxLimit": 10.05, "shipCharge": { "amount": 10, "currency": "CAD" } } ] } ] } ]
}
Shipping Template Requirements
Shipping Template Requirements
The seller must use seller authentication to use the POST Create Shipping Template API with proper External Headers.
- When the Seller invokes the “CREATE SHIPPING TEMPLATE” API, the attribute “type” in the request payload must be set to “CUSTOM.”
- The seller can create a total of 60 CUSTOM templates.
- Seller can update DEFAULT and CUSTOM shipping templates.
- The seller can have a total of 60 CUSTOM templates and 1 Default Template.
Template Type
- The “type” attribute of the template can be DEFAULT and CUSTOM templates.
- The “type” attribute in the request payload of the Shipping Template cannot be updated.
- A CUSTOM shipping template can have one combination of Ship method
- Standard and any other shipping methods
- The DEFAULT shipping template cannot be created/ deleted/ disabled.
Template Naming Conventions
- Only alphanumeric characters (a-z, A-Z, 0-9) and spaces are allowed in the template name. Spaces will be removed from the start and end of the name. Name having only spaces will be considered empty.
- The maximum template length allowed is 25 chars.
- Template Name must be unique for a seller, and it is case-insensitive
Allowable Shipping Method per Transit Time
Allowable shipping methods and transit time combinations are:
| Method | Transit Time (days) |
|---|---|
| STANDARD | 0-25 |
| EXPRESS | 2-4 |
Max Charges allowed for Ship Methods
No limit currently, but we recommend Shipping Charges to be as low as possible.
Standard Ship Method
Granular subregions must be supplied for 10 regions and address type Street and PO_BOX
Express Ship Method
Granular subregions must be supplied for 10 regions and address type Street and PO_BOX
Coverage Areas
10 regions, along with the PO box, are supported. Overlapping of areas is not allowed in different shipping rules for the same shipping method in a template.
Rate Model
If the attribute “rateModelType” is set to “PER_SHIPMENT_PRICING”, then only Per Shipment charges must be supplied.
If the attribute “rateModelType” is set to “TIERED_PRICING”, then only a list of Tiered shipping charges must be supplied.
If the attribute “rateModelType” is set to “TIERED_PRICING”, then the range of “minLimit” to “maxLimit” for the attribute “tieredShippingCharges” should be continuous.
For example, minLimit=0, maxLimit=5, minLimit=5.01, maxLimit=-1-1 for attribute “maxLimit” indicates the highest value of charges for the shipping method.
Available List of Regions
| RegionCode | RegionName | SubregionCode | SubregionName | StateCode | StateName | StateSubRegionCode | StateSubRegionName |
|---|---|---|---|---|---|---|---|
| 2001 | Greater Toronto | 2001 | Greater Toronto | GT | Greater Toronto | GT | Greater Toronto |
| 2003 | Greater Montreal | 2003 | Greater Montreal | GM | Greater Montreal | GM | Greater Montreal |
| 2009 | Rest of Canada | 2009 | Rest of Canada | RC | Rest of Canada | RC | Rest of Canada |
| 3017 | Urban Ontario | 3017 | Urban Ontario | UO | Urban Ontario | UO | Urban Ontario |
| 3019 | Rural Ontario | 3019 | Rural Ontario | RO | Rural Ontario | RO | Rural Ontario |
| 3025 | Eastern Canada | 3025 | Eastern Canada | EC | Eastern Canada | EC | Eastern Canada |
| 3023 | Rural Quebec | 3023 | Rural Quebec | RQ | Rural Quebec | RQ | Rural Quebec |
| 2005 | Urban British Columbia | 2005 | Urban British Columbia | UC | Urban British Columbia | UC | Urban British Columbia |
| 3005 | Rural British Columbia | 3005 | Rural British Columbia | RB | Rural British Columbia | RB | Rural British Columbia |
| 3007 | Urban Prairies (MB, SK, AB) | 3007 | Urban Prairies (MB, SK, AB) | UP | Urban Prairies (MB, SK, AB) | UP | Urban Prairies (MB, SK, AB) |
| 2002 | Greater Toronto – PO Box | 2002 | Greater Toronto – PO Box | GT-PO | Greater Toronto – PO Box | GT-PO | Greater Toronto – PO Box |
| 2004 | Greater Montreal – PO Box | 2004 | Greater Montreal – PO Box | GM-PO | Greater Montreal – PO Box | GM-PO | Greater Montreal – PO Box |
| 2010 | Rest of Canada – PO Box | 2010 | Rest of Canada – PO Box | RC-PO | Rest of Canada – PO Box | RC-PO | Rest of Canada – PO Box |
| 3018 | Urban Ontario – PO Box | 3018 | Urban Ontario – PO Box | UO-PO | Urban Ontario – PO Box | UO-PO | Urban Ontario – PO Box |
| 3020 | Rural Ontario – PO Box | 3020 | Rural Ontario – PO Box | RO-PO | Rural Ontario – PO Box | RO-PO | Rural Ontario – PO Box |
| 3026 | Eastern Canada – PO Box | 3026 | Eastern Canada – PO Box | EC-PO | Eastern Canada – PO Box | EC-PO | Eastern Canada – PO Box |
| 3024 | Rural Quebec – PO Box | 3024 | Rural Quebec – PO Box | RQ-PO | Rural Quebec – PO Box | RQ-PO | Rural Quebec – PO Box |
| 2006 | Urban British Columbia – PO Box | 2006 | Urban British Columbia – PO Box | UC-PO | Urban British Columbia – PO Box | UC-PO | Urban British Columbia – PO Box |
| 3006 | Rural British Columbia – PO Box | 3006 | Rural British Columbia – PO Box | RB-PO | Rural British Columbia – PO Box | RB-PO | Rural British Columbia – PO Box |
| 3008 | Urban Prairies (MB, SK, AB) – PO Box | 3008 | Urban Prairies (MB, SK, AB) – PO Box | UP-PO | Urban Prairies (MB, SK, AB) – PO Box | UP-PO | Urban Prairies (MB, SK, AB) – PO Box |
Updated about 1 month ago