POST v1/ShippingTemplate/{id}

This method saves an individual shipping template

Request Information

URI Parameters

Name Description Type Additional information
id

The unique identifier of the shipping template

integer

Optional

Body Parameters

The shipping template data to insert/update

ShippingTemplate

Name Description Type
ShippingTemplateID

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

integer
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer
Name

The shipping template name e.g. Post template

string
ShippingTemplateOptions

The list of shipping template options for the shipping template

Collection of ShippingTemplateOption

Request Formats

application/json

Sample:

{
  "ShippingTemplateID": null,
  "OrganisationID": 3451460443781171981,
  "Name": "Shipping template 1",
  "ShippingTemplateOptions": [
    {
      "ShippingTemplateOptionID": 3451460443781171982,
      "Cost": 15.0,
      "Name": "Courier",
      "ShippingType": 25003
    },
    {
      "ShippingTemplateOptionID": 3451460443781171984,
      "Cost": 5.0,
      "Name": "Post",
      "ShippingType": 25002
    }
  ]
}

Response Information

Resource Description

The shipping template data from the Tradevine database

ShippingTemplate

Name Description Type
ShippingTemplateID

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

integer
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer
Name

The shipping template name e.g. Post template

string
ShippingTemplateOptions

The list of shipping template options for the shipping template

Collection of ShippingTemplateOption

Response Formats

application/json

Sample:

{
  "ShippingTemplateID": null,
  "OrganisationID": 3451460443781171981,
  "Name": "Shipping template 1",
  "ShippingTemplateOptions": [
    {
      "ShippingTemplateOptionID": 3451460443781171982,
      "Cost": 15.0,
      "Name": "Courier",
      "ShippingType": 25003
    },
    {
      "ShippingTemplateOptionID": 3451460443781171984,
      "Cost": 5.0,
      "Name": "Post",
      "ShippingType": 25002
    }
  ]
}