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

# Get featured collection products

> Use this endpoint to retrieve the featured products of a collection for a budget range. Featured products are a Snappy-curated selection of the most popular items in the collection that fit the budget. We recommend displaying them at the top of your collection page, above the full product list from `GET /v3/collections/{collectionId}/products`.

###### Required parameters:
- `collectionId` path parameter - the collection to retrieve featured products from.
- `filter[price][gte]` - inclusive minimum budget (0 or more).
- `filter[price][lte]` - inclusive maximum budget. Must be greater than or equal to `filter[price][gte]`.

###### Optional parameters:
- `location` - ISO 3166-1 alpha-2 country code (default `US`).
- `include` - related entities to include, comma-separated. One or more of `brand`, `tags`.
- `fields` - computed fields, comma-separated. One or more of `selectedOrFirstAvailableVariant`, `priceRange`, `variantsCount`.
- `seed` - any string. The same seed returns the same selection for the same collection, budget, and location - for example, pass a recipient ID so each recipient sees a stable set of featured products.
- `Snappy-Account-Id` header - optional account scoping.

###### Please note:
- The response is not paginated. All featured products are returned in a single `data` array.
- Each product has the same shape as in `GET /v3/collections/{collectionId}/products`, plus `selectedOrFirstAvailableVariant` when requested through `fields`.
- Returns `400` when the price range is missing or invalid (e.g. `filter[price][gte]` greater than `filter[price][lte]`).
- Returns `404` if the collection does not exist.

#### Permissions
- Requires: `products:read`



## OpenAPI

````yaml get /v3/collections/{collectionId}/products/featured
openapi: 3.0.3
info:
  title: Snappy Public API v3
  version: 3.0.0
  contact:
    name: Snappy Support
    email: info@snappy.com
  description: >-
    Welcome to the Snappy API reference documentation!

    You can use this API to integrate with Snappy and spread smiles to your
    employees/clients/customers and much more.

    So let's get started!
servers:
  - url: https://api.snappy.com/public-api
    description: Base API URL
  - url: https://mtls-api.snappy.com/public-api
    description: >-
      ## mTLS URL

      You can also use mTLS to enhance your API security. To get your specific
      certificates please contact our support.

      Once you configure the certificated correctly, you need to also update
      endpoints to use the following secure api base URL:
security: []
tags:
  - name: Products
    description: >-
      Use these endpoints to retrieve products and tags for building catalog and
      browse experiences in your UI.
  - name: Collections
    description: >-
      Use these endpoints to retrieve products within curated collections for
      marketplace and browse experiences.
  - name: Variants
    description: >-
      Use these endpoints to retrieve variants, variant pricing, and country
      availability for orderable product SKUs.
  - name: Billing Methods
    description: >-
      A **Billing Method** is the funding source attached to an **Account** -
      for example, a Purchase Order (PO), Invoice, Prepay deposit, or Credit
      Card. Use these endpoints to retrieve billing method details such as
      remaining balance, status, and expiration.
  - name: Accounts
    description: >-
      An **Account** is a sub-entity within a **Company**, used to organize
      campaigns and gift sends. Use these endpoints to list, retrieve, and
      create accounts.
  - name: API Keys
    description: >-
      Use these endpoints to manage API keys for programmatic access. Key
      management requires company owner privileges.
  - name: Orders
    description: >-
      Use these endpoints to place, retrieve, cancel, and validate orders and
      shipping addresses.
  - name: Digital cards
    description: Use these endpoints to create, retrieve, and access digital cards.
  - name: Base products
    description: Browse swag product templates and their available variants.
  - name: Base variants
    description: Retrieve individual orderable variants of swag product templates.
