{"openapi":"3.1.0","info":{"title":"Kernvel AuctionAI Public API","description":"The Kernvel Public API for AuctionAI. Authenticate with a bearer API key (`Authorization: Bearer kv_auc_live_...` or `X-API-Key`). Errors are RFC 9457 problem+json; lists are cursor-paginated; writes are idempotent via the `Idempotency-Key` header.","version":"2026-06-23"},"paths":{"/api/public/v1/ping":{"get":{"tags":["meta"],"summary":"Ping","description":"Unauthenticated liveness probe — returns no store data (§13b).","operationId":"ping_api_public_v1_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Ping Api Public V1 Ping Get"}}}}}}},"/api/public/v1/account":{"get":{"tags":["account"],"summary":"Get Account","operationId":"get_account_api_public_v1_account_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAccount"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/public/v1/account/usage":{"get":{"tags":["account"],"summary":"Get Account Usage","operationId":"get_account_usage_api_public_v1_account_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUsage"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/public/v1/auctions":{"get":{"tags":["auctions"],"summary":"List Auctions","operationId":"list_auctions_api_public_v1_auctions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"active|scheduled|ended|cancelled|failed|draft","title":"Status"},"description":"active|scheduled|ended|cancelled|failed|draft"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnvelope_PublicAuction_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["auctions"],"summary":"Create Auction","operationId":"create_auction_api_public_v1_auctions_post","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuctionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/auctions/{auction_id}":{"get":{"tags":["auctions"],"summary":"Get Auction","operationId":"get_auction_api_public_v1_auctions__auction_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["auctions"],"summary":"Update Auction","operationId":"update_auction_api_public_v1_auctions__auction_id__patch","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuctionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["auctions"],"summary":"Cancel Auction","operationId":"cancel_auction_api_public_v1_auctions__auction_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/auctions/{auction_id}/winner":{"get":{"tags":["auctions"],"summary":"Get Auction Winner","description":"The winner of a closed auction (scope ``winners:read`` — a PII scope, so\navailable on the top plan tiers only).\n\nThe winner is identified by the merchant's own **Shopify customer id**,\ntranslated from the internal ``winner_id`` (the internal users.id integer PK\nis NEVER exposed). Returns ``404`` while the auction has no winner yet (still\nrunning, or it closed with no qualifying bid).","operationId":"get_auction_winner_api_public_v1_auctions__auction_id__winner_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuctionWinner"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/customers/{customer_id}/bidder-phone":{"post":{"tags":["bids"],"summary":"Save Public Bidder Phone","operationId":"save_public_bidder_phone_api_public_v1_customers__customer_id__bidder_phone_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBidderPhone"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/auctions/{auction_id}/bids":{"get":{"tags":["bids"],"summary":"List Bids","operationId":"list_bids_api_public_v1_auctions__auction_id__bids_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnvelope_PublicBid_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["bids"],"summary":"Place Bid","operationId":"place_bid_api_public_v1_auctions__auction_id__bids_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBidCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBid"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/auctions/{auction_id}/buy-now":{"post":{"tags":["bids"],"summary":"Buy Now","description":"Buy an auction outright at its ``buy_now_price`` on behalf of a customer.\n\nEnds the auction immediately and records the buyer as the winner. Idempotent\nvia ``Idempotency-Key`` (§11 — this is a money/state-moving write). The auction\nmust be active and have a configured buy-now price; both guards surface as\n``409 conflict``. Returns the now-ended auction and emits\n``auction.buy_now_accepted``. A test-mode key transacts with no real side\neffects (the shared services consult the public-API test-mode context).","operationId":"buy_now_api_public_v1_auctions__auction_id__buy_now_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"auction_id","in":"path","required":true,"schema":{"type":"string","title":"Auction Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBuyNowCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAuction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/products":{"get":{"tags":["products"],"summary":"List Products","operationId":"list_products_api_public_v1_products_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnvelope_PublicProduct_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/products/{product_id}":{"get":{"tags":["products"],"summary":"Get Product","operationId":"get_product_api_public_v1_products__product_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string","title":"Product Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicProduct"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/webhooks":{"get":{"tags":["webhooks"],"summary":"List Webhooks","operationId":"list_webhooks_api_public_v1_webhooks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnvelope_PublicWebhook_"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["webhooks"],"summary":"Create Webhook","operationId":"create_webhook_api_public_v1_webhooks_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicWebhookWithSecret"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/public/v1/webhooks/{webhook_id}":{"get":{"tags":["webhooks"],"summary":"Get Webhook","operationId":"get_webhook_api_public_v1_webhooks__webhook_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicWebhook"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["webhooks"],"summary":"Delete Webhook","operationId":"delete_webhook_api_public_v1_webhooks__webhook_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Delete Webhook Api Public V1 Webhooks  Webhook Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AuctionType":{"type":"string","enum":["standard","proxy","popcorn","penny","dutch","sealed"],"title":"AuctionType","description":"Supported auction types."},"AuctionVisibility":{"type":"string","enum":["public","private","unlisted"],"title":"AuctionVisibility","description":"Auction visibility settings."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ListEnvelope_PublicAuction_":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/PublicAuction"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["data"],"title":"ListEnvelope[PublicAuction]"},"ListEnvelope_PublicBid_":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/PublicBid"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["data"],"title":"ListEnvelope[PublicBid]"},"ListEnvelope_PublicProduct_":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/PublicProduct"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["data"],"title":"ListEnvelope[PublicProduct]"},"ListEnvelope_PublicWebhook_":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/PublicWebhook"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["data"],"title":"ListEnvelope[PublicWebhook]"},"PublicAccount":{"properties":{"object":{"type":"string","title":"Object","default":"account"},"id":{"type":"string","title":"Id"},"shop_domain":{"type":"string","title":"Shop Domain"},"plan":{"type":"string","title":"Plan"},"subscription_status":{"type":"string","title":"Subscription Status"},"currency":{"type":"string","title":"Currency"},"test_mode":{"type":"boolean","title":"Test Mode"},"api_access":{"$ref":"#/components/schemas/PublicApiAccess"}},"type":"object","required":["id","shop_domain","plan","subscription_status","currency","test_mode","api_access"],"title":"PublicAccount"},"PublicApiAccess":{"properties":{"live_keys":{"type":"boolean","title":"Live Keys"},"max_keys":{"type":"integer","title":"Max Keys"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"rate_per_min":{"type":"integer","title":"Rate Per Min"},"webhook_endpoints":{"type":"integer","title":"Webhook Endpoints"}},"type":"object","required":["live_keys","max_keys","scopes","rate_per_min","webhook_endpoints"],"title":"PublicApiAccess"},"PublicAuction":{"properties":{"object":{"type":"string","title":"Object","default":"auction"},"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"status":{"type":"string","title":"Status"},"auction_type":{"type":"string","title":"Auction Type"},"currency":{"type":"string","title":"Currency"},"current_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Price"},"starting_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting Price"},"reserve_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reserve Price"},"buy_now_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Buy Now Price"},"final_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Price"},"total_bids":{"type":"integer","title":"Total Bids","default":0},"unique_bidders":{"type":"integer","title":"Unique Bidders","default":0},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Id"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starts At"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ends At"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ended At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","title","status","auction_type","currency"],"title":"PublicAuction"},"PublicAuctionCreate":{"properties":{"target_wishlisters":{"type":"boolean","title":"Target Wishlisters","default":false},"wishlister_targeting_mode":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Wishlister Targeting Mode"},"early_access_hours":{"anyOf":[{"type":"integer","maximum":336.0,"minimum":1.0},{"type":"null"}],"title":"Early Access Hours"},"wishlister_invite_enabled":{"type":"boolean","title":"Wishlister Invite Enabled","default":false},"wishlister_discount_enabled":{"type":"boolean","title":"Wishlister Discount Enabled","default":false},"wishlister_discount_percent":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Wishlister Discount Percent"},"wishlister_discount_window":{"type":"string","enum":["before_start","if_unsold","both"],"title":"Wishlister Discount Window","default":"if_unsold"},"wishlister_discount_unsold_days":{"type":"integer","maximum":30.0,"minimum":1.0,"title":"Wishlister Discount Unsold Days","default":7},"product_id":{"type":"string","title":"Product Id"},"title":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"auction_type":{"$ref":"#/components/schemas/AuctionType","default":"standard"},"visibility":{"$ref":"#/components/schemas/AuctionVisibility","default":"public"},"scheduled_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled Start"},"duration_hours":{"type":"integer","maximum":720.0,"minimum":1.0,"title":"Duration Hours","default":24},"starting_price":{"type":"number","minimum":0.0,"title":"Starting Price"},"reserve_price":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Reserve Price"},"buy_now_price":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Buy Now Price"},"min_bid_increment":{"type":"number","exclusiveMinimum":0.0,"title":"Min Bid Increment","default":1.0},"currency":{"type":"string","pattern":"^[A-Z]{3}$","title":"Currency","default":"USD"},"proxy_bidding_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proxy Bidding Enabled"},"popcorn_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Popcorn Enabled"},"popcorn_extension_minutes":{"anyOf":[{"type":"integer","maximum":30.0,"minimum":1.0},{"type":"null"}],"title":"Popcorn Extension Minutes"},"popcorn_threshold_minutes":{"anyOf":[{"type":"integer","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Popcorn Threshold Minutes"},"max_extensions":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Max Extensions"},"payment_due_hours":{"type":"integer","maximum":720.0,"minimum":1.0,"title":"Payment Due Hours","default":48}},"additionalProperties":false,"type":"object","required":["product_id","starting_price"],"title":"PublicAuctionCreate","description":"Public create body — a validated subset of the internal AuctionCreate.\n\nCross-app/internal-only fields (GateIQ member access,\nAI flags, liquidation provenance) are intentionally NOT exposed on the public\nsurface; merchants drive those through the embedded app."},"PublicAuctionUpdate":{"properties":{"wishlister_discount_window":{"anyOf":[{"type":"string","enum":["before_start","if_unsold","both"]},{"type":"null"}],"title":"Wishlister Discount Window"},"wishlister_discount_unsold_days":{"anyOf":[{"type":"integer","maximum":30.0,"minimum":1.0},{"type":"null"}],"title":"Wishlister Discount Unsold Days"},"wishlister_discount_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Wishlister Discount Enabled"},"wishlister_discount_percent":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Wishlister Discount Percent"},"wishlister_invite_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Wishlister Invite Enabled"},"payment_due_hours":{"anyOf":[{"type":"integer","maximum":720.0,"minimum":1.0},{"type":"null"}],"title":"Payment Due Hours"},"title":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"visibility":{"anyOf":[{"$ref":"#/components/schemas/AuctionVisibility"},{"type":"null"}]},"extend_hours":{"anyOf":[{"type":"integer","maximum":168.0,"minimum":1.0},{"type":"null"}],"title":"Extend Hours"},"buy_now_price":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Buy Now Price"},"proxy_bidding_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proxy Bidding Enabled"},"popcorn_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Popcorn Enabled"},"popcorn_extension_minutes":{"anyOf":[{"type":"integer","maximum":30.0,"minimum":1.0},{"type":"null"}],"title":"Popcorn Extension Minutes"},"popcorn_threshold_minutes":{"anyOf":[{"type":"integer","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Popcorn Threshold Minutes"},"max_extensions":{"anyOf":[{"type":"integer","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Max Extensions"}},"additionalProperties":false,"type":"object","title":"PublicAuctionUpdate"},"PublicAuctionWinner":{"properties":{"object":{"type":"string","title":"Object","default":"auction_winner"},"auction_id":{"type":"string","title":"Auction Id"},"winner_shopify_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Winner Shopify Customer Id"},"winning_bid_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Winning Bid Id"},"final_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Price"},"currency":{"type":"string","title":"Currency"},"won_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Won At"},"payment_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Status"}},"type":"object","required":["auction_id","currency"],"title":"PublicAuctionWinner","description":"The winner of a closed auction (scope ``winners:read``).\n\nPII-safe by construction: the winner is identified ONLY by the merchant's own\nShopify customer id (translated from the internal ``winner_id`` users.id PK,\nwhich is NEVER exposed). Contact details are NOT included here — fetch those\nvia the customers surface under ``customers:read`` if needed."},"PublicBid":{"properties":{"object":{"type":"string","title":"Object","default":"bid"},"id":{"type":"string","title":"Id"},"auction_id":{"type":"string","title":"Auction Id"},"amount":{"type":"string","title":"Amount"},"currency":{"type":"string","title":"Currency"},"status":{"type":"string","title":"Status"},"source":{"type":"string","title":"Source"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","auction_id","amount","currency","status","source"],"title":"PublicBid"},"PublicBidCreate":{"properties":{"confirmation_token":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"title":"Confirmation Token"},"amount":{"type":"number","maximum":9999999999.99,"exclusiveMinimum":0.0,"title":"Amount"},"customer_id":{"type":"string","minLength":1,"title":"Customer Id","description":"Shopify customer id to attribute the bid to"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"}},"additionalProperties":false,"type":"object","required":["amount","customer_id"],"title":"PublicBidCreate"},"PublicBidderPhone":{"properties":{"phone":{"type":"string","maxLength":80,"minLength":1,"title":"Phone"},"country":{"anyOf":[{"type":"string","pattern":"^[A-Za-z]{2}$"},{"type":"null"}],"title":"Country"}},"additionalProperties":false,"type":"object","required":["phone"],"title":"PublicBidderPhone"},"PublicBuyNowCreate":{"properties":{"customer_id":{"type":"string","minLength":1,"title":"Customer Id","description":"Shopify customer id to attribute the purchase to"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"}},"additionalProperties":false,"type":"object","required":["customer_id"],"title":"PublicBuyNowCreate"},"PublicProduct":{"properties":{"object":{"type":"string","title":"Object","default":"product"},"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"shopify_product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shopify Product Id"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"condition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Condition"},"currency":{"type":"string","title":"Currency","default":"USD"},"original_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Price"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","title"],"title":"PublicProduct"},"PublicUsage":{"properties":{"object":{"type":"string","title":"Object","default":"usage"},"plan":{"type":"string","title":"Plan"},"active_auctions":{"type":"integer","title":"Active Auctions"},"auction_limit":{"type":"integer","title":"Auction Limit"},"rate_limit":{"type":"integer","title":"Rate Limit"},"rate_limit_remaining":{"type":"integer","title":"Rate Limit Remaining"}},"type":"object","required":["plan","active_auctions","auction_limit","rate_limit","rate_limit_remaining"],"title":"PublicUsage"},"PublicWebhook":{"properties":{"object":{"type":"string","title":"Object","default":"webhook_subscription"},"id":{"type":"string","title":"Id"},"url":{"type":"string","title":"Url"},"events":{"items":{"type":"string"},"type":"array","title":"Events"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"env":{"type":"string","title":"Env"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","url","events","env","is_active"],"title":"PublicWebhook"},"PublicWebhookWithSecret":{"properties":{"object":{"type":"string","title":"Object","default":"webhook_subscription"},"id":{"type":"string","title":"Id"},"url":{"type":"string","title":"Url"},"events":{"items":{"type":"string"},"type":"array","title":"Events"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"env":{"type":"string","title":"Env"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"signing_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signing Secret","description":"Shown only once at creation; null on idempotent replay."}},"type":"object","required":["id","url","events","env","is_active"],"title":"PublicWebhookWithSecret"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookCreate":{"properties":{"url":{"type":"string","title":"Url"},"events":{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array","minItems":1,"title":"Events"},"description":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Description"}},"additionalProperties":false,"type":"object","required":["url","events"],"title":"WebhookCreate"},"WebhookEvent":{"type":"string","enum":["auction.buy_now_accepted","auction.cancelled","auction.created","auction.ended","auction.sold","auction.started","auction.updated","auction.won","bid.outbid","bid.placed","payment.captured"],"title":"WebhookEvent"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"},"BearerApiKey":{"type":"http","scheme":"bearer","description":"API key as a bearer token: kv_auc_<env>_<secret>."},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"servers":[{"url":"https://auctionai.kernvellabs.com"}],"security":[{"BearerApiKey":[]},{"ApiKeyHeader":[]}]}