Skip to main content
PATCH
Edit a custom transport mode
Requires permission:

Authorizations

Authorization
string
header
required

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

Path Parameters

code
string
required

A built-in mode's code, or a custom mode's code or uuid.

Body

application/json

How cargo moves on a transport leg. Built-in modes (truck, container-ship, train, air-*, …) are system-curated and work out of the box; create a custom mode only when no built-in fits. A custom mode is backed by a Product[DATASET_CONTAINER], so its code is that product's sku and it also appears under /v1/product — intentional, not a leak.

code
string

Stable handle for the mode, equal to the backing product's sku for a custom mode. 1–128 characters of letters, digits, hyphens, dots, or underscores; unique within your company; cannot reuse a built-in code.

Example:

"electric-truck"

name
string

Required on create.

Example:

"Electric truck"

taxonomy
object

On write, reference a category by { path } or { uuid }; it must sit under transport/freight/modes/*. Required on create. Reads return the full reference.

footprint
object
deprecated
write-only

Deprecated — use dataset. Backwards-compatible alias for the backing emission-factor dataset; dataset takes precedence when both are sent. Reference it by uuid.

dataset
object

Custom modes only: the freight emission-factor dataset the mode draws from (declared per tonne-kilometre or tonne-mile). On write, reference it by { uuid } — required on create, and it must be a freight-unit dataset (a per-km or per-kg dataset is rejected). Reads return the full reference. Built-ins have none.

Response

The updated transport mode

How cargo moves on a transport leg. Built-in modes (truck, container-ship, train, air-*, …) are system-curated and work out of the box; create a custom mode only when no built-in fits. A custom mode is backed by a Product[DATASET_CONTAINER], so its code is that product's sku and it also appears under /v1/product — intentional, not a leak.

uuid
string<uuid>
read-only

Present only for custom modes; built-ins have none.

code
string

Stable handle for the mode, equal to the backing product's sku for a custom mode. 1–128 characters of letters, digits, hyphens, dots, or underscores; unique within your company; cannot reuse a built-in code.

Example:

"electric-truck"

name
string

Required on create.

Example:

"Electric truck"

taxonomy
object

On write, reference a category by { path } or { uuid }; it must sit under transport/freight/modes/*. Required on create. Reads return the full reference.

dataset
object

Custom modes only: the freight emission-factor dataset the mode draws from (declared per tonne-kilometre or tonne-mile). On write, reference it by { uuid } — required on create, and it must be a freight-unit dataset (a per-km or per-kg dataset is rejected). Reads return the full reference. Built-ins have none.