PUT v1/CustomerAddressPreferences

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Put.CustomerAddressPreference
NameDescriptionTypeAdditional information
contactName

string

String length: inclusive between 0 and 100

shippingInstructions

string

String length: inclusive between 0 and 1000

useBillingAddressAsShippingAddress

boolean

None.

id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "contactName": "sample string 1",
  "shippingInstructions": "sample string 2",
  "useBillingAddressAsShippingAddress": true,
  "id": 4
}

Response Information

Resource Description

Common.Dto.Get.CustomerAddressPreference
NameDescriptionTypeAdditional information
contactName

string

None.

shippingInstructions

string

None.

useBillingAddressAsShippingAddress

boolean

None.

addressForTaxes

Common.Dto.Get.Address

None.

billingAddress

Common.Dto.Get.Address

None.

shippingAddress

Common.Dto.Get.Address

None.

id

integer

None.

uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "contactName": "sample string 1",
  "shippingInstructions": "sample string 2",
  "useBillingAddressAsShippingAddress": true,
  "addressForTaxes": {
    "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"
  },
  "billingAddress": {
    "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"
  },
  "shippingAddress": {
    "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"
  },
  "id": 4,
  "uri": "sample string 5"
}