GET v2/ShippingTemplate
Retrieves a list of Shipping Templates for the current organisation.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A collection of Shipping Templates
Collection of ShippingTemplateV2Response
| Name | Description | Type |
|---|---|---|
| ShippingTemplateID |
The unique internal identifier of each shipping template in Tradevine e.g. 3451582911247567682 |
integer |
| Name |
The shipping template name e.g. Post template |
string |
| HandlingTime |
Handling time of the Shipping Template in ISO 8601 duration. eg "P1DT12H" being 1 day and 12 hours |
time interval |
| HandlingTimeCutOff |
Handling time cut off of the Shipping Template. It is a 24-hour time in ISO 8601 extended format. Any seconds are truncated. E.g. for a cut-off time of 4:30 pm, this value will be "16:30". |
string |
| IsOversized |
If the Shipping Template is oversized |
boolean |
| IsRestricted |
If the Shipping Template is restricted |
boolean |
| ShippingOptions |
The list of shipping template options for the shipping template. Not returned as part of the response when using GET v2/ShippingTemplate to retrieve a collection of shipping templates |
Collection of ShippingTemplateOptionV2Response |
Response Formats
application/json
Sample:
[
{
"ShippingTemplateID": 1,
"Name": "sample string 1",
"HandlingTime": "PT0.1234567S",
"HandlingTimeCutOff": "sample string 3",
"IsOversized": true,
"IsRestricted": true,
"ShippingOptions": [
{
"Cost": 1.0,
"CarrierProduct": {
"CarrierProductId": 1,
"Name": "sample string 2",
"MinimumDeliveryTime": "PT0.1234567S",
"MaximumDeliveryTime": "PT0.1234567S",
"IsRural": true,
"IsCombined": true,
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
}
]
},
"ShipToRegions": [
{
"RegionId": 1,
"Name": "sample string 2"
},
{
"RegionId": 1,
"Name": "sample string 2"
}
],
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
}
]
},
{
"Cost": 1.0,
"CarrierProduct": {
"CarrierProductId": 1,
"Name": "sample string 2",
"MinimumDeliveryTime": "PT0.1234567S",
"MaximumDeliveryTime": "PT0.1234567S",
"IsRural": true,
"IsCombined": true,
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
}
]
},
"ShipToRegions": [
{
"RegionId": 1,
"Name": "sample string 2"
},
{
"RegionId": 1,
"Name": "sample string 2"
}
],
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
}
]
}
]
},
{
"ShippingTemplateID": 1,
"Name": "sample string 1",
"HandlingTime": "PT0.1234567S",
"HandlingTimeCutOff": "sample string 3",
"IsOversized": true,
"IsRestricted": true,
"ShippingOptions": [
{
"Cost": 1.0,
"CarrierProduct": {
"CarrierProductId": 1,
"Name": "sample string 2",
"MinimumDeliveryTime": "PT0.1234567S",
"MaximumDeliveryTime": "PT0.1234567S",
"IsRural": true,
"IsCombined": true,
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
}
]
},
"ShipToRegions": [
{
"RegionId": 1,
"Name": "sample string 2"
},
{
"RegionId": 1,
"Name": "sample string 2"
}
],
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
}
]
},
{
"Cost": 1.0,
"CarrierProduct": {
"CarrierProductId": 1,
"Name": "sample string 2",
"MinimumDeliveryTime": "PT0.1234567S",
"MaximumDeliveryTime": "PT0.1234567S",
"IsRural": true,
"IsCombined": true,
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0
}
]
},
"ShipToRegions": [
{
"RegionId": 1,
"Name": "sample string 2"
},
{
"RegionId": 1,
"Name": "sample string 2"
}
],
"Addons": [
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
},
{
"CarrierAddonId": 1,
"Name": "sample string 2",
"Type": 0,
"AdditionalCost": 3.0
}
]
}
]
}
]