getAddress

get

/ccagent/v1/organizationAddresses/{id}

Get Address. This endpoint is used to get address by its id of a Organization/Account in Oracle Commerce Cloud. 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
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getAddress_response
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "country":"US",
    "phoneNumber":"973-974-1234",
    "address2":"Street 2",
    "city":"Montgomery",
    "address1":"600 Dexter Avenue",
    "companyName":"National Discount Auto Parts",
    "postalCode":"36130",
    "repositoryId":"280004",
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/organizationAddresses/280004"
        }
    ],
    "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| |------------------|------------------| |100185|Invalid Address Id| |100187|No address is found with the id for the account associated to the profileId passed in the AgentContext header| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |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