Create a claim letter

curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_number": "3SABCD1234567",
  "items": [
    {
      "description": "T-Shirt",
      "quantity": 3,
      "unit_price": 19.95
    },
    {
      "description": "Pants",
      "quantity": 1,
      "unit_price": 45
    }
  ],
  "currency_code": "EUR",
  "tax_rate": 21,
  "ticket_category": "damaged"
}
'

import requests

url = "https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter"

payload = {
    "tracking_number": "3SABCD1234567",
    "items": [
        {
            "description": "T-Shirt",
            "quantity": 3,
            "unit_price": 19.95
        },
        {
            "description": "Pants",
            "quantity": 1,
            "unit_price": 45
        }
    ],
    "currency_code": "EUR",
    "tax_rate": 21,
    "ticket_category": "damaged"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tracking_number: '3SABCD1234567',
    items: [
      {description: 'T-Shirt', quantity: 3, unit_price: 19.95},
      {description: 'Pants', quantity: 1, unit_price: 45}
    ],
    currency_code: 'EUR',
    tax_rate: 21,
    ticket_category: 'damaged'
  })
};

fetch('https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter', 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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter",
  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([
    'tracking_number' => '3SABCD1234567',
    'items' => [
        [
                'description' => 'T-Shirt',
                'quantity' => 3,
                'unit_price' => 19.95
        ],
        [
                'description' => 'Pants',
                'quantity' => 1,
                'unit_price' => 45
        ]
    ],
    'currency_code' => 'EUR',
    'tax_rate' => 21,
    'ticket_category' => 'damaged'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter"

	payload := strings.NewReader("{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}"

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

{
  "file_token": "c91f8b81-68d7-5449-aa3b-fbf61e748372",
  "preview_url": "https://s3.example.com/claim_letter.pdf?token=..."
}

Ticket data & attachments

Create a claim letter

Generate a claim letter PDF for a parcel. The claim letter is created based on the provided items, currency, tax rate, and ticket category, combined with parcel and sender details fetched from the system.

Company details and addresses are auto-populated from the parcel and sender information stored in the system.

Note: Claim letters are currently generated in French only.

The generated PDF returns a file token that can be used with the Create a requested data response endpoint or when creating tickets.

POST

dsf

documents

generate

claim-letter

Create a claim letter

curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_number": "3SABCD1234567",
  "items": [
    {
      "description": "T-Shirt",
      "quantity": 3,
      "unit_price": 19.95
    },
    {
      "description": "Pants",
      "quantity": 1,
      "unit_price": 45
    }
  ],
  "currency_code": "EUR",
  "tax_rate": 21,
  "ticket_category": "damaged"
}
'

import requests

url = "https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter"

payload = {
    "tracking_number": "3SABCD1234567",
    "items": [
        {
            "description": "T-Shirt",
            "quantity": 3,
            "unit_price": 19.95
        },
        {
            "description": "Pants",
            "quantity": 1,
            "unit_price": 45
        }
    ],
    "currency_code": "EUR",
    "tax_rate": 21,
    "ticket_category": "damaged"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tracking_number: '3SABCD1234567',
    items: [
      {description: 'T-Shirt', quantity: 3, unit_price: 19.95},
      {description: 'Pants', quantity: 1, unit_price: 45}
    ],
    currency_code: 'EUR',
    tax_rate: 21,
    ticket_category: 'damaged'
  })
};

fetch('https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter', 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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter",
  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([
    'tracking_number' => '3SABCD1234567',
    'items' => [
        [
                'description' => 'T-Shirt',
                'quantity' => 3,
                'unit_price' => 19.95
        ],
        [
                'description' => 'Pants',
                'quantity' => 1,
                'unit_price' => 45
        ]
    ],
    'currency_code' => 'EUR',
    'tax_rate' => 21,
    'ticket_category' => 'damaged'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter"

	payload := strings.NewReader("{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/dsf/documents/generate/claim-letter")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_number\": \"3SABCD1234567\",\n  \"items\": [\n    {\n      \"description\": \"T-Shirt\",\n      \"quantity\": 3,\n      \"unit_price\": 19.95\n    },\n    {\n      \"description\": \"Pants\",\n      \"quantity\": 1,\n      \"unit_price\": 45\n    }\n  ],\n  \"currency_code\": \"EUR\",\n  \"tax_rate\": 21,\n  \"ticket_category\": \"damaged\"\n}"

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

{
  "file_token": "c91f8b81-68d7-5449-aa3b-fbf61e748372",
  "preview_url": "https://s3.example.com/claim_letter.pdf?token=..."
}

Authorizations

Authorization

string

header

required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Body

application/json

tracking_number

string

required

Parcel tracking number

Example:

"3SABCD1234567"

items

object[]

required

List of invoice line items

Show child attributes

currency_code

string

required

ISO 4217 currency code

Example:

"EUR"

tax_rate

number<double>

required

Tax rate percentage (0-99)

Required range: 0 <= x <= 99

Example:

21

ticket_category

enum<string>

required

The type of claim this letter is for

Available options:

damaged,

lost,

unjust_return,

delivered_not_received

force

boolean

default:false

Bypasses the maximum invoice amount validation (5000 EUR). Only use this when strictly necessary, as the validation exists to prevent erroneous documents.

Response

Claim letter generated successfully

file_token

string

required

A token referencing the generated document. Use this token when attaching the document to a ticket (in the attachments array) or when submitting it as part of a requested data response.

preview_url

string

required

Temporary pre-signed URL for previewing or downloading the generated PDF. This URL expires after 72 hours and should not be stored for long-term use.

Files Generate sales invoice

⌘I

General

Authentication & account

Shipping

Checkout & delivery options

Tracking & post-purchase

Events & notifications

Carriers & pickups

Financial

Data & insights

Integrations

Create a claim letter

Authorizations

Body

Response