Skip to content

Supplier

A Supplier is a Person or Company that delivers work through a Startup’s human supply: recruited, credentialed, and paid out.

Properties

PropertyTypeRequiredDescription
statusstringrequiredOne of recruited, onboarded, active, or suspended.
payoutAccountstringWhere payouts land, held through Stripe.
Inherited from Party: 1 property
PropertyTypeRequiredDescription
namestringrequiredThe legal or personal name.

Object

JSON
{
  "$id": "https://api.sb/kilnbakery.com/suppliers/supplier_1",
  "$type": "Supplier",
  "name": "Kiln Bakery",
  "status": "recruited",
  "payoutAccount": "Example payout account"
}

Relationships

Verbs

  1. createCreates a Supplier.
    POST /{namespace}/suppliersdoSupplier.created
  2. getReturns one Supplier by id.
    GET /{namespace}/suppliers/{id}readNo Event
  3. listReturns Suppliers, newest first, one page at a time.
    GET /{namespace}/suppliersreadNo Event
  4. updateChanges the given properties of a Supplier.
    PATCH /{namespace}/suppliers/{id}doSupplier.updated
  5. deleteDeletes a Supplier; its history is kept.
    DELETE /{namespace}/suppliers/{id}doSupplier.deleted

Permissions

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

Operationowneradminmemberviewer
Supplier.createYesYesYesNo
Supplier.getYesYesYesYes
Supplier.listYesYesYesYes
Supplier.updateYesYesYesNo
Supplier.deleteYesYesYesNo

Call it

Text
Add a supplier to PetPantry.

Example

A licensed home inspector recruited by an inspection-booking network is a Supplier. She holds her state Credential, takes assigned bookings, and is paid out to her payoutAccount after each accepted report.