Skip to content

Motion

A Motion is the shape of a sale: who buys an Offer and who acts for them, such as b2b, b2c, b2d, b2a, or b2a2b.

Properties

PropertyTypeRequiredDescription
codestringrequiredThe code: b2b, b2c, b2d, b2a, b2h2a, b2a2b, b2a2c, or b2a2d. Each letter after the 2 names the next party in the chain.
buyerstringrequiredThe party that accepts the Offer: a business, a consumer, a developer, or an Agent.
actorstringWho calls the Interfaces for the buyer: the buyer, a human operator, or an Agent.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/motions/motion_1",
  "$type": "Motion",
  "code": "Example code",
  "buyer": "Example buyer",
  "actor": "Example actor"
}

Relationships

Verbs

  1. getReturns one Motion by id.
    GET /{namespace}/motions/{id}readNo Event
  2. listReturns Motions, newest first, one page at a time.
    GET /{namespace}/motionsreadNo Event

A Motion is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Motion.getYesYesYesYes
Motion.listYesYesYesYes

Call it

Text
Show me the latest motion.

Example

An invoice API sells in b2d when a developer signs up and pays by card. It sells in b2a2b when an accounting firm is the Customer and its Agent calls the API at night.