Requires write_product access scope. More access scope
The Delete Product Image API allows users to remove a specific image from a product. By providing the product_id and image_id, users can delete an image to ensure that only relevant and accurate images are associated with their products.This API is especially useful for:
Remove outdated or incorrect product images.
Manage product image lists to ensure accurate representation of products.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
["Product not found"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
404
Product Not Found
The product_id provided in the request does not exist.
{ "errors": ["Product not found"] }
422
Invalid or empty product_idorimage_id
Missing required product_id, image_id, or incorrect UUID types.
{ "errors": [ "ProductId must be a valid UUID", "ImageId must be a valid UUID"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
