API Reference

List products with pagination, search and advanced filters.

Create a new product.

Get a single product with competitor prices, smart-price rule name, and resolved brand/category.

Update a product. Send only the fields you want to change.

Soft-delete (deactivate) a product.

Price history chart data for a product, including competitor price time-series and optional calendar snapshot.

Bulk import products from CSV or JSON array.

Queue a smart-price for approval and push to your ERP/ecommerce platform.

Apply a pricing rule to a single product and compute the recommended smart price.

Request an AI-generated pricing recommendation with reasoning and confidence score.

List all monitored competitors with stats (product count, avg price, last seen).

Add a new competitor to monitor.

Get competitor detail with recent price observations across products.

Update a competitor (name, inclusion status).

Permanently delete a competitor and all associated price observations.

List tracked product URLs for a specific competitor.

Bulk import competitors from a JSON array.

List all active pricing rules with targets, landscape competitors and sub-rules.

Create a new pricing rule.

Get a single pricing rule with all targets, landscape competitors and sub-rules.

Update a pricing rule. Send only the fields you want to change. Targets, landscape competitors and sub-rules are replaced entirely if provided.

Soft-delete (deactivate) a pricing rule.

Preview the effect of a pricing rule on matching products without applying changes.

Get a real-time view of products affected by a rule with their current and computed prices.

Price position distribution over time and per-product breakdown.

Price trend data showing your price vs. competitor min/max/avg over time.

Top 20 biggest price movers (your products and competitors) in a given period.

Activity log of recent price changes, monitoring events and rule applications.

Margin analysis across products, showing cost vs. selling price vs. smart price.

Push all approved smart prices in the queue to your configured ERP webhook.

Approve one or more price approval items for pushing.

Reject one or more price approval items.

Retry failed price approval items.

Paginated history of price price approval items with approval audit trail.

List all alert rules for your organisation.

Create a new alert rule.

Update an alert rule. Pass the id in the request body.

Delete an alert rule permanently.

List brands with product counts and pagination.

Create a new brand. Triggers auto-mapping of existing products.

Get a single brand by ID.

Update a brand.

Delete a brand.

Bulk import brands from a JSON array.

List categories (flat or tree mode) with product counts.

Create a new category. Specify parentId for nested categories.

Get a single category by ID.

Update a category.

Delete a category.

Bulk import categories from a JSON array.

List product types with product counts.

Create a new product type.

Get a single product type.

Update a product type.

Delete a product type.

Bulk import product types.

List buyers with product counts.

Create a new buyer.

Get a single buyer.

Update a buyer.

Delete a buyer.

Bulk import buyers.

List suppliers with product counts.

Create a new supplier.

Get a single supplier.

Update a supplier.

Delete a supplier.

Bulk import suppliers.

List all dashboards for your organisation.

Create a new dashboard.

Get a single dashboard with its tiles.

Update dashboard name or description.

Delete a dashboard.

Fetch computed data for all tiles in a dashboard.

Add a tile to a dashboard.

Search products, rules and competitors by name, SKU or domain. Returns up to 5 results per type.

Generate a CSV or XLSX export. Returns file download directly (not JSON). Requires Basic plan or above.

List notifications for the authenticated user.