{"openapi":"3.1.0","info":{"title":"FareHarbor API (Bowmark)","version":"e833508f87ff","description":"FareHarbor tour, activity and cruise booking pages: find an operator, list its tours, check live availability by date, and book or cancel a reservation.\n\nEvery function Bowmark has for FareHarbor (fareharbor.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/fareharbor/searchItems":{"post":{"operationId":"searchItems","summary":"Lists every tour, activity or rental a FareHarbor operator sells (e.g.","description":"Lists every tour, activity or rental a FareHarbor operator sells (e.g. { operator: \"sail-nyc\" }), optionally filtered by words in the name. Returns each item's id, name, headline, image and booking url.\n\nCalls `bowmark.providers.fareharbor.searchItems`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborItemSearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborSearchItemsArgs","description":"TypeScript: `FareharborSearchItemsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fareharbor/getItem":{"post":{"operationId":"getItem","summary":"One FareHarbor item in full: description, booking and cancellation notes, cancellation policy, images and meeting point.","description":"One FareHarbor item in full: description, booking and cancellation notes, cancellation policy, images and meeting point.\n\nCalls `bowmark.providers.fareharbor.getItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborItemArgs","description":"TypeScript: `FareharborItemArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fareharbor/listAvailability":{"post":{"operationId":"listAvailability","summary":"The live time slots for one FareHarbor item on one date, each with start/end (local and UTC), whether it is bookable, sold out or waitlist-only, and its booking url.","description":"The live time slots for one FareHarbor item on one date, each with start/end (local and UTC), whether it is bookable, sold out or waitlist-only, and its booking url.\n\nCalls `bowmark.providers.fareharbor.listAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborListAvailabilityArgs","description":"TypeScript: `FareharborListAvailabilityArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fareharbor/getAvailabilitySlot":{"post":{"operationId":"getAvailabilitySlot","summary":"One bookable time slot in full: its remaining capacity and every ticket type (customer type) it can be booked under, each with its own party-size limits.","description":"One bookable time slot in full: its remaining capacity and every ticket type (customer type) it can be booked under, each with its own party-size limits.\n\nCalls `bowmark.providers.fareharbor.getAvailabilitySlot`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborAvailabilitySlotDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborGetAvailabilitySlotArgs","description":"TypeScript: `FareharborGetAvailabilitySlotArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fareharbor/quoteBooking":{"post":{"operationId":"quoteBooking","summary":"Prices a FareHarbor booking up to the payment step: the ticket lines, booking fee, tax and total due for a slot and ticket mix, from the checkout's own live quote.","description":"Prices a FareHarbor booking up to the payment step: the ticket lines, booking fee, tax and total due for a slot and ticket mix, from the checkout's own live quote. Reserves nothing; returns the checkout url to finish, and `checkout`, that url as a handoff the person opens to book and pay themselves (Bowmark never books).\n\nCalls `bowmark.providers.fareharbor.quoteBooking`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborBookingQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborQuoteBookingArgs","description":"TypeScript: `FareharborQuoteBookingArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fareharbor/createBooking":{"post":{"operationId":"createBooking","summary":"Places a FareHarbor booking for a slot and ticket mix under a contact (name, email, phone), through the checkout's own order call.","description":"Places a FareHarbor booking for a slot and ticket mix under a contact (name, email, phone), through the checkout's own order call. Never pays: a slot that needs a card is refused in FareHarbor's own words with the checkout url. Returns the order uuid.\n\nCalls `bowmark.providers.fareharbor.createBooking`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FareharborBookingResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FareharborCreateBookingArgs","description":"TypeScript: `FareharborCreateBookingArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"FareharborContact":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"}},"required":["name","email","phone"],"additionalProperties":true},"FareharborCreateBookingArgs":{"type":"object","properties":{"operator":{"type":"string"},"itemId":{"type":"number"},"availabilityId":{"type":"number"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/FareharborQuoteTicket"}},"contact":{"$ref":"#/components/schemas/FareharborContact"}},"required":["operator","itemId","availabilityId","tickets","contact"],"additionalProperties":true},"FareharborGetAvailabilitySlotArgs":{"type":"object","properties":{"operator":{"type":"string"},"itemId":{"type":"number"},"availabilityId":{"type":"number"}},"required":["operator","itemId","availabilityId"],"additionalProperties":true},"FareharborItemArgs":{"type":"object","properties":{"operator":{"type":"string"},"itemId":{"type":"number"}},"required":["operator","itemId"],"additionalProperties":true},"FareharborListAvailabilityArgs":{"type":"object","properties":{"operator":{"type":"string"},"itemId":{"type":"number"},"date":{"type":"string"}},"required":["operator","itemId","date"],"additionalProperties":true},"FareharborQuoteBookingArgs":{"type":"object","properties":{"operator":{"type":"string"},"itemId":{"type":"number"},"availabilityId":{"type":"number"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/FareharborQuoteTicket"}}},"required":["operator","itemId","availabilityId","tickets"],"additionalProperties":true},"FareharborQuoteTicket":{"type":"object","properties":{"customerTypeRateId":{"type":"number"},"name":{"type":"string"},"count":{"type":"number"}},"additionalProperties":true},"FareharborSearchItemsArgs":{"type":"object","properties":{"operator":{"type":"string"},"query":{"type":"string"},"limit":{"type":"number"}},"required":["operator"],"additionalProperties":true}}}}