​
Purpose

The Items API provides comprehensive functionality for managing monitored products. This unified system replaces the previous separate “lists” and “mutes” endpoints, offering enhanced features including:

  • Add/remove products from monitoring
  • Force-add products (bypassing certain validations)
  • Mute/unmute products to control notifications
  • Manage affiliate links for tracked products
  • Configure price and stock alerts with custom thresholds
  • View hyped (popular) products

​
Query Parameters

All endpoints require the site parameter, which specifies the monitor name. A list of available monitors can be found using the Monitor Sites endpoint.

​
Request Body Format

Most endpoints that modify items use the following request format:

{
  "items": [
    {
      "itemId": "B09DFHJTF5",
      "config": {
        "monitorPrice": true,
        "priceAlertMaxPrice": 450.00,
        "stockAlertMaxPrice": 500.00,
        "mutedVariants": {}
      }
    }
  ]
}

​
Response Body

The response from the API contains two main parts:

  • site: An object that contains information about the site being queried.
  • results: An object with product IDs as keys and result objects as values.

​
Site Object

The site object contains detailed information about the monitoring site, including supported features and configuration options.

​
Results Object

Each result in the results object has the following structure:

FieldTypeDescription
errorBooleanIndicates if an error occurred
statusStringDetailed status indicating error/success
productObjectProduct object with detailed information
configObjectItem configuration settings

​
Product Object

The product object contains comprehensive product information including SKU, name, price, images, and monitoring metadata.

​
Item Configuration

Item configurations allow fine-grained control over monitoring behavior:

  • Price Monitoring: Enable/disable price change alerts
  • Stock Alerts: Set maximum price thresholds for stock notifications
  • Price Alerts: Set maximum price thresholds for price drop notifications
  • Muted Variants: Selectively mute specific product variants