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

deleteAddress

delete

/ccagent/v1/organizationAddresses/{id}

Delete Address. This endpoint is used to delete 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
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : deleteAddress_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 '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 : 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 : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
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
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "repositoryId":"or-100001",
    "name":"National Discount Auto Parts",
    "active":true,
    "description":null,
    "shippingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "addressType":"Shipping",
                "repositoryId":"ss-10001"
            }
        ],
        "phoneNumber":"631-748-6479",
        "address2":"Suffolk",
        "city":"Bohemia",
        "address1":"70 Euclid Ave #722",
        "companyName":"National Discount Auto Parts",
        "postalCode":"11716",
        "repositoryId":"280010",
        "state":"NY"
    },
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "addressType":"Shipping",
                        "repositoryId":"ss-10001"
                    }
                ],
                "phoneNumber":"907-385-4412",
                "address2":null,
                "city":"Anchorage",
                "address1":"639 Main St",
                "companyName":"National Discount Auto Parts",
                "postalCode":"99501",
                "repositoryId":"160062",
                "state":"AZ"
            },
            "addressType":"Arizona Office Address"
        },
        {
            "address":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "addressType":"Shipping",
                        "repositoryId":"ss-10001"
                    }
                ],
                "phoneNumber":"631-748-6479",
                "address2":"Suffolk",
                "city":"Bohemia",
                "address1":"70 Euclid Ave #722",
                "companyName":"National Discount Auto Parts",
                "postalCode":"11716",
                "repositoryId":"280010",
                "state":"NY"
            },
            "addressType":"NewYork Office Address"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/organizationAddresses"
        }
    ],
    "externalOrganizationId":"EXT_ORG_1",
    "billingAddress":{
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "types":[
            {
                "addressType":"Shipping",
                "repositoryId":"ss-10001"
            }
        ],
        "phoneNumber":"631-748-6479",
        "address2":"Suffolk",
        "city":"Bohemia",
        "address1":"70 Euclid Ave #722",
        "companyName":"National Discount Auto Parts",
        "postalCode":"11716",
        "repositoryId":"280010",
        "state":"NY"
    },
    "id":"or-100001"
}

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| |------------------|------------------| |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| |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|
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