Documentation for PUT api/order/OnlineOrder?partyGUID={partyGUID}&useValidation={useValidation}&localeID={localeID}

PUT api/order/OnlineOrder?partyGUID={partyGUID}&useValidation={useValidation}&localeID={localeID}

This function allows you to update the addresses associated to an online order

Request Information

URI Parameters

Name	Type	Additional information
partyGUID	string	Default value is
useValidation	boolean	Default value is True
localeID	integer	None.

Body Parameters

OnlineOrderAddressesViewModel

Name	Type	Additional information
onlineOrderId	integer	None.
shippingAddress	AddressViewModelAddress	None.
billingAddress	AddressViewModelAddress	None.
ShippingMethod	OnlineOrderShippingMethodViewModel	None.

Request Formats

application/xml, text/xml

Sample:

<OnlineOrderAddressesViewModel>
  <onlineOrderId>1</onlineOrderId>
  <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>
  <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>
  <ShippingMethod>
    <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>
  </ShippingMethod>
</OnlineOrderAddressesViewModel>

application/json, text/json

Sample:

{
  "onlineOrderId": 1,
  "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
  },
  "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
  },
  "ShippingMethod": {
    "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
    }
  }
}

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

Response Information

Resource Description

IOperationResultOfOnlineOrderAddressesViewModel

Name	Type	Additional information
IsSuccessful	boolean	None.
ValidationErrors	Dictionary of string [key] and string [value]	None.
Value	OnlineOrderAddressesViewModel	None.

Response Formats

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

Sample:

Sample not available.