REST API for Oracle Commerce Cloud December 2017

deleteAddress

delete

/ccstore/v1/organizationAddresses/{id}

Delete Address. This endpoint is used to delete address by its id of a Organization/Account in Oracle Commerce Cloud.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

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-CCOrganization: Type: string

Current organization context of the logged in user

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Example 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/addresses"
        }
    ],
    "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| |------------------|------------------| |100184|If address id entered is empty| |100187|No address is found with the id in logged in user's organization| |100000|If input passed is invalid| |100001|If there was no organization found with the given id|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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/addresses"
  }],
  "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"
  }
}