Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
ProductWhat you sellProductService

Service routes: close, open, pause, setCapacity

The Service Verbs close, open, pause, setCapacity as api.sb routes, with inputs, result, refusals and an example.

Service.openMode do
curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/open \
  -H "Authorization: Bearer $SB_TOKEN"
API referenceService.open
npx startup-builder do Service.open --data '{"service":"service_Eq1ssq4AOW"}'
CLI referenceService.open
{
  "name": "do",
  "arguments": {
    "code": "return await $.Service.open({ service: 'service_Eq1ssq4AOW' })"
  }
}
MCP referenceService.open
import { $ } from 'startup-builder'

const service = await $.Service.open({ service: 'service_Eq1ssq4AOW' })
SDK referenceService.open

Reference for Service, one group of Service routes.

Service.close

Close stops a Service taking new Orders for good, while every placed Order runs to its end. Verb page.

Text
POST /{namespace}/services/{service}/close

Path: service. Body, as JSON: the other inputs. Emits Service.closed.

Inputs

InputTypeRequiredDescription
serviceServicerequiredThe Service to close.
reasontextrequiredWhy it closes.

Returns

OutputTypeRequiredDescription
serviceServicerequiredThe closed Service.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operationforbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
service is missing, or is not a serviceinvalid-inputSend service as a service, then call it again.None.
reason is missing, or is not a textinvalid-inputSend reason as a text, then call it again.None.
The Idempotency-Key was sent before with another operation or other inputidempotency-mismatchSend a new key for new input; reuse a key only to retry the same request.None.

Example

Terminal
curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/close \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Idempotency-Key: catalogmend-service-close-1" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "service": {
    "$id": "https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW",
    "$type": "Service",
    "name": "Catalogmend",
    "promise": "Every listing error fixed or explained within 48 hours.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "Service.close",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}

Service.open

Open starts a Service taking new Orders on every published Offer that sells it. Verb page.

Text
POST /{namespace}/services/{service}/open

Path: service. Emits Service.opened.

Inputs

InputTypeRequiredDescription
serviceServicerequiredThe Service to open.

Returns

OutputTypeRequiredDescription
serviceServicerequiredThe Service, now taking new Orders.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operationforbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
service is missing, or is not a serviceinvalid-inputSend service as a service, then call it again.None.
The Idempotency-Key was sent before with another operation or other inputidempotency-mismatchSend a new key for new input; reuse a key only to retry the same request.None.

Example

Terminal
curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/open \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Idempotency-Key: catalogmend-service-open-1"
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "service": {
    "$id": "https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW",
    "$type": "Service",
    "name": "Catalogmend",
    "promise": "Every listing error fixed or explained within 48 hours.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "Service.open",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}

Service.pause

Pause stops a Service taking new Orders until a stated time, while every placed Order runs to its end. Verb page.

Text
POST /{namespace}/services/{service}/pause

Path: service. Body, as JSON: the other inputs. Emits Service.paused.

Inputs

InputTypeRequiredDescription
serviceServicerequiredThe Service to pause.
reasontextrequiredWhy it pauses, shown to buyers.
untildatetimeWhen it reopens on its own.

Returns

OutputTypeRequiredDescription
serviceServicerequiredThe paused Service.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operationforbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
service is missing, or is not a serviceinvalid-inputSend service as a service, then call it again.None.
reason is missing, or is not a textinvalid-inputSend reason as a text, then call it again.None.
The Idempotency-Key was sent before with another operation or other inputidempotency-mismatchSend a new key for new input; reuse a key only to retry the same request.None.

Example

Terminal
curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/pause \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Idempotency-Key: catalogmend-service-pause-1" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "service": {
    "$id": "https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW",
    "$type": "Service",
    "name": "Catalogmend",
    "promise": "Every listing error fixed or explained within 48 hours.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "Service.pause",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}

Service.setCapacity

SetCapacity sets the most work a Service holds in flight, in the unit its intake counts. Verb page.

Text
POST /{namespace}/services/{service}/setCapacity

Path: service. Body, as JSON: the other inputs. Emits Service.capacitySet.

Inputs

InputTypeRequiredDescription
serviceServicerequiredThe Service.
capacityintegerrequiredThe most work in flight, in the intake’s unit, such as listings.

Returns

OutputTypeRequiredDescription
serviceServicerequiredThe Service with its new capacity.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operationforbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
service is missing, or is not a serviceinvalid-inputSend service as a service, then call it again.None.
capacity is missing, or is not a integerinvalid-inputSend capacity as a integer, then call it again.None.
The Idempotency-Key was sent before with another operation or other inputidempotency-mismatchSend a new key for new input; reuse a key only to retry the same request.None.

Example

Terminal
curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/setCapacity \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Idempotency-Key: catalogmend-service-set-capacity-1" \
  -H "Content-Type: application/json" \
  -d '{"capacity":1}'
JSON
{
  "api": "https://api.sb/catalogmend.com",
  "service": {
    "$id": "https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW",
    "$type": "Service",
    "name": "Catalogmend",
    "promise": "Every listing error fixed or explained within 48 hours.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "Service.setCapacity",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}

update, delete

Previous

Software

Next