Delete Product Image

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.
  3. 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.

🔒

Requires product access scope. For more info , refer to:

access scope

Public Request Parameters

Parameter NameTypeRequiredParameter LocationParameter ValueDescription
Access-TokenStringYesHeaderBx-_5aV
eXNwl-4AB98s5xLV
yg0fNzGf

MuTpqtlBA
Used to authenticate API requests. Obtain an access token from the Access Token Guide.
Pass it in the Authorization header for every request.
Content-TypeStringYesHeaderapplication
/json
Indicates the media type of the request body. It tells the server how to parse the request and
the client how to interpret the response. For more details, visit Content-Type.

Public Response Parameters

Parameter NameTypeMandatoryParameter LocationExample ValueDescription
errorStringNoResponse Body{ "error": "store is not active" }Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" }.
errorsArrayNoResponse Body{ "errors"["No Context"] }A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }.
Request-IdStringYesHeaderBx-_5aV
eXNwl-4AB98s5xLV
yg0fNzGf

MuTpqtlBA
A unique identifier for each request. It helps in identifying and debugging specific requests.

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

FieldTypeRequiredExampleDescription
product_idstringYes636a07da-39eb-4829-bde9-b65fae1c28b0The unique identifier of the product.
image_idstringYes91d032e7-bbc8-47e4-8668-9ba6fe714de6The unique identifier of the image.

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.

FieldTypeExampleDescription
errorsArray["Product not found"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorArray "store is not active"Indicates an error encountered during the process.

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

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
404Product Not FoundThe product_id provided in the request does not exist.{ "errors": ["Product not found"] }
422Invalid or empty product_idorimage_idMissing required product_id, image_id, or incorrect UUID types.{ "errors": [ "ProductId must be a valid UUID", "ImageId must be a valid UUID"]}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!