Skip to content

by Startups.Studio

Supplier.create

POST /{namespace}/suppliers

Creates a Supplier.

Noun: Supplier
Mode: do
Event: Supplier.created

You, to your agent

Add a supplier to PetPantry.

curl -X POST https://api.sb/petpantry.shop/suppliers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry"}'

import { $ } from 'startup-builder'

const supplier = await $.Supplier.create({ name: 'PetPantry' })

npx startup-builder do Supplier.create --json '{"name":"PetPantry"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Supplier.create({ name: 'PetPantry' })"
  }
}

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

Inputs

Input	Type	Required	Description
`name`	`string`	required	The legal or personal name.
`payoutAccount`	`string`		Where payouts land, held through Stripe.

Outputs

Output	Type	Required	Description
`supplier`	Supplier	required	The Supplier.

Effects

Emits Supplier.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.	Supplier.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`.

Supplier

Previous Page

Supplier.delete

Next Page