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

# Introduction to Carousel

> Generate URLs for rotating marketing content displays

Carousel endpoints allow you to generate URLs that display rotating marketing slides on customer-facing screens. This enables you to show dynamic promotional content, offers, and announcements in a visually engaging format.

## What is a Carousel?

A carousel is a rotating slideshow of marketing content displayed on customer-facing screens (CFS) or kiosk displays. Carousels help you:

* **Display Multiple Offers:** Rotate through several promotions in one screen space
* **Increase Engagement:** Catch customer attention with dynamic visual content
* **Promote Campaigns:** Showcase seasonal offers, new products, or events
* **Brand Awareness:** Display brand messaging and marketing materials

## How It Works

<Steps>
  <Step title="Generate Carousel URL" icon="link">
    Call the [carousel endpoint](/api-reference/carousel/generate-carousel-url)
    with your location and terminal information.
  </Step>

  <Step title="Receive URL" icon="globe">
    API returns a unique URL pointing to the carousel content configured for
    your location.
  </Step>

  <Step title="Display on Screen" icon="display">
    Load the carousel URL in a web view or browser on your customer-facing
    screen or kiosk.
  </Step>

  <Step title="Content Auto-Updates" icon="arrows-rotate">
    Carousel content updates automatically based on your ClearLine admin
    configuration - no need to regenerate the URL.
  </Step>
</Steps>

## Carousel Endpoint

<Card title="Generate Carousel URL" icon="images" href="/api-reference/carousel/generate-carousel-url">
  Generate a URL for carousel content display
</Card>

## Best Practices

<AccordionGroup>
  <Accordion title="Generate Once Per Session" icon="clock" defaultOpen>
    Generate the carousel URL once when your CFS/kiosk initializes. The URL
    remains valid and content updates automatically.
  </Accordion>

  <Accordion title="Use Full-Screen Display" icon="expand">
    Display the carousel in a full-screen web view for maximum visual impact on
    customer-facing screens.
  </Accordion>

  <Accordion title="Handle Network Errors" icon="wifi-slash">
    Implement fallback content (static image or message) if the carousel URL
    fails to load due to network issues.
  </Accordion>

  <Accordion title="Refresh URL Periodically" icon="arrows-rotate">
    Regenerate the carousel URL daily or when restarting your display to ensure
    you have the latest configuration.
  </Accordion>
</AccordionGroup>

## Common Use Cases

**Retail Stores:** Display rotating product promotions, seasonal offers, and store announcements on screens at checkout or entrance.

**Restaurants:** Show menu specials, combo deals, and promotional offers on customer-facing displays at the counter.

**Service Businesses:** Promote loyalty programs, new services, and special pricing on waiting area screens.

**Kiosks:** Attract customers with dynamic marketing content on self-service kiosk idle screens.

## Next Steps

<CardGroup cols={2}>
  <Card title="Carousel API Reference" icon="code" href="/api-reference/carousel/generate-carousel-url">
    View complete API specification
  </Card>

  <Card title="CFS Carousel Guide" icon="book-open" href="/integration-options/checkout-integration-app/cfs-carousel">
    Learn how to implement carousel displays
  </Card>
</CardGroup>
