Public API

Public API

Base URL: https://api.priceboostai.com/api. All Public API routes live under /v1/public and require a Bearer token.

Authentication

Create an API token in Dashboard → Integrations → API keys. Use it as a Bearer token. The same token is used for the dashboard session; you can also create a dedicated token for scripts or tools.

Authorization: Bearer YOUR_API_TOKEN

Access requirements: The Public API is available on plans that include API access and during your trial period. After trial, your plan must have API access enabled; otherwise requests return 403.

GET /v1/public/prices

List products with current, original, and optimized prices. Paginated.

Query parameters:

• store_id (optional) – filter by store ID
• per_page (optional, default 50, max 100)
• page (optional, default 1)

GET https://api.priceboostai.com/api/v1/public/prices?store_id=1&per_page=50&page=1

Response:

{
  "data": [
    {
      "id": 123,
      "store_id": 1,
      "woo_product_id": "456",
      "name": "Product name",
      "category": "Category",
      "original_price": 29.99,
      "current_price": 27.99,
      "optimized_price": 27.99,
      "last_optimized_at": "2025-03-10T12:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 50,
    "total": 230
  }
}

POST /v1/public/prices

Update product price(s). You can send a single product_id and price, or product_ids (array) and one price to apply to all. Prices are constrained by your safety caps (min/max).

Single product:

POST https://api.priceboostai.com/api/v1/public/prices
Content-Type: application/json

{
  "product_id": 123,
  "price": 29.99
}

Bulk (same price for multiple products):

POST https://api.priceboostai.com/api/v1/public/prices
Content-Type: application/json

{
  "product_ids": [123, 124, 125],
  "price": 24.99
}

Response:

{
  "success": true,
  "updated": [
    { "product_id": 123, "price": 29.99 }
  ]
}

POST /v1/public/reports/trigger

Trigger report generation. Returns immediately with report_id. When the report is ready, a report.ready webhook is sent (if you have subscribed—see Webhooks).

Body:

POST https://api.priceboostai.com/api/v1/public/reports/trigger
Content-Type: application/json

{
  "type": "pricing",
  "date_from": "2025-03-01",
  "date_to": "2025-03-10",
  "category": "Electronics"
}

type: pricing | revenue | optimization | performance. category is optional (used for pricing and performance).

Response (201):

{
  "success": true,
  "report_id": 42,
  "report_type": "pricing"
}