Delete
/api/product-catalog/v1/catalogs/{catalogId}/variants/{variantId}
Security
HTTP
Type bearer
Path parameters
catalogId
integer (int64) Required
Catalog identifier containing the variant to delete.
variantId
stringRequired
Variant identifier to delete.
Responses
202
Variant delete accepted for processing
{
"variant_id": "V-1001",
"catalog_id": 123,
"status": "accepted",
"message": "Variant delete accepted for processing",
"event_id": "550e8400-e29b-41d4-a716-446655440000",
"operation": "delete",
"accepted_at": 1783502993000
}object
variant_id
string
ExampleV-1001
catalog_id
integer (int64)
Example123
status
string
Valid values[
"accepted",
"failed"
]
Exampleaccepted
message
string
ExampleVariant add accepted for processing
event_id
string
Unique generated UUID assigned to the event and preserved throughout its whole lifecycle. The event_id is used in logs and is also sent back to the client with webhook events when webhooks are configured, so clients are advised to log/save it on their side.
Example550e8400-e29b-41d4-a716-446655440000
operation
string
Valid values[
"add",
"upsert",
"partial_update",
"delete",
"delete_attributes",
"add_existing_only",
"overwrite",
"overwrite_existing_only",
"update",
"update_existing_only",
"update_localized_attribute",
"update_localized_attribute_existing_only",
"clean"
]
Exampleadd
accepted_at
integer (int64)
Example1783502993000
accepted_attributes
object
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
property*
object additionalProperties
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
skipped_attributes
object (SkippedAttributesDTO)
non_existing_attributes
Array of string
Example[
"custom_attribute_abc"
]
string
Example["custom_attribute_abc"]
inactive_attributes
Array of string
Example[
"custom_attribute_def"
]
string
Example["custom_attribute_def"]
invalid_data_type_attributes
object
Example{
"price": "price map value must be a number",
"gtin": "gtin field must be 8-14 digits",
"min_age": "min_age value must be a number"
}
property*
string additionalProperties
Example{"price":"price map value must be a number","gtin":"gtin field must be 8-14 digits","min_age":"min_age value must be a number"}
400
Variant delete was rejected during validation.
{
"variant_id": "V-1001",
"catalog_id": 123,
"status": "failed",
"message": "Variant delete failed: price mandatory field cannot be deleted",
"operation": "delete",
"accepted_at": 1783502993000,
"accepted_attributes": {},
"skipped_attributes": {}
}object
variant_id
string
ExampleV-1001
catalog_id
integer (int64)
Example123
status
string
Valid values[
"accepted",
"failed"
]
Exampleaccepted
message
string
ExampleVariant add accepted for processing
event_id
string
Unique generated UUID assigned to the event and preserved throughout its whole lifecycle. The event_id is used in logs and is also sent back to the client with webhook events when webhooks are configured, so clients are advised to log/save it on their side.
Example550e8400-e29b-41d4-a716-446655440000
operation
string
Valid values[
"add",
"upsert",
"partial_update",
"delete",
"delete_attributes",
"add_existing_only",
"overwrite",
"overwrite_existing_only",
"update",
"update_existing_only",
"update_localized_attribute",
"update_localized_attribute_existing_only",
"clean"
]
Exampleadd
accepted_at
integer (int64)
Example1783502993000
accepted_attributes
object
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
property*
object additionalProperties
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
skipped_attributes
object (SkippedAttributesDTO)
non_existing_attributes
Array of string
Example[
"custom_attribute_abc"
]
string
Example["custom_attribute_abc"]
inactive_attributes
Array of string
Example[
"custom_attribute_def"
]
string
Example["custom_attribute_def"]
invalid_data_type_attributes
object
Example{
"price": "price map value must be a number",
"gtin": "gtin field must be 8-14 digits",
"min_age": "min_age value must be a number"
}
property*
string additionalProperties
Example{"price":"price map value must be a number","gtin":"gtin field must be 8-14 digits","min_age":"min_age value must be a number"}
404
Variant delete target was not found by downstream validation.
{
"variant_id": "V-1001",
"catalog_id": 123,
"status": "failed",
"message": "Variant delete failed: price mandatory field cannot be deleted",
"operation": "delete",
"accepted_at": 1783502993000,
"accepted_attributes": {},
"skipped_attributes": {}
}object
variant_id
string
ExampleV-1001
catalog_id
integer (int64)
Example123
status
string
Valid values[
"accepted",
"failed"
]
Exampleaccepted
message
string
ExampleVariant add accepted for processing
event_id
string
Unique generated UUID assigned to the event and preserved throughout its whole lifecycle. The event_id is used in logs and is also sent back to the client with webhook events when webhooks are configured, so clients are advised to log/save it on their side.
Example550e8400-e29b-41d4-a716-446655440000
operation
string
Valid values[
"add",
"upsert",
"partial_update",
"delete",
"delete_attributes",
"add_existing_only",
"overwrite",
"overwrite_existing_only",
"update",
"update_existing_only",
"update_localized_attribute",
"update_localized_attribute_existing_only",
"clean"
]
Exampleadd
accepted_at
integer (int64)
Example1783502993000
accepted_attributes
object
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
property*
object additionalProperties
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
skipped_attributes
object (SkippedAttributesDTO)
non_existing_attributes
Array of string
Example[
"custom_attribute_abc"
]
string
Example["custom_attribute_abc"]
inactive_attributes
Array of string
Example[
"custom_attribute_def"
]
string
Example["custom_attribute_def"]
invalid_data_type_attributes
object
Example{
"price": "price map value must be a number",
"gtin": "gtin field must be 8-14 digits",
"min_age": "min_age value must be a number"
}
property*
string additionalProperties
Example{"price":"price map value must be a number","gtin":"gtin field must be 8-14 digits","min_age":"min_age value must be a number"}
500
Variant delete failed unexpectedly.
{
"message": "Unexpected error while processing request",
"httpStatus": 500,
"errorCode": "500 Internal Server Error",
"timestamp": "2026-07-08T12:00:00Z"
}OneOf
VariantOperationResponseDTO
object (VariantOperationResponseDTO)
variant_id
string
ExampleV-1001
catalog_id
integer (int64)
Example123
status
string
Valid values[
"accepted",
"failed"
]
Exampleaccepted
message
string
ExampleVariant add accepted for processing
event_id
string
Unique generated UUID assigned to the event and preserved throughout its whole lifecycle. The event_id is used in logs and is also sent back to the client with webhook events when webhooks are configured, so clients are advised to log/save it on their side.
Example550e8400-e29b-41d4-a716-446655440000
operation
string
Valid values[
"add",
"upsert",
"partial_update",
"delete",
"delete_attributes",
"add_existing_only",
"overwrite",
"overwrite_existing_only",
"update",
"update_existing_only",
"update_localized_attribute",
"update_localized_attribute_existing_only",
"clean"
]
Exampleadd
accepted_at
integer (int64)
Example1783502993000
accepted_attributes
object
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
property*
object additionalProperties
Example{
"color": {
"en-GB": "Navy Blue",
"de-DE": "Marineblau",
"fr-FR": "Bleu marine"
},
"size": {
"US": "S",
"EU": "36"
}
}
skipped_attributes
object (SkippedAttributesDTO)
non_existing_attributes
Array of string
Example[
"custom_attribute_abc"
]
string
Example["custom_attribute_abc"]
inactive_attributes
Array of string
Example[
"custom_attribute_def"
]
string
Example["custom_attribute_def"]
invalid_data_type_attributes
object
Example{
"price": "price map value must be a number",
"gtin": "gtin field must be 8-14 digits",
"min_age": "min_age value must be a number"
}
property*
string additionalProperties
Example{"price":"price map value must be a number","gtin":"gtin field must be 8-14 digits","min_age":"min_age value must be a number"}
ErrorResponse
object (ErrorResponse)
message
string
httpStatus
integer (int32)
errorCode
string
timestamp
string (date-time)