Skip to main content
POST
Store a new shipment and book a label

Authorizations

Authorization
string
header
required

Provide API Token as Bearer authentication

api_token
string
query
required

Query API Token

Path Parameters

team
string
required

The domain of the website making the agent lookup request

Body

application/json

Input data format

Base shipment

internal_id
string
required

The database id used by the website for the resource

Example:

"1226"

internal_reference
string
required

The id that is used to reference the resource externally

Example:

"AB-00001445"

shipping_carrier
enum<string>
required

The carrier code

Available options:
postnord,
gls,
dao,
bifrost,
bring
Example:

"postnord"

shipping_method
string
required

The code for the shipping method

Example:

"collect"

subtotal_price_excluding_tax
number

The subtotal price excluding tax

Example:

159.2

subtotal_price_including_tax
number

The subtotal price including tax

Example:

199

shipping_price_excluding_tax
number

The shipping price excluding tax

Example:

20

shipping_price_including_tax
number

The shipping price including tax

Example:

25

total_price_excluding_tax
number

The total price excluding tax

Example:

179.2

total_price_including_tax
number

The total price including tax

Example:

224

total_tax_amount
number

The total tax amount

Example:

44.8

currency
string

The three letter ISO4217 currency code

Example:

"EUR"

receiver
object

Base Receiver

sender
object

Base Sender

agent
object

Base Pickup

parcels
object[]

List of parcels

addons
object[]

List of addons

Response

Successful operation

data
object

Label Resource