paths:
  /v3/collections/{collectionId}/products/featured:
    get:
      tags:
        - Collections
      summary: Get featured collection products
      description: >-
        Use this endpoint to retrieve the featured products of a collection for
        a budget range. Featured products are a Snappy-curated selection of the
        most popular items in the collection that fit the budget. We recommend
        displaying them at the top of your collection page, above the full
        product list from `GET /v3/collections/{collectionId}/products`.


        ###### Required parameters:

        - `collectionId` path parameter - the collection to retrieve featured
        products from.

        - `filter[price][gte]` - inclusive minimum budget (0 or more).

        - `filter[price][lte]` - inclusive maximum budget. Must be greater than
        or equal to `filter[price][gte]`.


        ###### Optional parameters:

        - `location` - ISO 3166-1 alpha-2 country code (default `US`).

        - `include` - related entities to include, comma-separated. One or more
        of `brand`, `tags`.

        - `fields` - computed fields, comma-separated. One or more of
        `selectedOrFirstAvailableVariant`, `priceRange`, `variantsCount`.

        - `seed` - any string. The same seed returns the same selection for the
        same collection, budget, and location - for example, pass a recipient ID
        so each recipient sees a stable set of featured products.

        - `Snappy-Account-Id` header - optional account scoping.


        ###### Please note:

        - The response is not paginated. All featured products are returned in a
        single `data` array.

        - Each product has the same shape as in `GET
        /v3/collections/{collectionId}/products`, plus
        `selectedOrFirstAvailableVariant` when requested through `fields`.

        - Returns `400` when the price range is missing or invalid (e.g.
        `filter[price][gte]` greater than `filter[price][lte]`).

        - Returns `404` if the collection does not exist.


        #### Permissions

        - Requires: `products:read`
      parameters:
        - schema:
            type: string
            pattern: ^[A-Za-z0-9]{8,}$
            description: Collection identifier.
            example: abcdef12
          required: true
          description: Collection identifier.
          name: collectionId
          in: path
        - schema:
            type: number
            minimum: 0
            description: Inclusive minimum budget for featured products.
            example: 70
          required: true
          description: Inclusive minimum budget for featured products.
          name: filter[price][gte]
          in: query
        - schema:
            type: number
            minimum: 0
            description: Inclusive maximum budget for featured products.
            example: 100
          required: true
          description: Inclusive maximum budget for featured products.
          name: filter[price][lte]
          in: query
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
            default: US
            description: ISO 3166-1 alpha-2 country code.
            example: US
          required: false
          description: ISO 3166-1 alpha-2 country code.
          name: location
          in: query
        - schema:
            type: array
            items:
              $ref: '#/components/schemas/ProductIncludeV3'
            description: Related entities to include.
            example:
              - brand
              - tags
          required: false
          description: Related entities to include.
          name: include
          in: query
          style: form
          explode: false
        - schema:
            type: array
            items:
              $ref: '#/components/schemas/FeaturedProductFieldsV3'
            description: Computed or expanded product fields.
            example:
              - selectedOrFirstAvailableVariant
              - priceRange
          required: false
          description: Computed or expanded product fields.
          name: fields
          in: query
          style: form
          explode: false
        - schema:
            type: string
            description: Seed used to produce deterministic featured product selection.
            example: recipient-123
          required: false
          description: Seed used to produce deterministic featured product selection.
          name: seed
          in: query
        - schema:
            type: string
            minLength: 1
            description: Must be provided to retrieve swag products.
            example: acc123456
          required: false
          description: Must be provided to retrieve swag products.
          name: snappy-account-id
          in: header
      responses:
        '200':
          description: Featured products selected for the requested budget.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionFeaturedProductsV3Response'
        '400':
          description: Bad Request - Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
              example:
                message: Request validation failed.
                errorCode: 400_PBLC_001
                errors:
                  - errorCode: 400_PBLC_001
                    message: >-
                      filter[price][gte] must be less than or equal to
                      filter[price][lte]
                    path: queryStringParameters.filter[price][gte]
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
        '404':
          description: Not Found - Collection does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
              example:
                message: Collection not found.
                errorCode: 404_PBLC_004
      security:
        - ApiKeyAuthentication: []
