Create batch deliveries for multiple products

curl --request POST \
  --url https://api.royalti.io/product/batch-delivery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productIds": [
    "prod_abc123",
    "prod_def456",
    "prod_ghi789"
  ],
  "provider": "fuga-csv-ftp",
  "priority": "normal",
  "settings": {}
}
'

import requests

url = "https://api.royalti.io/product/batch-delivery"

payload = {
    "productIds": ["prod_abc123", "prod_def456", "prod_ghi789"],
    "provider": "fuga-csv-ftp",
    "priority": "normal",
    "settings": {}
}
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({
    productIds: ['prod_abc123', 'prod_def456', 'prod_ghi789'],
    provider: 'fuga-csv-ftp',
    priority: 'normal',
    settings: {}
  })
};

fetch('https://api.royalti.io/product/batch-delivery', 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/batch-delivery",
  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([
    'productIds' => [
        'prod_abc123',
        'prod_def456',
        'prod_ghi789'
    ],
    'provider' => 'fuga-csv-ftp',
    'priority' => 'normal',
    'settings' => [
        
    ]
  ]),
  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/batch-delivery"

	payload := strings.NewReader("{\n  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\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/batch-delivery")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/product/batch-delivery")

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  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\n}"

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

{
  "status": "success",
  "message": "Batch delivery initiated successfully",
  "data": {
    "batchId": "batch_abc123xyz",
    "totalProducts": 10,
    "foundProducts": 10,
    "successfulDeliveries": 10,
    "failedDeliveries": 0,
    "invalidProducts": 0,
    "provider": "fuga-csv-ftp",
    "priority": "normal",
    "deliveries": [
      {
        "productId": "<string>",
        "upc": "<string>",
        "title": "<string>",
        "status": "queued",
        "deliveryId": "<string>",
        "messageId": "<string>"
      }
    ],
    "errors": [
      {
        "productId": "<string>",
        "upc": "<string>",
        "title": "<string>",
        "error": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

POST

product

batch-delivery

Create batch deliveries for multiple products

curl --request POST \
  --url https://api.royalti.io/product/batch-delivery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productIds": [
    "prod_abc123",
    "prod_def456",
    "prod_ghi789"
  ],
  "provider": "fuga-csv-ftp",
  "priority": "normal",
  "settings": {}
}
'

import requests

url = "https://api.royalti.io/product/batch-delivery"

payload = {
    "productIds": ["prod_abc123", "prod_def456", "prod_ghi789"],
    "provider": "fuga-csv-ftp",
    "priority": "normal",
    "settings": {}
}
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({
    productIds: ['prod_abc123', 'prod_def456', 'prod_ghi789'],
    provider: 'fuga-csv-ftp',
    priority: 'normal',
    settings: {}
  })
};

fetch('https://api.royalti.io/product/batch-delivery', 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/batch-delivery",
  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([
    'productIds' => [
        'prod_abc123',
        'prod_def456',
        'prod_ghi789'
    ],
    'provider' => 'fuga-csv-ftp',
    'priority' => 'normal',
    'settings' => [
        
    ]
  ]),
  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/batch-delivery"

	payload := strings.NewReader("{\n  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\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/batch-delivery")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/product/batch-delivery")

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  \"productIds\": [\n    \"prod_abc123\",\n    \"prod_def456\",\n    \"prod_ghi789\"\n  ],\n  \"provider\": \"fuga-csv-ftp\",\n  \"priority\": \"normal\",\n  \"settings\": {}\n}"

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

{
  "status": "success",
  "message": "Batch delivery initiated successfully",
  "data": {
    "batchId": "batch_abc123xyz",
    "totalProducts": 10,
    "foundProducts": 10,
    "successfulDeliveries": 10,
    "failedDeliveries": 0,
    "invalidProducts": 0,
    "provider": "fuga-csv-ftp",
    "priority": "normal",
    "deliveries": [
      {
        "productId": "<string>",
        "upc": "<string>",
        "title": "<string>",
        "status": "queued",
        "deliveryId": "<string>",
        "messageId": "<string>"
      }
    ],
    "errors": [
      {
        "productId": "<string>",
        "upc": "<string>",
        "title": "<string>",
        "error": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

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

Description

POST /product/batch-delivery Create deliveries for multiple products in a single request. Features:

Process up to 100 products per request
Returns detailed status for each product
Supports partial success (some products succeed, others fail)
Asynchronous queue-based processing

Validation Rules:

All products must have UPC codes
Provider must be active and configured
“DDEX & Deliveries” addon must be enabled
Products must have required DDEX metadata

Rate Limits:

Maximum 100 products per batch

Authorization:

Required role: admin or higher

Response status code: 201 is returned whenever at least one product’s delivery succeeded — including a partial success where some products failed (check status / data.errors in the body to tell them apart). 207 is only returned when every product failed (nothing succeeded).

Code Examples

const response = await fetch('https://api.royalti.io/product/batch-delivery', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "productIds": [
      "prod_abc123",
      "prod_def456",
      "prod_ghi789"
    ],
    "provider": "fuga-csv-ftp",
    "priority": "normal",
    "settings": {}
  })
});

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

import requests

response = requests.post(
  'https://api.royalti.io/product/batch-delivery',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"productIds":["prod_abc123","prod_def456","prod_ghi789"],"provider":"fuga-csv-ftp","priority":"normal","settings":{}}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/product/batch-delivery \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"productIds":["prod_abc123","prod_def456","prod_ghi789"],"provider":"fuga-csv-ftp","priority":"normal","settings":{}}'

Authorizations

Authorization

string

header

required

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

Body

application/json

productIds

string[]

required

Array of product IDs to deliver (max 100)

Required array length: 1 - 100 elements

Example:

["prod_abc123", "prod_def456", "prod_ghi789"]

provider

string

required

Provider identifier

Example:

"fuga-csv-ftp"

priority

string

default:normal

Delivery priority. Echoed back in the response but not otherwise validated or enforced server-side (any string is accepted).

Example:

"normal"

settings

object

Optional DDEX metadata overrides, merged into each product's ddexMetadata

Response

At least one product's delivery succeeded (status success or partial_success)

status

enum<string>

Available options:

success,

partial_success

Example:

"success"

message

string

Example:

"Batch delivery initiated successfully"

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Body

Response

Description

Code Examples