Documentation for GET api/Shipping/ShippingMethod/GetByCountry?country={country}

GET api/Shipping/ShippingMethod/GetByCountry?country={country}

Retrieves all shipping methods for the specified country.

Request Information

URI Parameters

Name	Description	Type	Additional information
country		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ByAddressOutputViewModel

Name	Type	Additional information
ShipMethodID	integer	None.
Description	string	None.
SortOrder	integer	None.
ShipCost	decimal number	None.
MultipleUnit	string	None.
AddressOverride	ByAddressOverrideOutputViewModel	None.
Web	boolean	None.
Autoship	boolean	None.
Signup	boolean	None.
BackOffice	boolean	None.
Reps	boolean	None.
Customers	boolean	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfByAddressOutputViewModel>
  <ByAddressOutputViewModel>
    <ShipMethodID>1</ShipMethodID>
    <Description>sample string 2</Description>
    <SortOrder>3</SortOrder>
    <ShipCost>4</ShipCost>
    <MultipleUnit>sample string 5</MultipleUnit>
    <AddressOverride>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <PostalCode>sample string 5</PostalCode>
      <County>sample string 6</County>
      <Country>sample string 7</Country>
    </AddressOverride>
    <Web>True</Web>
    <Autoship>True</Autoship>
    <Signup>True</Signup>
    <Orders>True</Orders>
    <Reps>True</Reps>
    <Customers>True</Customers>
  </ByAddressOutputViewModel>
  <ByAddressOutputViewModel>
    <ShipMethodID>1</ShipMethodID>
    <Description>sample string 2</Description>
    <SortOrder>3</SortOrder>
    <ShipCost>4</ShipCost>
    <MultipleUnit>sample string 5</MultipleUnit>
    <AddressOverride>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <PostalCode>sample string 5</PostalCode>
      <County>sample string 6</County>
      <Country>sample string 7</Country>
    </AddressOverride>
    <Web>True</Web>
    <Autoship>True</Autoship>
    <Signup>True</Signup>
    <Orders>True</Orders>
    <Reps>True</Reps>
    <Customers>True</Customers>
  </ByAddressOutputViewModel>
</ListOfByAddressOutputViewModel>

application/json, text/json

Sample:

[
  {
    "ShipMethodID": 1,
    "Description": "sample string 2",
    "SortOrder": 3,
    "ShipCost": 4.0,
    "MultipleUnit": "sample string 5",
    "AddressOverride": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "PostalCode": "sample string 5",
      "County": "sample string 6",
      "Country": "sample string 7"
    },
    "Web": true,
    "Autoship": true,
    "Signup": true,
    "BackOffice": true,
    "Reps": true,
    "Customers": true
  },
  {
    "ShipMethodID": 1,
    "Description": "sample string 2",
    "SortOrder": 3,
    "ShipCost": 4.0,
    "MultipleUnit": "sample string 5",
    "AddressOverride": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "PostalCode": "sample string 5",
      "County": "sample string 6",
      "Country": "sample string 7"
    },
    "Web": true,
    "Autoship": true,
    "Signup": true,
    "BackOffice": true,
    "Reps": true,
    "Customers": true
  }
]