> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tailoredd.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Claim by order

> Look up an incentive claim by order ID to verify eligibility before triggering a review request.

`GET {BASE_URL}/admin/incentive-claims/by-order/{orderId}`

## Response

```json theme={null}
{
  "success": true,
  "data": {
    "claimId": "claim_abc",
    "status":  "reviews_pending",
    "incentiveDescription": "10% off your next order",
    "products": [
      { "productId": "SKU-001", "name": "Classic Tee", "reviewed": false }
    ]
  }
}
```


## OpenAPI

````yaml openapi.yaml GET /admin/incentive-claims/by-order/{sampleOrderId}
openapi: 3.0.0
info:
  title: ReviewFlow API
  description: >-
    ReviewFlow is a fully managed ratings, reviews, and UGC platform by
    Tailoredd. This API covers batch reviews, product reviews, Q&A, media
    management, webhooks, tokens, analytics, incentives, and CSV export
    endpoints.
  version: 2.3.0
servers:
  - url: https://cdn.tailoredd.com/apiV2
    description: Production Gen 2 API front door
security: []
tags:
  - name: Batch Reviews
    description: Fetch rating summaries for multiple products in a single request.
  - name: Webhooks
    description: Receive post-purchase order events to trigger review request flows.
  - name: Tokens
    description: Validate and revoke review request tokens sent to customers.
  - name: CSV Export
    description: Asynchronous export of reviews or questions as CSV files.
  - name: Health
    description: Service availability and version check.
  - name: Cloudinary Media
    description: Upload, retrieve, and delete media assets attached to reviews.
  - name: Reviews & Ratings
    description: Create, read, moderate, and interact with product reviews.
  - name: Featured Reviews
    description: Feature or unfeature reviews for prominent display.
  - name: Questions & Answers
    description: Product Q&A with moderation and merchant answers.
  - name: Admin Dashboard
    description: Admin analytics and dashboard aggregation endpoints.
  - name: Custom Attributes (Growth+/Enterprise)
    description: Manage custom review form attributes like fit, quality, etc.
  - name: Incentive Claims
    description: Track and fulfill review incentive coupon claims.
  - name: Sentiment Analysis
    description: Filter reviews by NLP-derived sentiment labels.
  - name: Google Shopping Feed
    description: Generate and check eligibility for Google product reviews XML feed.
paths:
  /admin/incentive-claims/by-order/{sampleOrderId}:
    get:
      tags:
        - Incentive Claims
      summary: Get Claim by Order ID (Public)
      description: |-
        Get incentive claim by order ID (for review form).

        Returns products to review and incentive details.
      operationId: getIncentiveClaimByOrder
      parameters:
        - name: X-Merchant-Id
          in: header
          schema:
            type: string
          example: your-merchant-id
        - name: sampleOrderId
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '400':
          description: Bad Request / Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
      required:
        - success
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Rating must be between 1 and 5
      required:
        - success
        - error

````