Get the current Agent Readiness Score

GET/stores/{store_id}/catalog/readiness

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.

Responses

200

Overall and per-dimension readiness.

overallinteger

min 0 · max 100

dimensionsobject

Show properties

completenessinteger

min 0 · max 100

consistencyinteger

min 0 · max 100

attribute_qualityinteger

min 0 · max 100

delivery_datainteger

min 0 · max 100

last_audit_atstring<date-time>

product_countinteger

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.

Request

curl -X GET "https://api.sarvex.example.com/v1/stores/string/catalog/readiness" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.sarvex.example.com/v1/stores/string/catalog/readiness", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.sarvex.example.com/v1/stores/string/catalog/readiness",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "overall": 74,
  "dimensions": {
    "completeness": 0,
    "consistency": 0,
    "attribute_quality": 0,
    "delivery_data": 0
  },
  "last_audit_at": "2019-08-24T14:15:22Z",
  "product_count": 0
}