listProfileAddresses

get

/ccagent/v1/profiles/{id}/addresses

Get Profile Addresses specific to the customer profile.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listProfileAddresses_response
Type: object
Show Source
Nested Schema : items
Type: array
Addresses related properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
The address object of the profile
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
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":{
                "firstName":null,
                "lastName":null,
                "country":"US",
                "phoneNumber":null,
                "address2":null,
                "city":"sdf",
                "address1":"sdfs",
                "postalCode":"35005",
                "companyName":null,
                "repositoryId":"140065",
                "county":null,
                "state":"AL"
            },
            "addressType":"test2##0"
        },
        {
            "address":{
                "firstName":null,
                "lastName":null,
                "country":"US",
                "phoneNumber":null,
                "address2":"dsfsd",
                "city":"sdf",
                "address1":"dsss",
                "postalCode":"35005",
                "companyName":null,
                "repositoryId":"140059",
                "county":null,
                "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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top