listAddresses

get

/ccstore/v1/addresses

List Addresses. This operation is used to get the list of addresses of an organization.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

Request

Supported Media Types
Query Parameters
  • Query string to get all/inherited secondaryAddresses. "all"/"inheritedOnly" are the only allowed values. If include is not specified, secondaryAddresses of that organization is returned. If value of include is "all" , then secondaryAddresses of that organization as well as secondaryAddresses of parent organizations is returned. Whereas in case of "inheritedOnly", secondaryAddresses of parentOrganization is returned.
  • The custom properties for the addresses will also be returned if this is set to true.
  • 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
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":"http://localhost:8080/ccstore/v1/addresses?orgId=10001"
        }
    ],
    "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|
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