Skip to content

Market methods: enter

The Market Verbs enter as typed SDK methods, with inputs, result, refusals and an example.

Reference for Market, one group of Market methods.

Market.enter

Enter opens a Market to a Startup: Prices in its currency, the Site in its locales, and its floor rows woken. Verb page.

TypeScript
interface MarketVerbs {
  enter(input: MarketEnterInput, options?: SB.CallOptions): SB.Call<Market>
}

Emits Market.entered.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup that enters.
marketMarketrequiredThe Market to open.

Returns

OutputTypeRequiredDescription
marketMarketrequiredThe Market, now open to the Startup.

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

TypeScript
import { $ } from 'startup-builder'

const market = await $.Market.enter({ startup: 'startup_l3hr1EnUGY', market: 'market_4uFEzN14G4' })