Early Access - The Dcycle CLI is currently available for enterprise customers.
Contact us to learn more about access.
Overview
The shipment command tracks merchandise transport emissions — goods shipped to or received from third parties.
dcy shipment <subcommand> [flags]
Available Commands
Command
Description
list
List shipments
show
Show shipment details
create
Create a shipment
delete
Delete a shipment
List Shipments
dcy shipment list [flags]# Aliasesdcy shipment ls
Examples
# List all shipmentsdcy shipment list# Filter by directiondcy shipment list --direction sentdcy shipment list --direction received# Filter by date rangedcy shipment list --start-date 2024-01-01 --end-date 2024-06-30# Filter by supplierdcy shipment list --supplier "Acme Corp"# Paginationdcy shipment list --page 1 --size 50# JSON outputdcy shipment list --format json
Flags
Flag
Short
Default
Description
--direction
-d
—
Filter by direction (sent, received)
--supplier
-s
—
Filter by supplier name (case-insensitive match)
--status
—
—
Filter by status
--start-date
—
—
Filter from date (YYYY-MM-DD)
--end-date
—
—
Filter to date (YYYY-MM-DD)
--page
—
1
Page number
--size
—
50
Page size
--org
—
—
Organization ID override
Show Shipment Details
dcy shipment show <shipment-id>
Examples
dcy shipment show 00000000-0000-0000-0000-000000000000# JSON outputdcy shipment show <shipment-id> --format json