1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Organizations Addresses

updateAddress

put

/ccagent/v1/organizationAddresses/{id}

Update Address. This endpoint is used to update 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. The inherited addresses cannot be updated, except setting the existing inherited address to default. 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
Body ()
Root Schema : updateAddress_request
Type: object
Show Source
Example:
{
    "address":{
        "isDefaultBillingAddress":false,
        "country":"US",
        "types":[
            {
                "id":"ss-10002"
            }
        ],
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle New",
        "isDefaultShippingAddress":false,
        "state":"AL"
    },
    "addressType":"Office Address New"
}
Nested Schema : address
Type: object
Updated address 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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateAddress_response
Type: object
Show Source
Nested Schema : address
Type: object
Address Object 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)
{
    "address":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            "ss-10001",
            "ss-10002"
        ],
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "companyName":"National Discount Auto Parts",
        "postalCode":"36130",
        "repositoryId":"280004",
        "state":"AL"
    },
    "addressType":"Montgomery Office Address",
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/organizationAddresses"
        }
    ]
}

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| |------------------|------------------| |80018|If an invalid country is provided| |100053|If the organization invalid default billing address value| |100185|If the address's repositoryId is invalid| |100054|If the organization invalid default shipping address value| |100067|If an invalid state is provided| |100188|If input properties passed are Null or empty string| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |23005|Phone Number is invalid| |89103|If no shopperProfileId is passed in the AgentContext header| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account| |100192|One of the dynamic properties is not writable by the Agent user| |180106|One or more address type ID is invalid| |
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