CLICommand reference
Orders
Generated reference for nimbu orders
Generated from the CLI command contract. Do not edit this page manually.
nimbu orders
Manage orders
nimbu orders archive
Archive a done or canceled order
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number |
nimbu orders cancel
Cancel a completed order
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number | |
--notify | no | true | Send notification |
--reason | no | Cancel reason |
nimbu orders count
Count orders
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--locale | no | Filter by locale | |
--filters | no | Filter by key=value, repeatable | |
--status | no | Filter by status |
nimbu orders finish
Finish a paid order
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number | |
--notify | no | true | Send notification |
nimbu orders get
Get order by ID or number
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number |
nimbu orders list
List orders
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Filter by locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--status | no | Filter by status | |
--all | no | Fetch all pages | |
--page | no | 1 | Page number |
--per-page | no | 25 | Items per page |
nimbu orders pay
Record manual payment for an order
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number |
nimbu orders reopen
Reopen a done or canceled order
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number |
nimbu orders update
Update order (status changes)
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. status=paid, note=Done) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--order | yes | Order ID or number | |
--status | no | Set order status | |
--file | no | Read order JSON from file (use - for stdin) |