Trigger a catalog audit

POST/stores/{store_id}/catalog/audits

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Path parameters

store_idstringrequired

A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Header parameters

Idempotency-Keystring

Client-generated key; replays return the original result.

Request body

application/json

triggerstring

default: "manual"

Allowed:manual

Responses

202

Audit queued.

job_idstring

statusstring

Allowed:queuedrunning

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

store_idpath*A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.Idempotency-KeyheaderClient-generated key; replays return the original result.

Bodyapplication/json

triggerstring

Request

curl -X POST "https://api.sarvex.example.com/v1/stores/string/catalog/audits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "trigger": "manual"
}'

const response = await fetch("https://api.sarvex.example.com/v1/stores/string/catalog/audits", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"trigger\": \"manual\"\n}"
});

import requests

response = requests.post(
    "https://api.sarvex.example.com/v1/stores/string/catalog/audits",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"trigger\": \"manual\"\n}",
)

Response

{
  "job_id": "string",
  "status": "queued"
}