> ## 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.
# Validate Product for Delivery (Dry Run)
> **/product/{id}/deliveries/validate**
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Description
**/product/{id}/deliveries/validate**
**Description:**
Validate that a product can be delivered to FUGA without actually performing the delivery.
This performs a "dry run" that checks:
* Product has required metadata
* Assets exist and are accessible
* Audio files can be converted to required format
* Images meet size/format requirements
**Method:**
`POST`
**Parameters:**
| Parameter | Type | Description |
| --------- | ------ | ----------------------------------------- |
| id | string | Product ID (path parameter) |
| providers | array | Array of provider IDs to validate against |
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/product/example-id/deliveries/validate', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"providers": [
"fuga-csv-ftp"
]
})
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.post(
'https://api.royalti.io/product/example-id/deliveries/validate',
headers={
'Authorization': f'Bearer {token}'
},
json={"providers":["fuga-csv-ftp"]}
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X POST https://api.royalti.io/product/example-id/deliveries/validate \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"providers":["fuga-csv-ftp"]}'
```
## OpenAPI
````yaml post /product/{id}/deliveries/validate
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:
/product/{id}/deliveries/validate:
post:
tags:
- Product Delivery
summary: Validate Product Delivery
description: >-
**/product/{id}/deliveries/validate**
**Description:**
Validate a product against provider requirements without actually
delivering it (dry-run).
This endpoint checks if the product meets all requirements and provides
suggestions for missing fields.
**Method:**
`POST`
**Path Parameter:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | string | The unique identifier of the product |
**Request Payload:**
| Parameter | Type | Description |
| --- | --- | --- |
| providers | array/string | Provider ID(s) to validate against |
**Use Cases:**
- Pre-flight validation before delivery
- Identifying missing metadata
- Getting suggestions for field values
parameters:
- name: id
in: path
required: true
description: Product ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
providers:
oneOf:
- type: string
- type: array
items:
type: string
description: Single provider ID or array of provider IDs
required:
- providers
example:
providers:
- spotify-ddex-sftp
responses:
'200':
description: Validation completed
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
message:
type: string
example: Validation completed
data:
type: object
properties:
productId:
type: string
upc:
type: string
validations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
example:
status: success
message: Validation completed
data:
productId: prod-123
upc: '123456789012'
validations:
- provider: spotify-ddex-sftp
isValid: false
errors:
- 'Missing required field: releaseDate'
suggestions:
releaseDate: '2024-09-01'
'404':
$ref: '#/components/schemas/Error'
'500':
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
ValidationResult:
type: object
properties:
provider:
type: string
description: Provider identifier
isValid:
type: boolean
description: Whether product passes validation
errors:
type: array
items:
type: string
description: Validation error messages
suggestions:
type: object
description: Suggested values for missing fields
nullable: true
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}"
````