1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Agent
  4. Organizations Address List

listAddresses

get

/ccagent/v1/addresses

List Addresses. This operation is used to get the list of addresses based on the search criteria provided. 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
  • Exact nick name to search. Wild card/Partial / Case insensitive search is not supported
  • Query string to get all/inherited secondaryAddresses. "all"/"inheritedOnly" are the only allowed values. If include is not specified, seondaryAddresses of that organization is returned.
  • The custom properties for the addresses will be returned if this is set to true.Custom properties will also be returned if queryFormat/addressType/q/sort is specified. There is no significance for this property if any of these properties are specified queryFormat/addressType/q/sort
  • This is the field to determine number of records to be fetched per REST call.
  • This field determines the offset/starting index from which data to be fetched.
  • Organization Id whose addresses has to be fetched
  • SCIM query to search on the address properties. Search on all the address possible except repositoryId and addressType
  • queryFormat to search on the address properties. Possible values SCIM or null.
  • This is the field to provide sort on the address properties except addressType.
  • Tells whether to include total and totalResults in the SCIM query.By default the value is true
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
  • items
    List of all the addresses associated with an Organization, if property like ???isDefaultShippingAddress??? or ???isDefaultBillingAddress??? is set to ???true???, then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
  • Number of records to be fetched.
  • The offset provided.
  • Total number of records present in database matching the searched string.
  • Total number of records present in database matching the searched string.
Nested Schema : items
Type: array
List of all the addresses associated with an Organization, if property like ???isDefaultShippingAddress??? or ???isDefaultBillingAddress??? is set to ???true???, then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"/ccagent/v1/addresses?orgId=100001&q=country eq \"US\"&addressType=Office Address"
        }
    ],
    "items":[
        {
            "address":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"shipping",
                        "repositoryId":"ss-10002",
                        "id":"SHIPPING"
                    }
                ],
                "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