listProfileAddresses
get
/ccapp/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
-
address3(optional):
string
Address line 3 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
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
Fax number for this address.
-
firstName(optional):
string
The first name of the user for whom the address is created. This field can be null also
-
id(optional):
string
Id for this address.
-
jobTitle(optional):
string
Job title for this address.
-
lastName(optional):
string
The last name of the user for whom the address is created. This field can be null also
-
middleName(optional):
string
Middle name for this address.
-
phoneNumber(optional):
string
Phone number of the address
-
postalCode(optional):
string
postalCode for the address
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
Unique Id for the address
-
state(optional):
string
state for the address
-
suffix(optional):
string
Suffix for this 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
-
repositroyId(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/ccadminui/v1/profiles/bb-110023/addresses?limit=8&offset=0"
}
],
"items":[
{
"address":{
"country":"US",
"lastName":"Anderson",
"types":[
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10002"
}
],
"address3":null,
"city":"Buffalo",
"address2":null,
"prefix":null,
"address1":"451 Brooks Ave",
"postalCode":"14201",
"jobTitle":null,
"companyName":null,
"county":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-2150",
"repositoryId":"se-970031",
"faxNumber":null,
"middleName":null,
"state":"NY",
"id":"se-970031"
},
"addressType":"test2##0"
},
{
"address":{
"country":"US",
"lastName":"Smith",
"types":[
{
"displayName":"Shipping",
"repositoryId":"ss-10001",
"id":"ss-10001"
}
],
"address3":null,
"city":"New York",
"address2":null,
"prefix":null,
"address1":"14 New Ave",
"postalCode":"34563",
"jobTitle":null,
"companyName":null,
"county":null,
"suffix":null,
"firstName":"John",
"phoneNumber":"667-45-2345",
"repositoryId":"ss-456631",
"faxNumber":null,
"middleName":null,
"state":"NY",
"id":"ss-456631"
},
"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|
|------------------|------------------|
|22031|Internal error during get profile|
|22002|No profile found with profile id|
|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