Skip to content

Market

A Market is a region where a Startup sells, hires, or keeps books, with its currency, locales, and the floor rows that wake there.

Properties

PropertyTypeRequiredDescription
countriesstring[]requiredISO 3166-1 alpha-2 country codes.
currencystringrequiredThe ISO 4217 currency Prices show in.
localesstring[]requiredBCP 47 locale tags, the default first.

Object

JSON
{
  "$id": "https://api.sb/kilnbakery.com/markets/market_1",
  "$type": "Market",
  "countries": [
    "Example countries"
  ],
  "currency": "USD",
  "locales": [
    "Example locales"
  ]
}

Relationships

  • A Market has many Startups: where the Startup sells, hires, or keeps books. Each Market wakes its floor rows. startups, inverse markets.

Verbs

  1. createCreates a Market.
    POST /{namespace}/marketsdoMarket.created
  2. getReturns one Market by id.
    GET /{namespace}/markets/{id}readNo Event
  3. listReturns Markets, newest first, one page at a time.
    GET /{namespace}/marketsreadNo Event
  4. updateChanges the given properties of a Market.
    PATCH /{namespace}/markets/{id}doMarket.updated
  5. deleteDeletes a Market; its history is kept.
    DELETE /{namespace}/markets/{id}doMarket.deleted
  6. enterEnter opens a Market to a Startup: Prices in its currency, the Site in its locales, and its floor rows woken.
    POST /{namespace}/markets/{market}/enterdoMarket.entered

Permissions

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

Operationowneradminmemberviewer
Market.createYesYesYesNo
Market.getYesYesYesYes
Market.listYesYesYesYes
Market.updateYesYesYesNo
Market.deleteYesYesYesNo
Market.enterYesNoNoNo

Call it

Text
Enter the latest market with a startup.

Example

A Startup that enters the European Union Market shows Prices in euros and translates its Site into de-DE and fr-FR. The Market wakes the VAT and accessibility floor rows.