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 the samples, see Payload Samples in the Create Shipping Templates API Reference.

Note: Each template description corresponds to a template sample. See all Payload Samples in Create Shipping Templates API Reference.

General request template

To create a general request, see the sample shipping template in the API Reference section, Sample Request Body: SAMPLE 1.

{“name”: “Next Day servc”, “type”: “CUSTOM”, “rateModelType”: “TIERED_PRICING”, “status”: “ACTIVE”, “shippingMethods”: [

Template 2

This sample provides for the scenario with 48 States Street + 48 states PO Box + (AK and HI Street and PO Box + US Protectorates Street and PO Box) + APO/FPO .48 States Street has granular subregions -> state -> stateSubRegions.

Template 3

48 States Street + PO Box => Cannot be clubbed with other regions. This will create an individual rule (configuration).

Template 4

Hawaii & Alaska + US Protectorates + Street + PO Box => create one rule with both regions and PO Box and Street selected. Otherwise, two rules need to be created

Template 5

APO/FPO => Cannot be clubbed with any other regions Has MILITARY address Type.

Template 6

(Hawaii & Alaska and US Protectorates + PO Box) + US Protectorates Street => creates two rules

Template 7

Seller selects a subset of 48 State Street Subregions.

Template 8

When PARTNER invokes “CREATE SHIPPING TEMPLATE” API, the attribute “type” needs to be set as ”CUSTOM.”

Template 9

Third-party delivers the item and invokes “CREATE SHIPPING TEMPLATE,” API, the attribute “type” needs to be set 3PL Specific (for example: “DELIVERR”).

Template 10

A tiered shipping template example.

Template 11

This sample shows a payload example for creating or updating the Paid Standard shipping template, which allows you to add a shipping charge.

This differs from the typical usage, where the Paid Standard Shipping template provides free shipping.

Template 12

For “VALUE” shipping, HI, and AK states can be selected during template creation or updates.

Freight Template

Freight templates are custom templates that allow sellers to define their settings specific to oversized/heavy items. Freight shipping templates can have transit times ranging from 6 – 10 days and are paid shipping templates. See the sample shipping template in the API Reference section, Sample Request Body: FREIGHT TEMPLATE.

Shipping template requirements

Authentication headers

Sellers 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 needs to be set as “CUSTOM.”
The seller can create a total of 100 CUSTOM templates.
The seller can update DEFAULT, CUSTOM and 3PL-specific (DELIVERR/ShipBob) shipping templates.

Delegate access for Solution Providers

Third-party Solution Providers must use delegated access to invoke this API with proper External Headers.

When a 3PL partner invokes the “CREATE SHIPPING TEMPLATE” API, the attribute “type” in the request payload needs to be set as a template specific to 3PL (for example, if DELIVERR invokes the API, template type should be set as “DELIVERR”).
3PL cannot create Freight Shipping Templates.
3PL can only update 3PL-specific templates (for example, DELIVERR can update only DELIVERR template).

Template Type

The “type” attribute of the template can be DEFAULT, CUSTOM, or 3PL-specific (for example, DELIVERR) templates.
The “type” attribute in the request payload of the Shipping Template cannot be updated.
A CUSTOM shipping template can have two combinations of Ship method
Only Freight Ship Method
Value and any other Ship Methods (Except Freight)
The international shipping template is designed for sellers whose fulfillment centers are located overseas, such as in China, India, or Hong Kong. These templates accommodate longer transit times than domestic ones.
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. Names with only spaces will be considered empty.
The maximum template length allowed is 25 characters.
The 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)
VALUE	6, 7
ONE_DAY	1
TWO_DAY	2
STANDARD	3, 4, 5
FREIGHT	6, 7, 8, 9, 10
INTERNATIONAL – STANDARD	Depends on the country of origin (for example, China: 5 to 13 business days).

Note: Use the VALUE ship method for free shipping with a six- or seven-day transit time. Use the FREIGHT ship method for paid shipping with a six to ten-day transit time.*

Max charges allowed for ship methods

Max Charges allowed for Ship Methods:

Method	Shipping and Handling	Charge Per Weight	Charge Per Item	Tiered Charges
VALUE	0	0	0	0
STANDARD	700	700	700	700
TWO_DAY	0	0	0	0
ONE_DAY	700	700	700	700
FREIGHT	700	700	700	700
INTERNATIONAL	700	700	700	700

Freight ship method

Only allowed for Custom templates.
No granular subregions are supported.

One day (rush) ship method

Only allow Sellers approved for the One Day Program.
Shipping can be free or paid (For both rate models).

Two-day (expedited) ship method

– Only allowed for Sellers approved on the Two-Day Program.
– Free shipping is always available for expedited shipping methods (Both rate models).

Value ship method

Can have multiple shipping rules.
Value Ship-method should have 48 STATE region, and the address type should be STREET.
HI, AK, and other uncommon regions can be selected if required.
For VALUE ship methods, no granular subregions are supported.
Free shipping is always for Value Shipping Methods (both rate models).

Standard ship method

Granular subregions must be supplied for 48 states and address type Street.

International standard ship method

Granular subregions must be supplied for 48 states and address type Street.

Coverage areas

No Granular subregion support for regions: HI and AK, Street, US Protec, APO/FPO. No Granular subregion support for 48 States PO BOX. No Overlapping of areas is 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, and -1 for attribute “maxLimit” indicates the highest value of charges for the shipping method.