POST api/order/OnlineOrder/{onlineOrderID}/UpdateShipMethodWithOverrides?shipMethodID={shipMethodID}&ShippingTotal={ShippingTotal}&HandlingFee={HandlingFee}&ShippingTax={ShippingTax}&ShippingTaxCodeID={ShippingTaxCodeID}&HandlingTax={HandlingTax}&HandlingTaxCodeID={HandlingTaxCodeID}&shouldCalculateTax={shouldCalculateTax}
This function allows you to update the shipmethod associated to an online order with override values for Shipping and Handling
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| onlineOrderID | integer |
Required |
|
| shipMethodID | integer |
Required |
|
| ShippingTotal | decimal number |
None. |
|
| HandlingFee | decimal number |
None. |
|
| ShippingTax | decimal number |
None. |
|
| ShippingTaxCodeID | string |
None. |
|
| HandlingTax | decimal number |
None. |
|
| HandlingTaxCodeID | string |
None. |
|
| shouldCalculateTax | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
UpdateShipMethodViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingTotal |
New shipping total based on the new shipping rate. |
decimal number |
None. |
| TaxTotal |
New tax total based on the new shipping rate. |
decimal number |
None. |
| HandlingFee |
New handling fee based on the new shipping rate. |
decimal number |
None. |
| OrderTotal |
New order total based on the new shipping rate. |
decimal number |
None. |
| CreditUsed |
Credit used if any |
decimal number |
None. |
| BalanceDue |
New Balance due based on the new shipping rate. |
decimal number |
None. |
Response Formats
application/xml, text/xml
Sample:
<UpdateShipMethodViewModel> <ShippingTotal>1</ShippingTotal> <TaxTotal>2</TaxTotal> <HandlingFee>3</HandlingFee> <OrderTotal>4</OrderTotal> <CreditUsed>5</CreditUsed> <BalanceDue>6</BalanceDue> </UpdateShipMethodViewModel>
application/json, text/json
Sample:
{
"ShippingTotal": 1.0,
"TaxTotal": 2.0,
"HandlingFee": 3.0,
"OrderTotal": 4.0,
"CreditUsed": 5.0,
"BalanceDue": 6.0
}