Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductWhat you sell

Outcome Contract routes

Every Outcome Contract Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Outcome Contract.

NounSystemRun by
Outcome ContractService deliveryDelivery Manager

OutcomeContract.get

Returns one Outcome Contract by id. Verb page.

Text
GET /{namespace}/outcome-contracts/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Outcome Contract.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
outcomeContractOutcome ContractrequiredThe Outcome Contract.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "$type": "OutcomeContract",
  "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
  "outcomeContract": {
    "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "$type": "OutcomeContract",
    "done": "Order.accepted",
    "accept": "The buyer, within 5 business days of delivery",
    "remedy": "Redo once, then refund in full"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "up": "https://api.sb/catalogmend.com/outcome-contracts"
  }
}

OutcomeContract.list

Returns Outcome Contracts, newest first, one page at a time. Verb page.

Text
GET /{namespace}/outcome-contracts

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
outcomeContractslist of Outcome ContractrequiredOne page of Outcome Contracts.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/catalogmend.com/outcome-contracts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "$type": "OutcomeContract",
  "outcomeContracts": [
    {
      "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
      "$type": "OutcomeContract",
      "done": "Order.accepted",
      "accept": "The buyer, within 5 business days of delivery",
      "remedy": "Redo once, then refund in full"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "outcome_goNlouZJ7A"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/outcome-contracts?limit=20",
    "next": "https://api.sb/catalogmend.com/outcome-contracts?after=outcome_goNlouZJ7A"
  }
}

OutcomeContract.update

Changes the given properties of an Outcome Contract. Verb page.

Text
PATCH /{namespace}/outcome-contracts/{id}

Path: id. Body, as JSON: the other inputs. Emits OutcomeContract.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Outcome Contract.
donetextThe state or Event that counts as done.
accepttextWho accepts the result, and within what window.
remedytextWhat happens on a miss: redo, refund, or credit.
revisionsintegerHow many times the Customer may send work back before the remedy applies, such as 1.
silencestringWhat the Customer’s silence means once the acceptance window passes.
earnsstringThe Event that captures payment and earns the fee.
assurancejsonThe Evaluators that check done before every delivery, and the share of work a person grades, such as 2%.
windowstringHow long the Customer has to confirm, revise or dispute each delivery, as an ISO duration.

Returns

OutputTypeRequiredDescription
outcomeContractOutcome ContractrequiredThe Outcome Contract.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"done":"Order.accepted"}'
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "outcomeContract": {
    "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "$type": "OutcomeContract",
    "done": "Order.accepted",
    "accept": "The buyer, within 5 business days of delivery",
    "remedy": "Redo once, then refund in full"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "OutcomeContract.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}

trial, withdraw

Previous

Product

Next