Overview
Delete specific products from a product block using their external IDs. This endpoint removes only the products you specify, leaving all others unchanged.Use Cases
- Remove Discontinued Products: Delete products no longer available
- Inventory Cleanup: Remove out-of-stock items
- Bulk Delete: Remove multiple products at once
- Selective Removal: Delete specific products without affecting catalog
Authentication
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
promptBlockId | string | Yes | Product block ID |
Request Body
Array of objects with external IDs (minimum 1):Field | Type | Required | Description |
---|---|---|---|
external_id | string | Yes | External ID of product to delete |
Example Request
Example Response
Error Responses
Status Code | Description |
---|---|
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Product block not found |
500 | Internal Server Error |
Related Endpoints
- POST /api/public/product/create/ - Create products
- POST /api/public/product/upsert/ - Full sync
- GET /api/public/product/product-blocks - List blocks
Headers
API key needed to authorize the request
Path Parameters
The prompt block ID from which to delete the products
Body
application/json · object[]
The payload with external IDs of products to delete
External ID of product to delete
Minimum length:
1
Response
Products deleted successfully.