1. REST API for Oracle Commerce Cloud December 2017
  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
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the address that has to be deleted.
Header Parameters
X-CCAgentContext
Type: string
Required: true
The Agent Context is a JSON object with shopperProfileId as a property.
X-CCAsset-Language
Type: string
The asset language of the request. E.g., en,de,fr_CA.
X-CCOrganization
Type: string
the organization Id

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Example application/json

{
    "repositoryId":"or-100001",
    "name":"National Discount Auto Parts",
    "active":true,
    "description":null,
    "shippingAddress":{
        "country":"US",
        "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",
                "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",
                "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"
        }
    ],
    "billingAddress":{
        "country":"US",
        "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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "repositoryId": "or-100001",
  "name": "National Discount Auto Parts",
  "active": true,
  "description": null,
  "shippingAddress": {
    "country": "US",
    "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",
        "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",
        "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"
  }],
  "billingAddress": {
    "country": "US",
    "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"
}