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

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

reference

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

shipmentType

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.

exportDeclarations

Headers

Accept-Language

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

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

text/html

200Response body for generating a shipment.

400IETF RFC 9457 Problem API compliant response

401Unable to authenticate the client