POST v2/ShippingTemplate

This method creates a structured shipping template

Request Information

URI Parameters

None.

Body Parameters

The shipping template data to insert/update

ShippingTemplateV2Request

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
ShippingOptions

The list of shipping template options for the shipping template

 Collection of ShippingTemplateOptionV2Request

Request Formats

application/json

Sample: 

{
  "ShippingTemplateID": 1,
  "Name": "sample string 1",
  "HandlingTime": "PT0.1234567S",
  "HandlingTimeCutOff": "sample string 3",
  "ShippingOptions": [
    {
      "Cost": 1.0,
      "CarrierProductId": 2,
      "ShipToRegions": [
        1,
        2
      ],
      "Addons": [
        {
          "CarrierAddonId": 1,
          "AdditionalCost": 2.0
        },
        {
          "CarrierAddonId": 1,
          "AdditionalCost": 2.0
        }
      ]
    },
    {
      "Cost": 1.0,
      "CarrierProductId": 2,
      "ShipToRegions": [
        1,
        2
      ],
      "Addons": [
        {
          "CarrierAddonId": 1,
          "AdditionalCost": 2.0
        },
        {
          "CarrierAddonId": 1,
          "AdditionalCost": 2.0
        }
      ]
    }
  ]
}

Response Information

Resource Description

The created shipping template id

ShippingTemplateV2CreateResponse

Name Description Type
ShippingTemplateID

The unique internal identifier of each shipping template in Tradevine e.g. 3451582911247567682

 integer

Response Formats

application/json

Sample: 

{
  "ShippingTemplateID": 1
}