components:
  schemas:
    ProductIncludeV3:
      type: string
      enum:
        - brand
        - tags
      description: Related entities to include.
      example: brand
    FeaturedProductFieldsV3:
      type: string
      enum:
        - selectedOrFirstAvailableVariant
        - priceRange
        - variantsCount
      description: Computed or expanded fields for featured collection products.
      example: selectedOrFirstAvailableVariant
    GetCollectionFeaturedProductsV3Response:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedProductV3'
          description: Featured products selected for the requested budget.
      required:
        - data
    ErrorResponseV3:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
          example: Product not found.
        errorCode:
          type: string
          description: Structured error code.
          example: 404_PROD_001
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                example: Product with id 'q1w2e3r4t5' was not found
              path:
                type: string
                description: Dot-separated path to the field that caused the error.
                example: pathParameters.productId
              errorCode:
                type: string
                example: 404_PROD_001
            required:
              - message
              - path
          description: Optional field-level error details.
      required:
        - message
        - errorCode
      description: Standard v3 error envelope.
    FeaturedProductV3:
      allOf:
        - $ref: '#/components/schemas/ProductV3'
        - type: object
          properties:
            selectedOrFirstAvailableVariant:
              allOf:
                - $ref: '#/components/schemas/VariantV3'
                - description: >-
                    Selected or first available variant when requested through
                    `fields`.
      description: >-
        Product (VariationGroup). Optional fields are returned only when
        requested via `include` (related entities) or `fields`
        (computed/expanded). Field availability depends on the calling endpoint
        - see the `include` / `fields` parameter descriptions.
    ProductV3:
      type: object
      properties:
        id:
          type: string
          description: Stable product identifier.
          example: 655277e68e0719000d6c3fd5
        title:
          type: string
          description: Product title.
          example: NFL 25-Layer StadiumView Wall Art
        createdAt:
          type: string
          format: date-time
          description: Product creation date.
          example: '2026-05-11T10:53:01.026Z'
        media:
          type: array
          items:
            $ref: '#/components/schemas/MediaV3'
          description: Product media.
        category:
          type: object
          properties:
            fullName:
              type: string
              description: Full taxonomy path.
              example: Fan Merchandise / NFL / NFL Memorabilia / Autographed Helmets
          required:
            - fullName
          description: Product category.
        catalog:
          type: string
          enum:
            - marketplace
            - swag
            - giftCards
            - donations
          description: Product catalog.
          example: marketplace
        brand:
          $ref: '#/components/schemas/ProductBrandV3'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/ProductTagV3'
          description: Returned only when `include=tags`.
        options:
          type: array
          items:
            $ref: '#/components/schemas/ProductOptionV3'
          description: Aggregated variant options.
        priceRange:
          $ref: '#/components/schemas/PriceRangeV3'
        variantsCount:
          type: integer
          description: >-
            Number of variants. Returned only when `fields` includes
            `variantsCount`.
          example: 12
      required:
        - id
        - title
        - createdAt
        - media
        - category
        - catalog
      description: >-
        Product (VariationGroup). Optional fields are returned only when
        requested via `include` (related entities) or `fields`
        (computed/expanded). Field availability depends on the calling endpoint
        - see the `include` / `fields` parameter descriptions.
    VariantV3:
      type: object
      properties:
        id:
          type: string
          description: Variant identifier.
          example: FB6bgFV4lf
        productId:
          type: string
          description: Parent product identifier.
          example: 655277e68e0719000d6c3fd5
        title:
          type: string
          description: Variant title.
          example: NFL 25-Layer StadiumView Wall Art
        selectedOptions:
          type: object
          additionalProperties:
            type: string
          description: Selected option values for this variant.
          example:
            nfl_team: Denver Broncos
        taxable:
          type: boolean
          description: Whether the variant is taxable.
          example: true
        media:
          type: array
          items:
            $ref: '#/components/schemas/MediaV3'
          description: Variant media.
        personalization:
          $ref: '#/components/schemas/PersonalizationV3'
        price:
          $ref: '#/components/schemas/PriceV3'
        priceBreakdown:
          $ref: '#/components/schemas/PriceBreakdownV3'
        descriptionHtml:
          type: string
          description: HTML full narrative description.
          example: <p>The 25-Layer StadiumViews 3D Wall Art</p>
        details:
          $ref: '#/components/schemas/VariantDetailsV3'
        brand:
          $ref: '#/components/schemas/ProductBrandV3'
        shippingRequired:
          type: boolean
      required:
        - id
        - title
        - selectedOptions
        - taxable
        - media
        - personalization
      description: First selectable variant for this option value.
    MediaV3:
      type: object
      properties:
        type:
          type: string
          enum:
            - image
            - video
          description: Media type.
          example: image
        src:
          type: string
          format: uri
          description: Media source URL.
          example: >-
            https://media.snappy.com/image/o1xc17wfbda6cl91hm0r6_picture-1.jpg?w=1000&h=1000&q=80&f=auto
      required:
        - type
        - src
      description: A media item for v3 endpoints.
    ProductBrandV3:
      type: object
      nullable: true
      properties:
        id:
          type: string
          description: Brand ID.
          example: 6511b55142c420000d083a55
        name:
          type: string
          description: Brand name.
          example: YouTheFan
        description:
          type: string
          nullable: true
          description: Brand description.
          example: Officially licensed NFL fan merchandise.
      required:
        - id
        - name
        - description
      description: >-
        Product or variant brand. Returned only when `include=brand`. Nullable
        when the product or variant has no brand.
    ProductTagV3:
      type: object
      properties:
        id:
          type: string
          description: Tag ID.
          example: tag12345
        name:
          type: string
          description: Tag name.
          example: Sustainable
      required:
        - id
        - name
      description: Product tag.
    ProductOptionV3:
      type: object
      properties:
        name:
          type: string
          description: Option name.
          example: nfl_team
        displayName:
          type: string
          description: Option display name.
          example: Team
        displayType:
          type: string
          description: Display type hint.
          example: image
        values:
          type: array
          items:
            $ref: '#/components/schemas/ProductOptionValueV3'
          description: Available values.
      required:
        - name
        - displayName
        - displayType
        - values
      description: Aggregated product option.
    PriceRangeV3:
      type: object
      properties:
        min:
          $ref: '#/components/schemas/PriceV3'
        max:
          $ref: '#/components/schemas/PriceV3'
      required:
        - min
        - max
      description: >-
        Min/max pricing across the product's variants. Returned only when
        `fields` includes `priceRange`.
    PersonalizationV3:
      type: object
      nullable: true
      properties:
        isPersonalized:
          type: boolean
          description: Whether the variant is personalizable.
          example: true
        personalizationTemplateFields:
          type: array
          items:
            type: string
          description: Personalization template field names.
          example:
            - firstName
            - lastName
            - department
      required:
        - isPersonalized
        - personalizationTemplateFields
      description: Personalization metadata, or null when unavailable.
    PriceV3:
      type: object
      properties:
        amount:
          type: number
          example: 215
        currency:
          type: string
          description: ISO 4217 currency code.
          example: USD
      required:
        - amount
        - currency
      description: Variant price in a given currency.
    PriceBreakdownV3:
      type: object
      properties:
        ddp:
          type: number
          description: Delivered Duty Paid charges (duties + import taxes).
          example: 10
        shippingFee:
          type: number
          example: 5
        itemPrice:
          type: number
          description: Base item price before shipping/duties.
          example: 200
      required:
        - ddp
        - shippingFee
        - itemPrice
      description: Detailed breakdown of the variant price.
    VariantDetailsV3:
      type: object
      properties:
        includes:
          type: string
          nullable: true
          description: HTML content describing what is included.
          example: <p>Set of 4 glasses (12oz each)</p>
        features:
          type: string
          nullable: true
          description: HTML product highlights.
          example: <ul><li>Feature</li></ul>
        specifications:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Structured key-value non-regulatory specifications.
          example:
            material: lead-free glass
            capacity: 12oz
            dimensions: 4.5' tall
        notices:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Structured key-value regulatory notices.
          example:
            prop65Warning: Warning text
      description: >-
        Variant-level structured details wrapper. Returned only when `fields`
        includes `details`.
    ProductOptionValueV3:
      type: object
      properties:
        displayName:
          type: string
          description: Option value display name.
          example: Denver Broncos
        value:
          type: string
          description: Option value.
          example: Denver Broncos
        firstSelectableVariant:
          $ref: '#/components/schemas/VariantV3'
      required:
        - displayName
        - value
        - firstSelectableVariant
      description: Product option value.
  securitySchemes:
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        ## Company Level Authentication

        Include your API key in the `X-Api-Key` header for every request:
        ```
        X-Api-Key: YOUR_API_KEY
        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.