Documentation for PUT api/order/Order/Address?orderID={orderID}&shouldCalculateTax={shouldCalculateTax}

PUT api/order/Order/Address?orderID={orderID}&shouldCalculateTax={shouldCalculateTax}

This API allows updating shipping or billing address information for a given order..

Request Information

URI Parameters

Name	Description	Type	Additional information
orderID	The identifier of order to be updated.	integer	Required
shouldCalculateTax	When this flag is set to false the taxes won’t be recomputed as product of the shipping or billing address change. Optional. Default is true.	boolean	Default value is True

Body Parameters

UpdateAddressViewModel

Name	Description	Type	Additional information
BillingAddress	Billing address to be updated. This object field is optional when ShippingAddress object is sent.	AddressViewModelAddress	None.
ShippingAddress	Shipping address to be updated. This object field is optional when BillingAddress object is sent.	AddressViewModelAddress	None.
ShipGeoCode	The ship geo code of the order. This is automatically calculated by Freedom, but can be overriden by the client if required. Do not send if you want that Freedom finds this value.	string	None.

Request Formats

application/xml, text/xml

Sample:

<UpdateAddressViewModel>
  <BillingAddress>
    <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>
  </BillingAddress>
  <ShippingAddress>
    <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>
  </ShippingAddress>
  <ShipGeoCode>sample string 1</ShipGeoCode>
</UpdateAddressViewModel>

application/json, text/json

Sample:

{
  "BillingAddress": {
    "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
  },
  "ShippingAddress": {
    "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
  },
  "ShipGeoCode": "sample string 1"
}

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

Response Information

Resource Description

ApiResultOfOrderSummaryViewModel

Name	Type	Additional information
Result	OrderSummaryViewModel	None.
IsSuccessful	boolean	None.
MessageTranslationKey	string	None.
Message	string	None.
Messages	Collection of ApiResultMessage	None.

Response Formats

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

Sample:

Sample not available.