> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Check Royalty Products
> **/checklist/royaltyproducts**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**/checklist/royaltyproducts**
Retrieves a list of royalty products that exist in the sales data but don't have corresponding product records.
**Requirements:**
* BigQuery dataset must be configured for the tenant
* Requires valid authentication
**Method:**
`GET`
**Headers:**
* `x-tenant-id`: Required. The tenant ID
* `Authorization`: Required. Bearer token for authentication
**Response:**
* `count`: Total number of royalty products
* `royaltyproducts`: Array of product objects with details about their respective status.
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/checklist/royaltyproducts', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.get(
'https://api.royalti.io/checklist/royaltyproducts',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/checklist/royaltyproducts \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /checklist/royaltyproducts
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/checklist/royaltyproducts:
get:
tags:
- Checklists
summary: Check Royalty Products
description: >-
**/checklist/royaltyproducts**
Retrieves a list of royalty products that exist in the sales data but
don't have corresponding product records.
**Requirements:**
- BigQuery dataset must be configured for the tenant
- Requires valid authentication
**Method:**
`GET`
**Headers:**
- `x-tenant-id`: Required. The tenant ID
- `Authorization`: Required. Bearer token for authentication
**Response:**
- `count`: Total number of royalty products
- `royaltyproducts`: Array of product objects with details about their
respective status.
responses:
'200':
description: Successfully retrieved royalty products checklist
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of royalty products
royaltyproducts:
type: array
items:
$ref: '#/components/schemas/RoyaltyProduct'
example:
count: 70
royaltyproducts:
- upc: '36336749436'
catalog: ''
artists: Soltune
displayArtist: Soltune
type: Audio
format: Single
title: Holy Spirit
releaseDate: ''
mainGenre: ''
subGenre: ''
Label: DIXTRIT.media
status: Live
distribution: Symphonic Distribution
tracklist: NGA601900320
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
RoyaltyProduct:
type: object
properties:
upc:
type: string
description: Universal Product Code
catalog:
type: string
description: Product catalog number
artists:
type: string
description: Primary artist name
displayArtist:
type: string
description: Display artist name
type:
type: string
description: Product type (e.g., 'Audio')
format:
type: string
enum:
- Single
- EP
- Album
description: Product format based on number of tracks
title:
type: string
description: Product title
releaseDate:
type: string
format: date
description: Release date (YYYY-MM-DD)
mainGenre:
type: string
description: Main genre
subGenre:
type: string
description: Sub-genre
Label:
type: string
description: Record label name
status:
type: string
description: Product status (e.g., 'Live')
distribution:
type: string
description: Distributor/Aggregator name
tracklist:
type: string
description: Pipe-separated list of ISRCs
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````