One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook.
A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses.
If the odds stop selling before the payment settles, the pack isn’t opened at other odds: the order goes to refund_due and the customer is refunded.
Your API key (cb_live_…), sent as a bearer token, with the scope nft:orders. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a 403 with Access denied, whether or not it has a valid key. See Authentication and keys.
Scopes
nft:orders
Headers
Idempotency-Key
string
required
Your own order id, 8-128 characters of A-Za-z0-9_-, one per order. It becomes the order's order_id. Retry a timed-out or 500 call with the same key. The same key with a different request (pack_type, category, resolved odds, quantity, recipient, refund_address) is 422.
Pattern: ^[A-Za-z0-9_-]{8,128}$
Body
application/json
pack_type
string
required
A pack_type from List packs.
recipient
string
required
The customer's self-custody wallet on your mint chain. Never an exchange deposit address: the NFTs are minted to it.
category
enum<string>
default:pokemon
goods packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.
Available options:
pokemon,
onepiece,
sports,
riftbound,
watches,
goods
odds
enum<string>
One the pack sells. Default: the pack's default_odds.
Available options:
standard,
hot,
chill,
classic
quantity
integer
default:1
2 or more makes a multi-pack order.
Required range: 1 <= x <= 10
refund_address
string
An EVM wallet that can receive USDC on Base, for refunds. Required on a Solana program; defaults to recipient on an EVM program.
partner_user_ref
string
Your opaque user id. Never put personal data here. Not compared on an idempotent replay.
Pattern: ^[A-Za-z0-9_.:-]{1,128}$
Response
A replay of an earlier request with the same Idempotency-Key (idempotent_replay is true). Nothing new is created and nothing is charged twice.
order
object
required
A multi-pack order (quantity 2-10), paid with one payment.
Option 1
Option 2
Show child attributes
payment
object
required
A Unifold Payment Intent for exactly the amount due. Open it in your app with client_secret and publishable_key (Unifold's web or React Native SDK), or show deposit_addresses and amount. Paid once at least 99% has arrived. Payments.
Show child attributes
idempotent_replay
boolean
Present on a replay.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CatchBack Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/catchbackcards/t6yI8GaEaBqQQEpE/logo/catchback_logo_dark.png?fit=max\u0026auto=format\u0026n=t6yI8GaEaBqQQEpE\u0026q=85\u0026s=c0a46c19893e31a50cd0f4716d47686b","dark":"https://mintcdn.com/catchbackcards/t6yI8GaEaBqQQEpE/logo/catchback_logo_white.png?fit=max\u0026auto=format\u0026n=t6yI8GaEaBqQQEpE\u0026q=85\u0026s=e3c457633020dab4b98738040c7ae111"},"favicon":"https://mintcdn.com/catchbackcards/t6yI8GaEaBqQQEpE/logo/catchback_logo_dark.png?fit=max\u0026auto=format\u0026n=t6yI8GaEaBqQQEpE\u0026q=85\u0026s=c0a46c19893e31a50cd0f4716d47686b","api":{"playground":{"display":"simple"},"mdx":{"auth":{"method":"bearer"},"server":"https://catchbackcards.com"}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:support@catchbackcards.com","label":"Support"}],"primary":{"type":"button","label":"Launch App","href":"https://catchbackcards.com"}},"footer":{"socials":{"x":"https://x.com/catchback_cards","instagram":"https://www.instagram.com/catchback_cards","discord":"https://discord.gg/6WjMbRgPMq"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"CatchBack Website","icon":"globe","href":"https://catchbackcards.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"catchbackcards","hasAudioNarration":false,"actualSubdomain":"catchbackcards","customDomains":[],"gitSource":{"type":"github","owner":"josephhhzhanggg","repo":"catchback-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6afd1c63365759e98bf2eec9","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Partner API","count":47},{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Documentation","count":21},{"language":"default","tag":"Shipments","count":14},{"language":"default","tag":"Concepts","count":11},{"language":"default","tag":"Keys \u0026 revenue","count":8},{"language":"default","tag":"Features","count":7},{"language":"default","tag":"Resources","count":7},{"language":"default","tag":"Packs \u0026 orders","count":6},{"language":"default","tag":"Tokens \u0026 sell-back","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/orders/create-an-order","slug":"/api-reference/orders/create-an-order","pageMetadata":{"title":"Create an order","description":"**Rate limit:** 30 a minute.\n\nOne order buys 1-10 packs of one kind for one wallet, paid with one payment. `quantity` 2-10 makes a multi-pack order (`OrderBatch`): one payment for `quantity` × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the `nft_order.updated` webhook.\n\nA refused order creates nothing. A replay with the same `Idempotency-Key` and the same request answers `200` with `idempotent_replay: true` and the order as it stands now; once the order is past `awaiting_payment`, its `payment` has no `client_secret` and no deposit addresses.\n\nIf the odds stop selling before the payment settles, the pack isn't opened at other odds: the order goes to `refund_due` and the customer is refunded.","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/orders","href":"/api-reference/orders/create-an-order","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limit:\"\n }), \" 30 a minute.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"One order buys 1-10 packs of one kind for one wallet, paid with one payment. \", _jsx(_components.code, {\n children: \"quantity\"\n }), \" 2-10 makes a multi-pack order (\", _jsx(_components.code, {\n children: \"OrderBatch\"\n }), \"): one payment for \", _jsx(_components.code, {\n children: \"quantity\"\n }), \" × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the \", _jsx(_components.code, {\n children: \"nft_order.updated\"\n }), \" webhook.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A refused order creates nothing. A replay with the same \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" and the same request answers \", _jsx(_components.code, {\n children: \"200\"\n }), \" with \", _jsx(_components.code, {\n children: \"idempotent_replay: true\"\n }), \" and the order as it stands now; once the order is past \", _jsx(_components.code, {\n children: \"awaiting_payment\"\n }), \", its \", _jsx(_components.code, {\n children: \"payment\"\n }), \" has no \", _jsx(_components.code, {\n children: \"client_secret\"\n }), \" and no deposit addresses.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the odds stop selling before the payment settles, the pack isn’t opened at other odds: the order goes to \", _jsx(_components.code, {\n children: \"refund_due\"\n }), \" and the customer is refunded.\"]\n })]\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 an order","description":"**Rate limit:** 30 a minute.\n\nOne order buys 1-10 packs of one kind for one wallet, paid with one payment. `quantity` 2-10 makes a multi-pack order (`OrderBatch`): one payment for `quantity` × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the `nft_order.updated` webhook.\n\nA refused order creates nothing. A replay with the same `Idempotency-Key` and the same request answers `200` with `idempotent_replay: true` and the order as it stands now; once the order is past `awaiting_payment`, its `payment` has no `client_secret` and no deposit addresses.\n\nIf the odds stop selling before the payment settles, the pack isn't opened at other odds: the order goes to `refund_due` and the customer is refunded.","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/orders","href":"/api-reference/orders/create-an-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Orders"],"operationId":"createOrder","summary":"Create an order","description":"**Rate limit:** 30 a minute.\n\nOne order buys 1-10 packs of one kind for one wallet, paid with one payment. `quantity` 2-10 makes a multi-pack order (`OrderBatch`): one payment for `quantity` × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the `nft_order.updated` webhook.\n\nA refused order creates nothing. A replay with the same `Idempotency-Key` and the same request answers `200` with `idempotent_replay: true` and the order as it stands now; once the order is past `awaiting_payment`, its `payment` has no `client_secret` and no deposit addresses.\n\nIf the odds stop selling before the payment settles, the pack isn't opened at other odds: the order goes to `refund_due` and the customer is refunded.","parameters":["6ab4eb57-6c37-41e0-8fc0-687fa0809dda"],"requestBody":"330ef36d-5734-4073-9e88-4fc164c92d9b","responses":{"200":"ed8bc0e4-48d6-4929-a8bd-55c9c192bfcf","201":"ed6483cd-46e0-4450-8bc9-2991398850bd","400":"cf956e30-95a2-4b08-bdce-a95590b6d135","401":"8200be07-0110-4d74-aba3-729ba4b223d1","403":"b9d04d12-bb7c-4e71-afc6-0ac5cd814657","404":"1a608c88-d1f6-4cd7-874d-702a4406cad1","409":"390dea4e-23bd-4d03-b236-7f60f1d0fa57","422":"def193fd-f5cd-4f17-9014-1e9194396def","429":"e5802be3-3f23-416b-8b8d-e4626c2a7978","500":"d00f2a00-d0cf-45f2-8124-ddce858d4a98","503":"45ca3ec9-5935-4945-8647-33eb9f219ca9"},"method":"post","type":"path","servers":["ed38223c-7284-4c4c-a036-024a32e33c56"],"security":["5d417d19-47d3-4b3c-a84b-120ca58d807f"],"path":"/api/partner/v2/orders","baseUrlOptions":["https://catchbackcards.com"],"title":"Create an order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6ab4eb57-6c37-41e0-8fc0-687fa0809dda":{"name":"Idempotency-Key","in":"header","required":true,"description":"Your own order id, 8-128 characters of `A-Za-z0-9_-`, one per order. It becomes the order's `order_id`. Retry a timed-out or `500` call with the same key. The same key with a different request (`pack_type`, `category`, resolved `odds`, `quantity`, `recipient`, `refund_address`) is `422`.","schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,128}$","isRequired":true,"description":"Your own order id, 8-128 characters of `A-Za-z0-9_-`, one per order. It becomes the order's `order_id`. Retry a timed-out or `500` call with the same key. The same key with a different request (`pack_type`, `category`, resolved `odds`, `quantity`, `recipient`, `refund_address`) is `422`.","uniqueKey":"","typeLabel":"string"},"example":"okx-ord-7f3a9c21"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pack_type","recipient"],"properties":{"pack_type":{"type":"string","description":"A `pack_type` from List packs.","isRequired":true,"uniqueKey":"pack_type","typeLabel":"string"},"recipient":{"type":"string","description":"The customer's self-custody wallet on your mint chain. Never an exchange deposit address: the NFTs are minted to it.","isRequired":true,"uniqueKey":"recipient","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","uniqueKey":"category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","description":"One the pack sells. Default: the pack's `default_odds`.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds","typeLabel":"enum\u003cstring>"},"quantity":{"type":"integer","minimum":1,"maximum":10,"default":1,"description":"2 or more makes a multi-pack order.","uniqueKey":"quantity","typeLabel":"integer"},"refund_address":{"type":"string","description":"An EVM wallet that can receive USDC on Base, for refunds. Required on a Solana program; defaults to `recipient` on an EVM program.","uniqueKey":"refund_address","typeLabel":"string"},"partner_user_ref":{"type":"string","pattern":"^[A-Za-z0-9_.:-]{1,128}$","description":"Your opaque user id. Never put personal data here. Not compared on an idempotent replay.","uniqueKey":"partner_user_ref","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"pack_type":"bronze","category":"pokemon","odds":"standard","quantity":1,"recipient":"0x8f3c...e21a","refund_address":"0x8f3c...e21a","partner_user_ref":"okx-uid-102938"},"examples":{"Example":{"title":"Example","value":{"pack_type":"bronze","category":"pokemon","odds":"standard","quantity":1,"recipient":"0x8f3c...e21a","refund_address":"0x8f3c...e21a","partner_user_ref":"okx-uid-102938"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"ed8bc0e4-48d6-4929-a8bd-55c9c192bfcf":{"description":"A replay of an earlier request with the same `Idempotency-Key` (`idempotent_replay` is true). Nothing new is created and nothing is charged twice.","content":{"application/json":{"schema":{"type":"object","required":["order","payment"],"properties":{"order":{"oneOf":[{"type":"object","description":"A multi-pack order (`quantity` 2-10), paid with one payment.","required":["order_id","id","status","quantity","pack_type","category","odds","unit_price","price","recipient","mint_chain","paid_at","units","created_at"],"properties":{"order_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"order.oneOf.0.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded","processing","completed"],"description":"`awaiting_payment` until paid; once paid, the units' status when they all agree; otherwise `processing` while any unit is still moving, and `completed` once every unit is final.","isRequired":true,"uniqueKey":"order.oneOf.0.status","typeLabel":"enum\u003cstring>"},"quantity":{"type":"integer","minimum":2,"maximum":10,"isRequired":true,"uniqueKey":"order.oneOf.0.quantity","typeLabel":"integer"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.0.odds","typeLabel":"enum\u003cstring>"},"unit_price":{"type":"number","description":"The price of one pack.","isRequired":true,"uniqueKey":"order.oneOf.0.unit_price","typeLabel":"number"},"price":{"type":"number","description":"The total due.","isRequired":true,"uniqueKey":"order.oneOf.0.price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.paid_at","typeLabel":"string\u003cdate-time> | null"},"units":{"type":"array","items":{"type":"object","description":"One pack of a multi-pack order, in the single-order shape under the order's `order_id`.","required":["batch_id","unit","order_id","id","status","pack_type","category","odds","price","recipient","mint_chain","paid_at","pull","token","failure_reason","created_at"],"properties":{"order_id":{"type":"string","description":"Your `Idempotency-Key`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Our id.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded"],"description":"- `awaiting_payment`: waiting for the payment, for up to 24 hours.\n- `expired`: not paid within 24 hours. A payment that still arrives is refunded in full.\n- `paid`: settled; the pack opens next.\n- `rolled`: the pack opened (`pull` is set); the NFT is being minted.\n- `minted` (final): the NFT is in `recipient`'s wallet.\n- `mint_failed`: the mint hasn't landed yet; it is retried and never re-opens the pack.\n- `refund_due`: being refunded in USDC on Base to `refund_address`; `failure_reason` says why (e.g. `paid_after_expiry`, `underpaid`).\n- `refunded` (final): the refund was sent.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].odds","typeLabel":"enum\u003cstring>"},"price":{"type":"number","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at","typeLabel":"string\u003cdate-time> | null"},"pull":{"oneOf":[{"type":"object","required":["card_id","category","name","value","pulled_at"],"properties":{"card_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.card_id","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.category","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name","typeLabel":"string | null"},"value":{"type":"number","description":"The item's value when it was pulled; it anchors the sell-back offer.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.value","typeLabel":"number"},"pulled_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.pulled_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull","typeLabel":"object | null"},"token":{"oneOf":[{"type":"object","description":"The NFT. On an EVM program it has `contract`; on a Solana program `collection` and `asset` instead.","required":["chain","token_id","status","tx"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.chain","typeLabel":"string"},"token_id":{"oneOf":[{"type":"string","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","submitted","confirmed","failed","burned"],"description":"`pending` (reserved, not sent), `submitted`, `confirmed`, `failed` (being retried), or `burned` once sold back or shipped.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.status","typeLabel":"enum\u003cstring>"},"tx":{"oneOf":[{"type":"string","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx.oneOf.0","typeLabel":"string"},{"type":"null","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx","typeLabel":"string | null"},"contract":{"oneOf":[{"type":"string","description":"EVM only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract.oneOf.0","typeLabel":"string"},{"type":"null","description":"EVM only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract","typeLabel":"string | null"},"collection":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection","typeLabel":"string | null"},"asset":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token","typeLabel":"object | null"},"failure_reason":{"oneOf":[{"type":"string","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"batch_id":{"type":"string","format":"uuid","description":"The multi-pack order's `id`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].batch_id","typeLabel":"string\u003cuuid>"},"unit":{"oneOf":[{"type":"integer","minimum":1,"maximum":10,"description":"1 to `quantity`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":10,"description":"1 to `quantity`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit","typeLabel":"integer | null"}},"uniqueKey":"order.oneOf.0.units.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.oneOf.0.units","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.0","typeLabel":"object"},{"type":"object","description":"One single-pack order.","required":["order_id","id","status","pack_type","category","odds","price","recipient","mint_chain","paid_at","pull","token","failure_reason","created_at"],"properties":{"order_id":{"type":"string","description":"Your `Idempotency-Key`.","isRequired":true,"uniqueKey":"order.oneOf.1.order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Our id.","isRequired":true,"uniqueKey":"order.oneOf.1.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded"],"description":"- `awaiting_payment`: waiting for the payment, for up to 24 hours.\n- `expired`: not paid within 24 hours. A payment that still arrives is refunded in full.\n- `paid`: settled; the pack opens next.\n- `rolled`: the pack opened (`pull` is set); the NFT is being minted.\n- `minted` (final): the NFT is in `recipient`'s wallet.\n- `mint_failed`: the mint hasn't landed yet; it is retried and never re-opens the pack.\n- `refund_due`: being refunded in USDC on Base to `refund_address`; `failure_reason` says why (e.g. `paid_after_expiry`, `underpaid`).\n- `refunded` (final): the refund was sent.","isRequired":true,"uniqueKey":"order.oneOf.1.status","typeLabel":"enum\u003cstring>"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.1.category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.1.odds","typeLabel":"enum\u003cstring>"},"price":{"type":"number","isRequired":true,"uniqueKey":"order.oneOf.1.price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.1.mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.paid_at","typeLabel":"string\u003cdate-time> | null"},"pull":{"oneOf":[{"type":"object","required":["card_id","category","name","value","pulled_at"],"properties":{"card_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.card_id","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.category","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name","typeLabel":"string | null"},"value":{"type":"number","description":"The item's value when it was pulled; it anchors the sell-back offer.","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.value","typeLabel":"number"},"pulled_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.pulled_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.pull","typeLabel":"object | null"},"token":{"oneOf":[{"type":"object","description":"The NFT. On an EVM program it has `contract`; on a Solana program `collection` and `asset` instead.","required":["chain","token_id","status","tx"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.chain","typeLabel":"string"},"token_id":{"oneOf":[{"type":"string","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","submitted","confirmed","failed","burned"],"description":"`pending` (reserved, not sent), `submitted`, `confirmed`, `failed` (being retried), or `burned` once sold back or shipped.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.status","typeLabel":"enum\u003cstring>"},"tx":{"oneOf":[{"type":"string","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx.oneOf.0","typeLabel":"string"},{"type":"null","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx","typeLabel":"string | null"},"contract":{"oneOf":[{"type":"string","description":"EVM only.","uniqueKey":"order.oneOf.1.token.oneOf.0.contract.oneOf.0","typeLabel":"string"},{"type":"null","description":"EVM only.","uniqueKey":"order.oneOf.1.token.oneOf.0.contract.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.contract","typeLabel":"string | null"},"collection":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.collection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.collection.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.collection","typeLabel":"string | null"},"asset":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.asset.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.asset","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token","typeLabel":"object | null"},"failure_reason":{"oneOf":[{"type":"string","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"payment":{"type":"object","description":"A Unifold Payment Intent for exactly the amount due. Open it in your app with `client_secret` and `publishable_key` (Unifold's web or React Native SDK), or show `deposit_addresses` and `amount`. Paid once at least 99% has arrived. [Payments](/partner-api/v2/payments).","required":["intent_id","client_secret","publishable_key","amount","deposit_addresses"],"properties":{"intent_id":{"oneOf":[{"type":"string","description":"The Payment Intent's id (`sbx_pi_…` in the sandbox).","isRequired":true,"uniqueKey":"payment.intent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Payment Intent's id (`sbx_pi_…` in the sandbox).","isRequired":true,"uniqueKey":"payment.intent_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.intent_id","typeLabel":"string | null"},"client_secret":{"oneOf":[{"type":"string","description":"Opens Unifold's checkout. Null once there is nothing left to pay.","isRequired":true,"uniqueKey":"payment.client_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opens Unifold's checkout. Null once there is nothing left to pay.","isRequired":true,"uniqueKey":"payment.client_secret.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.client_secret","typeLabel":"string | null"},"publishable_key":{"oneOf":[{"type":"string","description":"The public Unifold key to initialise the SDK with.","isRequired":true,"uniqueKey":"payment.publishable_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public Unifold key to initialise the SDK with.","isRequired":true,"uniqueKey":"payment.publishable_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.publishable_key","typeLabel":"string | null"},"amount":{"type":"number","description":"The amount due in USD (a multi-pack order's total).","isRequired":true,"uniqueKey":"payment.amount","typeLabel":"number"},"deposit_addresses":{"type":"array","description":"Addresses the customer can send to directly, on Base and Solana. Empty once there is nothing left to pay. Never reuse one for another order.","items":{"type":"object","required":["chain","address"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"payment.deposit_addresses.items.[INDEX].chain","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"payment.deposit_addresses.items.[INDEX].address","typeLabel":"string"}},"uniqueKey":"payment.deposit_addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payment.deposit_addresses","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"},"idempotent_replay":{"type":"boolean","const":true,"description":"Present on a replay.","uniqueKey":"idempotent_replay","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"order":{"order_id":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"awaiting_payment","quantity":6,"pack_type":"\u003cstring>","category":"pokemon","odds":"standard","unit_price":123,"price":123,"recipient":"\u003cstring>","mint_chain":"evm:196","paid_at":"2023-11-07T05:31:56Z","units":[{"order_id":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"awaiting_payment","pack_type":"\u003cstring>","category":"pokemon","odds":"standard","price":123,"recipient":"\u003cstring>","mint_chain":"evm:196","paid_at":"2023-11-07T05:31:56Z","pull":{"card_id":"\u003cstring>","category":"pokemon","name":"\u003cstring>","value":123,"pulled_at":"2023-11-07T05:31:56Z"},"token":{"chain":"evm:196","token_id":"\u003cstring>","status":"pending","tx":"\u003cstring>","contract":"\u003cstring>","collection":"\u003cstring>","asset":"\u003cstring>"},"failure_reason":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","batch_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","unit":5}],"created_at":"2023-11-07T05:31:56Z"},"payment":{"intent_id":"\u003cstring>","client_secret":"\u003cstring>","publishable_key":"\u003cstring>","amount":123,"deposit_addresses":[{"chain":"evm:196","address":"\u003cstring>"}]},"idempotent_replay":true}}},"exampleType":"generated"}},"exampleType":"generated"},"ed6483cd-46e0-4450-8bc9-2991398850bd":{"description":"The order and how to pay it.","content":{"application/json":{"schema":{"type":"object","required":["order","payment"],"properties":{"order":{"oneOf":[{"type":"object","description":"A multi-pack order (`quantity` 2-10), paid with one payment.","required":["order_id","id","status","quantity","pack_type","category","odds","unit_price","price","recipient","mint_chain","paid_at","units","created_at"],"properties":{"order_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"order.oneOf.0.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded","processing","completed"],"description":"`awaiting_payment` until paid; once paid, the units' status when they all agree; otherwise `processing` while any unit is still moving, and `completed` once every unit is final.","isRequired":true,"uniqueKey":"order.oneOf.0.status","typeLabel":"enum\u003cstring>"},"quantity":{"type":"integer","minimum":2,"maximum":10,"isRequired":true,"uniqueKey":"order.oneOf.0.quantity","typeLabel":"integer"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.0.odds","typeLabel":"enum\u003cstring>"},"unit_price":{"type":"number","description":"The price of one pack.","isRequired":true,"uniqueKey":"order.oneOf.0.unit_price","typeLabel":"number"},"price":{"type":"number","description":"The total due.","isRequired":true,"uniqueKey":"order.oneOf.0.price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.paid_at","typeLabel":"string\u003cdate-time> | null"},"units":{"type":"array","items":{"type":"object","description":"One pack of a multi-pack order, in the single-order shape under the order's `order_id`.","required":["batch_id","unit","order_id","id","status","pack_type","category","odds","price","recipient","mint_chain","paid_at","pull","token","failure_reason","created_at"],"properties":{"order_id":{"type":"string","description":"Your `Idempotency-Key`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Our id.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded"],"description":"- `awaiting_payment`: waiting for the payment, for up to 24 hours.\n- `expired`: not paid within 24 hours. A payment that still arrives is refunded in full.\n- `paid`: settled; the pack opens next.\n- `rolled`: the pack opened (`pull` is set); the NFT is being minted.\n- `minted` (final): the NFT is in `recipient`'s wallet.\n- `mint_failed`: the mint hasn't landed yet; it is retried and never re-opens the pack.\n- `refund_due`: being refunded in USDC on Base to `refund_address`; `failure_reason` says why (e.g. `paid_after_expiry`, `underpaid`).\n- `refunded` (final): the refund was sent.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].odds","typeLabel":"enum\u003cstring>"},"price":{"type":"number","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].paid_at","typeLabel":"string\u003cdate-time> | null"},"pull":{"oneOf":[{"type":"object","required":["card_id","category","name","value","pulled_at"],"properties":{"card_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.card_id","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.category","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.name","typeLabel":"string | null"},"value":{"type":"number","description":"The item's value when it was pulled; it anchors the sell-back offer.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.value","typeLabel":"number"},"pulled_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0.pulled_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].pull","typeLabel":"object | null"},"token":{"oneOf":[{"type":"object","description":"The NFT. On an EVM program it has `contract`; on a Solana program `collection` and `asset` instead.","required":["chain","token_id","status","tx"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.chain","typeLabel":"string"},"token_id":{"oneOf":[{"type":"string","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.token_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","submitted","confirmed","failed","burned"],"description":"`pending` (reserved, not sent), `submitted`, `confirmed`, `failed` (being retried), or `burned` once sold back or shipped.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.status","typeLabel":"enum\u003cstring>"},"tx":{"oneOf":[{"type":"string","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx.oneOf.0","typeLabel":"string"},{"type":"null","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.tx","typeLabel":"string | null"},"contract":{"oneOf":[{"type":"string","description":"EVM only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract.oneOf.0","typeLabel":"string"},{"type":"null","description":"EVM only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.contract","typeLabel":"string | null"},"collection":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.collection","typeLabel":"string | null"},"asset":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0.asset","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].token","typeLabel":"object | null"},"failure_reason":{"oneOf":[{"type":"string","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].failure_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"batch_id":{"type":"string","format":"uuid","description":"The multi-pack order's `id`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].batch_id","typeLabel":"string\u003cuuid>"},"unit":{"oneOf":[{"type":"integer","minimum":1,"maximum":10,"description":"1 to `quantity`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":10,"description":"1 to `quantity`.","isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.0.units.items.[INDEX].unit","typeLabel":"integer | null"}},"uniqueKey":"order.oneOf.0.units.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.oneOf.0.units","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.0","typeLabel":"object"},{"type":"object","description":"One single-pack order.","required":["order_id","id","status","pack_type","category","odds","price","recipient","mint_chain","paid_at","pull","token","failure_reason","created_at"],"properties":{"order_id":{"type":"string","description":"Your `Idempotency-Key`.","isRequired":true,"uniqueKey":"order.oneOf.1.order_id","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Our id.","isRequired":true,"uniqueKey":"order.oneOf.1.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["awaiting_payment","paid","rolled","minted","mint_failed","expired","refund_due","refunded"],"description":"- `awaiting_payment`: waiting for the payment, for up to 24 hours.\n- `expired`: not paid within 24 hours. A payment that still arrives is refunded in full.\n- `paid`: settled; the pack opens next.\n- `rolled`: the pack opened (`pull` is set); the NFT is being minted.\n- `minted` (final): the NFT is in `recipient`'s wallet.\n- `mint_failed`: the mint hasn't landed yet; it is retried and never re-opens the pack.\n- `refund_due`: being refunded in USDC on Base to `refund_address`; `failure_reason` says why (e.g. `paid_after_expiry`, `underpaid`).\n- `refunded` (final): the refund was sent.","isRequired":true,"uniqueKey":"order.oneOf.1.status","typeLabel":"enum\u003cstring>"},"pack_type":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pack_type","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.1.category","typeLabel":"enum\u003cstring>"},"odds":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","isRequired":true,"uniqueKey":"order.oneOf.1.odds","typeLabel":"enum\u003cstring>"},"price":{"type":"number","isRequired":true,"uniqueKey":"order.oneOf.1.price","typeLabel":"number"},"recipient":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.recipient","typeLabel":"string"},"mint_chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.1.mint_chain","typeLabel":"string"},"paid_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.paid_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.paid_at","typeLabel":"string\u003cdate-time> | null"},"pull":{"oneOf":[{"type":"object","required":["card_id","category","name","value","pulled_at"],"properties":{"card_id":{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.card_id","typeLabel":"string"},"category":{"type":"string","enum":["pokemon","onepiece","sports","riftbound","watches","goods"],"default":"pokemon","description":"`goods` packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.category","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.name","typeLabel":"string | null"},"value":{"type":"number","description":"The item's value when it was pulled; it anchors the sell-back offer.","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.value","typeLabel":"number"},"pulled_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0.pulled_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.pull.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.pull","typeLabel":"object | null"},"token":{"oneOf":[{"type":"object","description":"The NFT. On an EVM program it has `contract`; on a Solana program `collection` and `asset` instead.","required":["chain","token_id","status","tx"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.chain","typeLabel":"string"},"token_id":{"oneOf":[{"type":"string","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Decimal. Keep it as a string or bigint.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.token_id","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","submitted","confirmed","failed","burned"],"description":"`pending` (reserved, not sent), `submitted`, `confirmed`, `failed` (being retried), or `burned` once sold back or shipped.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.status","typeLabel":"enum\u003cstring>"},"tx":{"oneOf":[{"type":"string","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx.oneOf.0","typeLabel":"string"},{"type":"null","description":"The mint transaction.","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0.tx","typeLabel":"string | null"},"contract":{"oneOf":[{"type":"string","description":"EVM only.","uniqueKey":"order.oneOf.1.token.oneOf.0.contract.oneOf.0","typeLabel":"string"},{"type":"null","description":"EVM only.","uniqueKey":"order.oneOf.1.token.oneOf.0.contract.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.contract","typeLabel":"string | null"},"collection":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.collection.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.collection.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.collection","typeLabel":"string | null"},"asset":{"oneOf":[{"type":"string","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.asset.oneOf.0","typeLabel":"string"},{"type":"null","description":"Solana only.","uniqueKey":"order.oneOf.1.token.oneOf.0.asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.1.token.oneOf.0.asset","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"order.oneOf.1.token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.token","typeLabel":"object | null"},"failure_reason":{"oneOf":[{"type":"string","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `mint_failed`, `expired`, `refund_due` and `refunded`: why.","isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"order.oneOf.1.failure_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"order.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"order.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"payment":{"type":"object","description":"A Unifold Payment Intent for exactly the amount due. Open it in your app with `client_secret` and `publishable_key` (Unifold's web or React Native SDK), or show `deposit_addresses` and `amount`. Paid once at least 99% has arrived. [Payments](/partner-api/v2/payments).","required":["intent_id","client_secret","publishable_key","amount","deposit_addresses"],"properties":{"intent_id":{"oneOf":[{"type":"string","description":"The Payment Intent's id (`sbx_pi_…` in the sandbox).","isRequired":true,"uniqueKey":"payment.intent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Payment Intent's id (`sbx_pi_…` in the sandbox).","isRequired":true,"uniqueKey":"payment.intent_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.intent_id","typeLabel":"string | null"},"client_secret":{"oneOf":[{"type":"string","description":"Opens Unifold's checkout. Null once there is nothing left to pay.","isRequired":true,"uniqueKey":"payment.client_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"Opens Unifold's checkout. Null once there is nothing left to pay.","isRequired":true,"uniqueKey":"payment.client_secret.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.client_secret","typeLabel":"string | null"},"publishable_key":{"oneOf":[{"type":"string","description":"The public Unifold key to initialise the SDK with.","isRequired":true,"uniqueKey":"payment.publishable_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public Unifold key to initialise the SDK with.","isRequired":true,"uniqueKey":"payment.publishable_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment.publishable_key","typeLabel":"string | null"},"amount":{"type":"number","description":"The amount due in USD (a multi-pack order's total).","isRequired":true,"uniqueKey":"payment.amount","typeLabel":"number"},"deposit_addresses":{"type":"array","description":"Addresses the customer can send to directly, on Base and Solana. Empty once there is nothing left to pay. Never reuse one for another order.","items":{"type":"object","required":["chain","address"],"properties":{"chain":{"type":"string","description":"A chain as `\u003cfamily>:\u003cid>`: `evm:8453` is Base, `evm:\u003cchainId>` any other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The sandbox uses a public testnet.","pattern":"^(evm:[0-9]+|solana:(mainnet|devnet))$","examples":["evm:196"],"isRequired":true,"uniqueKey":"payment.deposit_addresses.items.[INDEX].chain","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"payment.deposit_addresses.items.[INDEX].address","typeLabel":"string"}},"uniqueKey":"payment.deposit_addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payment.deposit_addresses","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"},"idempotent_replay":{"type":"boolean","const":true,"description":"Present on a replay.","uniqueKey":"idempotent_replay","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"single":{"title":"single","summary":"One pack","value":{"order":{"order_id":"okx-ord-7f3a9c21","id":"3d2b8f0e-6c1a-4f7e-9a51-2b0d8c4e7f13","status":"awaiting_payment","pack_type":"bronze","category":"pokemon","odds":"standard","price":25,"recipient":"0x8f3c...e21a","mint_chain":"evm:196","paid_at":null,"pull":null,"token":null,"failure_reason":null,"created_at":"2026-11-16T18:02:11.420Z"},"payment":{"intent_id":"pi_01JD...","client_secret":"pi_01JD..._secret_...","publishable_key":"pk_live_...","amount":25,"deposit_addresses":[{"chain":"evm:8453","address":"0x5a4d...0001"},{"chain":"solana:mainnet","address":"9xQe...Vf2p"}]}}},"multi":{"title":"multi","summary":"Three packs","value":{"order":{"order_id":"okx-ord-9b21e4c0","id":"5f1c2a90-8d3e-4b6a-9e1f-7c0a2b4d6e81","status":"awaiting_payment","quantity":3,"pack_type":"bronze","category":"pokemon","odds":"standard","unit_price":25,"price":75,"recipient":"0x8f3c...e21a","mint_chain":"evm:196","paid_at":null,"units":[{"order_id":"okx-ord-9b21e4c0","id":"a0e1c3d5-2b4f-4e6a-8c1d-3f5a7b9c1e20","batch_id":"5f1c2a90-8d3e-4b6a-9e1f-7c0a2b4d6e81","unit":1,"status":"awaiting_payment","pack_type":"bronze","category":"pokemon","odds":"standard","price":25,"recipient":"0x8f3c...e21a","mint_chain":"evm:196","paid_at":null,"pull":null,"token":null,"failure_reason":null,"created_at":"2026-11-16T18:02:11.420Z"},{"order_id":"okx-ord-9b21e4c0","id":"b7d2e4f6-3c5a-4f7b-9d2e-4a6b8c0d2f31","batch_id":"5f1c2a90-8d3e-4b6a-9e1f-7c0a2b4d6e81","unit":2,"status":"awaiting_payment","pack_type":"bronze","category":"pokemon","odds":"standard","price":25,"recipient":"0x8f3c...e21a","mint_chain":"evm:196","paid_at":null,"pull":null,"token":null,"failure_reason":null,"created_at":"2026-11-16T18:02:11.420Z"},{"order_id":"okx-ord-9b21e4c0","id":"c4f9a1b3-4d6e-4a8c-8e3f-5b7c9d1e3a42","batch_id":"5f1c2a90-8d3e-4b6a-9e1f-7c0a2b4d6e81","unit":3,"status":"awaiting_payment","pack_type":"bronze","category":"pokemon","odds":"standard","price":25,"recipient":"0x8f3c...e21a","mint_chain":"evm:196","paid_at":null,"pull":null,"token":null,"failure_reason":null,"created_at":"2026-11-16T18:02:11.420Z"}],"created_at":"2026-11-16T18:02:11.420Z"},"payment":{"intent_id":"pi_01JD...","client_secret":"pi_01JD..._secret_...","publishable_key":"pk_live_...","amount":75,"deposit_addresses":[{"chain":"evm:8453","address":"0x5a4d...0001"},{"chain":"solana:mainnet","address":"9xQe...Vf2p"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"cf956e30-95a2-4b08-bdce-a95590b6d135":{"description":"- `BAD_IDEMPOTENCY_KEY`: `Idempotency-Key` missing, or not 8-128 characters of `A-Za-z0-9_-`.\n- `BAD_JSON`: the body isn't JSON.\n- `BAD_RECIPIENT`: `recipient` is not a wallet address on your mint chain.\n- `BAD_PACK`: `pack_type` missing.\n- `BAD_CATEGORY`: unknown `category`.\n- `BAD_ODDS`: `odds` isn't `standard`, `hot`, `chill` or `classic`, or not one the pack sells (then `odds` lists the choices it sells).\n- `BAD_QUANTITY`: `quantity` isn't a whole number from 1 to 10.\n- `BAD_REFUND_ADDRESS`: no usable EVM `refund_address` (required when you mint on Solana).","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"recipient must be a evm:196 wallet address","code":"BAD_RECIPIENT"},"examples":{"Example":{"title":"Example","value":{"error":"recipient must be a evm:196 wallet address","code":"BAD_RECIPIENT"}}},"exampleType":"examples"}},"exampleType":"examples"},"8200be07-0110-4d74-aba3-729ba4b223d1":{"description":"- `Missing or malformed API key`: no `Bearer cb_live_…` header.\n- `Invalid API key`: unknown or disabled, or a rotated key past its 24 hours.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Missing or malformed API key"},"examples":{"Example":{"title":"Example","value":{"error":"Missing or malformed API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"b9d04d12-bb7c-4e71-afc6-0ac5cd814657":{"description":"- `WALLET_REFUSED`: a wallet in the request failed sanctions screening.\n- `WALLET_BLOCKED`: this wallet may not buy from CatchBack.\n- Any of the key and program refusals every endpoint can return (`NO_PROGRAM`, `PROGRAM_INACTIVE`, `NOT_AVAILABLE`, a missing scope, `Access denied`).","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"This wallet cannot buy here.","code":"WALLET_REFUSED"},"examples":{"Example":{"title":"Example","value":{"error":"This wallet cannot buy here.","code":"WALLET_REFUSED"}}},"exampleType":"examples"}},"exampleType":"examples"},"1a608c88-d1f6-4cd7-874d-702a4406cad1":{"description":"`PACK_NOT_OFFERED`: that pack isn't sold through your program.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"That pack is not sold through this program.","code":"PACK_NOT_OFFERED"},"examples":{"Example":{"title":"Example","value":{"error":"That pack is not sold through this program.","code":"PACK_NOT_OFFERED"}}},"exampleType":"examples"}},"exampleType":"examples"},"390dea4e-23bd-4d03-b236-7f60f1d0fa57":{"description":"Nothing is created.\n- `ODDS_UNAVAILABLE`: those odds aren't selling right now; try another choice or later. `odds` echoes the choice.\n- `PACK_UNAVAILABLE`: a pack that sells only its own odds can't open right now; `reason` says why.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Bronze Pack isn't selling hot odds right now.","code":"ODDS_UNAVAILABLE","odds":"hot"},"examples":{"Example":{"title":"Example","value":{"error":"Bronze Pack isn't selling hot odds right now.","code":"ODDS_UNAVAILABLE","odds":"hot"}}},"exampleType":"examples"}},"exampleType":"examples"},"def193fd-f5cd-4f17-9014-1e9194396def":{"description":"`IDEMPOTENCY_KEY_REUSED`: the key was already used for a different order.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"This Idempotency-Key was already used for a different order.","code":"IDEMPOTENCY_KEY_REUSED"},"examples":{"Example":{"title":"Example","value":{"error":"This Idempotency-Key was already used for a different order.","code":"IDEMPOTENCY_KEY_REUSED"}}},"exampleType":"examples"}},"exampleType":"examples"},"e5802be3-3f23-416b-8b8d-e4626c2a7978":{"description":"`RATE_LIMITED`: too many requests from this key. Wait `retry_after_seconds`. Limits per key: `POST /orders` 30 a minute; the two shipment estimates 30 a minute together; every other endpoint 120 a minute together.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Too many requests. Slow down.","code":"RATE_LIMITED","retry_after_seconds":23},"examples":{"Example":{"title":"Example","value":{"error":"Too many requests. Slow down.","code":"RATE_LIMITED","retry_after_seconds":23}}},"exampleType":"examples"}},"exampleType":"examples"},"d00f2a00-d0cf-45f2-8124-ddce858d4a98":{"description":"Our fault. Retry with backoff, with the same `Idempotency-Key` where the endpoint takes one.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Something went wrong; retry with the same Idempotency-Key."},"examples":{"Example":{"title":"Example","value":{"error":"Something went wrong; retry with the same Idempotency-Key."}}},"exampleType":"examples"}},"exampleType":"examples"},"45ca3ec9-5935-4945-8647-33eb9f219ca9":{"description":"- `SCREENING_UNAVAILABLE`: wallet screening is briefly unavailable; retry shortly with the same `Idempotency-Key`.\n- `AUTH_UNAVAILABLE`, or no code: we couldn't check your key or load your program; retry after `Retry-After`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every error body. `code` is stable where you might branch on it; some errors add the fields below.","properties":{"error":{"type":"string","description":"For people. The text can change, so branch on the status and the `code`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","enum":["RATE_LIMITED","AUTH_UNAVAILABLE","NO_PROGRAM","PROGRAM_INACTIVE","NOT_AVAILABLE","BAD_JSON","BAD_IDEMPOTENCY_KEY","IDEMPOTENCY_KEY_REUSED","BAD_RECIPIENT","BAD_PACK","BAD_CATEGORY","BAD_ODDS","BAD_QUANTITY","ODDS_UNAVAILABLE","BAD_REFUND_ADDRESS","PACK_NOT_OFFERED","PACK_UNAVAILABLE","WALLET_REFUSED","WALLET_BLOCKED","SCREENING_UNAVAILABLE","UNKNOWN_ORDER","NOT_PULLED","VERIFY_UNAVAILABLE","BAD_CURSOR","BAD_LIMIT","BAD_STATUS","BAD_ADDRESS","BAD_PARTNER_USER_REF","TOO_MANY_WALLETS","UNKNOWN_TOKEN","BAD_HOLDER","NOT_HOLDER","CHAIN_UNAVAILABLE","TOKEN_NOT_MINTED","TOKEN_BURNED","TOKEN_NOT_LIVE","NO_OFFER","PAYOUT_CHAIN_NOT_SUPPORTED","PAYOUT_CHAIN_NOT_ENABLED","BAD_PAYOUT_ADDRESS","USE_SHIPMENT_ENDPOINT","BAD_TOKEN_IDS","TOKEN_IN_SHIPMENT","BAD_COVER","COVER_NOT_ALLOWED","COVER_UNAVAILABLE","BAD_MAX_COST","NOT_SHIPPABLE","PARTNER_GOODS","COUNTRY_NOT_SUPPORTED","OVER_CUSTOMS_CAP","RATE_UNAVAILABLE","PRICE_CHANGED","UNKNOWN_SHIPMENT","NOT_PAID","ALREADY_REDEEMED","HOLDER_CHANGED","UNKNOWN_QUOTE","INVALID_WEBHOOK_URL","WEBHOOK_ACCOUNT_CHANGED","WEBHOOKS_UNAVAILABLE","UNKNOWN_WEBHOOK","KEY_ROTATED","BAD_PERIOD","INVALID_KEY","NO_PREVIOUS_KEY","ALREADY_ROTATED","UNKNOWN_PAYMENT","NOT_BURNED"],"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Machine-readable, where you might branch on it. New codes can be added, so treat an unknown one like a missing one.","uniqueKey":"code.oneOf.1","typeLabel":"string"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | string"},"retry_after_seconds":{"type":"integer","description":"On `RATE_LIMITED`.","uniqueKey":"retry_after_seconds","typeLabel":"integer"},"odds":{"oneOf":[{"type":"array","items":{"type":"string","enum":["standard","hot","chill","classic"],"description":"The odds a pack is opened at, as in our app's picker. Standard, Hot and Chill share one value-band ladder and differ only in the chance of each band; Classic is the pack's own bands and chances. A pack that sells only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).","uniqueKey":"odds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","uniqueKey":"odds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"On `BAD_ODDS` when the pack sells other odds: the choices it sells. On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.","enum":["standard","hot","chill","classic"],"uniqueKey":"odds.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"odds","typeLabel":"enum\u003cstring>[] | enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"On `PACK_UNAVAILABLE`, why the pack can't open.","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"status":{"type":"string","description":"On `NOT_PULLED`, the order's status.","uniqueKey":"status","typeLabel":"string"},"token_ids":{"type":"array","items":{"type":"string","uniqueKey":"token_ids.items.[INDEX]","typeLabel":"string"},"description":"On a refusal about particular tokens, the token ids it is about.","uniqueKey":"token_ids","typeLabel":"string[]"},"quote_id":{"type":"string","description":"On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment waiting for the burn.","uniqueKey":"quote_id","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"description":"On `BAD_ADDRESS` from a shipment or estimate, each bad address field and what is wrong with it.","uniqueKey":"fields","typeLabel":"object"},"order_value":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"order_value","typeLabel":"number"},"min_cover":{"type":"number","description":"On `COVER_NOT_ALLOWED`.","uniqueKey":"min_cover","typeLabel":"number"},"max_cover":{"oneOf":[{"type":"number","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.0","typeLabel":"number"},{"type":"null","description":"On `COVER_NOT_ALLOWED`; null when the items can't be insured.","uniqueKey":"max_cover.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_cover","typeLabel":"number | null"},"amount":{"type":"number","description":"On `PRICE_CHANGED`, the current shipping cost.","uniqueKey":"amount","typeLabel":"number"},"successor":{"type":"object","description":"On `ALREADY_ROTATED`, the key that replaced this one.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"successor.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"successor.name","typeLabel":"string"}},"uniqueKey":"successor","typeLabel":"object"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On `ALREADY_ROTATED`, when this key stops working.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Wallet screening is unavailable; try again shortly.","code":"SCREENING_UNAVAILABLE"},"examples":{"Example":{"title":"Example","value":{"error":"Wallet screening is unavailable; try again shortly.","code":"SCREENING_UNAVAILABLE"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"5d417d19-47d3-4b3c-a84b-120ca58d807f":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"cb_live_\u003c48 hex>","description":"Your API key (`cb_live_…`), sent as a bearer token, with the scope `nft:orders`. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a `403` with `Access denied`, whether or not it has a valid key. See [Authentication and keys](/partner-api/v2/authentication).","scopes":["nft:orders"],"schemeName":"bearerAuth"}}},"servers":{"ed38223c-7284-4c4c-a036-024a32e33c56":{"url":"https://catchbackcards.com","description":"Production. Every payment is real money. The sandbox base URL is issued on request."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"cb_live_\u003c48 hex>","description":"Your API key (`cb_live_…`), sent as a bearer token, with the scope `nft:orders`. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a `403` with `Access denied`, whether or not it has a valid key. See [Authentication and keys](/partner-api/v2/authentication).","scopes":["nft:orders"],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key (`cb_live_…`), sent as a bearer token, with the scope `nft:orders`. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a `403` with `Access denied`, whether or not it has a valid key. See [Authentication and keys](/partner-api/v2/authentication).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"partner-api/v2/openapi.yaml"},"subdomain":"catchbackcards","siteName":"CatchBack Documentation","title":"Create an order - CatchBack Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T03:32:55.266Z","originalFileLocation":"api-reference/orders/create-an-order.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=\"dark\"}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=\"Rate limit: 30 a minute. One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook. A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses. If the odds stop selling before the payment settles, the pack isn\u0026#x27;t opened at other odds: the order goes to refund_due and the customer is refunded.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CatchBack Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_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/catchbackcards/mlIgZutg782HIdAn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an order - CatchBack Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Rate limit: 30 a minute. One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook. A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses. If the odds stop selling before the payment settles, the pack isn\u0026#x27;t opened at other odds: the order goes to refund_due and the customer is refunded.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CatchBack Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://catchbackcards.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+an+order\u0026amp;description=**Rate+limit%3A**+30+a+minute.%0A%0AOne+order+buys+1-10+packs+of+one+kind+for+one+wallet%2C+paid+with+one+payment.+%60quantity%60+2-10+makes+a+multi-pack+order+%28%60OrderBatch\u0026amp;theme=779a40f3f67beacb233f5a4b\u0026amp;signature=0885306cd6c5fb3bbe9ac1beea2b724a1a548d0d00c01f7cfeca34fdd819690e\">\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 an order - CatchBack Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Rate limit: 30 a minute. One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook. A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses. If the odds stop selling before the payment settles, the pack isn\u0026#x27;t opened at other odds: the order goes to refund_due and the customer is refunded.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://catchbackcards.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+an+order\u0026amp;description=**Rate+limit%3A**+30+a+minute.%0A%0AOne+order+buys+1-10+packs+of+one+kind+for+one+wallet%2C+paid+with+one+payment.+%60quantity%60+2-10+makes+a+multi-pack+order+%28%60OrderBatch\u0026amp;theme=779a40f3f67beacb233f5a4b\u0026amp;signature=0885306cd6c5fb3bbe9ac1beea2b724a1a548d0d00c01f7cfeca34fdd819690e\">\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/catchbackcards/mlIgZutg782HIdAn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CatchBack Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/create-an-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://catchbackcards.mintlify.app/#organization\",\"name\":\"CatchBack Documentation\",\"url\":\"https://catchbackcards.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/catchbackcards/t6yI8GaEaBqQQEpE/logo/catchback_logo_dark.png?fit=max\u0026auto=format\u0026n=t6yI8GaEaBqQQEpE\u0026q=85\u0026s=c0a46c19893e31a50cd0f4716d47686b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://catchbackcards.mintlify.app#website\",\"name\":\"CatchBack Documentation\",\"url\":\"https://catchbackcards.mintlify.app\",\"publisher\":{\"@id\":\"https://catchbackcards.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order#webpage\",\"url\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order\",\"name\":\"Create an order\",\"description\":\"Rate limit: 30 a minute. One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook. A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses. If the odds stop selling before the payment settles, the pack isn't opened at other odds: the order goes to refund_due and the customer is refunded.\",\"dateModified\":\"2026-11-18T03:32:55.266Z\",\"isPartOf\":{\"@id\":\"https://catchbackcards.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CatchBack Documentation\",\"item\":\"https://catchbackcards.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an order\",\"item\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order#apireference\",\"headline\":\"Create an order\",\"name\":\"Create an order\",\"description\":\"Rate limit: 30 a minute. One order buys 1-10 packs of one kind for one wallet, paid with one payment. quantity 2-10 makes a multi-pack order (OrderBatch): one payment for quantity × the pack price, whose units each open, mint and (if they must) refund on their own. The pack opens and the NFT mints once the payment settles; follow it with Get an order or the nft_order.updated webhook. A refused order creates nothing. A replay with the same Idempotency-Key and the same request answers 200 with idempotent_replay: true and the order as it stands now; once the order is past awaiting_payment, its payment has no client_secret and no deposit addresses. If the odds stop selling before the payment settles, the pack isn't opened at other odds: the order goes to refund_due and the customer is refunded.\",\"url\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order\",\"mainEntityOfPage\":{\"@id\":\"https://catchbackcards.mintlify.app/api-reference/orders/create-an-order#webpage\"},\"dateModified\":\"2026-11-18T03:32:55.266Z\",\"publisher\":{\"@id\":\"https://catchbackcards.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://catchbackcards.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CatchBack Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CatchBack Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/orders/create-an-order.md","siteName":"CatchBack Documentation","nav":{"global":{"anchors":[{"anchor":"CatchBack Website","icon":"globe","href":"https://catchbackcards.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/about-catchback/overview"}]},{"tab":"Partner API","pages":[{"title":"Partner API","href":"/partner-api/v2/overview"}]},{"tab":"API Reference","groups":[{"group":"Packs","pages":[{"title":"List packs","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/catalog/packs","href":"/api-reference/packs/list-packs"},{"title":"Get a pack's pool","description":"What one pack can pull at one odds choice: the value bands with their chances, whether those odds are selling right now, and every item a pull can produce, highest value first. This is the same information as the odds panel in our app; show it to your customers before they buy.\n\nA pack that sells only its own odds answers `odds: \"classic\"` with its own band shape (`ClassicPackPool`). Every other pack answers `ModePackPool`.","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/catalog/packs/pool","href":"/api-reference/packs/get-a-packs-pool"}]},{"group":"Orders","pages":[{"title":"Create an order","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/orders","href":"/api-reference/orders/create-an-order"},{"title":"List orders","description":"Your orders, newest first, each in the Get an order shape. The units of a multi-pack order are listed one by one, each with the order's `order_id`, its `batch_id` and its `unit` number. `partner_user_ref` matches the wallets you first sent with that ref.","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/orders","href":"/api-reference/orders/list-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Get an order's proof","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/orders/{id}/verification","href":"/api-reference/orders/get-an-orders-proof"}]},{"group":"Tokens","pages":[{"title":"List a wallet's tokens","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/wallets/{address}/tokens","href":"/api-reference/tokens/list-a-wallets-tokens"},{"title":"Get a token","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/tokens/{tokenId}","href":"/api-reference/tokens/get-a-token"}]},{"group":"Sell-back","pages":[{"title":"Create a sell-back quote","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/tokens/{tokenId}/quote","href":"/api-reference/sell-back/create-a-sell-back-quote"},{"title":"List sell-back quotes","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/quotes","href":"/api-reference/sell-back/list-sell-back-quotes"},{"title":"Get a sell-back quote","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/quotes/{quoteId}","href":"/api-reference/sell-back/get-a-sell-back-quote"}]},{"group":"Shipments","pages":[{"title":"Estimate a shipment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/shipments/estimate","href":"/api-reference/shipments/estimate-a-shipment"},{"title":"Create a shipment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/shipments","href":"/api-reference/shipments/create-a-shipment"},{"title":"List shipments","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/shipments","href":"/api-reference/shipments/list-shipments"},{"title":"Estimate a one-token shipment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/tokens/{tokenId}/shipment/estimate","href":"/api-reference/shipments/estimate-a-one-token-shipment"},{"title":"Create a one-token shipment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/tokens/{tokenId}/shipment","href":"/api-reference/shipments/create-a-one-token-shipment"},{"title":"Get a shipment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/shipments/{id}","href":"/api-reference/shipments/get-a-shipment"},{"title":"Renew a shipment's burn window","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/shipments/{id}/renew","href":"/api-reference/shipments/renew-a-shipments-burn-window"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/webhooks","href":"/api-reference/webhooks/register-a-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml delete /api/partner/v2/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Test a webhook","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/webhooks/{id}/test","href":"/api-reference/webhooks/test-a-webhook"}]},{"group":"Webhook events","pages":[{"title":"Order updated","version":null,"deprecated":null,"openapi":"/partner-api/v2/openapi.yaml webhook nft_order.updated","href":"/api-reference/webhook-events/order-updated"},{"title":"Sell back updated","version":null,"deprecated":null,"openapi":"/partner-api/v2/openapi.yaml webhook sellback.updated","href":"/api-reference/webhook-events/sell-back-updated"},{"title":"Shipment updated","version":null,"deprecated":null,"openapi":"/partner-api/v2/openapi.yaml webhook nft_shipment.updated","href":"/api-reference/webhook-events/shipment-updated"},{"title":"Ping","version":null,"deprecated":null,"openapi":"/partner-api/v2/openapi.yaml webhook ping","href":"/api-reference/webhook-events/ping"}]},{"group":"Keys \u0026 revenue","pages":[{"title":"Get your key","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/keys","href":"/api-reference/keys/get-your-key"},{"title":"Rotate your key","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/keys/rotate","href":"/api-reference/keys/rotate-your-key"},{"title":"Revoke the previous key","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/keys/revoke-previous","href":"/api-reference/keys/revoke-the-previous-key"},{"title":"Get your revenue statement","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner/v2/revenue","href":"/api-reference/revenue/get-your-revenue-statement"}]},{"group":"Sandbox","pages":[{"title":"Simulate a payment","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/sandbox/payments/{intentId}","href":"/api-reference/sandbox/simulate-a-payment"},{"title":"Run the background work","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/sandbox/tick","href":"/api-reference/sandbox/run-the-background-work"},{"title":"Mark a shipment shipped or delivered","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml post /api/partner/v2/sandbox/shipments/{id}","href":"/api-reference/sandbox/mark-a-shipment-shipped-or-delivered"}]},{"group":"Metadata","pages":[{"title":"Token metadata (EVM)","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner-nfts/metadata/{chainId}/{tokenId}","href":"/api-reference/metadata/token-metadata-evm"},{"title":"Token metadata (Solana)","deprecated":null,"version":null,"openapi":"/partner-api/v2/openapi.yaml get /api/partner-nfts/metadata/{id}","href":"/api-reference/metadata/token-metadata-solana"}]}]}]},"basePath":"","title":"Create an order - CatchBack Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}