GET shipping-methods/{shippingmethodid}

Get a shipping method by ID for an account.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shippingmethodid The ID of the shipping method you want to retrieve. integer Required

Body Parameters

None.

Response Information

Resource Description

Get a shipping method by ID for an account.

ShippingMethodModel
NameDescriptionTypeAdditional information
ShippingCompany This is the company that facilitates the shipping. 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",
  "IsDefault": true,
  "Cost": 1.5,
  "ShippingTaxAmount": 20,
  "ShippingMethodID": 1,
  "Name": "Royal Mail First Class"
}

application/xml, text/xml

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