delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/products//images/
Requires
write_productaccess 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.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
product_id | string | Yes | 636a07da-39eb-4829-bde9-b65fae1c28b0 | The unique identifier of the product. |
image_id | string | Yes | 91d032e7-bbc8-47e4-8668-9ba6fe714de6 | The unique identifier of the image. |
Response Explanation
Public Response Parameters
Error Response
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"]} |