List address requests
get
/ccstore/v1/organizations/current/customerAccounts/addressRequests
Fetches a paginated list of address requests for the current customer account.
Request
Supported Media Types
- application/json
Query Parameters
-
limit: integer
The number of items to return per page.Default Value:
250 -
offset: integer
The number of items to skip for pagination.Default Value:
0 -
q: string
This field specifies the query used to limit elements. The properties that are not supported for querying: address, statusDisplayName, repositoryId
-
sort: string
This field determines the sort order of the address requests to be fetched. The properties that are not supported for sorting: address, statusDisplayName, repositoryIdDefault Value:
lastModifiedTime:desc -
totalResults: boolean
Indicates if the total results should be included in the response.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
A paginated list of address requests.
Root Schema : listAddressRequests_response
Type:
objectResponse schema for a successful address request list.
Show Source
-
items:
array items
List of address requests.
-
limit:
integer
The limit of results per page.Example:
1 -
links:
array links
Pagination links.
-
offset:
integer
The current offset in the paginated results.Example:
0 -
sort:
array sort
An array that specifies the sort order.
-
total:
integer
The total number of address requests.Example:
1 -
totalResults:
integer
Total number of results available.Example:
1
Nested Schema : items
Type:
arrayList of address requests.
Show Source
-
Array of:
object addressRequest
Schema for a single address request.
Nested Schema : addressRequest
Type:
objectSchema for a single address request.
Show Source
-
address:
object requestAddressObject
Object representing a complete address, including street, city, state, postal code, and country.
-
approver:
object addressApprover
Approver details
-
comment:
string
Comment associated with the request.Example:
-
id:
string
Unique identifier for the address request.Example:
caar-10014 -
lastModifiedTime:
string(date-time)
Timestamp of the last modification.Example:
2025-10-06T18:41:22.000Z -
requester:
object addressRequester
Requester details.
-
status:
string
Current status of the address request.Example:
new -
statusDisplayName:
string
Human-readable status name.Example:
New
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 : addressApprover
Type:
objectApprover details
Show Source
-
email:
string
Email address of the approver.Example:
john.doe@oracle.com -
firstName:
string
First name of the approver.Example:
John -
id:
string
Unique identifier for the approver.Example:
aa-110034 -
lastName:
string
Last name of the approver.Example:
Doe
Nested Schema : addressRequester
Type:
objectRequester details.
Show Source
-
email:
string
Email address of the requester.Example:
vipendra.mehra@oracle.com -
firstName:
string
First name of the requester.Example:
Michael -
id:
string
Unique identifier for the requester.Example:
bb-110034 -
lastName:
string
Last name of the requester.Example:
Keaton
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
Nested Schema : items
Type:
Show Source
object-
href:
string
URL to interact with the request.Example:
ccstore/v1/organizations/current/customerAccounts/addressRequests -
rel:
string
Relation type of the link.Example:
self
Nested Schema : items
Type:
Show Source
object-
order:
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").Example:
desc -
property:
string
The name of the property to use for sorting.Example:
lastModifiedTime
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