Skip to content

by Startups.Studio

Order.create

POST /{namespace}/orders

Creates an Order.

Noun: Order
Mode: do
Event: Order.created

You, to your agent

Add an order to TutorLoop.

curl -X POST https://api.sb/tutorloop.com/orders \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"total":{"amount":60,"currency":"USD"}}'

import { $ } from 'startup-builder'

const order = await $.Order.create({ total: { amount: 60, currency: 'USD' } })

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

{
  "name": "do",
  "arguments": {
    "code": "return await $.Order.create({ total: { amount: 60, currency: 'USD' } })"
  }
}

Create makes a new Order from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

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

Outputs

Output	Type	Required	Description
`order`	Order	required	The Order.

Effects

Emits Order.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Order.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Order.confirm

Previous Page

Order.deliver

Next Page