import CheckoutIntents from 'checkout-intents';const client = new CheckoutIntents({ apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted});const checkoutIntent = await client.checkoutIntents.create({ buyer: { address1: '123 Main St', city: 'New York', country: 'US', email: 'john.doe@example.com', firstName: 'John', lastName: 'Doe', phone: '1234567890', postalCode: '10001', province: 'NY', }, productUrl: 'https://www.amazon.com/dp/B0DFC9MT8Q', quantity: 1,});console.log(checkoutIntent);
import os
from checkout_intents import CheckoutIntents
client = CheckoutIntents(
api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"), # This is the default and can be omitted
)
checkout_intent = client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://www.amazon.com/dp/B0DFC9MT8Q",
quantity=1,
)
print(checkout_intent)
package com.rye.example;
import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.checkoutintents.Buyer;
import com.rye.models.checkoutintents.CheckoutIntent;
import com.rye.models.checkoutintents.CheckoutIntentCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();
CheckoutIntentCreateParams params = CheckoutIntentCreateParams.builder()
.buyer(Buyer.builder()
.address1("123 Main St")
.city("New York")
.country("US")
.email("john.doe@example.com")
.firstName("John")
.lastName("Doe")
.phone("1234567890")
.postalCode("10001")
.province("NY")
.build())
.productUrl("https://www.amazon.com/dp/B0DFC9MT8Q")
.quantity(1)
.build();
CheckoutIntent checkoutIntent = client.checkoutIntents().create(params);
}
}
Create a checkout intent with the given request body.
POST
/
api
/
v1
/
checkout-intents
JavaScript
import CheckoutIntents from 'checkout-intents';const client = new CheckoutIntents({ apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted});const checkoutIntent = await client.checkoutIntents.create({ buyer: { address1: '123 Main St', city: 'New York', country: 'US', email: 'john.doe@example.com', firstName: 'John', lastName: 'Doe', phone: '1234567890', postalCode: '10001', province: 'NY', }, productUrl: 'https://www.amazon.com/dp/B0DFC9MT8Q', quantity: 1,});console.log(checkoutIntent);
import os
from checkout_intents import CheckoutIntents
client = CheckoutIntents(
api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"), # This is the default and can be omitted
)
checkout_intent = client.checkout_intents.create(
buyer={
"address1": "123 Main St",
"city": "New York",
"country": "US",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "1234567890",
"postal_code": "10001",
"province": "NY",
},
product_url="https://www.amazon.com/dp/B0DFC9MT8Q",
quantity=1,
)
print(checkout_intent)
package com.rye.example;
import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.checkoutintents.Buyer;
import com.rye.models.checkoutintents.CheckoutIntent;
import com.rye.models.checkoutintents.CheckoutIntentCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();
CheckoutIntentCreateParams params = CheckoutIntentCreateParams.builder()
.buyer(Buyer.builder()
.address1("123 Main St")
.city("New York")
.country("US")
.email("john.doe@example.com")
.firstName("John")
.lastName("Doe")
.phone("1234567890")
.postalCode("10001")
.province("NY")
.build())
.productUrl("https://www.amazon.com/dp/B0DFC9MT8Q")
.quantity(1)
.build();
CheckoutIntent checkoutIntent = client.checkoutIntents().create(params);
}
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rye","colors":{"primary":"#8FA957","light":"#71F47B","dark":"#4ED558"},"logo":{"light":"https://mintcdn.com/jolly-commerce/2QIqebHt5agkP3jl/logo/light.png?fit=max\u0026auto=format\u0026n=2QIqebHt5agkP3jl\u0026q=85\u0026s=2a4e22eb948fabaea0f01104b2df971e","dark":"https://mintcdn.com/jolly-commerce/2QIqebHt5agkP3jl/logo/dark.png?fit=max\u0026auto=format\u0026n=2QIqebHt5agkP3jl\u0026q=85\u0026s=47c75c6234a2fd03f4cfe608e5f90c75"},"favicon":"https://mintcdn.com/jolly-commerce/2QIqebHt5agkP3jl/favicon.svg?fit=max\u0026auto=format\u0026n=2QIqebHt5agkP3jl\u0026q=85\u0026s=74b75f6539d14cf8746d9fbd2034edc6","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://console.commerce.jolly.dev/login"}},"footer":{"socials":{"twitter":"https://twitter.com/rye","linkedin":"https://www.linkedin.com/company/rye"}},"seo":{"metatags":{"canonical":"https://docs.commerce.jolly.dev"}},"integrations":{"koala":{"publicApiKey":"pk_95052208d158276836ec341f6a0080042796"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jolly-commerce","hasAudioNarration":false,"actualSubdomain":"jolly-commerce","customDomains":["docs.commerce.jolly.dev"],"gitSource":{"type":"github","owner":"rye-com","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6accf0cbe4af841eed300616","collectionId":"bb8defe8-0802-4533-b881-325df86d53e4","liveDeploymentHistoryId":"6accf0cbe4af841eed300616","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6accf0cbe4af841eed300616","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Universal Checkout API Documentation","count":74},{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Universal Checkout API","count":23},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Checkout Intents","count":7},{"language":"default","tag":"Rewards SDK","count":6},{"language":"default","tag":"Billing","count":6},{"language":"default","tag":"Test Helpers","count":6},{"language":"default","tag":"API Access \u0026 Environments","count":4},{"language":"default","tag":"Quickstart","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-v2/api-reference/checkout-intents/create-checkout-intent","slug":"/api-v2/api-reference/checkout-intents/create-checkout-intent","pageMetadata":{"title":"Create checkout intent","description":"Create a checkout intent with the given request body.","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/checkout-intents","href":"/api-v2/api-reference/checkout-intents/create-checkout-intent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a checkout intent with the given request body.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create checkout intent","description":"Create a checkout intent with the given request body.","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/checkout-intents","href":"/api-v2/api-reference/checkout-intents/create-checkout-intent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"CreateCheckoutIntent","responses":{"201":"7b6205ae-4feb-4199-bced-a2d99ae583de","401":"efc598a0-c041-476d-89ae-4fe388b23ef1","422":"550a365c-e584-4bbb-b0fc-87b7bb612ddd","500":"69881233-9df5-4e20-bf08-4291c005f600","503":"1281cad6-bb93-4d8b-862d-31b0909250aa"},"description":"Create a checkout intent with the given request body.","summary":"Create checkout intent","tags":["Checkout Intents"],"security":["5444a21f-bfa7-4f6a-ac99-2ab486e8c3c5"],"parameters":[],"requestBody":"2dfd24f6-163a-4d67-909b-261fb2a00a09","x-codeSamples":[{"lang":"JavaScript","source":"import CheckoutIntents from 'checkout-intents';\n\nconst client = new CheckoutIntents({\n apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted\n});\n\nconst checkoutIntent = await client.checkoutIntents.create({\n buyer: {\n address1: '123 Main St',\n city: 'New York',\n country: 'US',\n email: 'john.doe@example.com',\n firstName: 'John',\n lastName: 'Doe',\n phone: '1234567890',\n postalCode: '10001',\n province: 'NY',\n },\n productUrl: 'https://www.amazon.com/dp/B0DFC9MT8Q',\n quantity: 1,\n});\n\nconsole.log(checkoutIntent);"},{"lang":"Python","source":"import os\nfrom checkout_intents import CheckoutIntents\n\nclient = CheckoutIntents(\n api_key=os.environ.get(\"CHECKOUT_INTENTS_API_KEY\"), # This is the default and can be omitted\n)\ncheckout_intent = client.checkout_intents.create(\n buyer={\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"1234567890\",\n \"postal_code\": \"10001\",\n \"province\": \"NY\",\n },\n product_url=\"https://www.amazon.com/dp/B0DFC9MT8Q\",\n quantity=1,\n)\nprint(checkout_intent)"},{"lang":"Java","source":"package com.rye.example;\n\nimport com.rye.client.CheckoutIntentsClient;\nimport com.rye.client.okhttp.CheckoutIntentsOkHttpClient;\nimport com.rye.models.checkoutintents.Buyer;\nimport com.rye.models.checkoutintents.CheckoutIntent;\nimport com.rye.models.checkoutintents.CheckoutIntentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();\n\n CheckoutIntentCreateParams params = CheckoutIntentCreateParams.builder()\n .buyer(Buyer.builder()\n .address1(\"123 Main St\")\n .city(\"New York\")\n .country(\"US\")\n .email(\"john.doe@example.com\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .phone(\"1234567890\")\n .postalCode(\"10001\")\n .province(\"NY\")\n .build())\n .productUrl(\"https://www.amazon.com/dp/B0DFC9MT8Q\")\n .quantity(1)\n .build();\n CheckoutIntent checkoutIntent = client.checkoutIntents().create(params);\n }\n}"},{"lang":"cURL","source":"curl https://api.commerce.staging.jolly.dev/api/v1/checkout-intents \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $CHECKOUT_INTENTS_API_KEY\" \\\n -d '{\n \"buyer\": {\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"1234567890\",\n \"postalCode\": \"10001\",\n \"province\": \"NY\"\n },\n \"productUrl\": \"https://www.amazon.com/dp/B0DFC9MT8Q\",\n \"quantity\": 1,\n \"referenceId\": \"order-1234\"\n }'"}],"method":"post","type":"path","servers":["99c05a2f-4820-44d6-8ed6-ae02cdc31ff1"],"path":"/api/v1/checkout-intents","baseUrlOptions":["https://api.commerce.staging.jolly.dev"],"title":"Create checkout intent","codeSamples":[{"lang":"JavaScript","source":"import CheckoutIntents from 'checkout-intents';\n\nconst client = new CheckoutIntents({\n apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted\n});\n\nconst checkoutIntent = await client.checkoutIntents.create({\n buyer: {\n address1: '123 Main St',\n city: 'New York',\n country: 'US',\n email: 'john.doe@example.com',\n firstName: 'John',\n lastName: 'Doe',\n phone: '1234567890',\n postalCode: '10001',\n province: 'NY',\n },\n productUrl: 'https://www.amazon.com/dp/B0DFC9MT8Q',\n quantity: 1,\n});\n\nconsole.log(checkoutIntent);"},{"lang":"Python","source":"import os\nfrom checkout_intents import CheckoutIntents\n\nclient = CheckoutIntents(\n api_key=os.environ.get(\"CHECKOUT_INTENTS_API_KEY\"), # This is the default and can be omitted\n)\ncheckout_intent = client.checkout_intents.create(\n buyer={\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"1234567890\",\n \"postal_code\": \"10001\",\n \"province\": \"NY\",\n },\n product_url=\"https://www.amazon.com/dp/B0DFC9MT8Q\",\n quantity=1,\n)\nprint(checkout_intent)"},{"lang":"Java","source":"package com.rye.example;\n\nimport com.rye.client.CheckoutIntentsClient;\nimport com.rye.client.okhttp.CheckoutIntentsOkHttpClient;\nimport com.rye.models.checkoutintents.Buyer;\nimport com.rye.models.checkoutintents.CheckoutIntent;\nimport com.rye.models.checkoutintents.CheckoutIntentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();\n\n CheckoutIntentCreateParams params = CheckoutIntentCreateParams.builder()\n .buyer(Buyer.builder()\n .address1(\"123 Main St\")\n .city(\"New York\")\n .country(\"US\")\n .email(\"john.doe@example.com\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .phone(\"1234567890\")\n .postalCode(\"10001\")\n .province(\"NY\")\n .build())\n .productUrl(\"https://www.amazon.com/dp/B0DFC9MT8Q\")\n .quantity(1)\n .build();\n CheckoutIntent checkoutIntent = client.checkoutIntents().create(params);\n }\n}"},{"lang":"cURL","source":"curl https://api.commerce.staging.jolly.dev/api/v1/checkout-intents \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $CHECKOUT_INTENTS_API_KEY\" \\\n -d '{\n \"buyer\": {\n \"address1\": \"123 Main St\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"1234567890\",\n \"postalCode\": \"10001\",\n \"province\": \"NY\"\n },\n \"productUrl\": \"https://www.amazon.com/dp/B0DFC9MT8Q\",\n \"quantity\": 1,\n \"referenceId\": \"order-1234\"\n }'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","example":1,"minimum":0,"isRequired":true,"uniqueKey":"quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","example":"https://www.amazon.com/dp/B0DFC9MT8Q","isRequired":true,"uniqueKey":"productUrl","typeLabel":"string"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","maxItems":16,"uniqueKey":"promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"variantSelections","typeLabel":"object[]"}},"required":["buyer","quantity","productUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"buyer":{"postalCode":"10001","country":"US","province":"NY","city":"New York","address1":"123 Main St","phone":"1234567890","email":"john.doe@example.com","lastName":"Doe","firstName":"John","address2":"Apt 1"},"quantity":1,"productUrl":"https://www.amazon.com/dp/B0DFC9MT8Q","referenceId":"order-1234","discoverPromoCodes":true,"constraints":{"offerRetrievalEffort":"max","maxShippingPrice":500,"maxTotalPrice":100000},"promoCodes":["SAVE20"],"variantSelections":[{"value":"Small, Red, XS, L, etc.","label":"Size, Color, etc."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7b6205ae-4feb-4199-bced-a2d99ae583de":{"description":"Created","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Retrieving Offer","required":["state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.0.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.0.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.0.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.0.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.0.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.0.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"state":{"type":"string","enum":["retrieving_offer"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.0.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.0.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.0.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.0.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.0.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.0.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.0.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.0.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.0.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.0.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.0.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.0.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.0.variantSelections","typeLabel":"object[]"}},"uniqueKey":"oneOf.0","typeLabel":"Retrieving Offer · object"},{"type":"object","title":"Awaiting Confirmation","required":["offer","state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.1.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.1.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.1.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.1.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.1.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"offer":{"properties":{"shipping":{"properties":{"availableOptions":{"items":{"properties":{"cost":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].cost.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].cost.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].cost","typeLabel":"object"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].id","typeLabel":"string"},"deliveryEstimate":{"oneOf":[{"type":"object","description":"Estimated range of dates that items will be delivered in. At least one of\n`earliest` or `latest` are guaranteed to be set.\n\nInterpretation:\n\n* If both `earliest` and `latest` are set, then the delivery estimate is the range between the two dates.\n* If only `earliest` is set, then the delivery estimate is any date after that date.\n* If only `latest` is set, then the delivery estimate is any date before that date.","properties":{"latest":{"type":"string","format":"date-time","description":"Latest date that items will be delivered by.","example":"2026-03-28T00:00:00Z","uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.latest","typeLabel":"string\u003cdate-time>"},"earliest":{"type":"string","format":"date-time","description":"Earliest date that items will be delivered by.","example":"2026-03-25T00:00:00Z","uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate","typeLabel":"object | null"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX].discount","typeLabel":"object"}},"required":["cost","id"],"type":"object","uniqueKey":"oneOf.1.offer.shipping.availableOptions.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping.availableOptions","typeLabel":"object[]"},"selectedOptionId":{"type":"string","uniqueKey":"oneOf.1.offer.shipping.selectedOptionId","typeLabel":"string"}},"required":["availableOptions"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.shipping","typeLabel":"object"},"cost":{"properties":{"total":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.total.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.total.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.total","typeLabel":"object"},"subtotal":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.subtotal.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.subtotal.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.subtotal","typeLabel":"object"},"surcharge":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.surcharge.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.surcharge.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.1.offer.cost.surcharge","typeLabel":"object"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.1.offer.cost.discount","typeLabel":"object"},"tax":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.tax.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.tax.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.1.offer.cost.tax","typeLabel":"object"},"shipping":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.cost.shipping.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.cost.shipping.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.1.offer.cost.shipping","typeLabel":"object"}},"required":["total","subtotal"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.cost","typeLabel":"object"},"commission":{"properties":{"estimate":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.offer.commission.estimate","typeLabel":"boolean"},"amount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.offer.commission.amount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.1.offer.commission.amount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer.commission.amount","typeLabel":"object"}},"required":["estimate","amount"],"type":"object","description":"The commission a developer would earn if this offer is placed.","uniqueKey":"oneOf.1.offer.commission","typeLabel":"object"},"appliedPromoCodes":{"items":{"type":"string","uniqueKey":"oneOf.1.offer.appliedPromoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.1.offer.appliedPromoCodes","typeLabel":"string[]"}},"required":["shipping","cost"],"type":"object","isRequired":true,"uniqueKey":"oneOf.1.offer","typeLabel":"object"},"state":{"type":"string","enum":["awaiting_confirmation"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.1.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.1.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.1.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.1.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.1.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.1.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.1.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.1.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.1.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.1.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.1.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.1.variantSelections","typeLabel":"object[]"},"paymentMethod":{"oneOf":[{"type":"object","title":"Stripe","required":["stripeToken","type"],"properties":{"stripeToken":{"type":"string","example":"tok_1RkrWWHGDlstla3f1Fc7ZrhH","isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.0.stripeToken","typeLabel":"string"},"type":{"type":"string","enum":["stripe_token"],"nullable":false,"example":"stripe_token","isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.paymentMethod.oneOf.0","typeLabel":"Stripe · object"},{"type":"object","title":"Basis Theory","required":["basisTheoryToken","type"],"properties":{"basisTheoryToken":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.1.basisTheoryToken","typeLabel":"string"},"type":{"type":"string","enum":["basis_theory_token"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.paymentMethod.oneOf.1","typeLabel":"Basis Theory · object"},{"type":"object","title":"Drawdown","required":["type"],"properties":{"type":{"type":"string","enum":["drawdown"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.paymentMethod.oneOf.2","typeLabel":"Drawdown · object"},{"type":"object","title":"X402","required":["network","type"],"properties":{"network":{"type":"string","enum":["base","solana","tempo"],"isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.3.network","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.1.paymentMethod.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.paymentMethod.oneOf.3","typeLabel":"X402 · object"}],"uniqueKey":"oneOf.1.paymentMethod","typeLabel":"Stripe · object | Basis Theory · object | Drawdown · object | X402 · object"}},"uniqueKey":"oneOf.1","typeLabel":"Awaiting Confirmation · object"},{"type":"object","title":"Requires Action","required":["nextAction","paymentMethod","offer","state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.2.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.2.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.2.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.2.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.2.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.2.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"nextAction":{"properties":{"x402":{"properties":{"expiresAt":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.expiresAt","typeLabel":"string"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.recipient","typeLabel":"string"},"currency":{"type":"string","enum":["USDC"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.currency","typeLabel":"enum\u003cstring>"},"maxAmountRequired":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.maxAmountRequired","typeLabel":"string"},"network":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.network","typeLabel":"string"},"scheme":{"type":"string","enum":["exact"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402.scheme","typeLabel":"enum\u003cstring>"}},"required":["expiresAt","recipient","currency","maxAmountRequired","network","scheme"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.nextAction.x402","typeLabel":"object"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.nextAction.type","typeLabel":"enum\u003cstring>"}},"required":["x402","type"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.nextAction","typeLabel":"object"},"paymentMethod":{"oneOf":[{"type":"object","title":"Stripe","required":["stripeToken","type"],"properties":{"stripeToken":{"type":"string","example":"tok_1RkrWWHGDlstla3f1Fc7ZrhH","isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.0.stripeToken","typeLabel":"string"},"type":{"type":"string","enum":["stripe_token"],"nullable":false,"example":"stripe_token","isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.0","typeLabel":"Stripe · object"},{"type":"object","title":"Basis Theory","required":["basisTheoryToken","type"],"properties":{"basisTheoryToken":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.1.basisTheoryToken","typeLabel":"string"},"type":{"type":"string","enum":["basis_theory_token"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.1","typeLabel":"Basis Theory · object"},{"type":"object","title":"Drawdown","required":["type"],"properties":{"type":{"type":"string","enum":["drawdown"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.2","typeLabel":"Drawdown · object"},{"type":"object","title":"X402","required":["network","type"],"properties":{"network":{"type":"string","enum":["base","solana","tempo"],"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.3.network","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod.oneOf.3","typeLabel":"X402 · object"}],"isRequired":true,"uniqueKey":"oneOf.2.paymentMethod","typeLabel":"Stripe · object | Basis Theory · object | Drawdown · object | X402 · object"},"offer":{"properties":{"shipping":{"properties":{"availableOptions":{"items":{"properties":{"cost":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].cost.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].cost.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].cost","typeLabel":"object"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].id","typeLabel":"string"},"deliveryEstimate":{"oneOf":[{"type":"object","description":"Estimated range of dates that items will be delivered in. At least one of\n`earliest` or `latest` are guaranteed to be set.\n\nInterpretation:\n\n* If both `earliest` and `latest` are set, then the delivery estimate is the range between the two dates.\n* If only `earliest` is set, then the delivery estimate is any date after that date.\n* If only `latest` is set, then the delivery estimate is any date before that date.","properties":{"latest":{"type":"string","format":"date-time","description":"Latest date that items will be delivered by.","example":"2026-03-28T00:00:00Z","uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.latest","typeLabel":"string\u003cdate-time>"},"earliest":{"type":"string","format":"date-time","description":"Earliest date that items will be delivered by.","example":"2026-03-25T00:00:00Z","uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate","typeLabel":"object | null"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX].discount","typeLabel":"object"}},"required":["cost","id"],"type":"object","uniqueKey":"oneOf.2.offer.shipping.availableOptions.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping.availableOptions","typeLabel":"object[]"},"selectedOptionId":{"type":"string","uniqueKey":"oneOf.2.offer.shipping.selectedOptionId","typeLabel":"string"}},"required":["availableOptions"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.shipping","typeLabel":"object"},"cost":{"properties":{"total":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.total.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.total.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.total","typeLabel":"object"},"subtotal":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.subtotal.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.subtotal.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.subtotal","typeLabel":"object"},"surcharge":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.surcharge.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.surcharge.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.2.offer.cost.surcharge","typeLabel":"object"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.2.offer.cost.discount","typeLabel":"object"},"tax":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.tax.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.tax.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.2.offer.cost.tax","typeLabel":"object"},"shipping":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.cost.shipping.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.cost.shipping.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.2.offer.cost.shipping","typeLabel":"object"}},"required":["total","subtotal"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.cost","typeLabel":"object"},"commission":{"properties":{"estimate":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.2.offer.commission.estimate","typeLabel":"boolean"},"amount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.offer.commission.amount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.2.offer.commission.amount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer.commission.amount","typeLabel":"object"}},"required":["estimate","amount"],"type":"object","description":"The commission a developer would earn if this offer is placed.","uniqueKey":"oneOf.2.offer.commission","typeLabel":"object"},"appliedPromoCodes":{"items":{"type":"string","uniqueKey":"oneOf.2.offer.appliedPromoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.2.offer.appliedPromoCodes","typeLabel":"string[]"}},"required":["shipping","cost"],"type":"object","isRequired":true,"uniqueKey":"oneOf.2.offer","typeLabel":"object"},"state":{"type":"string","enum":["requires_action"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.2.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.2.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.2.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.2.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.2.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.2.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.2.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.2.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.2.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.2.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.2.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.2.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.2.variantSelections","typeLabel":"object[]"}},"uniqueKey":"oneOf.2","typeLabel":"Requires Action · object"},{"type":"object","title":"Placing Order","required":["paymentMethod","offer","state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.3.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.3.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.3.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.3.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.3.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.3.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"paymentMethod":{"oneOf":[{"type":"object","title":"Stripe","required":["stripeToken","type"],"properties":{"stripeToken":{"type":"string","example":"tok_1RkrWWHGDlstla3f1Fc7ZrhH","isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.0.stripeToken","typeLabel":"string"},"type":{"type":"string","enum":["stripe_token"],"nullable":false,"example":"stripe_token","isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.0","typeLabel":"Stripe · object"},{"type":"object","title":"Basis Theory","required":["basisTheoryToken","type"],"properties":{"basisTheoryToken":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.1.basisTheoryToken","typeLabel":"string"},"type":{"type":"string","enum":["basis_theory_token"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.1","typeLabel":"Basis Theory · object"},{"type":"object","title":"Drawdown","required":["type"],"properties":{"type":{"type":"string","enum":["drawdown"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.2","typeLabel":"Drawdown · object"},{"type":"object","title":"X402","required":["network","type"],"properties":{"network":{"type":"string","enum":["base","solana","tempo"],"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.3.network","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod.oneOf.3","typeLabel":"X402 · object"}],"isRequired":true,"uniqueKey":"oneOf.3.paymentMethod","typeLabel":"Stripe · object | Basis Theory · object | Drawdown · object | X402 · object"},"offer":{"properties":{"shipping":{"properties":{"availableOptions":{"items":{"properties":{"cost":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].cost.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].cost.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].cost","typeLabel":"object"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].id","typeLabel":"string"},"deliveryEstimate":{"oneOf":[{"type":"object","description":"Estimated range of dates that items will be delivered in. At least one of\n`earliest` or `latest` are guaranteed to be set.\n\nInterpretation:\n\n* If both `earliest` and `latest` are set, then the delivery estimate is the range between the two dates.\n* If only `earliest` is set, then the delivery estimate is any date after that date.\n* If only `latest` is set, then the delivery estimate is any date before that date.","properties":{"latest":{"type":"string","format":"date-time","description":"Latest date that items will be delivered by.","example":"2026-03-28T00:00:00Z","uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.latest","typeLabel":"string\u003cdate-time>"},"earliest":{"type":"string","format":"date-time","description":"Earliest date that items will be delivered by.","example":"2026-03-25T00:00:00Z","uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate","typeLabel":"object | null"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX].discount","typeLabel":"object"}},"required":["cost","id"],"type":"object","uniqueKey":"oneOf.3.offer.shipping.availableOptions.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping.availableOptions","typeLabel":"object[]"},"selectedOptionId":{"type":"string","uniqueKey":"oneOf.3.offer.shipping.selectedOptionId","typeLabel":"string"}},"required":["availableOptions"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.shipping","typeLabel":"object"},"cost":{"properties":{"total":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.total.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.total.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.total","typeLabel":"object"},"subtotal":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.subtotal.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.subtotal.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.subtotal","typeLabel":"object"},"surcharge":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.surcharge.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.surcharge.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.3.offer.cost.surcharge","typeLabel":"object"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.3.offer.cost.discount","typeLabel":"object"},"tax":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.tax.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.tax.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.3.offer.cost.tax","typeLabel":"object"},"shipping":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.cost.shipping.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.cost.shipping.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.3.offer.cost.shipping","typeLabel":"object"}},"required":["total","subtotal"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.cost","typeLabel":"object"},"commission":{"properties":{"estimate":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.3.offer.commission.estimate","typeLabel":"boolean"},"amount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.offer.commission.amount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.3.offer.commission.amount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer.commission.amount","typeLabel":"object"}},"required":["estimate","amount"],"type":"object","description":"The commission a developer would earn if this offer is placed.","uniqueKey":"oneOf.3.offer.commission","typeLabel":"object"},"appliedPromoCodes":{"items":{"type":"string","uniqueKey":"oneOf.3.offer.appliedPromoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.3.offer.appliedPromoCodes","typeLabel":"string[]"}},"required":["shipping","cost"],"type":"object","isRequired":true,"uniqueKey":"oneOf.3.offer","typeLabel":"object"},"state":{"type":"string","enum":["placing_order"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.3.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.3.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.3.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.3.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.3.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.3.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.3.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.3.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.3.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.3.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.3.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.3.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.3.variantSelections","typeLabel":"object[]"}},"uniqueKey":"oneOf.3","typeLabel":"Placing Order · object"},{"type":"object","title":"Completed","required":["orderId","paymentMethod","offer","state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.4.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.4.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.4.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.4.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.4.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.4.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.4.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.id","typeLabel":"string"},"orderId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.orderId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.4.orderId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.4.orderId","typeLabel":"string | null"},"paymentMethod":{"oneOf":[{"type":"object","title":"Stripe","required":["stripeToken","type"],"properties":{"stripeToken":{"type":"string","example":"tok_1RkrWWHGDlstla3f1Fc7ZrhH","isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.0.stripeToken","typeLabel":"string"},"type":{"type":"string","enum":["stripe_token"],"nullable":false,"example":"stripe_token","isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.0","typeLabel":"Stripe · object"},{"type":"object","title":"Basis Theory","required":["basisTheoryToken","type"],"properties":{"basisTheoryToken":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.1.basisTheoryToken","typeLabel":"string"},"type":{"type":"string","enum":["basis_theory_token"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.1","typeLabel":"Basis Theory · object"},{"type":"object","title":"Drawdown","required":["type"],"properties":{"type":{"type":"string","enum":["drawdown"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.2","typeLabel":"Drawdown · object"},{"type":"object","title":"X402","required":["network","type"],"properties":{"network":{"type":"string","enum":["base","solana","tempo"],"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.3.network","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod.oneOf.3","typeLabel":"X402 · object"}],"isRequired":true,"uniqueKey":"oneOf.4.paymentMethod","typeLabel":"Stripe · object | Basis Theory · object | Drawdown · object | X402 · object"},"offer":{"properties":{"shipping":{"properties":{"availableOptions":{"items":{"properties":{"cost":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].cost.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].cost.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].cost","typeLabel":"object"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].id","typeLabel":"string"},"deliveryEstimate":{"oneOf":[{"type":"object","description":"Estimated range of dates that items will be delivered in. At least one of\n`earliest` or `latest` are guaranteed to be set.\n\nInterpretation:\n\n* If both `earliest` and `latest` are set, then the delivery estimate is the range between the two dates.\n* If only `earliest` is set, then the delivery estimate is any date after that date.\n* If only `latest` is set, then the delivery estimate is any date before that date.","properties":{"latest":{"type":"string","format":"date-time","description":"Latest date that items will be delivered by.","example":"2026-03-28T00:00:00Z","uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.latest","typeLabel":"string\u003cdate-time>"},"earliest":{"type":"string","format":"date-time","description":"Earliest date that items will be delivered by.","example":"2026-03-25T00:00:00Z","uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate","typeLabel":"object | null"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX].discount","typeLabel":"object"}},"required":["cost","id"],"type":"object","uniqueKey":"oneOf.4.offer.shipping.availableOptions.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping.availableOptions","typeLabel":"object[]"},"selectedOptionId":{"type":"string","uniqueKey":"oneOf.4.offer.shipping.selectedOptionId","typeLabel":"string"}},"required":["availableOptions"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.shipping","typeLabel":"object"},"cost":{"properties":{"total":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.total.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.total.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.total","typeLabel":"object"},"subtotal":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.subtotal.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.subtotal.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.subtotal","typeLabel":"object"},"surcharge":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.surcharge.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.surcharge.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.4.offer.cost.surcharge","typeLabel":"object"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.4.offer.cost.discount","typeLabel":"object"},"tax":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.tax.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.tax.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.4.offer.cost.tax","typeLabel":"object"},"shipping":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.cost.shipping.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.cost.shipping.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.4.offer.cost.shipping","typeLabel":"object"}},"required":["total","subtotal"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.cost","typeLabel":"object"},"commission":{"properties":{"estimate":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.4.offer.commission.estimate","typeLabel":"boolean"},"amount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.offer.commission.amount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.4.offer.commission.amount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer.commission.amount","typeLabel":"object"}},"required":["estimate","amount"],"type":"object","description":"The commission a developer would earn if this offer is placed.","uniqueKey":"oneOf.4.offer.commission","typeLabel":"object"},"appliedPromoCodes":{"items":{"type":"string","uniqueKey":"oneOf.4.offer.appliedPromoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.4.offer.appliedPromoCodes","typeLabel":"string[]"}},"required":["shipping","cost"],"type":"object","isRequired":true,"uniqueKey":"oneOf.4.offer","typeLabel":"object"},"state":{"type":"string","enum":["completed"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.4.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.4.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.4.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.4.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.4.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.4.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.4.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.4.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.4.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.4.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.4.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.4.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.4.variantSelections","typeLabel":"object[]"},"estimatedDeliveryDate":{"oneOf":[{"type":"string","format":"date-time","deprecated":true,"uniqueKey":"oneOf.4.estimatedDeliveryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","deprecated":true,"uniqueKey":"oneOf.4.estimatedDeliveryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.estimatedDeliveryDate","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"oneOf.4","typeLabel":"Completed · object"},{"type":"object","title":"Failed","required":["failureReason","state","buyer","quantity","productUrl","createdAt","id"],"properties":{"buyer":{"properties":{"postalCode":{"type":"string","example":"10001","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.postalCode","typeLabel":"string"},"country":{"type":"string","example":"US","isRequired":true,"uniqueKey":"oneOf.5.buyer.country","typeLabel":"string"},"province":{"type":"string","example":"NY","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.province","typeLabel":"string"},"city":{"type":"string","example":"New York","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.city","typeLabel":"string"},"address1":{"type":"string","example":"123 Main St","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.address1","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","isRequired":true,"uniqueKey":"oneOf.5.buyer.phone","typeLabel":"string"},"email":{"type":"string","example":"john.doe@example.com","isRequired":true,"uniqueKey":"oneOf.5.buyer.email","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.lastName","typeLabel":"string"},"firstName":{"type":"string","example":"John","maxLength":255,"isRequired":true,"uniqueKey":"oneOf.5.buyer.firstName","typeLabel":"string"},"address2":{"type":"string","example":"Apt 1","maxLength":255,"uniqueKey":"oneOf.5.buyer.address2","typeLabel":"string"}},"required":["postalCode","country","province","city","address1","phone","email","lastName","firstName"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.buyer","typeLabel":"object"},"quantity":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"oneOf.5.quantity","typeLabel":"integer\u003cint32>"},"productUrl":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.productUrl","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.5.createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.id","typeLabel":"string"},"failureReason":{"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.failureReason.message","typeLabel":"string"},"code":{"type":"string","enum":["unknown","checkout_intent_expired","payment_failed","payment_cvc_expired","insufficient_stock","product_out_of_stock","offer_retrieval_failed","order_placement_failed","developer_not_found","missing_shipping_method","unsupported_currency","invalid_input","incorrect_cost_breakdown","unsupported_store_no_guest_checkout","workflow_invocation_failed","variant_selections_invalid","variant_selections_required","form_validation_error","captcha_blocked","bot_protection_blocked","constraint_total_price_exceeded","constraint_shipping_cost_exceeded","promo_code_discovery_not_enabled","product_not_found"],"description":"Type derived from runtime array - always in sync","isRequired":true,"uniqueKey":"oneOf.5.failureReason.code","typeLabel":"enum\u003cstring>"}},"required":["message","code"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.failureReason","typeLabel":"object"},"state":{"type":"string","enum":["failed"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.5.state","typeLabel":"enum\u003cstring>"},"referenceId":{"type":"string","example":"order-1234","maxLength":255,"uniqueKey":"oneOf.5.referenceId","typeLabel":"string"},"discoverPromoCodes":{"type":"boolean","uniqueKey":"oneOf.5.discoverPromoCodes","typeLabel":"boolean"},"constraints":{"properties":{"offerRetrievalEffort":{"type":"string","enum":["max","low"],"description":"Controls how much effort the system should spend retrieving an offer.\n- 'max': Full effort including AI agent fallback (slower, higher success rate)\n- 'low': Fast API-only retrieval, fails if API unavailable (faster, lower success rate)\n\nDefault: 'max'","example":"max","uniqueKey":"oneOf.5.constraints.offerRetrievalEffort","typeLabel":"enum\u003cstring>"},"maxShippingPrice":{"type":"integer","format":"int32","example":500,"minimum":0,"uniqueKey":"oneOf.5.constraints.maxShippingPrice","typeLabel":"integer\u003cint32>"},"maxTotalPrice":{"type":"integer","format":"int32","example":100000,"minimum":0,"uniqueKey":"oneOf.5.constraints.maxTotalPrice","typeLabel":"integer\u003cint32>"}},"type":"object","uniqueKey":"oneOf.5.constraints","typeLabel":"object"},"promoCodes":{"items":{"type":"string","example":"SAVE20","description":"Promo code string with validation constraints.\n- Must contain only letters, digits, underscores, or hyphens\n- Maximum length of 32 characters","pattern":"^[a-zA-Z0-9_\\-]+$","maxLength":32,"uniqueKey":"oneOf.5.promoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.5.promoCodes","typeLabel":"string[]"},"variantSelections":{"items":{"properties":{"value":{"type":"string","maxLength":60,"example":"Small, Red, XS, L, etc.","isRequired":true,"uniqueKey":"oneOf.5.variantSelections.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Size, Color, etc.","maxLength":30,"isRequired":true,"uniqueKey":"oneOf.5.variantSelections.items.[INDEX].label","typeLabel":"string"}},"required":["value","label"],"type":"object","uniqueKey":"oneOf.5.variantSelections.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"oneOf.5.variantSelections","typeLabel":"object[]"},"paymentMethod":{"oneOf":[{"type":"object","title":"Stripe","required":["stripeToken","type"],"properties":{"stripeToken":{"type":"string","example":"tok_1RkrWWHGDlstla3f1Fc7ZrhH","isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.0.stripeToken","typeLabel":"string"},"type":{"type":"string","enum":["stripe_token"],"nullable":false,"example":"stripe_token","isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.paymentMethod.oneOf.0","typeLabel":"Stripe · object"},{"type":"object","title":"Basis Theory","required":["basisTheoryToken","type"],"properties":{"basisTheoryToken":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.1.basisTheoryToken","typeLabel":"string"},"type":{"type":"string","enum":["basis_theory_token"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.paymentMethod.oneOf.1","typeLabel":"Basis Theory · object"},{"type":"object","title":"Drawdown","required":["type"],"properties":{"type":{"type":"string","enum":["drawdown"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.paymentMethod.oneOf.2","typeLabel":"Drawdown · object"},{"type":"object","title":"X402","required":["network","type"],"properties":{"network":{"type":"string","enum":["base","solana","tempo"],"isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.3.network","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["x402"],"nullable":false,"isRequired":true,"uniqueKey":"oneOf.5.paymentMethod.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.paymentMethod.oneOf.3","typeLabel":"X402 · object"}],"uniqueKey":"oneOf.5.paymentMethod","typeLabel":"Stripe · object | Basis Theory · object | Drawdown · object | X402 · object"},"offer":{"properties":{"shipping":{"properties":{"availableOptions":{"items":{"properties":{"cost":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].cost.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].cost.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].cost","typeLabel":"object"},"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].id","typeLabel":"string"},"deliveryEstimate":{"oneOf":[{"type":"object","description":"Estimated range of dates that items will be delivered in. At least one of\n`earliest` or `latest` are guaranteed to be set.\n\nInterpretation:\n\n* If both `earliest` and `latest` are set, then the delivery estimate is the range between the two dates.\n* If only `earliest` is set, then the delivery estimate is any date after that date.\n* If only `latest` is set, then the delivery estimate is any date before that date.","properties":{"latest":{"type":"string","format":"date-time","description":"Latest date that items will be delivered by.","example":"2026-03-28T00:00:00Z","uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.latest","typeLabel":"string\u003cdate-time>"},"earliest":{"type":"string","format":"date-time","description":"Earliest date that items will be delivered by.","example":"2026-03-25T00:00:00Z","uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].deliveryEstimate","typeLabel":"object | null"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX].discount","typeLabel":"object"}},"required":["cost","id"],"type":"object","uniqueKey":"oneOf.5.offer.shipping.availableOptions.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping.availableOptions","typeLabel":"object[]"},"selectedOptionId":{"type":"string","uniqueKey":"oneOf.5.offer.shipping.selectedOptionId","typeLabel":"string"}},"required":["availableOptions"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.shipping","typeLabel":"object"},"cost":{"properties":{"total":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.total.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.total.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.total","typeLabel":"object"},"subtotal":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.subtotal.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.subtotal.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.subtotal","typeLabel":"object"},"surcharge":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.surcharge.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.surcharge.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.5.offer.cost.surcharge","typeLabel":"object"},"discount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.discount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.discount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.5.offer.cost.discount","typeLabel":"object"},"tax":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.tax.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.tax.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.5.offer.cost.tax","typeLabel":"object"},"shipping":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.cost.shipping.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.cost.shipping.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","uniqueKey":"oneOf.5.offer.cost.shipping","typeLabel":"object"}},"required":["total","subtotal"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.cost","typeLabel":"object"},"commission":{"properties":{"estimate":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.5.offer.commission.estimate","typeLabel":"boolean"},"amount":{"properties":{"currencyCode":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.offer.commission.amount.currencyCode","typeLabel":"string"},"amountSubunits":{"type":"integer","format":"int32","example":1500,"isRequired":true,"uniqueKey":"oneOf.5.offer.commission.amount.amountSubunits","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amountSubunits"],"type":"object","isRequired":true,"uniqueKey":"oneOf.5.offer.commission.amount","typeLabel":"object"}},"required":["estimate","amount"],"type":"object","description":"The commission a developer would earn if this offer is placed.","uniqueKey":"oneOf.5.offer.commission","typeLabel":"object"},"appliedPromoCodes":{"items":{"type":"string","uniqueKey":"oneOf.5.offer.appliedPromoCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"oneOf.5.offer.appliedPromoCodes","typeLabel":"string[]"}},"required":["shipping","cost"],"type":"object","uniqueKey":"oneOf.5.offer","typeLabel":"object"}},"uniqueKey":"oneOf.5","typeLabel":"Failed · object"}],"uniqueKey":"","typeLabel":"Retrieving Offer · object | Awaiting Confirmation · object | Requires Action · object | Placing Order · object | Completed · object | Failed · object"},"examples":{"Example":{"title":"Example","value":{"buyer":{"postalCode":"10001","country":"US","province":"NY","city":"New York","address1":"123 Main St","phone":"1234567890","email":"john.doe@example.com","lastName":"Doe","firstName":"John","address2":"Apt 1"},"quantity":1,"productUrl":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","id":"\u003cstring>","state":"retrieving_offer","referenceId":"order-1234","discoverPromoCodes":true,"constraints":{"offerRetrievalEffort":"max","maxShippingPrice":500,"maxTotalPrice":100000},"promoCodes":["SAVE20"],"variantSelections":[{"value":"Small, Red, XS, L, etc.","label":"Size, Color, etc."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"efc598a0-c041-476d-89ae-4fe388b23ef1":{"description":"Authentication Failed","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"stack":{"type":"string","uniqueKey":"stack","typeLabel":"string"}},"required":["name","message"],"type":"object","additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","message":"\u003cstring>","stack":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"550a365c-e584-4bbb-b0fc-87b7bb612ddd":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"number","format":"double","isRequired":true,"uniqueKey":"status","typeLabel":"number\u003cdouble>"},"fields":{"properties":{},"type":"object","additionalProperties":{"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"fields.additionalProperties.message","typeLabel":"string"},"value":{"oneOf":[{}],"uniqueKey":"fields.additionalProperties.value","typeLabel":"any"}},"required":["message"],"type":"object","uniqueKey":"fields.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"fields","typeLabel":"object"},"stack":{"type":"string","uniqueKey":"stack","typeLabel":"string"}},"required":["name","message","status","fields"],"type":"object","additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","message":"\u003cstring>","status":123,"fields":{},"stack":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"69881233-9df5-4e20-bf08-4291c005f600":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"stack":{"type":"string","uniqueKey":"stack","typeLabel":"string"}},"required":["name","message"],"type":"object","additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","message":"\u003cstring>","stack":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1281cad6-bb93-4d8b-862d-31b0909250aa":{"description":"Service Unavailable","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"stack":{"type":"string","uniqueKey":"stack","typeLabel":"string"}},"required":["name","message"],"type":"object","additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","message":"\u003cstring>","stack":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5444a21f-bfa7-4f6a-ac99-2ab486e8c3c5":{"bearerAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Rye API key","scopes":["checkout_intents:write"],"schemeName":"bearerAuth"}}},"servers":{"99c05a2f-4820-44d6-8ed6-ae02cdc31ff1":{"url":"https://api.commerce.staging.jolly.dev"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Rye API key","scopes":["checkout_intents:write"],"schemeName":"bearerAuth"},"schema":{"title":"Authorization","type":"string","description":"Rye API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.documented.yml"},"subdomain":"jolly-commerce","siteName":"Rye","title":"Create checkout intent - Rye","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-12T14:38:10.687Z","originalFileLocation":"api-v2/api-reference/checkout-intents/create-checkout-intent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a checkout intent with the given request body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rye\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create checkout intent - Rye\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a checkout intent with the given request body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rye\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jolly-commerce.mintlify.app/_mintlify/api/og/v2?division=Checkout+Intents\u0026amp;title=Create+checkout+intent\u0026amp;description=Create+a+checkout+intent+with+the+given+request+body.\u0026amp;theme=2caa1a363738c32a16e79757\u0026amp;signature=b548b6d30e30273b6564c6cd1a32c95239794b289155fb80c1b536247aa2999b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create checkout intent - Rye\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a checkout intent with the given request body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jolly-commerce.mintlify.app/_mintlify/api/og/v2?division=Checkout+Intents\u0026amp;title=Create+checkout+intent\u0026amp;description=Create+a+checkout+intent+with+the+given+request+body.\u0026amp;theme=2caa1a363738c32a16e79757\u0026amp;signature=b548b6d30e30273b6564c6cd1a32c95239794b289155fb80c1b536247aa2999b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/jolly-commerce/JuKlhvW5GybgQh2j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rye\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8FA957\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-v2/api-reference/checkout-intents/create-checkout-intent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.commerce.jolly.dev/#organization\",\"name\":\"Rye\",\"url\":\"https://docs.commerce.jolly.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jolly-commerce/2QIqebHt5agkP3jl/logo/light.png?fit=max\u0026auto=format\u0026n=2QIqebHt5agkP3jl\u0026q=85\u0026s=2a4e22eb948fabaea0f01104b2df971e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.commerce.jolly.dev#website\",\"name\":\"Rye\",\"url\":\"https://docs.commerce.jolly.dev\",\"publisher\":{\"@id\":\"https://docs.commerce.jolly.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent#webpage\",\"url\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent\",\"name\":\"Create checkout intent\",\"description\":\"Create a checkout intent with the given request body.\",\"dateModified\":\"2026-10-12T14:38:10.687Z\",\"isPartOf\":{\"@id\":\"https://docs.commerce.jolly.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/billing/get-drawdown-balance\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkout Intents\",\"item\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/list-checkout-intents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create checkout intent\",\"item\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent#apireference\",\"headline\":\"Create checkout intent\",\"name\":\"Create checkout intent\",\"description\":\"Create a checkout intent with the given request body.\",\"url\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.commerce.jolly.dev/api-v2/api-reference/checkout-intents/create-checkout-intent#webpage\"},\"dateModified\":\"2026-10-12T14:38:10.687Z\",\"publisher\":{\"@id\":\"https://docs.commerce.jolly.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.commerce.jolly.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rye\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rye","nav":{"global":null,"tabs":[{"tab":"Universal Checkout API Documentation","groups":[{"group":"Universal Checkout API","pages":[{"title":"Rye API: Enable Your Users to Buy Any Product","sidebarTitle":"Introduction","href":"/api-v2/introduction"},{"group":"Quickstart","pages":[{"title":"Quickstart: Send an Order to Any Merchant","sidebarTitle":"Send an Order to Any Merchant","href":"/api-v2/example-flows/simple-checkout"},{"title":"Single Step Checkout","href":"/api-v2/example-flows/single-step-checkout"},{"title":"Build an AI chat storefront with Rye and Stripe in Next.js","sidebarTitle":"Chat Storefront","href":"/api-v2/example-flows/chat-storefront"},{"title":"Build an Ecommerce App with Lovable","sidebarTitle":"Lovable","href":"/api-v2/lovable-rye-tutorial"}]},{"group":"API Access \u0026 Environments","pages":[{"title":"Account Registration","sidebarTitle":"Account Registration","href":"/api-v2/account-registration"},{"title":"Authorization","href":"/api-v2/authorization"},{"title":"Environments","href":"/api-v2/environments"},{"title":"Rate Limits","href":"/api-v2/rate-limits"}]},{"group":"Guides","pages":[{"title":"API Comparison: Universal Checkout vs Sync","sidebarTitle":"API Comparison","href":"/api-v2/api-comparison"},{"title":"API Limitations","sidebarTitle":"API Limitations","href":"/api-v2/developer-notes"},{"title":"Submit Orders to Best Buy","sidebarTitle":"Best Buy","href":"/api-v2/best-buy"},{"title":"Checkout Intent Lifecycle","sidebarTitle":"Checkout Intent Lifecycle","href":"/api-v2/checkout-intent-lifecycle"},{"title":"Returns","sidebarTitle":"Returns","href":"/api-v2/returns"},{"title":"Go Live with Rye: Production Checklist","sidebarTitle":"Go Live","href":"/api-v2/go-live"},{"title":"Handling API Errors","sidebarTitle":"Handling API Errors","href":"/api-v2/errors"},{"title":"Promo Codes","href":"/api-v2/promo-codes"},{"title":"RyeBot Allowlisting","sidebarTitle":"RyeBot","href":"/api-v2/ryebot"},{"group":"Payment Providers","pages":[{"title":"Payment Providers","sidebarTitle":"Overview","href":"/api-v2/payment-providers"},{"title":"Basis Theory Elements","sidebarTitle":"Basis Theory","href":"/api-v2/payment-providers/basis-theory"},{"title":"Stripe","sidebarTitle":"Stripe","href":"/api-v2/payment-providers/stripe"},{"title":"Drawdown","sidebarTitle":"Drawdown","href":"/api-v2/payment-providers/drawdown"}]},{"title":"Variants","href":"/api-v2/variants"}]}]},{"group":"Tools","pages":[{"title":"Build with Rye Using AI","sidebarTitle":"Coding Agents","href":"/api-v2/llm-quickstart"},{"title":"SDKs","sidebarTitle":"SDKs","href":"/api-v2/sdk"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","url":"https://www.postman.com/rye-team/rye/collection/cwbmsqg/universal-checkout-api","href":"/api-v2/postman"}]},{"group":"Testing","pages":[{"title":"Create a Test Store","sidebarTitle":"Create a Test Store","href":"/api-v2/testing/with-shopify"},{"title":"Test Products","sidebarTitle":"Test Products","href":"/api-v2/testing/test-products"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Webhooks","href":"/api-v2/webhooks"},{"title":"Types of events","href":"/api-v2/webhooks/types"}]},{"group":"API Reference","pages":[{"group":"Billing","pages":[{"title":"Get drawdown balance","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/billing/balance","href":"/api-v2/api-reference/billing/get-drawdown-balance"},{"title":"Get billing info","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/billing","href":"/api-v2/api-reference/billing/get-billing-info"},{"title":"Setup drawdown billing","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/billing/drawdown","href":"/api-v2/api-reference/billing/setup-drawdown-billing"},{"title":"Create on-demand top-up invoice","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/billing/drawdown/topup","href":"/api-v2/api-reference/billing/create-on-demand-top-up-invoice"},{"title":"Cancel top-up invoice","deprecated":null,"version":null,"openapi":"/openapi.documented.yml delete /api/v1/billing/drawdown/topup/{invoiceId}","href":"/api-v2/api-reference/billing/cancel-top-up-invoice"},{"title":"List drawdown transactions","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/billing/transactions","href":"/api-v2/api-reference/billing/list-drawdown-transactions"}]},{"group":"Brands","pages":[{"title":"Retrieve brand","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/brands/domain/{domain}","href":"/api-v2/api-reference/brands/retrieve-brand"}]},{"group":"Checkout Intents","pages":[{"title":"List checkout intents","description":"Retrieve a paginated list of checkout intents\n\nEnables developers to query checkout intents associated with their account, with filters and cursor-based pagination.","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/checkout-intents","href":"/api-v2/api-reference/checkout-intents/list-checkout-intents"},{"title":"Create checkout intent","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/checkout-intents","href":"/api-v2/api-reference/checkout-intents/create-checkout-intent"},{"title":"Retrieve checkout intent","description":"Retrieve a checkout intent by id\n\nReturns checkout intent information if the lookup succeeds.","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/checkout-intents/{id}","href":"/api-v2/api-reference/checkout-intents/retrieve-checkout-intent"},{"title":"Retrieve order","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/checkout-intents/{id}/order","href":"/api-v2/api-reference/checkout-intents/retrieve-order"},{"title":"Confirm checkout intent","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/checkout-intents/{id}/confirm","href":"/api-v2/api-reference/checkout-intents/confirm-checkout-intent"},{"title":"List shipments for checkout intent","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/checkout-intents/{id}/shipments","href":"/api-v2/api-reference/checkout-intents/list-shipments-for-checkout-intent"},{"title":"Purchase product","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/checkout-intents/purchase","href":"/api-v2/api-reference/checkout-intents/purchase-product"}]},{"group":"Betas","pages":[{"title":"Create checkout session","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/betas/checkout-sessions","href":"/api-v2/api-reference/betas/create-checkout-session"}]},{"group":"Commissions","pages":[{"title":"Retrieve commission","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/commissions/{id}","href":"/api-v2/api-reference/commissions/retrieve-commission"},{"title":"List commissions","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/commissions","href":"/api-v2/api-reference/commissions/list-commissions"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/events","href":"/api-v2/api-reference/events/list-events"},{"title":"Retrieve event","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/events/{id}","href":"/api-v2/api-reference/events/retrieve-event"},{"title":"Trigger event","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/events/trigger","href":"/api-v2/api-reference/events/trigger-event"}]},{"group":"Merchant Connectors","pages":[{"title":"Create merchant connector installation link","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/merchant-connectors/{connector}/installation-link","href":"/api-v2/api-reference/merchant-connectors/create-merchant-connector-installation-link"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/orders","href":"/api-v2/api-reference/orders/list-orders"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/orders/{id}","href":"/api-v2/api-reference/orders/get-order"},{"title":"Update order buyer","deprecated":null,"version":null,"openapi":"/openapi.documented.yml put /api/v1/orders/{id}/buyer","href":"/api-v2/api-reference/orders/update-order-buyer"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/orders/{id}/cancel","href":"/api-v2/api-reference/orders/cancel-order"}]},{"group":"Payment Gateways","pages":[{"title":"Create payment gateway session","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/payment-gateways/{gateway}/session","href":"/api-v2/api-reference/payment-gateways/create-payment-gateway-session"}]},{"group":"Products","pages":[{"title":"Lookup product","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/products/lookup","href":"/api-v2/api-reference/products/lookup-product"},{"title":"List product subscriptions","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/products/subscriptions","href":"/api-v2/api-reference/products/list-product-subscriptions"},{"title":"Subscribe to product events","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/products/subscribe","href":"/api-v2/api-reference/products/subscribe-to-product-events"},{"title":"Unsubscribe from product events","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/products/unsubscribe","href":"/api-v2/api-reference/products/unsubscribe-from-product-events"}]},{"group":"Returns","pages":[{"title":"Create return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/returns","href":"/api-v2/api-reference/returns/create-return"},{"title":"Get return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/returns/{returnId}","href":"/api-v2/api-reference/returns/get-return"}]},{"group":"Shipments","pages":[{"title":"List shipments","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/shipments","href":"/api-v2/api-reference/shipments/list-shipments"},{"title":"Retrieve shipment by id","deprecated":null,"version":null,"openapi":"/openapi.documented.yml get /api/v1/shipments/{id}","href":"/api-v2/api-reference/shipments/retrieve-shipment-by-id"}]},{"group":"Test Helpers","pages":[{"title":"Advance simulated shipment","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance","href":"/api-v2/api-reference/test-helpers/advance-simulated-shipment"},{"title":"Create simulated return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/returns","href":"/api-v2/api-reference/test-helpers/create-simulated-return"},{"title":"Approve simulated return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/returns/{returnId}/approve","href":"/api-v2/api-reference/test-helpers/approve-simulated-return"},{"title":"Deny simulated return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/returns/{returnId}/deny","href":"/api-v2/api-reference/test-helpers/deny-simulated-return"},{"title":"Refund simulated return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/returns/{returnId}/refund","href":"/api-v2/api-reference/test-helpers/refund-simulated-return"},{"title":"Fail simulated return","deprecated":null,"version":null,"openapi":"/openapi.documented.yml post /api/v1/test-helpers/returns/{returnId}/fail","href":"/api-v2/api-reference/test-helpers/fail-simulated-return"}]}]},{"group":"Help","pages":[{"title":"Security","href":"/api-v2/security"},{"title":"Support","href":"/api-v2/support"},{"title":"Migrate from V1","href":"/api-v2/migrate-from-v1"},{"title":"Legacy Documentation","url":"https://docs-v1.rye.com","href":"/sync-api-docs"}]}]},{"tab":"Rewards SDK","pages":[{"title":"Rewards SDK","href":"/rewards/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/api-v2/changelog"}]},{"tab":"Rye Status","href":"https://ryestatus.com"}]},"title":"Create checkout intent - Rye","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}