Delete customer accounts including their addresses for the provided organization id.
post
/ccadmin/v1/organizations/{id}/customerAccounts/delete
Supports a configurable limit (default: 25 items)
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the requested Organization.
Root Schema : deleteCustomerAccount_request
Type:
Show Source
object
-
itemIds(required):
array itemIds
Minimum Number of Items:
1
Repository IDs of customer accounts to be deleted under given organization id.
Example:
{
"itemIds":[
"1035",
"1034"
]
}
Nested Schema : itemIds
Type:
array
Minimum Number of Items:
1
Repository IDs of customer accounts to be deleted under given organization id.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:240
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : deleteCustomerAccounts_response
Type:
Show Source
object
-
invalidItemIds:
array invalidItemIds
List of invalid/failed ids for Customer Accounts which could not be deleted.
-
resultingItemIds:
array resultingItemIds
List of repository ids of currently present customer accounts.
Nested Schema : invalidItemIds
Type:
array
List of invalid/failed ids for Customer Accounts which could not be deleted.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:240
Nested Schema : resultingItemIds
Type:
array
List of repository ids of currently present customer accounts.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:240
Example Response (application/json)
{
"customerAccountIds":[
"ca200002",
"ca200000",
"ca200001"
]
}
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|
|------------------|------------------|
|10194|Invalid Input|
|100193|Internal error occurred while deleting customer 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:
array
An 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