Skip to main content

Base URL

Use the production Gen 2 API front door unless Tailoredd gives you a tenant-specific endpoint. Staging smoke tests use the direct apiV2 Cloud Functions URL.
export RF_BASE_URL="https://cdn.tailoredd.com/apiV2"

Authentication

All requests require X-Merchant-Id. Additional auth depends on the call context:
ContextHeaders
Browser / widgetX-Merchant-Id + Origin (whitelisted domain)
Server-to-serverX-Merchant-Id + X-API-Key (prefix: tr_)
Admin endpointsX-Merchant-Id + Authorization: Bearer <token>
See Authentication for full details.

Response format

Admin and write endpoints return a structured JSON envelope:
{
  "success": true,
  "data": { /* endpoint-specific payload */ }
}
On error:
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable description"
  }
}
Public read endpoints can return resource-shaped payloads directly, for example GET /products/{productId}/reviews returns top-level reviews, totalReviews, and pagination fields. See Error codes for the full list.

Rate limits

Endpoint typeLimit
Public read (reviews, ratings)100 req/min per origin
Upload signature10 req/min per user
Admin write60 req/min per token
Webhooks30 req/min per merchant
Rate-limited responses return 429 Too Many Requests with a Retry-After header.

Pagination

Review endpoints use page-number pagination (page=1&limit=20). Q&A endpoints use cursor-based pagination (startAfter={id}).

Plan-gated features

Some features return 403 PLAN_UPGRADE_REQUIRED on lower-tier plans:
FeatureRequired plan
Sentiment analysisGrowth+
Custom attributesGrowth+
Google Shopping feedGrowth+
Featured reviewsGrowth+
Review update requestsGrowth+
See Plans for full comparison.