Update a Shipping Template

Updates the shipping template with the given ID.

URL:	https://api.trademe.co.nz/v1/Shipping/Templates/{shippingTemplateId}.{file_format}
HTTP Method:	PUT
Requires Authentication?	Yes
Permission Required:	MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
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.

PUT Data

ShippingTemplateId

Integer (optional)

ShippingTemplateId

Name

String (required)

Name

HandlingTime

TimeSpan (required)

HandlingTime

HandlingTimeCutOff

String (required)

HandlingTimeCutOff

IsOversized

Boolean (optional)

IsOversized

IsRestricted

Boolean (optional)

IsRestricted

ShippingOptions

Collection of <ShippingOptionRequest> (required)

ShippingOptions

ShippingOptionId

Integer (optional)

ShippingOptionId

Cost

Number (required)

Cost

CarrierProductId

Integer (required)

CarrierProductId

ShipToRegions

Collection of Integer (optional)

ShipToRegions

Addons

Collection of <ShippingOptionAddonRequest> (optional)

Addons

CarrierAddonId	Integer (required)	CarrierAddonId
AdditionalCost	Number (required)	AdditionalCost

Returns

Success	Boolean	Success

Example XML Request (switch to JSON)

<ShippingTemplateRequest 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>
    <ShippingOptionRequest>
      <ShippingOptionId>123</ShippingOptionId>
      <Cost>123.0</Cost>
      <CarrierProductId>123</CarrierProductId>
      <ShipToRegions>
        <int>123</int>
        <int>123</int>
      </ShipToRegions>
      <Addons>
        <ShippingOptionAddonRequest>
          <CarrierAddonId>123</CarrierAddonId>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddonRequest>
        <ShippingOptionAddonRequest>
          <CarrierAddonId>123</CarrierAddonId>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddonRequest>
      </Addons>
    </ShippingOptionRequest>
    <ShippingOptionRequest>
      <ShippingOptionId>123</ShippingOptionId>
      <Cost>123.0</Cost>
      <CarrierProductId>123</CarrierProductId>
      <ShipToRegions>
        <int>123</int>
        <int>123</int>
      </ShipToRegions>
      <Addons>
        <ShippingOptionAddonRequest>
          <CarrierAddonId>123</CarrierAddonId>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddonRequest>
        <ShippingOptionAddonRequest>
          <CarrierAddonId>123</CarrierAddonId>
          <AdditionalCost>123.0</AdditionalCost>
        </ShippingOptionAddonRequest>
      </Addons>
    </ShippingOptionRequest>
  </ShippingOptions>
</ShippingTemplateRequest>

Example JSON Request (switch to XML)

{
  "ShippingTemplateId": 123,
  "Name": "ABC",
  "HandlingTime": "PT4H5M",
  "HandlingTimeCutOff": "ABC",
  "IsOversized": false,
  "IsRestricted": false,
  "ShippingOptions": [
    {
      "ShippingOptionId": 123,
      "Cost": 123.0,
      "CarrierProductId": 123,
      "ShipToRegions": [
        123,
        123
      ],
      "Addons": [
        {
          "CarrierAddonId": 123,
          "AdditionalCost": 123.0
        },
        {
          "CarrierAddonId": 123,
          "AdditionalCost": 123.0
        }
      ]
    },
    {
      "ShippingOptionId": 123,
      "Cost": 123.0,
      "CarrierProductId": 123,
      "ShipToRegions": [
        123,
        123
      ],
      "Addons": [
        {
          "CarrierAddonId": 123,
          "AdditionalCost": 123.0
        },
        {
          "CarrierAddonId": 123,
          "AdditionalCost": 123.0
        }
      ]
    }
  ]
}

Example XML Response (switch to JSON)

<UpdateShippingTemplateResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
</UpdateShippingTemplateResponse>

Example JSON Response (switch to XML)

{
  "Success": false
}