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
| Property | Type | Required | Description |
|---|---|---|---|
countries | string[] | required | ISO 3166-1 alpha-2 country codes. |
currency | string | required | The ISO 4217 currency Prices show in. |
locales | string[] | required | BCP 47 locale tags, the default first. |
Object
{
"$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, inversemarkets.
Verbs
createCreates a Market.POST /{namespace}/marketsgetReturns one Market by id.GET /{namespace}/markets/{id}listReturns Markets, newest first, one page at a time.GET /{namespace}/marketsupdateChanges the given properties of a Market.PATCH /{namespace}/markets/{id}deleteDeletes a Market; its history is kept.DELETE /{namespace}/markets/{id}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}/enter
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Market.create | Yes | Yes | Yes | No |
Market.get | Yes | Yes | Yes | Yes |
Market.list | Yes | Yes | Yes | Yes |
Market.update | Yes | Yes | Yes | No |
Market.delete | Yes | Yes | Yes | No |
Market.enter | Yes | No | No | No |
Call it
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.