Skip to main content
POST
Delete products

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

Request Body

Array of objects with external IDs (minimum 1):

Example Request

Example Response

Error Responses

Headers

x-api-key
string
required

API key needed to authorize the request

Path Parameters

promptBlockId
string
required

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: 1
external_id
string
required

External ID of product to delete

Minimum string length: 1

Response

Products deleted successfully.