/loadcarriers

Create a new load carrier.
The identifier field cannot be changed after creation.
Required fields: id, localizedName (with at least one language), isBookable, status.
Optional fields: localizedDescription, preset (dimensions), restrictions.

Restrictions:

  • Use restrictions to limit which shippers can select this load carrier in the booking flow.
  • Structure: {combinator: 'and'|'or', rules: [{field: string, operator: string, value: string}]}
  • Available fields: id, name, status, createdAt, entityInfo.email, entityInfo.country, entityInfo.city, entityInfo.zipCode, source.type
  • Example: {combinator: 'and', rules: [{field: 'entityInfo.country', operator: '=', value: 'DEU'}]}
  • If no restrictions are provided, the load carrier is available to all shippers.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1
^[a-zA-Z0-9-]+$

The load type's slug-style key (letters, digits, hyphens) — chosen at creation, referenced by loads on shipments/drafts, and not changeable afterwards.

localizedName
object

The display name per language code, e.g. { en: 'Euro Pallet', de: 'Europalette' }. At least one language required.

localizedDescription
object

An optional longer description per language code.

preset
object

Default physical properties (stackable, length/width/height in cm) pre-filled when a load of this type is added.

boolean
required

Whether shippers can select this load type when booking in the shop.

restrictions
object | null

Query rule limiting which shippers may book this load type. Structure: {combinator: 'and'|'or', rules: [{field, operator, value}]}. Available fields: id, name, status, createdAt, entityInfo.email, entityInfo.country, entityInfo.city, entityInfo.zipCode, source.type, and custom property fields (properties.). Example: {combinator: 'and', rules: [{field: 'entityInfo.country', operator: '=', value: 'DEU'}]}. Null or omitted means no restriction (all shippers).

string
enum
required

'Active' load types are usable; 'Inactive' ones are retired.

Allowed:
Responses

400

bad request - validation error

401

unauthorized

409

conflict - identifier already exists

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json