Update a shipping template

You can update or delete a shipping template with the Settings APIs.

Update a shipping template

To update a shipping template, call the Update Shipping Template API: PUT /v3/settings/shipping/templates/{templateId}

View shipping template samples

We provide several sample shipping templates for various scenarios. To view samples, see Payload Samples in the Update Shipping Templates API Reference.

Template 3

This sample shows a payload example to update the Template 3 described above.

Each of these sample shipping templates corresponds to JSON samples provided in the API Reference: /v3/settings/shipping/templates{templateId}.

{ "id": "415805121105477633", "name": "Template a14", "type": "CUSTOM", "rateModelType": "TIERED_PRICING", "status": "ACTIVE", "shippingMethods": [ { "shipMethod": "STANDARD", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" }, { "regionCode": "3017", "regionName": "Urban Ontario" }, { "regionCode": "3019", "regionName": "Rural Ontario" }, { "regionCode": "2003", "regionName": "Greater Montreal" }, { "regionCode": "3023", "regionName": "Rural Quebec" }, { "regionCode": "3025", "regionName": "Eastern Canada" }, { "regionCode": "2005", "regionName": "Urban British Columbia" }, { "regionCode": "3005", "regionName": "Rural British Columbia" }, { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" }, { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 5, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": 8, "shipCharge": { "amount": 0, "currency": "CAD" } }, { "minLimit": 8.01, "maxLimit": -1, "shipCharge": { "amount": 0, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" }, { "regionCode": "2004", "regionName": "Greater Montreal - PO Box" }, { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" }, { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" }, { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 5, "minTransitTime": 2, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": 8, "shipCharge": { "amount": 0, "currency": "CAD" } }, { "minLimit": 8.01, "maxLimit": -1, "shipCharge": { "amount": 0, "currency": "CAD" } } ] } ] }, { "shipMethod": "EXPRESS", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" }, { "regionCode": "3017", "regionName": "Urban Ontario" }, { "regionCode": "3019", "regionName": "Rural Ontario" }, { "regionCode": "2003", "regionName": "Greater Montreal" }, { "regionCode": "3023", "regionName": "Rural Quebec" }, { "regionCode": "3025", "regionName": "Eastern Canada" }, { "regionCode": "2005", "regionName": "Urban British Columbia" }, { "regionCode": "3005", "regionName": "Rural British Columbia" }, { "regionCode": "3007", "regionName": "Urban Prairies (MB, SK, AB)" }, { "regionCode": "2009", "regionName": "Rest of Canada" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": 9, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 9.01, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } } ] }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" }, { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" }, { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "tieredShippingCharges": [ { "minLimit": 0, "maxLimit": 9, "shipCharge": { "amount": 2, "currency": "CAD" } }, { "minLimit": 9.01, "maxLimit": -1, "shipCharge": { "amount": 2, "currency": "CAD" } } ] } ] } ]
}