Skip to content

by Startups.Studio

Order.cancel

POST /{namespace}/orders/{order}/cancel

Cancel ends an Order before fulfillment and returns any payment in full.

Noun: Order
Mode: do
Event: Order.canceled

You, to your agent

Cancel the latest order.

curl -X POST https://api.sb/petpantry.shop/orders/order_1/cancel \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const order = await $.Order.cancel({ order: 'order_1' })

npx startup-builder do Order.cancel --json '{"order":"order_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Order.cancel({ order: 'order_1' })"
  }
}

Inputs

Input	Type	Required	Description
`order`	Order	required	The unfulfilled Order.

Outputs

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

Effects

Emits Order.canceled.
Two-way: it runs at once, in the try, send and do modes.
Posts the reversing Entries for any payment.

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.cancel
The record changed since it was read, so the write would overwrite a newer version.	`conflict`	Read the record again, then retry the write against its current state.	Order.cancel
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Order.cancel

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

Previous Page

Order.confirm

Next Page