Documentation for POST api/order/Address?repDID={repDID}&customerDID={customerDID}&useValidation={useValidation}&onlineOrderID={onlineOrderID}&localeID={localeID}

POST api/order/Address?repDID={repDID}&customerDID={customerDID}&useValidation={useValidation}&onlineOrderID={onlineOrderID}&localeID={localeID}

Allows the creation of a particular address associated to a rep or customer

Request Information

URI Parameters

Name	Type	Additional information
repDID	string	Default value is
customerDID	string	Default value is
useValidation	boolean	Default value is True
onlineOrderID	integer	Default value is -1
localeID	integer	None.

Body Parameters

AddressViewModel

Name	Type	Additional information
ID	integer	None.
Description	string	None.
Street1	string	None.
Street2	string	None.
City	string	None.
Company	string	None.
State	string	None.
PostalCode	string	None.
County	string	None.
Country	string	None.
Phone	string	None.
Email	string	None.
FirstName	string	None.
LastName	string	None.
SpecialInstructions	string	None.
SuggestedAddress	boolean	None.
IsHiddenOnCart	boolean	None.
IsOverrideAddress	boolean	None.
IsDefaultProfile	byte	None.

Request Formats

application/xml, text/xml

Sample:

<AddressViewModel>
  <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>
</AddressViewModel>

application/json, text/json

Sample:

{
  "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 'AddressViewModel'.

Response Information

Resource Description

IAddressViewModel

Name	Type	Additional information
ID	integer	None.
Description	string	None.
Street1	string	None.
Street2	string	None.
City	string	None.
Company	string	None.
State	string	None.
PostalCode	string	None.
County	string	None.
Country	string	None.
Phone	string	None.
Email	string	None.
FirstName	string	None.
LastName	string	None.
SpecialInstructions	string	None.
SuggestedAddress	boolean	None.
IsHiddenOnCart	boolean	None.
IsDefaultProfile	byte	None.

Response Formats

application/xml, text/xml

Sample:

<AddressViewModel>
  <ID>0</ID>
  <Description />
  <Street1 />
  <Street2 />
  <City />
  <Company />
  <State />
  <PostalCode />
  <County />
  <Country />
  <Phone />
  <Email />
  <FirstName />
  <LastName />
  <SpecialInstructions />
  <SuggestedAddress>False</SuggestedAddress>
  <IsHiddenOnCart>False</IsHiddenOnCart>
  <IsOverrideAddress>False</IsOverrideAddress>
  <IsDefaultProfile>0</IsDefaultProfile>
</AddressViewModel>

application/json, text/json

Sample:

{
  "ID": 0,
  "SuggestedAddress": false,
  "IsHiddenOnCart": false,
  "IsOverrideAddress": false,
  "IsDefaultProfile": 0
}