sitecore Incremental Feed API

openapi: 3.2.0
info:
  title: Sitecore Discover Incremental Feed API
  description: The Sitecore Discover API provides search and product discovery capabilities for commerce applications, enabling developers to build search experiences, product listing pages, and recommendation widgets.
  version: v3
  contact:
    name: Sitecore Support
    url: https://www.sitecore.com/support
  termsOfService: https://www.sitecore.com/legal/terms-of-service
servers:
- url: https://{subdomain}.rfksrv.com
  description: Sitecore Discover Production Server (subdomain URL)
  variables:
    subdomain:
      description: The customer-specific subdomain provided in the Discover CEC
      default: your-domain
- url: https://api.rfksrv.com
  description: Sitecore Discover Production Server (customer key URL)
security:
- bearerAuth: []
tags:
- name: Incremental Feed
  description: Endpoints for pushing real-time product catalog updates to Sitecore Discover without requiring a full feed re-index. Supports adding, updating, and removing products incrementally.
paths:
  /api/feed/v1/products/incremental/update:
    post:
      operationId: updateProductsFeed
      summary: Incrementally update products
      description: Pushes real-time product catalog updates to the Sitecore Discover index without requiring a full feed re-process. Supports adding new products, updating existing product attributes, and removing products from the Discover catalog.
      tags:
      - Incremental Feed
      parameters:
      - $ref: '#/components/parameters/customerKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncrementalFeedRequest'
      responses:
        '200':
          description: Incremental product update accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedUpdateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: The request body or parameters are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    customerKey:
      name: customerKey
      in: query
      description: The customer key identifying the Sitecore Discover account. Found in the Customer Engagement Console under Developer Resources > API Access.
      required: false
      schema:
        type: string
  schemas:
    FeedUpdateResponse:
      type: object
      description: Response from a product feed update operation
      properties:
        status:
          type: string
          description: The status of the feed update request
          enum:
          - accepted
          - failed
        processed:
          type: integer
          description: The number of products successfully processed
        failed:
          type: integer
          description: The number of products that failed to process
        errors:
          type: array
          description: List of error details for failed products
          items:
            type: string
    ErrorResponse:
      type: object
      description: An error response body
      properties:
        message:
          type: string
          description: A human-readable error message
        statusCode:
          type: integer
          description: The HTTP status code
        errors:
          type: array
          description: List of detailed error messages
          items:
            type: string
    FeedProduct:
      type: object
      description: A product record for the Discover catalog feed
      required:
      - id
      properties:
        id:
          type: string
          description: The unique identifier of the product
        name:
          type: string
          description: The display name of the product
        sku:
          type: string
          description: The product SKU
        description:
          type: string
          description: The product description
        url:
          type: string
          description: The URL of the product detail page
          format: uri
        image_url:
          type: string
          description: The URL of the product image
          format: uri
        price:
          type: number
          description: The base price of the product
          format: float
        final_price:
          type: number
          description: The final selling price after discounts
          format: float
        brand:
          type: string
          description: The brand name
        category:
          type: string
          description: The primary product category
        in_stock:
          type: boolean
          description: Whether the product is currently in stock
    IncrementalFeedRequest:
      type: object
      description: Request body for incrementally updating the product catalog
      required:
      - operation
      - products
      properties:
        operation:
          type: string
          description: The operation to perform on the products
          enum:
          - add
          - update
          - delete
        products:
          type: array
          description: The products to add, update, or delete
          items:
            $ref: '#/components/schemas/FeedProduct'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer access token obtained from the Sitecore Discover authentication endpoint. Include in the Authorization header.
externalDocs:
  description: Sitecore Discover Developer Guide
  url: https://doc.sitecore.com/discover/en/developers/discover-developer-guide/integrate-using-discover-rest-apis.html