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(required): string
The ID of the address that has to be deleted.
Query Parameters
-
removeReferences: boolean
Flag that determines whether to remove all references of this address.
Header Parameters
-
X-CCAgentContext(required): string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCAsset-Language: string
The asset language of the request. E.g., en,de,fr_CA.
-
X-CCOrganization: string
the organization Id
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : deleteAddress_response
Type:
Show Source
object-
active:
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
billingAddress:
object billingAddress
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.
-
description:
string
Description for Organization
-
externalOrganizationId:
string
External organization id
-
id:
string
Id of the Organization
-
name:
string
The name for Organization
-
repositoryId:
string
Repository Id of the Organization
-
secondaryAddresses:
array secondaryAddresses
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'.
-
shippingAddress:
object shippingAddress
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.
Nested Schema : billingAddress
Type:
objectThe 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
-
address1:
string
The address1 of the address
-
address2:
string
The address2 of the address
-
address3:
string
The address3 of the secondary address
-
city:
string
The city of the address
-
companyName:
string
The company name of the address
-
country:
string
The country of the address
-
county:
string
The county of the secondary address
-
externalAddressId:
string
External address id
-
phoneNumber:
string
The phone Number of the address
-
postalCode:
string
The postal Code of the address
-
repositoryId:
string
Repository Id of the address
-
state:
string
The state of the address
-
types:
array types
The types tagged to the address
Nested Schema : secondaryAddresses
Type:
arrayList 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:
objectThe 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
-
address1:
string
The address1 of the address
-
address2:
string
The address2 of the address
-
address3:
string
The address3 of the secondary address
-
city:
string
The city of the address
-
companyName:
string
The company name shipping address
-
country:
string
The country of the address
-
county:
string
The county of the secondary address
-
externalAddressId:
string
External address id
-
phoneNumber:
string
The phone Number of the company address
-
postalCode:
string
The postal Code of the address
-
repositoryId:
string
Repository Id of the address
-
state:
string
The state of the address
-
types:
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
addressType:
string
The name of the address type
-
repositoryId:
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object-
address:
object address
Address created for the Organization.
-
addressType:
string
Address type represents nick name of address if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress created for the Organization.
Show Source
-
address1:
string
The address1 of the secondary address
-
address2:
string
The address2 of the secondary address
-
address3:
string
The address3 of the secondary address
-
city:
string
The city of the secondary address
-
companyName:
string
Company name of the secondary address
-
country:
string
The country of the address
-
county:
string
The county of the secondary address
-
externalAddressId:
string
External address id
-
phoneNumber:
string
Phone Number of the address
-
postalCode:
string
Postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
The State of the address
-
types:
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
addressType:
string
The name of the address type
-
repositoryId:
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object-
addressType:
string
The name of the address type
-
repositoryId:
string
repository Id of the address type
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|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code