Approve of an address request.
post
/ccstore/v1/organizations/current/customerAccounts/addressRequests/{addressRequestId}/approve
Approval of a customer account address request by account address manager.
Request
Supported Media Types
- application/json
Path Parameters
-
addressRequestId(required): string
The unique identifier of the address request to approve.
Request body for an address request, including customer, billing account ans set id information.
Root Schema : approveAddressRequest_payload
Type:
objectRequest body for an address request, including customer, billing account ans set id information.
Show Source
-
address:
object requestAddressObject
Object representing a complete address, including street, city, state, postal code, and country.
-
billingAccountId:
string
Unique identifier for the billing account associated with the customer account. Approver should ensure valid value for the property.Example:
ba12345 -
comment:
string
Comment provided while approving the address request.Example:
approved. -
customerAccountId:
string
Unique identifier for the customer account. Approver should ensure valid value for the property.Example:
ca12345 -
setId:
string
Identifier for a set of addresses associated with the applicable business unit. Defaulted to configured set id. Approver should ensure valid value for the property.Example:
204
Nested Schema : requestAddressObject
Type:
objectObject representing a complete address, including street, city, state, postal code, and country.
Show Source
-
address1(required):
string
Primary street address line.Example:
600 Dexter Avenue -
address2:
string
Secondary address line (if applicable, e.g., apartment number, suite).Example:
Street 2 -
address3:
string
Tertiary address line (if applicable).Example:
Street 3 -
address4:
string
Additional address line (if applicable).Example:
Street 4 -
city(required):
string
City or locality of the address.Example:
Montgomery -
country(required):
string
Country code (e.g., US for United States).Example:
US -
postalCode(required):
string
Postal code or ZIP code for the address.Example:
36130 -
state(required):
string
State or region of the address (e.g., AL for Alabama).Example:
AL -
types:
array types
List of address types associated with the address (e.g., SHIPPING, BILLING). This can be an empty array.
Nested Schema : types
Type:
arrayList of address types associated with the address (e.g., SHIPPING, BILLING). This can be an empty array.
Show Source
-
Array of:
object requestAddressType
Defines the type of address (e.g., SHIPPING or BILLING).
Nested Schema : requestAddressType
Type:
objectDefines the type of address (e.g., SHIPPING or BILLING).
Show Source
-
id(required):
string
ID representing the type of address (e.g., SHIPPING or BILLING).Example:
SHIPPING
Response
Supported Media Types
- application/json
200 Response
Address request successfully approved
Root Schema : schema
Type:
Show Source
object-
links:
array links
-
result:
string
Message indicating the result of the address approval.Example:
Address request has been approved.
Nested Schema : items
Type:
Show Source
object-
href:
string
The URL to interact with the address request resource.Example:
/ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/approve -
rel:
string
The relationship type of the link.Example:
self
202 Response
Address request approved (only acceptance). This happens when Customer Data Master is not enabled. Approval will NOT result in address creation in downstream system or occ.
Root Schema : schema
Type:
Show Source
object-
links:
array links
-
result:
string
Message indicating the result of the address approval.Example:
Address request has been approved. Please proceed with creating the address in the downstream system.
Nested Schema : items
Type:
Show Source
object-
href:
string
The URL to interact with the address request resource.Example:
/ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/approve -
rel:
string
The relationship type of the link.Example:
self
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 |
|------------|-------------|
| 270001 | Error related to address request |
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