PUT v1/Addresses

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Put.Address
NameDescriptionTypeAdditional information
companyName

string

String length: inclusive between 0 and 255

line1

string

String length: inclusive between 0 and 60

line2

string

String length: inclusive between 0 and 60

countryId

integer

None.

stateId

integer

None.

city

string

String length: inclusive between 0 and 50

postalZip

string

String length: inclusive between 0 and 10

addressType

string

None.

enforceFullAddress

boolean

None.

country

string

String length: inclusive between 0 and 250

state

string

String length: inclusive between 0 and 250

id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "companyName": "sample string 1",
  "line1": "sample string 2",
  "line2": "sample string 3",
  "countryId": 1,
  "stateId": 1,
  "city": "sample string 4",
  "postalZip": "sample string 5",
  "addressType": "sample string 6",
  "enforceFullAddress": true,
  "country": "sample string 7",
  "state": "sample string 8",
  "id": 9
}

Response Information

Resource Description

Common.Dto.Get.Address
NameDescriptionTypeAdditional information
customerAddressPreferenceId

integer

None.

companyName

string

None.

line1

string

None.

line2

string

None.

countryId

integer

None.

country

string

None.

stateId

integer

None.

state

string

None.

city

string

None.

postalZip

string

None.

addressType

string

None.

valid

boolean

None.

id

integer

None.

uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "customerAddressPreferenceId": 1,
  "companyName": "sample string 2",
  "line1": "sample string 3",
  "line2": "sample string 4",
  "countryId": 1,
  "country": "sample string 5",
  "stateId": 1,
  "state": "sample string 6",
  "city": "sample string 7",
  "postalZip": "sample string 8",
  "addressType": "sample string 9",
  "valid": true,
  "id": 11,
  "uri": "sample string 12"
}