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.
- 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:
Public Request Parameters
Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
---|---|---|---|---|---|
Access-Token | String | Yes | Header | Bx-_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-Type | String | Yes | Header | application /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 Name | Type | Mandatory | Parameter Location | Example Value | Description |
---|---|---|---|---|---|
error | String | No | Response 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" } . |
errors | Array | No | Response Body | { "errors"["No Context"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] } . |
Request-Id | String | Yes | Header | Bx-_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
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
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. |
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 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_id orimage_id | Missing required product_id , image_id , or incorrect UUID types. | { "errors": [ "ProductId must be a valid UUID", "ImageId must be a valid UUID"]} |