Website logo

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

<ShippingTemplate>

ShippingTemplateId Integer ShippingTemplateId
Name String or null Name
HandlingTime TimeSpan HandlingTime
HandlingTimeCutOff String or null HandlingTimeCutOff
IsOversized Boolean IsOversized
IsRestricted Boolean IsRestricted
ShippingOptions Collection of <StructuredShippingOption> or null ShippingOptions
ShippingOptionId Integer ShippingOptionId
Cost Number Cost
CarrierProduct <CarrierProduct> or null CarrierProduct
CarrierProductId Integer CarrierProductId
Name String or null Name
MinimumDeliveryTime TimeSpan MinimumDeliveryTime
MaximumDeliveryTime TimeSpan MaximumDeliveryTime
IsRural Boolean IsRural
IsCombined Boolean IsCombined
ShipToRegions Collection of <Region> or null ShipToRegions
RegionId Integer RegionId
Name String or null Name
Addons Collection of <ShippingOptionAddon> or null Addons
CarrierAddonId Integer CarrierAddonId
Name String or null Name
Type Enumeration Type
Signature 0 Signature
AdditionalCost Number AdditionalCost

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
        }
      ]
    }
  ]
}