Skip to main content
POST
Create a shipment template

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$
Idempotency-Key
string

Optional, case-sensitive key for one intended action. Scope: team, HTTP method and canonical path. Retained for at least 24 hours and while processing. Same key and payload reuses the stored outcome without repeating side effects; the resource representation is current. Changed payload: 422 with an Idempotency-Key entry in errors. Concurrent duplicate: 409 with Retry-After and Location when known. Without a key there is no deduplication. Use GET at Location after 202.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._-]{16,128}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Body

application/json

Create or update a template using title, an optional description and partial shipment input. Request bodies have no outer data wrapper.

title
string
required

Human-readable name for the template.

Maximum string length: 255
shipment
object
required

Partial booking input to prefill a shipment. This is a reusable set of input fields, not a created shipment resource; it has no shipment UUID or booking state.

description
null | string

Optional description of what the template is used for.

Response

Shipment template created successfully

data
object
required

A saved template with its own identity, display metadata and partial shipment input. Successful responses wrap this template in data; its reusable booking fields are in shipment.