Documentation for GET api/order/Order/{orderID}/AvailableShippingMethods?localeID={localeID}&flushCache={flushCache}

GET api/order/Order/{orderID}/AvailableShippingMethods?localeID={localeID}&flushCache={flushCache}

Shipping methods allowed for this order (e.g. party checkout), from order-scoped rules such as shipping method territories (spShipping_GetShippingMethods).

Request Information

URI Parameters

Name	Type	Additional information
orderID	integer	Required
localeID	integer	Default value is 1
flushCache	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of OrderAvailableShippingMethodViewModel

Name	Type	Additional information
ID	integer	None.
ShipMethodID	integer	None.
Description	string	None.
Price	decimal number	None.
ShipToOverride	boolean	None.
Explanation	string	None.
SortOrder	integer	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfOrderAvailableShippingMethodViewModel>
  <OrderAvailableShippingMethodViewModel>
    <ID>1</ID>
    <ShipMethodID>2</ShipMethodID>
    <Description>sample string 3</Description>
    <Price>4</Price>
    <ShipToOverride>True</ShipToOverride>
    <Explanation>sample string 6</Explanation>
    <SortOrder>7</SortOrder>
  </OrderAvailableShippingMethodViewModel>
  <OrderAvailableShippingMethodViewModel>
    <ID>1</ID>
    <ShipMethodID>2</ShipMethodID>
    <Description>sample string 3</Description>
    <Price>4</Price>
    <ShipToOverride>True</ShipToOverride>
    <Explanation>sample string 6</Explanation>
    <SortOrder>7</SortOrder>
  </OrderAvailableShippingMethodViewModel>
</ListOfOrderAvailableShippingMethodViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "ShipMethodID": 2,
    "Description": "sample string 3",
    "Price": 4.0,
    "ShipToOverride": true,
    "Explanation": "sample string 6",
    "SortOrder": 7
  },
  {
    "ID": 1,
    "ShipMethodID": 2,
    "Description": "sample string 3",
    "Price": 4.0,
    "ShipToOverride": true,
    "Explanation": "sample string 6",
    "SortOrder": 7
  }
]