Documentation for GET api/Shipping/ShippingMethod/GetByAddress

GET api/Shipping/ShippingMethod/GetByAddress

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Country	string	None.
State	string	None.
City	string	None.
PostalCode	string	None.
OrderTotal	decimal number	None.
Weight	decimal number	None.
LocaleID	integer	None.
Area	string	None.

Request Formats

application/xml, text/xml

Sample:

<ByAddressRequestViewModel>
  <Country>sample string 1</Country>
  <State>sample string 2</State>
  <City>sample string 3</City>
  <PostalCode>sample string 4</PostalCode>
  <OrderTotal>5</OrderTotal>
  <Weight>6</Weight>
  <LocaleID>7</LocaleID>
  <Area>sample string 8</Area>
</ByAddressRequestViewModel>

application/json, text/json

Sample:

{
  "Country": "sample string 1",
  "State": "sample string 2",
  "City": "sample string 3",
  "PostalCode": "sample string 4",
  "OrderTotal": 5.0,
  "Weight": 6.0,
  "LocaleID": 7,
  "Area": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'ByAddressRequestViewModel'.

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
  }
]