GET shipping-methods

Get all shipping methods for an account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Get all shipping methods for an account.

Collection of 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"
  },
  {
    "ShippingCompany": "Royal Mail",
    "ShippingChannelName": "Royal Mail",
    "IsDefault": false,
    "Cost": 0.0,
    "ShippingTaxAmount": 20,
    "ShippingMethodID": 0,
    "Name": "Royal Mail Second Class"
  },
  {
    "ShippingCompany": "Royal Mail",
    "ShippingChannelName": "Royal Mail",
    "IsDefault": false,
    "Cost": 4.5,
    "ShippingTaxAmount": 20,
    "ShippingMethodID": 0,
    "Name": "Royal Mail Special Delivery"
  },
  {
    "ShippingCompany": "DPD",
    "ShippingChannelName": "DPD",
    "IsDefault": false,
    "Cost": 10.5,
    "ShippingTaxAmount": 20,
    "ShippingMethodID": 0,
    "Name": "Next Day Delivery"
  },
  {
    "ShippingCompany": "Royal Mail",
    "ShippingChannelName": "Royal Mail",
    "IsDefault": false,
    "Cost": 10.5,
    "ShippingTaxAmount": 0,
    "ShippingMethodID": 0,
    "Name": "Royal Mail International"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfShippingMethodModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ShippingMethodModel>
    <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>
  <ShippingMethodModel>
    <ShippingMethodID>0</ShippingMethodID>
    <Name>Royal Mail Second Class</Name>
    <ShippingCompany>Royal Mail</ShippingCompany>
    <ShippingChannelName>Royal Mail</ShippingChannelName>
    <IsDefault>false</IsDefault>
    <Cost>0.00</Cost>
    <ShippingTaxAmount>20</ShippingTaxAmount>
  </ShippingMethodModel>
  <ShippingMethodModel>
    <ShippingMethodID>0</ShippingMethodID>
    <Name>Royal Mail Special Delivery</Name>
    <ShippingCompany>Royal Mail</ShippingCompany>
    <ShippingChannelName>Royal Mail</ShippingChannelName>
    <IsDefault>false</IsDefault>
    <Cost>4.50</Cost>
    <ShippingTaxAmount>20</ShippingTaxAmount>
  </ShippingMethodModel>
  <ShippingMethodModel>
    <ShippingMethodID>0</ShippingMethodID>
    <Name>Next Day Delivery</Name>
    <ShippingCompany>DPD</ShippingCompany>
    <ShippingChannelName>DPD</ShippingChannelName>
    <IsDefault>false</IsDefault>
    <Cost>10.50</Cost>
    <ShippingTaxAmount>20</ShippingTaxAmount>
  </ShippingMethodModel>
  <ShippingMethodModel>
    <ShippingMethodID>0</ShippingMethodID>
    <Name>Royal Mail International</Name>
    <ShippingCompany>Royal Mail</ShippingCompany>
    <ShippingChannelName>Royal Mail</ShippingChannelName>
    <IsDefault>false</IsDefault>
    <Cost>10.50</Cost>
    <ShippingTaxAmount>0</ShippingTaxAmount>
  </ShippingMethodModel>
</ArrayOfShippingMethodModel>