Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Track merchandise transport emissions
shipment command tracks merchandise transport emissions — goods shipped to or received from third parties.
dcy shipment <subcommand> [flags]
| Command | Description |
|---|---|
list | List shipments |
show | Show shipment details |
create | Create a shipment |
delete | Delete a shipment |
dcy shipment list [flags]
# Aliases
dcy shipment ls
# List all shipments
dcy shipment list
# Filter by direction
dcy shipment list --direction sent
dcy shipment list --direction received
# Filter by date range
dcy shipment list --start-date 2024-01-01 --end-date 2024-06-30
# Filter by supplier
dcy shipment list --supplier "Acme Corp"
# Pagination
dcy shipment list --page 1 --size 50
# JSON output
dcy shipment list --format json
| 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 |
dcy shipment show <shipment-id>
dcy shipment show 00000000-0000-0000-0000-000000000000
# JSON output
dcy shipment show <shipment-id> --format json
| Flag | Description |
|---|---|
--org | Organization ID override |
dcy shipment create [flags]
dcy shipment create \
--quantity 1500 \
--unit <unit-id> \
--direction sent
dcy shipment create \
--quantity 1500 \
--unit <unit-id> \
--direction sent \
--supplier "Acme Corp" \
--date 2024-03-15 \
--description "Monthly delivery"
| 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 |
dcy shipment delete <shipment-id> [flags]
# Aliases
dcy shipment rm <shipment-id>
# Interactive confirmation
dcy shipment delete <shipment-id>
# Skip confirmation
dcy shipment delete <shipment-id> --yes
| Flag | Short | Default | Description |
|---|---|---|---|
--yes | -y | false | Skip confirmation prompt |
--org | — | — | Organization ID override |
| Flag | Description |
|---|---|
--format json | JSON output (default: text) |
--verbose | Show HTTP request/response details |
--timeout | Request timeout in seconds |
Was this page helpful?