Skip to main content
POST
Create a ticket for a delayed parcel

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 a delayed parcel created using Sendcloud rates.

tracking_number
string
required

Parcel tracking number

Example:

"3SABCD1234567"

contents_sales_price
object
required

Sales value of the contents of the parcel

Example:
contents_description
string
required

Description of the contents of the parcel

Example:

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

parcel_exterior_description
string
required

Parcel exterior description

Example:

"The box has our branding."

sales_invoice
object
required

The sales invoice

Example:
purchase_invoice
object
required

The purchase invoice

Example:
contents_purchase_price
object

Purchase value of the contents of the parcel

Example:

Response

Accepted

Create ticket response

ticket_id
integer
required