Units

Browse available units of measurement for quantities

Early Access - The Dcycle CLI is currently available for enterprise customers. Contact us to learn more about access.

Overview

Browse available units of measurement for quantities in purchases, shipments, and transport routes.

Available Commands

Command	Description
dcy units list	List available units

---

List Units

dcy units list

The command reads GET /v2/units and prints one line per unit: its id, its stored type and its name. Output for dcy units list --type vehicle_consumptions:

Showing 7 unit(s)
b018624f-dece-4609-a529-39e22e9e749f | distance | mile_(mi)
ba80e6cb-86a4-4bb1-a0c5-8104365d523c | energy | kilowatt_hour_(kwh)
accd2a4d-ff0c-4e7c-8e17-a187b01e49b4 | gas | kilometer_(km)
81dd018a-5b1c-4f6a-b304-e36664af5aa7 | liquid | gallon_(gal)
54a709bf-79fe-4acb-ab85-5e1d7cd26eb4 | liquid | litre_(l)
61743a63-ff70-459c-9567-5eee8f7dfd5c | solid | kilogram_(kg)
cab66828-c2b1-431b-92af-f9ab37149d3c | solid | metric_tonne_(t)

Units are sorted by type, then by name alphabetically. Without --type the command lists the whole catalog.

The type flag

--type is not the type printed in the second column. It is sent as the type parameter of GET /v2/units, and each of its values returns the units the Dcycle app offers in one form: --type wastes returns only kilogram_(kg), --type transport the weight units of a shipment. The accepted values are listed in What each type returns.

The type in the output is a legacy classification of each unit, and it is not reliable: kilogram_(kg) shows as solid and kilometer_(km) as gas. Passing one of those values, such as --type mass or --type energy, fails: the API rejects it as a validation error (422).

Flags

Flag	Short	Default	Description
--type	-t	—	Only the units the Dcycle app offers in one form (e.g. wastes, transport, vehicle_consumptions). See The type flag
--search	-s	—	Search by name (case-insensitive)
--org	—	—	Organization ID override

Examples

# Short alias
dcy units ls

# Only the units the app offers for a waste
dcy units list --type wastes

# Only the weight units of a shipment
dcy units list --type transport

# Search by name
dcy units list --search kg

# Get the ID of a unit by its exact name
dcy units list --format json | jq -r '.[] | select(.name == "kilowatt_hour_(kwh)") | .id'

# JSON output
dcy units list --format json | jq '.[] | {id, type, name}'

For dcy shipment create --unit <unit-id> and dcy transport edit --unit <unit-id>, take the id from dcy units list --type transport: shipments accept only those weight units.

---

Aliases

Command	Alias
dcy units list	dcy units ls

Next Steps

Suppliers

Browse available suppliers

Transport

Track upstream and downstream transport emissions

Shipments

Manage shipment records

Purchases

Manage purchased goods and services