Delete Products
starshipit_delete_productsDelete selected product IDs or clear the entire StarShipIt catalogue, including discontinued or test items; deletions are permanent and cannot be undone.
Instructions
Delete one or more products from the StarShipIt product catalogue. This operation is irreversible.
Two modes:
Delete specific products (recommended): Provide an array of numeric
product_ids. Only those products are deleted. Leaveall_productsasfalse(default).Delete ALL products (use with extreme caution): Set
all_products: trueand pass an emptyproduct_idsarray[]. This permanently removes every product in the catalogue — there is no undo.
Parameters:
product_ids: Array of numeric product IDs to delete. Use an empty array[]only whenall_productsistrue.all_products: Set totrueto delete the entire catalogue. Defaults tofalse. Iftrue,product_idsis ignored.
Returns:
success: Whether the deletion succeededdeleted_count: Number of products deleted (if returned by API)errors: Any per-product errors
Error cases:
400: Invalid product IDs or malformed request body
404: One or more product IDs not found (partial deletes may still succeed)
Use this tool when:
Removing discontinued products from the catalogue
Purging test/dummy products after setup
Clearing the entire catalogue before a fresh import (all_products=true — use carefully)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| product_ids | Yes | Array of numeric product IDs to delete. Pass an empty array [] only when all_products is true. | |
| all_products | No | Set to true to delete ALL products in the catalogue. Irreversible. When true, product_ids is ignored. Default: false. | |
| response_format | No | Output format: 'markdown' for human-readable or 'json' for machine-readable | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |