updateAddress
put
/ccstore/v1/organizationAddresses/{id}
Update Address. This endpoint is used to update address by its id of a Organization/Account in Oracle Commerce Cloud. All the properties in the request are optional but atleast one property is required to update an address.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the address that has to be updated.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Root Schema : updateAddress_request
Type:
Show Source
object-
address(optional):
object address
Updated address for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Example:
{
"address":{
"isDefaultBillingAddress":false,
"country":"US",
"types":[
{
"id":"ss-10002"
}
],
"phoneNumber":"973-974-1234",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle New",
"isDefaultShippingAddress":false,
"state":"AL"
},
"addressType":"Office Address New"
}Nested Schema : address
Type:
objectUpdated address for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address.
-
address2(optional):
string
The address2 of the secondary address
-
city(optional):
string
The city of the secondary address.
-
companyName(optional):
string
Company name of the secondary address.
-
country(optional):
string
The country of the address.
-
isDefaultBillingAddress(optional):
boolean
Marks an address as default billing address. Default value is false. Accepts true or false
-
isDefaultShippingAddress(optional):
boolean
Marks an address as default shipping address. Default value is false. Accepts true or false
-
phoneNumber(optional):
string
Phone Number of the address.
-
postalCode(optional):
string
Postal Code of the address.
-
state(optional):
string
The State of the address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
repository Id of the address type
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateAddress_response
Type:
Show Source
object-
address(optional):
object address
Address Object for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress Object for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Example Response (application/json)
{
"address":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10002"
}
],
"phoneNumber":"973-974-1234",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle",
"repositoryId":"180003",
"state":"AL"
},
"addressType":"Office Address",
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstore/v1/organizationAddresses"
}
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100183|If complete address input passed is empty|
|100184|If address id entered is empty|
|100053|If the organization invalid default billing address value|
|100185|If address id entered is invalid|
|100054|If the organization invalid default shipping address value|
|100186|Multiple address update is not allowed|
|100187|No address is found with the id in logged in user's organization|
|100188|If input properties passed are Null or empty string|
|23005|Phone Number is invalid|
|100000|If input passed is invalid|
|100001|If there was no organization found with the given id.|
|180106|One or more address type ID is invalid|
|100204|Missing ID for address type|
|
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code