Skip to content
The Bookwise guidev1.1.0Read as Markdown
Documentation menu
Docs/Discovery & availability
Discovery & availability

list_offerings

Lists a business's bookable offerings (room types, table areas or services) with attributes, prices and real photos. Supports simple filters and pagination.

Scope & access

Directory + businessRead only

Follow the credential fields below. Public discovery does not require a login; private booking operations require the indicated token.

This tool advertises idempotent behavior. If an idempotencyKey is specified, reuse it with identical arguments only when retrying that same intended action.

Parameters

These are the directory endpoint parameters. Business endpoints scope public discovery to the published business; owner calls still require businessId. Inspect tools/list on your endpoint for the exact schema.

businessIdRequired
string

businessId: a business ID from search_businesses, e.g. "biz_01j…", or the business's booking-page slug, e.g. "studio-nine"

maxPriceMinorOptional
integer

maxPriceMinor: optional maximum base price in minor units, e.g. 15000 for 150.00

minCapacityOptional
integer

minCapacity: optional minimum number of guests the offering must fit, e.g. 2

cursorOptional
string

cursor: pagination cursor from a previous call's nextCursor

Example call

Pass this object to the MCP client's callTool method. Replace placeholders with returned IDs, saved credentials and the customer's details; use future dates appropriate to their request.

list_offerings · MCP client arguments
json
{
  "name": "list_offerings",
  "arguments": {
    "businessId": "<businessId>"
  }
}

JSON schemas

Nested fields, formats, enums and constraints are included in the complete schemas. Successful data is returned in structuredContent. SDK input validation and domain errors use different error shapes.

Input schemaJSON Schema
Input JSON Schema
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "businessId": {
      "type": "string",
      "minLength": 1,
      "description": "businessId: a business ID from search_businesses, e.g. \"biz_01j…\", or the business's booking-page slug, e.g. \"studio-nine\""
    },
    "maxPriceMinor": {
      "description": "maxPriceMinor: optional maximum base price in minor units, e.g. 15000 for 150.00",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "minCapacity": {
      "description": "minCapacity: optional minimum number of guests the offering must fit, e.g. 2",
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "cursor": {
      "description": "cursor: pagination cursor from a previous call's nextCursor",
      "type": "string"
    }
  },
  "required": [
    "businessId"
  ]
}
Output schemaJSON Schema
Output JSON Schema
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "offerings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "offeringId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "offeringId",
          "name"
        ],
        "additionalProperties": {}
      }
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "offerings",
    "nextCursor"
  ],
  "additionalProperties": {}
}
Behavior annotationsMCP
Tool annotations
json
{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

Errors & next steps

Check isError before reading a success response. Follow nextStep where supplied, and never treat a pending booking as confirmed. See Errors and retries and the booking lifecycle for recovery paths.

Back to all tools