Skip to main content
POST
Trigger a compliance scan

Authorizations

Authorization
string
header
required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Path Parameters

id
integer
required

The unique identifier of the category.

Response

Scan accepted and queued.

Response from POST :id/lighthouse and POST :id/compliance — the scan was accepted and queued, and the body carries the meta envelope. The new result lands at the corresponding GET endpoint when the job completes.

message
string
required
Example:

"Lighthouse scan queued"

scan_status
object
required

Progress of an async lighthouse / compliance scan. Only status is guaranteed (requested_at is present in practice once a scan is requested); nil timestamps are omitted, so the present keys vary by phase — a failed scan carries failed_at + error, a completed one carries started_at + completed_at.

Example:
resource_type
enum<string>
required

PascalCase type name of the scanned resource.

Available options:
Category,
Collection,
Product,
Library,
Medium,
Post,
EnrollmentPack,
Page
Example:

"Category"

resource_id
integer
required
Example:

4821

meta
object
required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.