API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

Create shipment

post
https://{domain}/xentral/shipments

The request a Xentral instance makes to an external carrier service to generate a shipping label.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for generating a shipment.

recipient
object
required

When no Drop Off Location is specified, the recipient address is the location where the shipment is being send to.

dropOffLocation
object

An optional of the address where the packages should be delivered. If not provided, the recipient address will be used.

sender
object
required
string

A reference description that can be printed on the label. Depending on the Xentral configuration can for example contain a Delivery Note number, or some other information

carrier
object
required
parcels
array of objects
length ≥ 1

The parcels that are part of the shipment. The list contains at least one parcel.

parcels
string
required

The ID of the parcel. This ID should be used in a response to match parcels with labels.

weight
object
dimensions
object
insurance
object
label
object

The label options that the user has selected for the shipment

deliveryNote
object

Reference to another resource

return
object

Reference to another resource

shipment
object

Reference to another resource

salesOrder
object

Reference to another resource

string
enum
required

Informs whether the shipment is of outbound or return type.

Allowed:
exportDeclarations
array of objects

Export declaration lines for customs; one entry per exported item. Contains all customs-related item data required for international shipments. Sent when the sender and recipient countries differ and at least one of them is outside Xentral's list of EU customs countries - the EU member states plus Northern Ireland (XI). This is decided by country code, so territories of EU states that lie outside the EU customs union, such as the Canary Islands, are treated like their state. taxation plays no part, because it describes the customer's own address rather than the parcel's route. The key is omitted entirely rather than sent as an empty array.

exportDeclarations
string
enum

Tax treatment of the document being shipped, as held by Xentral. It is derived from the customer's own address, not from the address this parcel goes to: it is usually eu for an intra-EU shipment, but a domestic customer shipping to a one-off address abroad is still domestic. Informational only - whether customs paperwork and a declared value are sent is decided by the sender and recipient countries alone. Omitted when the document carries none, such as a return with no delivery note behind it.

Allowed:
invoice
object

The invoice this shipment belongs to, as held by Xentral. Sent on outbound shipments only, and only when that invoice has an id, a document number and a date.

number

Value of the shipment the carrier is liable for, sent alongside declaredValueCurrency whenever the sender and recipient countries differ - intra-EU included, not only on shipments needing customs paperwork, since a declared value is not customs data.

string
[A-Z]{3}

ISO 4217 currency of declaredValue, sent together with it: the document's own currency, or EUR when the document carries none.

Headers
string
required
[a-z]{2}-[A-Z]{2}

The used locale of the user making the request. Use this header to determine the language of the localised fields in the response

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Unable to authorize the client

404

Resource was not found or not enough access privileges

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
text/html

Updated 6 months ago

Did this page help you?