Create a shipping template

You can create shipping templates to manage your ship settings for more precise delivery.

To create shipping templates, use the 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 scenarios. To view samples, see Payload Samples in the Create Shipping Templates API Reference.

Samples for Shipping Template Creation

To create a shipping template, see the sample shipping template in the API Reference section.

Sample Request Body:

Template 1

{ "name": "CustomTemplate", "type": "CUSTOM", "rateModelType": "PER_SHIPMENT_PRICING", "shippingMethods": \[ { "shipMethod": "STANDARD", "status": "ACTIVE", "configurations": \[ { "regions": \[ { "regionCode": "MX-NE", "regionName": "REGIÓN NORESTE", "subRegions": [ { "subRegionCode": "1070", "subRegionName": "Coahuila" } ] } ], "addressTypes": [ "STREET" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KG", "shippingAndHandling": { "amount": 700, "currency": "MXN" }, "chargePerWeight": { "amount": 0, "currency": "MXN" } } } ] } ] }

Template 2

This sample provides for the scenario with 8 Regions + 32 States.

{ "name": "CUSTOM Template", "type": "CUSTOM", "rateModelType": "PER_SHIPMENT_PRICING", "shippingMethods": \[ { "shipMethod": "Standard", "status": "ACTIVE", "configurations": \[ { "addressTypes": [ "Street" ], "transitTime": 12, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1020", "subRegionName": "Baja California" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 10, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1030", "subRegionName": "Baja California Sur" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 10, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 34343, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1050", "subRegionName": "Chihuahua" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1090", "subRegionName": "Durango" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1240", "subRegionName": "Sinaloa" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NW", "regionName": "REGIÓN NOROESTE", "subRegions": [ { "subRegionCode": "1250", "subRegionName": "Sonora" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NE", "regionName": "REGIÓN NORESTE", "subRegions": [ { "subRegionCode": "1070", "subRegionName": "Coahuila" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NE", "regionName": "REGIÓN NORESTE", "subRegions": [ { "subRegionCode": "1180", "subRegionName": "Nuevo León" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NE", "regionName": "REGIÓN NORESTE", "subRegions": [ { "subRegionCode": "1270", "subRegionName": "Tamaulipas" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-WT", "regionName": "REGIÓN OCCIDENTE", "subRegions": [ { "subRegionCode": "1170", "subRegionName": "Nayarit" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-WT", "regionName": "REGIÓN OCCIDENTE", "subRegions": [ { "subRegionCode": "1130", "subRegionName": "Jalisco" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-WT", "regionName": "REGIÓN OCCIDENTE", "subRegions": [ { "subRegionCode": "1080", "subRegionName": "Colima" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-WT", "regionName": "REGIÓN OCCIDENTE", "subRegions": [ { "subRegionCode": "1150", "subRegionName": "Michoacán" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-ET", "regionName": "REGIÓN ORIENTE", "subRegions": [ { "subRegionCode": "1200", "subRegionName": "Puebla" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-ET", "regionName": "REGIÓN ORIENTE", "subRegions": [ { "subRegionCode": "1290", "subRegionName": "Veracruz" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-ET", "regionName": "REGIÓN ORIENTE", "subRegions": [ { "subRegionCode": "1280", "subRegionName": "Tlaxcala" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-ET", "regionName": "REGIÓN ORIENTE", "subRegions": [ { "subRegionCode": "1120", "subRegionName": "Hidalgo" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NC", "regionName": "REGIÓN CENTRONORTE", "subRegions": [ { "subRegionCode": "1010", "subRegionName": "Aguascalientes" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NC", "regionName": "REGIÓN CENTRONORTE", "subRegions": [ { "subRegionCode": "1100", "subRegionName": "Guanajuato" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NC", "regionName": "REGIÓN CENTRONORTE", "subRegions": [ { "subRegionCode": "1230", "subRegionName": "San Luis Potosí" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NC", "regionName": "REGIÓN CENTRONORTE", "subRegions": [ { "subRegionCode": "1310", "subRegionName": "Zacatecas" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-NC", "regionName": "REGIÓN CENTRONORTE", "subRegions": [ { "subRegionCode": "1210", "subRegionName": "Querétaro" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SC", "regionName": "REGIÓN CENTROSUR", "subRegions": [ { "subRegionCode": "1160", "subRegionName": "Morelos" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SC", "regionName": "REGIÓN CENTROSUR", "subRegions": [ { "subRegionCode": "1140", "subRegionName": "Estado de Mexico" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SC", "regionName": "REGIÓN CENTROSUR", "subRegions": [ { "subRegionCode": "1000", "subRegionName": "Ciudad de México" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SW", "regionName": "REGIÓN SUROESTE", "subRegions": [ { "subRegionCode": "1110", "subRegionName": "Guerrero" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SW", "regionName": "REGIÓN SUROESTE", "subRegions": [ { "subRegionCode": "1190", "subRegionName": "Oaxaca" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SW", "regionName": "REGIÓN SUROESTE", "subRegions": [ { "subRegionCode": "1060", "subRegionName": "Chiapas" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SE", "regionName": "REGIÓN SURESTE", "subRegions": [ { "subRegionCode": "1260", "subRegionName": "Tabasco" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SE", "regionName": "REGIÓN SURESTE", "subRegions": [ { "subRegionCode": "1040", "subRegionName": "Campeche" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SE", "regionName": "REGIÓN SURESTE", "subRegions": [ { "subRegionCode": "1220", "subRegionName": "Quintana Roo" } ] } ] }, { "addressTypes": [ "Street" ], "transitTime": 1, "perShippingCharge": { "unitOfMeasure": "KILOGRAM", "shippingAndHandling": { "currencyAmount": 0, "currencyUnit": "MXN" }, "chargePerWeight": { "currencyAmount": 0, "currencyUnit": "MXN" } }, "regions": \[ { "regionCode": "MX-SE", "regionName": "REGIÓN SURESTE", "subRegions": [ { "subRegionCode": "1300", "subRegionName": "Yucatán" } ] } ] } ] } ] }

Shipping Template Requirements

Authentication Headers

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 60 custom templates and 1 Default Template.
• Seller can update DEFAULT and CUSTOM shipping templates.
• The seller can have 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 methods.
• 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), accented characters (á, é, í, ó, ú, â, ê, ô, ã, õ, ç, Á, É, Í, Ó, Ú, Â, Ê, Ô, Ã, Õ, Ç, ü, ñ,Ü,Ñ), 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.
• Max 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:

Max Charges allowed for Ship Methods

There is no limit currently, but we recommend shipping charges be as low as possible.

Standard Ship Method

Granular subregions must be supplied for eight regions and 32 states and address type Street.

Coverage Areas

Eight regions, along with 32 states, are supported. Overlapping of areas is not allowed in different shipping rules for the same shipping method in a template.

Rate Model

Only a single ship rate model applicable at a shipment level can be set. If the attribute “rateModelType” is set to “PER_SHIPMENT_PRICING” then only Per Shipment charges must be supplied.If the attribute. For Mx, only “PER_SHIPMENT_PRICING” is allowed.

Available List of Regions