Documentation for POST api/Shipping/ShippingMethod/GetForAutoShip?localeID={localeID}&isRep={isRep}

POST api/Shipping/ShippingMethod/GetForAutoShip?localeID={localeID}&isRep={isRep}

To get available shipping methods based on address

Request Information

URI Parameters

Name	Description	Type	Additional information
localeID		integer	Default value is 1
isRep		boolean	Default value is False

Body Parameters

AddressViewModelAddress

Name	Type	Additional information
ID	integer	None.
Description	string	None.
Street1	string	None.
Street2	string	None.
City	string	None.
Company	string	None.
State	string	None.
PostalCode	string	None.
County	string	None.
Country	string	None.
Phone	string	None.
Email	string	None.
FirstName	string	None.
LastName	string	None.
SpecialInstructions	string	None.
SuggestedAddress	boolean	None.
IsHiddenOnCart	boolean	None.
IsOverrideAddress	boolean	None.
IsDefaultProfile	byte	None.

Request Formats

application/xml, text/xml

Sample:

<AddressViewModelAddress>
  <ID>1</ID>
  <Description>sample string 2</Description>
  <Street1>sample string 3</Street1>
  <Street2>sample string 4</Street2>
  <City>sample string 5</City>
  <Company>sample string 6</Company>
  <State>sample string 7</State>
  <PostalCode>sample string 8</PostalCode>
  <County>sample string 9</County>
  <Country>sample string 10</Country>
  <Phone>sample string 11</Phone>
  <Email>sample string 12</Email>
  <FirstName>sample string 13</FirstName>
  <LastName>sample string 14</LastName>
  <SpecialInstructions>sample string 15</SpecialInstructions>
  <SuggestedAddress>True</SuggestedAddress>
  <IsHiddenOnCart>True</IsHiddenOnCart>
  <IsOverrideAddress>True</IsOverrideAddress>
  <IsDefaultProfile>64</IsDefaultProfile>
</AddressViewModelAddress>

application/json, text/json

Sample:

{
  "ID": 1,
  "Description": "sample string 2",
  "Street1": "sample string 3",
  "Street2": "sample string 4",
  "City": "sample string 5",
  "Company": "sample string 6",
  "State": "sample string 7",
  "PostalCode": "sample string 8",
  "County": "sample string 9",
  "Country": "sample string 10",
  "Phone": "sample string 11",
  "Email": "sample string 12",
  "FirstName": "sample string 13",
  "LastName": "sample string 14",
  "SpecialInstructions": "sample string 15",
  "SuggestedAddress": true,
  "IsHiddenOnCart": true,
  "IsOverrideAddress": true,
  "IsDefaultProfile": 64
}

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 'AddressViewModelAddress'.

Response Information

Resource Description

Collection of IShippingMethodViewModel

Name	Type	Additional information
ShipMethodID	integer	None.
Description	string	None.
Price	decimal number	None.
SortOrder	integer	None.
SMTSortOrder	integer	None.
ShipToOverride	boolean	None.
ShipToPartyHost	boolean	None.
Explanation	string	None.
IsDefault	boolean	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipState	string	None.
ShipPostalCode	string	None.
ShipCountry	string	None.
ShipCounty	string	None.
MultipleUnit	string	None.
Web	boolean	None.
Autoship	boolean	None.
Signup	boolean	None.
Orders	boolean	None.
Reps	boolean	None.
Customers	boolean	None.
HandlingFee	decimal number	None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.