← Receivers

shipping:list

shipping family

List a workspace's shipping rates — the seller's own table, owner-gated

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
member
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/shipping:list \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "slug": "acme" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • slug string required The workspace whose rates to read. Names the target only; the attested caller must control it.
  • includeArchived boolean optional Include rows with active = 0. Default false.

Response

What comes back from the call.

  • rates object[] Rates in sort order: { srid, name, amount_cents, currency, countries, free_over_cents, sort, active }.
  • taxEnabled boolean Whether this seller has switched Stripe Tax on (owners.storefront_tax_enabled). OFF by default — automatic_tax on an account whose tax setup is incomplete errors or calculates zero.
  • error string `forbidden` when the attested caller does not control the workspace.

Traffic

Every call to shipping:list, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names shipping:list, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

UI 1
  • one.ie/web/src/components/studio/ShippingRates.tsx:6

Answered by

shipping:list one.ie/web/src/lib/resolvers/storefront/shipping.ts:156 Dispatched through POST /api/ask/shipping:list, after the envelope validates the payload.

shipping family · 1 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "The workspace whose rates to read. Names the target only; the attested caller must control it."
    },
    "includeArchived": {
      "description": "Include rows with active = 0. Default false.",
      "type": "boolean"
    }
  },
  "required": [
    "slug"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "rates": {
      "description": "Rates in sort order: { srid, name, amount_cents, currency, countries, free_over_cents, sort, active }.",
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "taxEnabled": {
      "description": "Whether this seller has switched Stripe Tax on (owners.storefront_tax_enabled). OFF by default — automatic_tax on an account whose tax setup is incomplete errors or calculates zero.",
      "type": "boolean"
    },
    "error": {
      "description": "`forbidden` when the attested caller does not control the workspace.",
      "type": "string"
    }
  }
}