Skip to main content
POST
/
dsf
/
tickets
/
damage
Create a ticket for a damaged parcel
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/dsf/tickets/damage \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_number": "3SABCD1234567",
  "carrier_contract_id": 123,
  "contents_sales_price": {
    "price": 10.55,
    "currency": "EUR"
  },
  "contents_purchase_price": {
    "price": 8,
    "currency": "EUR"
  },
  "contents_description": "The parcel contains 3 t-shits and 1 pair of shoes.",
  "parcel_exterior_description": "The box has our branding.",
  "additional_remarks": "<string>",
  "customer_confirmation": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "sales_invoice": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "purchase_invoice": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "exterior_photo": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "interior_photo": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "damage_photo_1": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "damage_photo_2": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "package_photo": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  },
  "entire_product_photo": {
    "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
  }
}
'
{
  "ticket_id": "b99c8ea5-3156-442e-8dfe-c746218a3fbe"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
is_portal_claim
boolean
default:false

Set to true to force a portal claim. Supported for Colissimo, Chronopost, Colis Privé, Mondial Relay, InPost ES, and DHL Express carriers only. Requires a carrier contract setup.

Body

application/json

Data that is needed for creation of a ticket for own contract parcel and parcels created using Sendcloud rates is different. Please refer to relevant examples below.

​
tracking_number
string
required

Parcel tracking number

Example:

"3SABCD1234567"

​
carrier_contract_id
integer

The ID of the carrier contract associated with the parcel. Required when creating a ticket for a support only parcel that is not tracked in the Sendcloud system. The contract must belong to the authenticated user.

Example:

123

​
contents_sales_price
object

Sales value of the contents of the parcel

Example:
{ "price": 10.55, "currency": "EUR" }
​
contents_purchase_price
object

Purchase value of the contents of the parcel

Example:
{ "price": 8, "currency": "EUR" }
​
contents_description
string

Description of the contents of the parcel

Example:

"The parcel contains 3 t-shits and 1 pair of shoes."

​
parcel_exterior_description
string

Parcel exterior description

Example:

"The box has our branding."

​
additional_remarks
string

Additional remarks about the parcel

​
customer_confirmation
object

Written confirmation about the problem by the intended receiver

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
sales_invoice
object

The sales invoice

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
purchase_invoice
object

The purchase invoice

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
exterior_photo
object

A photo of the exterior of the shipment's box

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
interior_photo
object

A photo of the inside padding material

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
damage_photo_1
object

A photo of the damaged goods

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
damage_photo_2
object

An additional photo of the damaged goods

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
package_photo
object

A photo of the opened package taken from above. The entire contents of the inner package must be clearly visible

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}
​
entire_product_photo
object

A photo showing the entire product

Example:
{
  "file_token": "b90e7a70-57c6-4338-992a-eae50d637261-6170706c69636174696f6e2f706466"
}

Response

Accepted

Create ticket response

​
ticket_id
string
required