{"openapi":"3.1.0","info":{"title":"Carl's Golfland API (Bowmark)","version":"e833508f87ff","description":"Carl's Golfland's golf-equipment catalog — search live inventory, read one product's real configurable options (hand, loft, shaft) with each combination's exact price and stock status, and resolve a specific configuration to its real variant rather than a researched estimate.\n\nEvery function Bowmark has for Carl's Golfland (carlsgolfland.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/carlsgolfland/searchProducts":{"post":{"operationId":"searchProducts","summary":"Searches Carl's Golfland's golf-equipment catalog by free text (e.g.","description":"Searches Carl's Golfland's golf-equipment catalog by free text (e.g. \"driver\", \"putter\") and returns every match's urlKey, SKU, name, entry URL, stock status and starting price. The `urlKey` on each row is what getProduct takes.\n\nCalls `bowmark.providers.carlsgolfland.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CglProductSummary[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["query"],"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/carlsgolfland/getProduct":{"post":{"operationId":"getProduct","summary":"Reads one product's full configurable-option set (e.g.","description":"Reads one product's full configurable-option set (e.g. Hand, Driver Loft, Shaft) with each choice's real label, plus every real buildable variant's exact price and stock status. THROWS on an unknown urlKey, naming searchProducts() as the way to find current ones.\n\nCalls `bowmark.providers.carlsgolfland.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CglProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlKey":{"type":"string","description":"TypeScript: `string`"}},"required":["urlKey"],"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/carlsgolfland/priceConfiguration":{"post":{"operationId":"priceConfiguration","summary":"Resolves ONE specific configuration — selections keyed by option group (case-insensitive), e.g.","description":"Resolves ONE specific configuration — selections keyed by option group (case-insensitive), e.g. { \"Hand\": \"Right\", \"Driver Loft\": \"10.5*\", \"Shaft\": \"PING ALTA CB Blue 50 Regular\" } — against the product's live options and returns the matching variant's real price and stock status, the applied choices, and the site URL to re-pick the same choices (Carl's Golfland publishes no shareable URL for a configured state). `missingGroups` names any option group with more than one choice left unpicked — price is null until every such group is chosen. `unmatched` names any selection that did not match a real group or choice, rather than silently mispricing. `unavailable` says so when every group was picked but the store does not offer that combination right now — it lists only in-stock combinations, so that is a sold-out variant, not an error.\n\nCalls `bowmark.providers.carlsgolfland.priceConfiguration`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CglPriceResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlKey":{"type":"string","description":"TypeScript: `string`"},"selections":{"type":"object","additionalProperties":{"type":"string"},"description":"TypeScript: `Record<string, string>`"}},"required":["urlKey","selections"],"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/carlsgolfland/addToCart":{"post":{"operationId":"addToCart","summary":"Turns a configuration into the handoff you give the shopper: Carl's Golfland's own product page URL plus the exact choices to click there, since this storefront does not honour a query-param deep link","description":"Turns a configuration into the handoff you give the shopper: Carl's Golfland's own product page URL plus the exact choices to click there, since this storefront does not honour a query-param deep link for a configured state (measured — see the provider's reach note). Same selections shape as priceConfiguration, and returns the same price, stock status and applied choices alongside the URL. NOTHING IS CREATED SERVER-SIDE and nothing is bought — this provider never posts to the site's own add-to-cart endpoint, which requires a session-bound form key this stateless call does not hold.\n\nCalls `bowmark.providers.carlsgolfland.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CglCartHandoff>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlKey":{"type":"string","description":"TypeScript: `string`"},"selections":{"type":"object","additionalProperties":{"type":"string"},"description":"TypeScript: `Record<string, string>`"}},"required":["urlKey","selections"],"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}}}}}}