Early Access - The Dcycle CLI is currently available for enterprise customers.
Contact us to learn more about access.
Overview
Theshipment command tracks merchandise transport emissions — goods shipped to or received from third parties.
Available Commands
| Command | Description |
|---|---|
list | List shipments |
show | Show shipment details |
create | Create a shipment |
delete | Delete a shipment |
List Shipments
Examples
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
Examples
Flags
| Flag | Description |
|---|---|
--org | Organization ID override |
Create Shipment
Examples
Flags
| Flag | Short | Required | Default | Description |
|---|---|---|---|---|
--quantity | -q | Yes | — | Quantity transported |
--unit | -u | Yes | — | Unit ID (use dcy units list for valid IDs) |
--direction | -d | Yes | — | sent/received or downstream/upstream |
--supplier | -s | No | — | Supplier name |
--description | — | No | — | Description |
--date | — | No | today | Shipment date (YYYY-MM-DD) |
--refrigerated | — | No | false | Is refrigerated transport |
--org | — | No | — | Organization ID override |
Delete Shipment
Examples
Flags
| Flag | Short | Default | Description |
|---|---|---|---|
--yes | -y | false | Skip confirmation prompt |
--org | — | — | Organization ID override |
Common Options
All shipment commands support:| Flag | Description |
|---|---|
--format json | JSON output (default: text) |
--verbose | Show HTTP request/response details |
--timeout | Request timeout in seconds |