POST shipping-methods

Create a new shipping method

Request Information

URI Parameters

None.

Body Parameters

CreateShippingMethodCommand
NameDescriptionTypeAdditional information
ChannelCourierID The ID of the courier to add this shipping method to integer None.
ShippingMethodName Name to give the shipping method, must be unique per courier string None.
ServiceCode Courier service code to be assigned to the shipping method string None.
Cost Optional, defaults to zero decimal number None.
ShippingTaxPercentage The percentage of the cost that is tax integer None.

Request Formats

application/json, text/json

Sample: 
{
  "ChannelCourierID": 1,
  "ShippingMethodName": "72 hours",
  "ServiceCode": "ANCDECO72",
  "Cost": 1.99,
  "ShippingTaxPercentage": 20
}

application/xml, text/xml

Sample: 
<CreateShippingMethodCommand xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChannelCourierID>1</ChannelCourierID>
  <ShippingMethodName>72 hours</ShippingMethodName>
  <ServiceCode>ANCDECO72</ServiceCode>
  <Cost>1.99</Cost>
  <ShippingTaxPercentage>20</ShippingTaxPercentage>
</CreateShippingMethodCommand>

Response Information

Resource Description

Create a new shipping method

ShippingMethodModel
NameDescriptionTypeAdditional information
ShippingCompany This is the company that facilitates the shipping. string None.
ShippingChannelName This is the channel name of the courier integration. string None.
IsDefault This is whether the shipping method is your default. boolean None.
Cost This is the shipping methods default cost. decimal number None.
ShippingTaxAmount This is the percentage of shipping tax included in the cost. integer None.
ShippingMethodID This is the Shipping Method ID for the Shipping Method. integer None.
Name This is the name of the shipping method string None.
ServiceCode This is the courier service code associated with the Shipping Method string None.

Response Formats

application/json, text/json

Sample: 
{
  "ShippingCompany": "Royal Mail",
  "ShippingChannelName": "Royal Mail",
  "IsDefault": true,
  "Cost": 1.5,
  "ShippingTaxAmount": 20,
  "ShippingMethodID": 1,
  "Name": "Royal Mail First Class"
}

application/xml, text/xml

Sample: 
<ShippingMethodModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ShippingMethodID>1</ShippingMethodID>
  <Name>Royal Mail First Class</Name>
  <ShippingCompany>Royal Mail</ShippingCompany>
  <ShippingChannelName>Royal Mail</ShippingChannelName>
  <IsDefault>true</IsDefault>
  <Cost>1.50</Cost>
  <ShippingTaxAmount>20</ShippingTaxAmount>
</ShippingMethodModel>