Requires
write_productaccess scope. For more access scope
The Delete Product API allows users to remove a specific product from the catalog by providing its unique product_id. This operation is irreversible and permanently deletes the product and its associated data, such as variants and images, from the system. It is crucial to ensure the product_id is valid and correct before making this request.This API is especially useful for:
-
Deleting obsolete or incorrect product entries to maintain catalog accuracy.
-
Cleaning up test or sample products from the system.
-
Removing products no longer available in inventory or for sale.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
product_id | string | Yes | 9fb9f3c6-2300-42c1-8593-d9008d7cfc09 | The unique identifier for the product. |
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 ID is not a valid UUID"] | 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. |
Success Response Example
{}
Error Details
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 404 | Product Not Found | The product ID provided in the request does not exist. | { "errors": [ "Product ID is not a valid UUID" ] } |
| 422 | Failed Validation | One or more fields failed validation checks. | { "errors": [ "Product ID is not a valid UUID"]} |