listProfileAddresses
get
/ccagent/v1/profiles/{id}/addresses
Get Profile Addresses specific to the customer profile.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The customer profile id.
Query Parameters
-
addressType(optional): string
Exact nick name to search.
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
q(optional): string
SCIM query to search on the address properties.
-
queryFormat(optional): string
queryFormat to search on the address properties. Possible values SCIM or null.
-
sort(optional): string
This field determines the sort order of the list to be fetched.
-
totalResults(optional): boolean
Tells whether to include total and totalResults in the SCIM query.By default the value is true
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listProfileAddresses_response
Type:
Show Source
object-
items(optional):
array items
Addresses related properties
-
limit(optional):
integer
The batch size of the records to be fetched together.
-
offset(optional):
integer
The start index of the list of records to be fetched
-
sort(optional):
string
Sorting format
Nested Schema : items
Type:
Show Source
object-
address(optional):
object address
The address object of the profile
-
addressType(optional):
string
The nickname for the address.
Nested Schema : address
Type:
objectThe address object of the profile
Show Source
-
address1(optional):
string
address line 1 for the address
-
address2(optional):
string
Address line 2 for the address
-
city(optional):
string
city for the address
-
companyName(optional):
string
companyName for the address. It is not mandatory for the profile addresses.
-
country(optional):
string
The country of the address
-
county(optional):
string
county for the address
-
firstName(optional):
string
The first name of the user for whom the address is created. This field can be null also
-
lastName(optional):
string
The last name of the user for whom the address is created. This field can be null also
-
phoneNumber(optional):
string
Phone number of the address
-
postalCode(optional):
string
postalCode for the address
-
repositoryId(optional):
string
Unique Id for the address
-
state(optional):
string
state for 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)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":8,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/profiles/bb-110023/addresses?limit=8&offset=0"
}
],
"items":[
{
"address":{
"lastName":null,
"country":"US",
"types":[
{
"displayName":"shipping",
"repositoryId":"ss-10002",
"id":"SHIPPING"
}
],
"address2":null,
"city":"sdf",
"address1":"sdfs",
"postalCode":"35005",
"companyName":null,
"county":null,
"firstName":null,
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":null,
"repositoryId":"140065",
"state":"AL"
},
"addressType":"test2##0"
},
{
"address":{
"lastName":null,
"country":"US",
"types":[
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"BILLING"
}
],
"address2":"dsfsd",
"city":"sdf",
"address1":"dsss",
"postalCode":"35005",
"companyName":null,
"county":null,
"firstName":null,
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":null,
"repositoryId":"140059",
"state":"AL"
},
"addressType":"This ##0"
}
]
}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|
|------------------|------------------|
|22030|User is not logged in|
|22031|Internal error during get profile|
|22032|Error occurred due to invalid data|
|22002|No profile found with profile id|
|89103|The current user does not have administrator privileges and is not associated to an account|
|100190|Error occurred while attempting to fetch addresses from the repository.|
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