Skip to main content

Public REST/JSON reference

PriceWatch CI Monitor API

Monitor competitor product URLs for price changes, compare them to your current catalog prices, and produce reports and alerts for SKUs that are above, below, or within competitive range. Part of the Logic Igniter E-commerce Operations bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Operations rendered

10

Response models rendered

13

GET/api/v1/pricewatch/health

Service liveness

Liveness probe for PriceWatch CI Monitor API. Returns 200 when the public API route is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/pricewatch/customers

List customers

List customers record for the customer workspace used by PriceWatch CI Monitor API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

PUT/api/v1/pricewatch/customers/{id}

Update customer

Update customer record for the customer workspace used by PriceWatch CI Monitor API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstringId

Request body (required)

Schema: CustomerInput

Sample JSON payload for evaluation.

{
  "companyName": "Mira Home Goods",
  "email": "[email protected]"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/pricewatch/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"companyName":"Mira Home Goods","email":"[email protected]"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/pricewatch/targets

List targets

List active and disabled competitor monitoring targets.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/targets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

DELETE/api/v1/pricewatch/targets/{id}

Remove target

Delete a competitor price monitoring target.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstringId

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X DELETE "https://api.logicigniter.com/api/v1/pricewatch/targets/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

POST/api/v1/pricewatch/targets/{id}/disable

Disable target

Pause monitoring for a target without deleting historical data.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstringId

Request body (required)

Schema: DisableTargetRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "DisableTargetRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/pricewatch/targets/:id/disable" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"DisableTargetRequest"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/pricewatch/reports

List reports

List generated price comparison reports.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/reports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/pricewatch/reports/{id}

Get report

Read a report with your price, competitor price, and competitive position by SKU.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstringId

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/reports/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/pricewatch/changes

List changes

List detected competitor price changes.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/changes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/pricewatch/changes/latest

Get latest changes

Return the latest price movement for each watched target.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/pricewatch/changes/latest" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Data models

Customer

FieldTypeNotes
idrequiredstringExample: "cus_mira_home"
companyNamerequiredstringExample: "Mira Home Goods"
emailrequiredstring (email)Example: "[email protected]"
bundlerequiredstringExample: "ecommerce-operations"
createdAtstring (date-time)

CustomerInput

FieldTypeNotes
companyNamerequiredstringExample: "Mira Home Goods"
emailrequiredstring (email)Example: "[email protected]"
bundlestringExample: "ecommerce-operations"

CustomerList

FieldTypeNotes
customersarray<Customer>

Error

FieldTypeNotes
errorrequiredstringExample: "validation failed"
messagestringExample: "sku is required"
requestIdstringExample: "req_01HX9E2M7K8Q4J3V"

DeleteResult

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "DeleteResult"

DisableTargetRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "DisableTargetRequest"

LatestChangeList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "LatestChangeList"

PriceChangeList

FieldTypeNotes
priceChangesrequiredarray<object>Example: [{"vendorId":"ven_acme","sku":"BOX-12","oldPrice":1.2,"newPrice":1.38,"deltaPercent":15}]

PriceReport

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "PriceReport"

ReportList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ReportList"

Target

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "Target"

TargetInput

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "TargetInput"

TargetList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "TargetList"