getAddresses

get

/ccstore/v1/organizationAddresses

Get Addresses. This operation is used to get the all the address of a Organization/Account Oracle Commerce Cloud.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

Request

Supported Media Types
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getAddresses_response
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The default billing address for the Organization. This a read only attribute. This will come if property isDefaultBillingAddress is set to ???true??? in secondaryAddresses attribute.
Show Source
Nested Schema : secondaryAddresses
Type: array
List of all the addresses associated with an Organization, if property like isDefaultShippingAddress or isDefaultBillingAddressis set to true, then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
Show Source
Nested Schema : shippingAddress
Type: object
The default shipping address for the Organization. This a read only attribute. This will come if property isDefaultShippingAddress is set to true in secondaryAddresses attribute.
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "repositoryId":"2100003",
    "name":"Oracle",
    "description":null,
    "active":true,
    "shippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizationAddresses"
        }
    ],
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"180003",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "id":"2100003",
    "billingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    }
}

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| |------------------|------------------| |22010|IF no organziation is found|
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