update address for an Organization
put
/ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
Update Organization Address. This endpoint is used to update secondary address of an Organization in Oracle Retail Digital Commerce.
Request
Supported Media Types
- application/json
Path Parameters
-
addressId(required): string
The address id of the requested address for an Organization.
-
id(required): string
The ID of the requested Organization.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request. E.g., en,de,fr_CA.
Root Schema : updateOrganizationAddress_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",
"types":[
{
"id":"ss-10002"
}
],
"address3":"Street 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle New",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"973-974-1234",
"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.
-
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
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateOrganizationAddress_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
-
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 : items
Type:
Show Source
object-
displayName:
string
The name of the address type
-
id:
string
repository Id of the address type
-
repositoryId:
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",
"address3":"Street 3",
"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":"/ccadminui/v1/organizations/or-100001/secondaryAddresses/280004"
}
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Retail Digital Commerce:
|Error Code|Description|
|------------------|------------------|
|100183|If input or nickname given is null/empty|
|100030|Postal Code is required|
|100031|Country is required|
|100032|No State Region is found|
|23015|Phone Number is required|
|23005|Phone Number is invalid|
|80018|If an invalid country is provided|
|100067|If an invalid state is provided|
|100189|Duplicate Addresses Type are giving in input|
|100026|Company Name is required|
|100027|Address 1 is required|
|100028|City is required|
|100029|State is required|
|100000|If input passed is invalid|
|100001|If there was no organization found with the given id|
|100192|If user doesn't have enough rights to modify a field|
|180106|One or more address type ID is invalid|
|100204|Missing ID for address type|
|21021|Invalid {0} specified|
|100100|{0} is not specified|
|23004|Invalid postal code|
|20132|Invalid default value|
|
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