listAddresses

get

/ccagent/v1/addresses

List Addresses. This operation is used to get the list of addresses. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.

Request

Supported Media Types
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listAddresses_response
Type: object
Show Source
Nested Schema : items
Type: array
List of all the addresses associated with an organization and it's ancestor organizations.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"/ccagent/v1/addresses?orgId=100001"
        }
    ],
    "items":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"190001",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ]
}

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| |------------------|------------------| |100191|Invalid query param.| |100000|If input passed is invalid| |100001|If there was no organization found with the given id| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive|
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