🔒

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:

1. Remove outdated or incorrect product images.
2. Manage product image lists to ensure accurate representation of products.

Note:Verifying shop details through its unique domain prefix (shopdomain).Example: If the shop’s domain is https://store123.myshoplazza.com, the shopdomain would be store123.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Path Parameters

Response Explanation

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.

Request Examples

curl --request DELETE \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/products/{product_id}/images/{image_id} \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json'

Success Response Example

{}

Error Response Example

{
  "errors": [
     "Product not found"
  ]
}

{
  "error": "store is not active"
}

Error Details