# Order commands: create, get, list

URL: /code/cli/order/records · Id: `page:code/cli/order/records`

> The Order Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for [Order](/business/nouns/order), one group of [Order commands](/code/cli/order).

### Order.create
Creates an Order. [Verb page](/business/nouns/order/create?interface=cli).

```text
npx startup-builder do Order.create --json '<input>' [--try | --send | --do]
```

Emits `Order.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `total` | `money` | Yes | The amount charged. |
| `merchantOfRecord` | [Party](/business/nouns/party) | No | The Party that charges and books the revenue. |
| `outside` | `boolean` | No | Computed: true when its Customer shares no owner, Studio account, Agreement, or sibling chain with the Startup. |
| `lines` | `json` | No | Each Offer bought, its quantity, amount and the Party that charges for it; a Service line carries its own verdict. |
| `fulfillment` | `string` | No | Where a Service Order’s work stands between `paid` and `fulfilled`. |
| `payment` | `string` | No | `authorized` when the Quote is accepted; `captured` on the Event the Outcome Contract `earns` names. |
| `revisionsUsed` | `integer` | No | Revisions the Customer has asked for, counted against the Outcome Contract’s `revisions`. |
| `risk` | `number` | No | The payment’s fraud risk score from 0 to 99 at screening, as Stripe scored it. |
| `tax` | `money` | No | The sales tax, VAT or GST computed at placement for the buyer’s location and the Offer’s tax category. |
| `taxJurisdiction` | `string` | No | Where the tax is owed, such as `US-CA` or `EU-DE`, or `none` when no registration applies. |
| `brief` | `json` | No | The scope a Service Order bought, from its Quote request: sizes, inputs and turnaround. Intake checks the inputs against it. |
| `dueAt` | `datetime` | No | When a Service Order’s work is due; time waiting on the Customer moves it later. |
| `collectedBy` | `string` | No | The id of the venue that charged the buyer and pays the Startup; unset when the Startup’s own checkout collected. |
| `customer` | [Customer](/business/nouns/customer) | No | A Customer commits to one-time purchases as Orders. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `order` | [Order](/business/nouns/order) | Yes | The Order. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Order.create --json '{"total":{"amount":29,"currency":"USD"}}'
```

### Order.get
Returns one Order by id. [Verb page](/business/nouns/order/get?interface=cli).

```text
npx startup-builder do Order.get --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Order. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `order` | [Order](/business/nouns/order) | Yes | The Order. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Order.get --json '{"id":"order_dswDnxf2vt"}'
```

### Order.list
Returns Orders, newest first, one page at a time. [Verb page](/business/nouns/order/list?interface=cli).

```text
npx startup-builder do Order.list --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `orders` | list of [Order](/business/nouns/order) | Yes | One page of Orders. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
npx startup-builder do Order.list --json '{"limit":20}'
```