Skip to content

by Startups.Studio

Order.dispute

POST /{namespace}/orders/{order}/dispute

Dispute contests a delivered Order under its Outcome Contract and starts the remedy the contract names.

Noun: Order
Mode: do
Event: Order.disputed

You, to your agent

Dispute the latest order.

curl -X POST https://api.sb/kilnbakery.com/orders/order_1/dispute \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const order = await $.Order.dispute({ order: 'order_1', reason: 'Example reason' })

npx startup-builder do Order.dispute --json '{"order":"order_1","reason":"Example reason"}'

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

Order.dispute contests a delivered Order under its Outcome Contract and opens a Dispute that starts the remedy the contract names.

Inputs

Input	Type	Required	Description
`order`	Order	required	The delivered Order.
`reason`	`text`	required	What falls short of the promise.
`lines`	`json`		The lines disputed; every delivered line when absent. Undisputed lines stay open to confirm.

Outputs

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

Effects

Emits Order.disputed.
Performed by the Billing Specialist.
Two-way: it runs at once, in the try, send and do modes.
Holds the fee until the remedy completes.
Opens an Issue for the Customer Team.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Order.dispute
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.dispute
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.dispute

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.deliver

Previous Page

Order.fulfill

Next Page