{"openapi":"3.1.0","info":{"title":"Checkfront API (Bowmark)","version":"e833508f87ff","description":"Checkfront booking hosts used by tour, rental and activity operators: find an operator, list its items, check availability and price for a date and party, and carry a guest booking up to the payment step.\n\nEvery function Bowmark has for Checkfront (checkfront.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/checkfront/findOperator":{"post":{"operationId":"findOperator","summary":"Finds a Checkfront operator from a bare subdomain (\"thewilds\"), a checkfront.com URL, or the operator's own website that links or embeds its checkfront.com booking page.","description":"Finds a Checkfront operator from a bare subdomain (\"thewilds\"), a checkfront.com URL, or the operator's own website that links or embeds its checkfront.com booking page. Returns the host every other function takes, the operator's name, and whether its public API is switched on (currency is only known when it is). Throws when the host answers Checkfront's own \"no such operator\" refusal.\n\nCalls `bowmark.providers.checkfront.findOperator`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontOperator>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"TypeScript: `string`"}},"required":["input"],"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/checkfront/getOperator":{"post":{"operationId":"getOperator","summary":"Returns an operator's own business card: address, city, region, country, phone, email, currency and timezone.","description":"Returns an operator's own business card: address, city, region, country, phone, email, currency and timezone. When the operator's public API is switched off, only its name and Checkfront account id are known and every other field is null — findOperator's `publicApiEnabled` says which case to expect.\n\nCalls `bowmark.providers.checkfront.getOperator`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontOperatorDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontHostArgs","description":"TypeScript: `CheckfrontHostArgs`"}},"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/checkfront/listItems":{"post":{"operationId":"listItems","summary":"Lists an operator's bookable items (tours, rentals, rooms, tickets, packages, gift certificates): id, name, SKU, category, unit (day, night, hour, timeslot, minutes) and stock.","description":"Lists an operator's bookable items (tours, rentals, rooms, tickets, packages, gift certificates): id, name, SKU, category, unit (day, night, hour, timeslot, minutes) and stock. No date, so no price or availability — call getAvailability for that. Optionally narrowed by categoryId or keyword. Needs the public API on; an operator with it off is not yet supported here and throws naming that.\n\nCalls `bowmark.providers.checkfront.listItems`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontListItemsArgs","description":"TypeScript: `CheckfrontListItemsArgs`"}},"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/checkfront/getItem":{"post":{"operationId":"getItem","summary":"Returns one item in full: description (summary/details), images, unit and booking length, the category it sits in, and the guest-type rules (e.g.","description":"Returns one item in full: description (summary/details), images, unit and booking length, the category it sits in, and the guest-type rules (e.g. adult 1-6, children 0-4) addToCart's party argument must satisfy. Needs an item id from listItems and the public API on; an operator with it off is not yet supported here and throws naming that.\n\nCalls `bowmark.providers.checkfront.getItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontGetItemArgs","description":"TypeScript: `CheckfrontGetItemArgs`"}},"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/checkfront/getAvailability":{"post":{"operationId":"getAvailability","summary":"Prices and checks a date for an operator's items, for a given party (e.g.","description":"Prices and checks a date for an operator's items, for a given party (e.g. { adult: 2 }) and optional discount code: per item whether it is available, the total price, and the booking token (slip) addToCart takes. Pass itemId to check one item (returns a single result instead of an array). An item that is not available carries errorTitle instead of a slip. Needs the public API on; an operator with it off is not yet supported here and throws naming that.\n\nCalls `bowmark.providers.checkfront.getAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontAvailability | CheckfrontAvailability[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontGetAvailabilityArgs","description":"TypeScript: `CheckfrontGetAvailabilityArgs`"}},"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/checkfront/getBookingForm":{"post":{"operationId":"getBookingForm","summary":"Returns the guest details an operator asks for at checkout — name, email, phone, address and its own custom questions — with each field's type, whether it is required, its help text and, for a select ","description":"Returns the guest details an operator asks for at checkout — name, email, phone, address and its own custom questions — with each field's type, whether it is required, its help text and, for a select field, its options. Display-only banner fields are dropped. Needs the public API on.\n\nCalls `bowmark.providers.checkfront.getBookingForm`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontFormField[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontHostArgs","description":"TypeScript: `CheckfrontHostArgs`"}},"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/checkfront/listCategories":{"post":{"operationId":"listCategories","summary":"Lists an operator's item categories (\"Kids Club\", \"Surf Boards\", \"General Admission\") with each category's id, name, description, display order, image and item count, so listItems and getAvailability ","description":"Lists an operator's item categories (\"Kids Club\", \"Surf Boards\", \"General Admission\") with each category's id, name, description, display order, image and item count, so listItems and getAvailability can be narrowed to one. Needs the public API on.\n\nCalls `bowmark.providers.checkfront.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontHostArgs","description":"TypeScript: `CheckfrontHostArgs`"}},"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/checkfront/listGiftCertificates":{"post":{"operationId":"listGiftCertificates","summary":"Lists the gift certificates an operator sells: id, name, SKU, category, price and thumbnail.","description":"Lists the gift certificates an operator sells: id, name, SKU, category, price and thumbnail. A price of \"0\" means the buyer picks the amount at checkout rather than a fixed face value. Needs the public API on.\n\nCalls `bowmark.providers.checkfront.listGiftCertificates`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontGiftCertificate[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontHostArgs","description":"TypeScript: `CheckfrontHostArgs`"}},"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/checkfront/getAvailabilityCalendar":{"post":{"operationId":"getAvailabilityCalendar","summary":"Returns which days in a date range each item can be booked (or one item, with itemId) — Checkfront's public answer is 1 for available rather than a real stock count for most operators.","description":"Returns which days in a date range each item can be booked (or one item, with itemId) — Checkfront's public answer is 1 for available rather than a real stock count for most operators. Use it to find an open date before pricing it with getAvailability. Needs the public API on; an operator with it off is not yet supported here and throws naming that.\n\nCalls `bowmark.providers.checkfront.getAvailabilityCalendar`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontItemCalendar[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontGetAvailabilityCalendarArgs","description":"TypeScript: `CheckfrontGetAvailabilityCalendarArgs`"}},"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/checkfront/addToCart":{"post":{"operationId":"addToCart","summary":"Starts (or adds to) a booking cart from one or more slip tokens getAvailability returned, holding that stock against over-booking.","description":"Starts (or adds to) a booking cart from one or more slip tokens getAvailability returned, holding that stock against over-booking. Returns the cart id (pass it back as sessionId to addToCart/getCart/updateCart), its lines, taxes, discount, deposit, total and amount due. Nothing is booked or charged. Needs the public API on.\n\nCalls `bowmark.providers.checkfront.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontAddToCartArgs","description":"TypeScript: `CheckfrontAddToCartArgs`"}},"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/checkfront/getCart":{"post":{"operationId":"getCart","summary":"Reads a booking cart back by its sessionId: lines, taxes, discount, deposit, total and amount due.","description":"Reads a booking cart back by its sessionId: lines, taxes, discount, deposit, total and amount due. Omit sessionId to see the empty cart an operator's booking page would start with. Needs the public API on.\n\nCalls `bowmark.providers.checkfront.getCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontGetCartArgs","description":"TypeScript: `CheckfrontGetCartArgs`"}},"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/checkfront/updateCart":{"post":{"operationId":"updateCart","summary":"Changes a booking cart: alter a line's quantity, remove a line, opt in or out of a tax/fee the cart offers, or clear it entirely — returning the updated cart.","description":"Changes a booking cart: alter a line's quantity, remove a line, opt in or out of a tax/fee the cart offers, or clear it entirely — returning the updated cart. Needs the public API on and a sessionId from addToCart.\n\nCalls `bowmark.providers.checkfront.updateCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontUpdateCartArgs","description":"TypeScript: `CheckfrontUpdateCartArgs`"}},"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/checkfront/bookItems":{"post":{"operationId":"bookItems","summary":"Books a cart from addToCart for a guest, with form answers keyed by getBookingForm's field ids (customer_name, customer_email, customer_tos_agree: 1, plus the operator's own).","description":"Books a cart from addToCart for a guest, with form answers keyed by getBookingForm's field ids (customer_name, customer_email, customer_tos_agree: 1, plus the operator's own). Never pays: when nothing is due the booking is complete; otherwise it is held pending (status PRE, completed: false) and paymentUrl is the operator's own page where the guest pays amountDue. A missing field is refused naming it. Public API on only.\n\nCalls `bowmark.providers.checkfront.bookItems`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontBooking>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CheckfrontBookItemsArgs","description":"TypeScript: `CheckfrontBookItemsArgs`"}},"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/checkfront/getMyBookings":{"post":{"operationId":"getMyBookings","summary":"The signed-in customer's own bookings with one operator (accounts are per operator): each booking's id, page url, created and booking dates, items, total, paid and due.","description":"The signed-in customer's own bookings with one operator (accounts are per operator): each booking's id, page url, created and booking dates, items, total, paid and due. Needs the caller signed in on that operator's booking page; refuses otherwise.\n\nCalls `bowmark.providers.checkfront.getMyBookings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CheckfrontMyBookings>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"host":{"type":"string"}},"required":["host"],"additionalProperties":true,"description":"TypeScript: `{ host: string }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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}}},"CheckfrontAddToCartArgs":{"type":"object","properties":{"host":{"type":"string"},"slips":{"type":"array","items":{"type":"string"}},"sessionId":{"type":"string"}},"required":["host","slips"],"additionalProperties":true},"CheckfrontBookItemsArgs":{"type":"object","properties":{"host":{"type":"string"},"sessionId":{"type":"string"},"form":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},"required":["host","sessionId","form"],"additionalProperties":true},"CheckfrontGetAvailabilityArgs":{"type":"object","properties":{"host":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"itemId":{"type":"string"},"categoryId":{"type":"string"},"party":{"type":"object","additionalProperties":{"type":"number"}},"discountCode":{"type":"string"}},"required":["host","startDate"],"additionalProperties":true},"CheckfrontGetAvailabilityCalendarArgs":{"type":"object","properties":{"host":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"itemId":{"type":"string"}},"required":["host","startDate","endDate"],"additionalProperties":true},"CheckfrontGetCartArgs":{"type":"object","properties":{"host":{"type":"string"},"sessionId":{"type":"string"}},"required":["host"],"additionalProperties":true},"CheckfrontGetItemArgs":{"type":"object","properties":{"host":{"type":"string"},"itemId":{"type":"string"}},"required":["host","itemId"],"additionalProperties":true},"CheckfrontHostArgs":{"type":"object","properties":{"host":{"type":"string"}},"required":["host"],"additionalProperties":true},"CheckfrontListItemsArgs":{"type":"object","properties":{"host":{"type":"string"},"categoryId":{"type":"string"},"keyword":{"type":"string"},"limit":{"type":"number"}},"required":["host"],"additionalProperties":true},"CheckfrontUpdateCartArgs":{"type":"object","properties":{"host":{"type":"string"},"sessionId":{"type":"string"},"alter":{"type":"object","additionalProperties":{"anyOf":[{"type":"number"},{"const":"remove"},{"const":"optin"},{"const":"optout"}]}},"clear":{"type":"boolean"}},"required":["host","sessionId"],"additionalProperties":true}}}}