Skip to main content
POST
/
checklist
/
products
/
enrich
Enrich Existing Products
curl --request POST \
  --url https://api.royalti.io/checklist/products/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "missingFields": [
    "genre",
    "label"
  ],
  "upcPrefix": "019",
  "limit": 200
}
'
import requests

url = "https://api.royalti.io/checklist/products/enrich"

payload = {
    "missingFields": ["genre", "label"],
    "upcPrefix": "019",
    "limit": 200
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({missingFields: ['genre', 'label'], upcPrefix: '019', limit: 200})
};

fetch('https://api.royalti.io/checklist/products/enrich', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/checklist/products/enrich",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'missingFields' => [
        'genre',
        'label'
    ],
    'upcPrefix' => '019',
    'limit' => 200
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/checklist/products/enrich"

	payload := strings.NewReader("{\n  \"missingFields\": [\n    \"genre\",\n    \"label\"\n  ],\n  \"upcPrefix\": \"019\",\n  \"limit\": 200\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/checklist/products/enrich")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"missingFields\": [\n    \"genre\",\n    \"label\"\n  ],\n  \"upcPrefix\": \"019\",\n  \"limit\": 200\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/checklist/products/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"missingFields\": [\n    \"genre\",\n    \"label\"\n  ],\n  \"upcPrefix\": \"019\",\n  \"limit\": 200\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Product enrichment job queued",
  "data": {
    "jobId": "<string>",
    "batchId": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/checklist/products/enrich Selects existing products matching the provided filters and stages them for admin review. Product enrichment currently uses existing metadata only (no external API enrichment in v1). Authorization:
  • Required role: admin or higher
Method: POST

​
Code Examples

const response = await fetch('https://api.royalti.io/checklist/products/enrich', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/EnrichmentFilters"
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
  'https://api.royalti.io/checklist/products/enrich',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/EnrichmentFilters"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/checklist/products/enrich \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/EnrichmentFilters"}'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json

Filters for selecting existing catalog items to enrich

​
missingFields
enum<string>[]

Only include items where these fields are empty/null

Available options:
genre,
artist,
explicit,
releaseDate,
label,
duration
​
isrcPrefix
string

Filter assets by ISRC prefix (e.g. 'NGA')

​
upcPrefix
string

Filter products by UPC prefix

​
isrcs
string[]

Exact-match list of ISRCs (assets endpoint). When supplied and non-empty, this supersedes isrcPrefix and search. Capped at 1000 entries; values are trimmed and de-duplicated. Use this for bulk "Enrich Selected (N)" actions instead of issuing N sequential prefix calls.

Maximum array length: 1000
​
upcs
string[]

Exact-match list of UPCs (products endpoint). When supplied and non-empty, this supersedes upcPrefix and search. Capped at 1000 entries; values are trimmed and de-duplicated.

Maximum array length: 1000
​
ids
string<uuid>[]

Specific asset/product UUIDs to enrich

​
search
string

Text search on title

​
limit
integer
default:1000

Maximum items to process

Response

Enrichment job queued successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Product enrichment job queued"

​
data
object