Create Product Delivery

curl --request POST \
  --url https://api.royalti.io/product/{id}/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "providers": [
    "fuga-csv-ftp"
  ],
  "autoDeliver": true,
  "settings": {},
  "confirmDestructive": false
}
'

import requests

url = "https://api.royalti.io/product/{id}/deliveries"

payload = {
    "providers": ["fuga-csv-ftp"],
    "autoDeliver": True,
    "settings": {},
    "confirmDestructive": False
}
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({
    providers: ['fuga-csv-ftp'],
    autoDeliver: true,
    settings: {},
    confirmDestructive: false
  })
};

fetch('https://api.royalti.io/product/{id}/deliveries', 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/product/{id}/deliveries",
  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([
    'providers' => [
        'fuga-csv-ftp'
    ],
    'autoDeliver' => true,
    'settings' => [
        
    ],
    'confirmDestructive' => false
  ]),
  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/product/{id}/deliveries"

	payload := strings.NewReader("{\n  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\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/product/{id}/deliveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/product/{id}/deliveries")

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  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Deliveries initiated successfully",
  "data": {
    "productId": "<string>",
    "upc": "<string>",
    "deliveries": [
      {
        "provider": "<string>",
        "deliveryId": "<string>",
        "messageId": "<string>",
        "errors": [
          "<string>"
        ]
      }
    ]
  }
}

POST

product

{id}

deliveries

Create Product Delivery

curl --request POST \
  --url https://api.royalti.io/product/{id}/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "providers": [
    "fuga-csv-ftp"
  ],
  "autoDeliver": true,
  "settings": {},
  "confirmDestructive": false
}
'

import requests

url = "https://api.royalti.io/product/{id}/deliveries"

payload = {
    "providers": ["fuga-csv-ftp"],
    "autoDeliver": True,
    "settings": {},
    "confirmDestructive": False
}
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({
    providers: ['fuga-csv-ftp'],
    autoDeliver: true,
    settings: {},
    confirmDestructive: false
  })
};

fetch('https://api.royalti.io/product/{id}/deliveries', 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/product/{id}/deliveries",
  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([
    'providers' => [
        'fuga-csv-ftp'
    ],
    'autoDeliver' => true,
    'settings' => [
        
    ],
    'confirmDestructive' => false
  ]),
  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/product/{id}/deliveries"

	payload := strings.NewReader("{\n  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\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/product/{id}/deliveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/product/{id}/deliveries")

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  \"providers\": [\n    \"fuga-csv-ftp\"\n  ],\n  \"autoDeliver\": true,\n  \"settings\": {},\n  \"confirmDestructive\": false\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Deliveries initiated successfully",
  "data": {
    "productId": "<string>",
    "upc": "<string>",
    "deliveries": [
      {
        "provider": "<string>",
        "deliveryId": "<string>",
        "messageId": "<string>",
        "errors": [
          "<string>"
        ]
      }
    ]
  }
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

/product//deliveries Description: Create a new delivery for a product to one or more DDEX/FUGA providers. Authorization:

Required role: admin or higher

Method: POST Parameters:

Parameter	Type	Description
id	string	Product ID (path parameter)
providers	string or array	Provider ID, or array of provider IDs to deliver to
autoDeliver	boolean	Automatically start delivery (default: true); when `false`, runs a validation-only dry run instead of dispatching
settings	object	Optional DDEX metadata overrides, merged into the product’s `ddexMetadata` before delivery
confirmDestructive	boolean	Must be `true` to proceed when a FUGA update would clear fields FUGA currently has populated (default: false)

Validation Requirements:

Product must have a UPC code
Provider must be configured and active for the tenant (“DDEX & Deliveries” addon)

Per-provider validation failures (missing assets, missing ISRC, missing metadata, unsupported audio format, etc.) do not raise an HTTP error — they come back as errors on that provider’s entry in the deliveries array of the response. Response status depends on outcome:

201 — every requested provider was dispatched
207 — some providers were dispatched, others were blocked
422 — every provider was blocked (nothing dispatched)
409 — blocked because a FUGA update would overwrite currently-populated fields with blanks; resend with confirmDestructive: true

Code Examples

const response = await fetch('https://api.royalti.io/product/example-id/deliveries', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "providers": [
      "fuga-csv-ftp"
    ],
    "autoDeliver": true,
    "settings": {},
    "confirmDestructive": true
  })
});

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

import requests

response = requests.post(
  'https://api.royalti.io/product/example-id/deliveries',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"providers":["fuga-csv-ftp"],"autoDeliver":true,"settings":{},"confirmDestructive":true}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/product/example-id/deliveries \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"providers":["fuga-csv-ftp"],"autoDeliver":true,"settings":{},"confirmDestructive":true}'

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Product ID

Body

application/json

providers

required

Single provider ID or array of provider IDs

Example:

["fuga-csv-ftp"]

autoDeliver

boolean

default:true

Automatically start delivery; when false, only validates each provider

settings

object

Optional DDEX metadata overrides applied to the product before delivery

confirmDestructive

boolean

default:false

Confirms a FUGA update that would clear previously-populated fields

Response

All requested deliveries were dispatched

status

string

Example:

"success"

message

string

Example:

"Deliveries initiated successfully"

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples