Documentation for GET api/Shipping/ShippingMethod/GetForOnlineOrder?onlineOrderID={onlineOrderID}&localeID={localeID}&partyGUID={partyGUID}

GET api/Shipping/ShippingMethod/GetForOnlineOrder?onlineOrderID={onlineOrderID}&localeID={localeID}&partyGUID={partyGUID}

To get all the available shipping methods for a given online order

Request Information

URI Parameters

Name	Type	Additional information
onlineOrderID	integer	Required
localeID	integer	Default value is 1
partyGUID	string	Default value is

Body Parameters

None.

Response Information

Resource Description

A list of shipping methods with descriptions

Collection of OnlineOrderShippingMethodViewModel

Name	Type	Additional information
ID	integer	None.
ShipMethodID	integer	None.
Description	string	None.
Price	decimal number	None.
SortOrder	integer	None.
SMTSortOrder	integer	None.
ShipToOverride	boolean	None.
ShipToPartyHost	boolean	None.
IsDefault	boolean	None.
Web	boolean	None.
Autoship	boolean	None.
Signup	boolean	None.
Orders	boolean	None.
Reps	boolean	None.
Customers	boolean	None.
HandlingFee	decimal number	None.
ShouldBypassPromotions	boolean	None.
OverrideAddress	AddressViewModel	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfOnlineOrderShippingMethodViewModel>
  <OnlineOrderShippingMethodViewModel>
    <ID>1</ID>
    <ShipMethodID>2</ShipMethodID>
    <Description>sample string 3</Description>
    <Price>4</Price>
    <SortOrder>5</SortOrder>
    <SMTSortOrder>6</SMTSortOrder>
    <ShipToOverride>True</ShipToOverride>
    <ShipToPartyHost>True</ShipToPartyHost>
    <IsDefault>True</IsDefault>
    <Web>True</Web>
    <Autoship>True</Autoship>
    <Signup>True</Signup>
    <Orders>True</Orders>
    <Reps>True</Reps>
    <Customers>True</Customers>
    <HandlingFee>16</HandlingFee>
    <ShouldBypassPromotions>True</ShouldBypassPromotions>
    <OverrideAddress>
      <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>
    </OverrideAddress>
  </OnlineOrderShippingMethodViewModel>
  <OnlineOrderShippingMethodViewModel>
    <ID>1</ID>
    <ShipMethodID>2</ShipMethodID>
    <Description>sample string 3</Description>
    <Price>4</Price>
    <SortOrder>5</SortOrder>
    <SMTSortOrder>6</SMTSortOrder>
    <ShipToOverride>True</ShipToOverride>
    <ShipToPartyHost>True</ShipToPartyHost>
    <IsDefault>True</IsDefault>
    <Web>True</Web>
    <Autoship>True</Autoship>
    <Signup>True</Signup>
    <Orders>True</Orders>
    <Reps>True</Reps>
    <Customers>True</Customers>
    <HandlingFee>16</HandlingFee>
    <ShouldBypassPromotions>True</ShouldBypassPromotions>
    <OverrideAddress>
      <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>
    </OverrideAddress>
  </OnlineOrderShippingMethodViewModel>
</ListOfOnlineOrderShippingMethodViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "ShipMethodID": 2,
    "Description": "sample string 3",
    "Price": 4.0,
    "SortOrder": 5,
    "SMTSortOrder": 6,
    "ShipToOverride": true,
    "ShipToPartyHost": true,
    "IsDefault": true,
    "Web": true,
    "Autoship": true,
    "Signup": true,
    "Orders": true,
    "Reps": true,
    "Customers": true,
    "HandlingFee": 16.0,
    "ShouldBypassPromotions": true,
    "OverrideAddress": {
      "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
    }
  },
  {
    "ID": 1,
    "ShipMethodID": 2,
    "Description": "sample string 3",
    "Price": 4.0,
    "SortOrder": 5,
    "SMTSortOrder": 6,
    "ShipToOverride": true,
    "ShipToPartyHost": true,
    "IsDefault": true,
    "Web": true,
    "Autoship": true,
    "Signup": true,
    "Orders": true,
    "Reps": true,
    "Customers": true,
    "HandlingFee": 16.0,
    "ShouldBypassPromotions": true,
    "OverrideAddress": {
      "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
    }
  }
]