Delete products
curl --request POST \
--url https://api.vambe.me/api/public/product/delete/{promptBlockId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
[
{
"external_id": "<string>"
}
]
'const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{external_id: '<string>'}])
};
fetch('https://api.vambe.me/api/public/product/delete/{promptBlockId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/product/delete/{promptBlockId}"
payload = [{ "external_id": "<string>" }]
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Product Catalog
Delete products
Delete products by their external IDs. This endpoint only deletes products.
POST
/
api
/
public
/
product
/
delete
/
{promptBlockId}
Delete products
curl --request POST \
--url https://api.vambe.me/api/public/product/delete/{promptBlockId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
[
{
"external_id": "<string>"
}
]
'const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{external_id: '<string>'}])
};
fetch('https://api.vambe.me/api/public/product/delete/{promptBlockId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/product/delete/{promptBlockId}"
payload = [{ "external_id": "<string>" }]
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)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
x-api-key: your_api_key_here
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
curl --request POST \
'https://api.vambe.me/api/public/product/delete/block-abc123' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your_api_key_here' \
--data-raw '[
{ "external_id": "discontinued-product-001" },
{ "external_id": "out-of-stock-002" }
]'
Example Response
{
"deleted": 2,
"external_ids": ["discontinued-product-001", "out-of-stock-002"]
}
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
The payload with external IDs of products to delete
Minimum array length:
1External ID of product to delete
Minimum string length:
1Response
Products deleted successfully.
Was this page helpful?
