Get a Shipping Template by Id

Retrieves the details of a single shipping template.

URL:	https://api.trademe.co.nz/v1/Shipping/Templates/{shippingTemplateId}.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	None
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

shippingTemplateId

Integer (required)

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Returns

ShippingTemplateId

Integer

Unique identifier of the Shipping Template

Name

String or null

Name of the Shipping Template

HandlingTime

TimeSpan

Handling time of the Shipping Template

HandlingTimeCutOff

String or null

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".

IsOversized

Boolean

If the Shipping Template is oversized

IsRestricted

Boolean

If the Shipping Template is restricted

ShippingOptions

Collection of <StructuredShippingOption> or null

List of Shipping Options related to the Shipping Template

ShippingOptionId

Integer

Unique identifier of the Shipping Option

Cost

Number

Cost of the Shipping Option

CarrierProduct

<CarrierProduct> or null

Carrier Product related to the Shipping Option

CarrierProductId	Integer	Unique identifier of the Carrier Product
Name	String or null	Name of the Carrier Product
MinimumDeliveryTime	TimeSpan	Minimum delivery time of the Carrier Product
MaximumDeliveryTime	TimeSpan	Maximum delivery time of the Carrier Product
IsRural	Boolean	If the product is rural
IsCombined	Boolean	If the product is combined shipping

ShipToRegions

Collection of <Region> or null

List of Regions that the Shipping Option ships to

RegionId	Integer	Unique identifier of the Region
Name	String or null	The name of the Region

Addons

Collection of <ShippingOptionAddon> or null

List of Addons that are available to the Shipping Option

CarrierAddonId

Integer

Identifier of the Carrier Addon

Name

String or null

Name of the addon

Type

Enumeration

Type of the addon

Signature

Addon is Signature

AdditionalCost

Number

Additional cost of the addon

Example XML Response (switch to JSON)

<ShippingTemplate xmlns="http://api.trademe.co.nz/v1">
  <ShippingTemplateId>123</ShippingTemplateId>
  <Name>ABC</Name>
  <HandlingTime>PT4H5M</HandlingTime>
  <HandlingTimeCutOff>ABC</HandlingTimeCutOff>
  <IsOversized>false</IsOversized>
  <IsRestricted>false</IsRestricted>
  <ShippingOptions>
    <StructuredShippingOption>
      <ShippingOptionId>123</ShippingOptionId>
      <Cost>123.0</Cost>
      <CarrierProduct>
        <CarrierProductId>123</CarrierProductId>
        <Name>ABC</Name>
        <MinimumDeliveryTime>PT4H5M</MinimumDeliveryTime>
        <MaximumDeliveryTime>PT4H5M</MaximumDeliveryTime>
        <IsRural>false</IsRural>
        <IsCombined>false</IsCombined>
      </CarrierProduct>
      <ShipToRegions>
        <Region>
          <RegionId>123</RegionId>
          <Name>ABC</Name>
        </Region>
        <Region>
          <RegionId>123</RegionId>
          <Name>ABC</Name>
        </Region>
      </ShipToRegions>
      <Addons>
        <ShippingOptionAddon>
          <CarrierAddonId>123</CarrierAddonId>
          <Name>ABC</Name>
          <Type>Signature</Type>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddon>
        <ShippingOptionAddon>
          <CarrierAddonId>123</CarrierAddonId>
          <Name>ABC</Name>
          <Type>Signature</Type>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddon>
      </Addons>
    </StructuredShippingOption>
    <StructuredShippingOption>
      <ShippingOptionId>123</ShippingOptionId>
      <Cost>123.0</Cost>
      <CarrierProduct>
        <CarrierProductId>123</CarrierProductId>
        <Name>ABC</Name>
        <MinimumDeliveryTime>PT4H5M</MinimumDeliveryTime>
        <MaximumDeliveryTime>PT4H5M</MaximumDeliveryTime>
        <IsRural>false</IsRural>
        <IsCombined>false</IsCombined>
      </CarrierProduct>
      <ShipToRegions>
        <Region>
          <RegionId>123</RegionId>
          <Name>ABC</Name>
        </Region>
        <Region>
          <RegionId>123</RegionId>
          <Name>ABC</Name>
        </Region>
      </ShipToRegions>
      <Addons>
        <ShippingOptionAddon>
          <CarrierAddonId>123</CarrierAddonId>
          <Name>ABC</Name>
          <Type>Signature</Type>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddon>
        <ShippingOptionAddon>
          <CarrierAddonId>123</CarrierAddonId>
          <Name>ABC</Name>
          <Type>Signature</Type>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddon>
      </Addons>
    </StructuredShippingOption>
  </ShippingOptions>
</ShippingTemplate>

Example JSON Response (switch to XML)

{
  "ShippingTemplateId": 123,
  "Name": "ABC",
  "HandlingTime": "PT4H5M",
  "HandlingTimeCutOff": "ABC",
  "IsOversized": false,
  "IsRestricted": false,
  "ShippingOptions": [
    {
      "ShippingOptionId": 123,
      "Cost": 123.0,
      "CarrierProduct": {
        "CarrierProductId": 123,
        "Name": "ABC",
        "MinimumDeliveryTime": "PT4H5M",
        "MaximumDeliveryTime": "PT4H5M",
        "IsRural": false,
        "IsCombined": false
      },
      "ShipToRegions": [
        {
          "RegionId": 123,
          "Name": "ABC"
        },
        {
          "RegionId": 123,
          "Name": "ABC"
        }
      ],
      "Addons": [
        {
          "CarrierAddonId": 123,
          "Name": "ABC",
          "Type": 0,
          "AdditionalCost": 123.0
        },
        {
          "CarrierAddonId": 123,
          "Name": "ABC",
          "Type": 0,
          "AdditionalCost": 123.0
        }
      ]
    },
    {
      "ShippingOptionId": 123,
      "Cost": 123.0,
      "CarrierProduct": {
        "CarrierProductId": 123,
        "Name": "ABC",
        "MinimumDeliveryTime": "PT4H5M",
        "MaximumDeliveryTime": "PT4H5M",
        "IsRural": false,
        "IsCombined": false
      },
      "ShipToRegions": [
        {
          "RegionId": 123,
          "Name": "ABC"
        },
        {
          "RegionId": 123,
          "Name": "ABC"
        }
      ],
      "Addons": [
        {
          "CarrierAddonId": 123,
          "Name": "ABC",
          "Type": 0,
          "AdditionalCost": 123.0
        },
        {
          "CarrierAddonId": 123,
          "Name": "ABC",
          "Type": 0,
          "AdditionalCost": 123.0
        }
      ]
    }
  ]
}