deleteCollection
delete
/ccadmin/v1/collections/{id}
Delete Collection. Delete a collection by ID.
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
stringRequired:trueID of collection to be deleted.
Query Parameters
- catalogId
-
Type:
stringRequired:trueID of catalog.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
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|
|------------------|------------------|
|20169|Internal Error|
|20162|Attempted to delete a collection {0} with child collections. Collections must have no children to be deleted|
|20161|Collection Id is invalid or non-existent|
|20160|Collection Id passed is null or empty|
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code