Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductWhat you sellProduct

Product routes: create, get, list

The Product Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Product, one group of Product routes.

Product.create

Creates a Product. Verb page.

Text
POST /{namespace}/products

Body, as JSON: the inputs. Emits Product.created.

Inputs

InputTypeRequiredDescription
namestringrequiredThe name of the Product.
promisetextrequiredWhat the Customer can rely on.

Returns

OutputTypeRequiredDescription
productProductrequiredThe Product.

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

Terminal
curl -X POST https://api.sb/leaseline.app/products \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline","promise":"No renewal slips past its date."}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "product": {
    "$id": "https://api.sb/leaseline.app/products/prod_MJmgS5dysq",
    "$type": "Product",
    "name": "Leaseline",
    "promise": "No renewal slips past its date.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Product.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Product.get

Returns one Product by id. Verb page.

Text
GET /{namespace}/products/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Product.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
productProductrequiredThe Product.

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

Terminal
curl https://api.sb/leaseline.app/products/prod_MJmgS5dysq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Product",
  "$id": "https://api.sb/leaseline.app/products/prod_MJmgS5dysq",
  "product": {
    "$id": "https://api.sb/leaseline.app/products/prod_MJmgS5dysq",
    "$type": "Product",
    "name": "Leaseline",
    "promise": "No renewal slips past its date.",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/products/prod_MJmgS5dysq",
    "up": "https://api.sb/leaseline.app/products"
  }
}

Product.list

Returns Products, newest first, one page at a time. Verb page.

Text
GET /{namespace}/products

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
productslist of ProductrequiredOne page of Products.

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

Terminal
curl "https://api.sb/leaseline.app/products?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Product",
  "products": [
    {
      "$id": "https://api.sb/leaseline.app/products/prod_MJmgS5dysq",
      "$type": "Product",
      "name": "Leaseline",
      "promise": "No renewal slips past its date.",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "prod_MJmgS5dysq"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/products?limit=20",
    "next": "https://api.sb/leaseline.app/products?after=prod_MJmgS5dysq"
  }
}

Product

Previous

update, delete

Next