updateAddress
put
/ccagent/v1/organizationAddresses/{id}
Update Address. This endpoint is used to update address by its id of a Organization/Account in Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. The inherited addresses cannot be updated, except setting the existing inherited address to default. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the address that has to be updated.
Header Parameters
-
X-CCAgentContext(required): string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCAsset-Language: string
The asset language of the request. E.g., en,de,fr_CA.
-
X-CCOrganization: string
the organization Id
Root Schema : updateAddress_request
Type:
Show Source
object-
address:
object address
Updated address for the Organization.
-
addressType:
string
Address type represents nick name of account if present else repository ID of address item.
Example:
{
"address":{
"isDefaultBillingAddress":false,
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
"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:
string
The address1 of the secondary address.
-
address2:
string
The address2 of the secondary address
-
address3:
string
The address3 of the secondary address
-
city:
string
The city of the secondary address.
-
companyName:
string
Company name of the secondary address.
-
country:
string
The country of the address.
-
county:
string
The county of the secondary address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
isDefaultBillingAddress:
boolean
Marks an address as default billing address. Default value is false. Accepts true or false
-
isDefaultShippingAddress:
boolean
Marks an address as default shipping address. Default value is false. Accepts true or false
-
phoneNumber:
string
Phone Number of the address.
-
postalCode:
string
Postal Code of the address.
-
state:
string
The State of the address.
-
types:
array types
The types tagged to the address
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : items
Type:
Show Source
object-
addressType:
string
The name of the address type
-
repositoryId:
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:
object address
Address created for the Organization.
-
addressType:
string
Address type represents nick name of address if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress created for the Organization.
Show Source
-
address1:
string
The address1 of the secondary address
-
address2:
string
The address2 of the secondary address
-
address3:
string
The address3 of the secondary address
-
city:
string
The city of the secondary address
-
companyName:
string
Company name of the secondary address
-
country:
string
The country of the address
-
county:
string
The county of the secondary address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
Phone Number of the address
-
postalCode:
string
Postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
The State of the address
-
types:
array types
The types tagged to the address
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Example Response (application/json)
{
"address":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
"ss-10001",
"ss-10002"
],
"phoneNumber":"973-974-1234",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"companyName":"National Discount Auto Parts",
"postalCode":"36130",
"repositoryId":"280004",
"state":"AL"
},
"addressType":"Montgomery Office Address",
"links":[
{
"rel":"self",
"href":"/ccagentui/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|
|------------------|------------------|
|80018|If an invalid country is provided|
|100053|If the organization invalid default billing address value|
|100185|If the address's repositoryId is invalid|
|100054|If the organization invalid default shipping address value|
|100067|If an invalid state is provided|
|100188|If input properties passed are Null or empty string|
|82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors|
|23005|Phone Number is invalid|
|89103|If no shopperProfileId is passed in the AgentContext header|
|89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|
|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account|
|100192|One of the dynamic properties is not writable by the Agent user|
|180106|One or more address type ID is invalid|
|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code