Jay Integration Documentation

Welcome to the developer documentation of the Jay marketplace. This guide is designed for developers, product engineers, and technical decision-makers who are integrating our services into their applications.

The Jay marketplace provides modular tools for content delivery, product management, and checkout — designed to be seamlessly integrated via APIs across web, iOS, Android, and connected TV environments.

Who is this documentation for?

This documentation addresses streaming platforms (here referred to as "platforms") looking to enrich their content offerings and improve user engagement through the Jay marketplace.

It is also useful for retailers looking to integrate their products into streaming content, providing a comprehensive guide to our APIs and checkout processes.

What you will find here

This documentation includes:

• Introduction
  Essential overview information including:

  • Jay Marketplace Overview: Key features and benefits
  • System Overview: Architecture and technical components
  • Glossary: Key terms and definitions

• Get Started
  Fundamental information to begin your integration:

  • How It Works: Core concepts and integration options
  • Synced Basket: Multi-device shopping experience
  • Cross-Device UX: Designing consistent experiences

• API Reference
  Complete OpenAPI specifications and usage examples for:

  • Playout API: Delivering curated content feeds
  • Basket API: Managing product selections and session-based carts
  • Product API: Managing product information and inventory
  • Security & Error Handling: Best practices and troubleshooting

• Platform Integration
  Documentation for streaming platforms looking to integrate the Jay marketplace:

  • How-To Guides: Task-based implementation guidance for tracking, fetching data, displaying products, and more
  • Use Cases: Practical examples for menu-based content, scene-based content, and shoppable ads

• Retailer Resources
  Documentation for retailers joining the Jay marketplace:

  • Getting Started: Onboarding process and initial setup
  • Product Management: Options for managing your product catalog
  • ERP Connectors: Methods to connect your existing systems
  • Payment Processing: Stripe Connected Account implementation, compliance, and reporting

System Components

The Jay marketplace is built on a layered architecture:

• APIs (REST-based): Backend services that deliver structured data
• Checkout Engine: A Stripe-based payment handler that works across devices

This modular setup allows you to choose the right combination for your platform, whether you want to embed a simple container or build a fully integrated commerce experience.

Where to Start

If you're new here:

1. Start with the Glossary for key terms.
2. Read the System Overview to understand the architecture.
3. Then go to Get Started to begin your integration.