Skip to content

by Startups.Studio

Market.create

POST /{namespace}/markets

Creates a Market.

Noun: Market
Mode: do
Event: Market.created

You, to your agent

Add a market to PetPantry.

curl -X POST https://api.sb/petpantry.shop/markets \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"countries":["Example countries"],"currency":"USD","locales":["Example locales"]}'

import { $ } from 'startup-builder'

const market = await $.Market.create({ countries: ['Example countries'], currency: 'USD', locales: ['Example locales'] })

npx startup-builder do Market.create --json '{"countries":["Example countries"],"currency":"USD","locales":["Example locales"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Market.create({ countries: ['Example countries'], currency: 'USD', locales: ['Example locales'] })"
  }
}

Create makes a new Market from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	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.

Outputs

Output	Type	Required	Description
`market`	Market	required	The Market.

Effects

Emits Market.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Market.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Market

Previous Page

Market.delete

Next Page