The dimensions of the parcel. Defaults to the parcel template's dimensions when parcel_template is set and no dimensions are given, and to the carrier's own preset when carrier_parcel_template_token resolves to a fixed-size package.
The token of a carrier parcel template (e.g. USPS_SmallFlatRateBox), resolved against this shipment's own shipping provider. Defaults to the parcel template's token when parcel_template is set, and can be cleared or overridden by passing it explicitly. When it resolves to a fixed-size package its dimensions are used, and quoted rates cover only that carrier — read the carrier itself from the parcel template, or from the selected rate once one is chosen. Cannot be changed after the label is purchased.
Time at which the object was last updated. Measured in seconds since the Unix epoch.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SureCart","colors":{"primary":"#00824c","light":"#00824c","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-light.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=38315d1a606d0a91773837ea01e08a74","dark":"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-dark.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=d0dc62ee850e0e69d81395b283b6c338"},"favicon":"https://mintcdn.com/surecart/jHwrSAqAc4o_umB5/favicon.png?fit=max\u0026auto=format\u0026n=jHwrSAqAc4o_umB5\u0026q=85\u0026s=8f5e1bed5ef79ba47647c500fedaadb1","footer":{"socials":{"facebook":"https://www.facebook.com/my.surecart","x":"https://x.com/my_surecart","youtube":"https://www.youtube.com/@SureCartOfficial","linkedin":"https://www.linkedin.com/company/surecart"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"surecart","hasAudioNarration":false,"actualSubdomain":"surecart","customDomains":["developer.surecart.com"],"gitSource":{"type":"github","owner":"surecart","repo":"surecart-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5e94203b76e0d8ece5922","collectionId":"1b72b928-4602-4933-96d8-3dfafcb11a67","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5e94203b76e0d8ece5922"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad5e94203b76e0d8ece5922","clientVersion":"0.0.3969","searchFilterCounts":[{"language":"default","tag":"API Reference","count":429},{"language":"default","tag":"Products","count":106},{"language":"default","tag":"Orders \u0026 Payments","count":86},{"language":"default","tag":"Shipping \u0026 Fulfillment","count":62},{"language":"default","tag":"Core Endpoints","count":48},{"language":"default","tag":"Affiliates","count":42},{"language":"default","tag":"Customers","count":39},{"language":"default","tag":"Subscriptions","count":36},{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Extending","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".prose :where(h1):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:800;font-size:2.25em;margin-top:2.5em;margin-bottom:.8888889em;line-height:1.1111111}.prose :where(h1 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:900;color:inherit}.prose :where(h2):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:700;font-size:1.5em;margin-top:4em;margin-bottom:.6666666666666666em;line-height:1.3333333}.prose :where(h2 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:800;color:inherit}.prose :where(h3):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:600;font-size:1.25em;margin-top:2.4em;margin-bottom:.6em;line-height:1.4}.prose :where(h3 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:700;color:inherit}.prose :where(h4):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:600;margin-top:2em;margin-bottom:.5em;line-height:1.5;font-size:1.125em}.prose :where(h4 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:700;color:inherit}"}],"page":{"pagePath":"api-reference/shipments/purchase","slug":"/api-reference/shipments/purchase","pageMetadata":{"title":"Purchase","description":"Purchases a shipping label for a specific shipment using the selected rate.","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/purchase","href":"/api-reference/shipments/purchase","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Purchases a shipping label for a specific shipment using the selected rate.\"\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":"Purchase","description":"Purchases a shipping label for a specific shipment using the selected rate.","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/purchase","href":"/api-reference/shipments/purchase","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Purchase","tags":["Shipments"],"operationId":"purchase_shipment","description":"Purchases a shipping label for a specific shipment using the selected rate.","parameters":[],"responses":{"200":"b84a4d89-f9d5-49f1-8d4f-5535f0cab73d"},"requestBody":"22c18156-f947-4011-88ad-7ffe7fe38f67","method":"patch","type":"path","servers":["5fb126e0-9a7e-463d-91f5-4cd758219aff"],"security":["0cf46948-8c2a-482c-ac34-25068cba0298"],"path":"/v1/shipments/{id}/purchase","baseUrlOptions":["https://{defaultHost}"],"title":"Purchase","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dc3d2b6e-2780-4f6e-aa69-fe437e1dcda0":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"shipment":{"type":"object","properties":{"rate_id":{"type":"string","description":"The ID of the selected rate to purchase.","uniqueKey":"shipment.rate_id","typeLabel":"string"},"label_file_type":{"type":"string","description":"The file type for the shipping label – one of `PDF`, `PDF_A4`, `PDF_A6`, `PDF_4x6`, `PDF_4x8`, `PNG`, `ZPLII`.","uniqueKey":"shipment.label_file_type","typeLabel":"string"}},"uniqueKey":"shipment","typeLabel":"object"}},"example":{"shipment":{"rate_id":"rate_1","label_file_type":"PDF"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"shipment":{"rate_id":"rate_1","label_file_type":"PDF"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b84a4d89-f9d5-49f1-8d4f-5535f0cab73d":{"description":"Success","content":{"application/json":{"example":{"id":"6874d17a-6f4f-45cd-ac4b-acf2634cb5ba","object":"shipment","carrier":"USPS","carrier_messages":[],"contact_validations":null,"dimensions":{"length":10,"width":8,"height":5,"unit":"in"},"eta":null,"inherit_weight":false,"label_file_type":"PDF","label_url":"https://deliver.goshippo.com/1e3adda1934443079737edb336067106.pdf?Expires=1806494587\u0026Signature=YcAo0uG7lvxdwCmD8KPOui7O~u7KGPKWQszBtrLcdfQg5hdRZlfabsM4zSa69zRVgpEH8Omon0ktgRETyPPoIP9WOyW4CvKa7tEKyoOMi04YQ7JLCNZJXybHoJ9Z31gYqfd5RYfn1SoFTaFUDjQ17Id9RMTGG-JICM7a8fbsKFBoaGEE6zme~POyX~KX2rhlv2XiQFfmXhoJn1tF1yeh0gTJ4Ayefno4u34AeiS2XipX1anBqYyrtsxIXa7gG8NC-QufLNSgBUMcnkDLT04aa8-XXvI7IsVAkml1QqzAHq2Ur-2HVYaxYhA1V3VUjkwv8E6LwkyS~23jEysytNbdNw__\u0026Key-Pair-Id=APKAJRICFXQ2S4YUQRSQ","live_mode":true,"rates":[{"id":"rate_1","amount":550,"currency":"usd","provider":"USPS","service_name":"Priority","estimated_days":3,"tags":["bestvalue"],"duration_terms":null,"provider_logo_url":"https://example.com/usps.png"}],"selected_rate":{"id":"rate_1","amount":550,"currency":"usd","provider":"USPS","service_name":"Priority","estimated_days":3,"tags":["bestvalue"],"duration_terms":null,"provider_logo_url":"https://example.com/usps.png"},"shipping_date":1792368000,"status":"purchased","tracking_number":"9234690396055702568186","tracking_status":null,"tracking_url":"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9234690396055702568186","weight":"2.0","weight_unit":"lb","carrier_parcel_template_token":null,"from_contact":"1f21e26d-0a9c-44b4-8634-c5dce72a16cb","fulfillment":"d1b27f20-43eb-47c0-a224-86a713433280","parcel_template":null,"shipping_provider":"4a688112-eb8b-456f-ba81-fad74c19e7c6","to_contact":"e4d6807b-a449-4256-aaaa-a5b71dc91ebd","created_at":1792401387,"updated_at":1792401387},"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"object","typeLabel":"string"},"label_file_type":{"type":"string","description":"The file type for the shipping label – one of `PDF`, `PDF_A4`, `PDF_A6`, `PDF_4x6`, `PDF_4x8`, `PNG`, `ZPLII`.","uniqueKey":"label_file_type","typeLabel":"string"},"parcel_template":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated parcel template ID.","uniqueKey":"parcel_template.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the parcel template.","uniqueKey":"parcel_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"parcel_template","typeLabel":"string | null"},"weight":{"oneOf":[{"type":"string","description":"The weight of the parcel.","uniqueKey":"weight.oneOf.0","typeLabel":"string"},{"type":"null","description":"The weight of the parcel.","uniqueKey":"weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"weight","typeLabel":"string | null"},"weight_unit":{"oneOf":[{"type":"string","description":"The unit of the weight – one of `g`, `kg`, `lb`, `oz`.","uniqueKey":"weight_unit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unit of the weight – one of `g`, `kg`, `lb`, `oz`.","uniqueKey":"weight_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"weight_unit","typeLabel":"string | null"},"inherit_weight":{"type":"boolean","description":"When true, inherit the weight from the fulfillment.","uniqueKey":"inherit_weight","typeLabel":"boolean"},"shipping_date":{"type":"integer","description":"The date the shipment will be tendered to the carrier. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_date","typeLabel":"integer"},"dimensions":{"oneOf":[{"type":"object","description":"The dimensions of the parcel. Defaults to the parcel template's dimensions when `parcel_template` is set and no dimensions are given, and to the carrier's own preset when `carrier_parcel_template_token` resolves to a fixed-size package.","properties":{"length":{"type":"number","description":"The length of the parcel.","uniqueKey":"dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width of the parcel.","uniqueKey":"dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height of the parcel.","uniqueKey":"dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit for dimensions – one of `in`, `cm`, `ft`, `m`, `mm`, `yd`.","uniqueKey":"dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The dimensions of the parcel. Defaults to the parcel template's dimensions when `parcel_template` is set and no dimensions are given, and to the carrier's own preset when `carrier_parcel_template_token` resolves to a fixed-size package.","properties":{"length":{"type":"number","description":"The length of the parcel."},"width":{"type":"number","description":"The width of the parcel."},"height":{"type":"number","description":"The height of the parcel."},"unit":{"type":"string","description":"The unit for dimensions – one of `in`, `cm`, `ft`, `m`, `mm`, `yd`."}},"uniqueKey":"dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"dimensions","typeLabel":"object | null"},"carrier_parcel_template_token":{"oneOf":[{"type":"string","description":"The token of a carrier parcel template (e.g. `USPS_SmallFlatRateBox`), resolved against this shipment's own shipping provider. Defaults to the parcel template's token when `parcel_template` is set, and can be cleared or overridden by passing it explicitly. When it resolves to a fixed-size package its dimensions are used, and quoted rates cover only that carrier — read the carrier itself from the parcel template, or from the selected rate once one is chosen. Cannot be changed after the label is purchased.","uniqueKey":"carrier_parcel_template_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token of a carrier parcel template (e.g. `USPS_SmallFlatRateBox`), resolved against this shipment's own shipping provider. Defaults to the parcel template's token when `parcel_template` is set, and can be cleared or overridden by passing it explicitly. When it resolves to a fixed-size package its dimensions are used, and quoted rates cover only that carrier — read the carrier itself from the parcel template, or from the selected rate once one is chosen. Cannot be changed after the label is purchased.","uniqueKey":"carrier_parcel_template_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"carrier_parcel_template_token","typeLabel":"string | null"},"status":{"type":"string","description":"The current status of this shipment – one of `draft`, `quoted`, `purchased`, `voided`.","uniqueKey":"status","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Whether or not this shipment was created in live mode.","uniqueKey":"live_mode","typeLabel":"boolean"},"label_url":{"oneOf":[{"type":"string","description":"The URL for the purchased shipping label.","uniqueKey":"label_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for the purchased shipping label.","uniqueKey":"label_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"label_url","typeLabel":"string | null"},"tracking_number":{"oneOf":[{"type":"string","description":"The tracking number for this shipment.","uniqueKey":"tracking_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tracking number for this shipment.","uniqueKey":"tracking_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"tracking_number","typeLabel":"string | null"},"tracking_url":{"oneOf":[{"type":"string","description":"The URL to track this shipment.","uniqueKey":"tracking_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to track this shipment.","uniqueKey":"tracking_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"tracking_url","typeLabel":"string | null"},"carrier":{"oneOf":[{"type":"string","description":"The shipping carrier of the selected rate.","uniqueKey":"carrier.oneOf.0","typeLabel":"string"},{"type":"null","description":"The shipping carrier of the selected rate.","uniqueKey":"carrier.oneOf.1","typeLabel":"null"}],"uniqueKey":"carrier","typeLabel":"string | null"},"carrier_messages":{"oneOf":[{"type":"array","description":"Messages from carriers about this shipment.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier source of the messages.","uniqueKey":"carrier_messages.oneOf.0.items.[INDEX].carrier","typeLabel":"string"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"carrier_messages.oneOf.0.items.[INDEX].messages.items.[INDEX]","typeLabel":"string"},"description":"The messages from this carrier.","uniqueKey":"carrier_messages.oneOf.0.items.[INDEX].messages","typeLabel":"string[]"}},"uniqueKey":"carrier_messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"carrier_messages.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Messages from carriers about this shipment.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier source of the messages."},"messages":{"type":"array","items":{"type":"string"},"description":"The messages from this carrier."}}},"uniqueKey":"carrier_messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"carrier_messages","typeLabel":"object[] | null"},"contact_validations":{"oneOf":[{"type":"object","description":"Contact validation results returned by the shipping provider. Only available after quoting.","properties":{"from_contact":{"type":"object","properties":{"valid":{"type":"boolean","description":"Whether the contact is valid.","uniqueKey":"contact_validations.oneOf.0.from_contact.valid","typeLabel":"boolean"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"contact_validations.oneOf.0.from_contact.messages.items.[INDEX]","typeLabel":"string"},"description":"Validation messages for this contact.","uniqueKey":"contact_validations.oneOf.0.from_contact.messages","typeLabel":"string[]"}},"uniqueKey":"contact_validations.oneOf.0.from_contact","typeLabel":"object"},"to_contact":{"type":"object","properties":{"valid":{"type":"boolean","description":"Whether the contact is valid.","uniqueKey":"contact_validations.oneOf.0.to_contact.valid","typeLabel":"boolean"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"contact_validations.oneOf.0.to_contact.messages.items.[INDEX]","typeLabel":"string"},"description":"Validation messages for this contact.","uniqueKey":"contact_validations.oneOf.0.to_contact.messages","typeLabel":"string[]"}},"uniqueKey":"contact_validations.oneOf.0.to_contact","typeLabel":"object"}},"uniqueKey":"contact_validations.oneOf.0","typeLabel":"object"},{"type":"null","description":"Contact validation results returned by the shipping provider. Only available after quoting.","properties":{"from_contact":{"type":"object","properties":{"valid":{"type":"boolean","description":"Whether the contact is valid."},"messages":{"type":"array","items":{"type":"string"},"description":"Validation messages for this contact."}}},"to_contact":{"type":"object","properties":{"valid":{"type":"boolean","description":"Whether the contact is valid."},"messages":{"type":"array","items":{"type":"string"},"description":"Validation messages for this contact."}}}},"uniqueKey":"contact_validations.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact_validations","typeLabel":"object | null"},"tracking_status":{"oneOf":[{"type":"string","description":"The current tracking status – one of `unknown`, `pre_transit`, `in_transit`, `delivered`, `returned`, `failure`.","uniqueKey":"tracking_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The current tracking status – one of `unknown`, `pre_transit`, `in_transit`, `delivered`, `returned`, `failure`.","uniqueKey":"tracking_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"tracking_status","typeLabel":"string | null"},"eta":{"oneOf":[{"type":"string","description":"The estimated time of arrival.","uniqueKey":"eta.oneOf.0","typeLabel":"string"},{"type":"null","description":"The estimated time of arrival.","uniqueKey":"eta.oneOf.1","typeLabel":"null"}],"uniqueKey":"eta","typeLabel":"string | null"},"rates":{"type":"array","description":"The available shipping rates for this shipment.","items":{"properties":{"id":{"type":"string","description":"The unique identifier for this rate.","uniqueKey":"rates.items.[INDEX].id","typeLabel":"string"},"amount":{"type":"integer","description":"The amount in cents to be paid for this rate. For example `9900` is equivalent to `$99`.","uniqueKey":"rates.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","description":"The three-letter currency code for this rate.","uniqueKey":"rates.items.[INDEX].currency","typeLabel":"string"},"duration_terms":{"oneOf":[{"type":"string","description":"The clarification for the transit times.","uniqueKey":"rates.items.[INDEX].duration_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"The clarification for the transit times.","uniqueKey":"rates.items.[INDEX].duration_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"rates.items.[INDEX].duration_terms","typeLabel":"string | null"},"estimated_days":{"oneOf":[{"type":"integer","description":"The estimated number of days for delivery.","uniqueKey":"rates.items.[INDEX].estimated_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The estimated number of days for delivery.","uniqueKey":"rates.items.[INDEX].estimated_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"rates.items.[INDEX].estimated_days","typeLabel":"integer | null"},"provider":{"type":"string","description":"The shipping carrier providing this rate.","uniqueKey":"rates.items.[INDEX].provider","typeLabel":"string"},"provider_logo_url":{"oneOf":[{"type":"string","description":"The URL for logo of the shipping carrier providing this rate.","uniqueKey":"rates.items.[INDEX].provider_logo_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for logo of the shipping carrier providing this rate.","uniqueKey":"rates.items.[INDEX].provider_logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"rates.items.[INDEX].provider_logo_url","typeLabel":"string | null"},"service_name":{"type":"string","description":"The name of the shipping service.","uniqueKey":"rates.items.[INDEX].service_name","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"rates.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"description":"An array containing specific attributes of this rate in context of the entire shipment. one of `cheapest`, `fastest`, or `bestvalue`","uniqueKey":"rates.items.[INDEX].tags","typeLabel":"string[]"}},"type":"object","uniqueKey":"rates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rates","typeLabel":"object[]"},"selected_rate":{"oneOf":[{"type":"object","description":"The selected shipping rate for this shipment.","properties":{"id":{"type":"string","description":"The unique identifier for this rate.","uniqueKey":"selected_rate.oneOf.0.id","typeLabel":"string"},"amount":{"type":"integer","description":"The amount in cents to be paid for this rate. For example `9900` is equivalent to `$99`.","uniqueKey":"selected_rate.oneOf.0.amount","typeLabel":"integer"},"currency":{"type":"string","description":"The three-letter currency code for this rate.","uniqueKey":"selected_rate.oneOf.0.currency","typeLabel":"string"},"duration_terms":{"oneOf":[{"type":"string","description":"The clarification for the transit times.","uniqueKey":"selected_rate.oneOf.0.duration_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"The clarification for the transit times.","uniqueKey":"selected_rate.oneOf.0.duration_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_rate.oneOf.0.duration_terms","typeLabel":"string | null"},"estimated_days":{"oneOf":[{"type":"integer","description":"The estimated number of days for delivery.","uniqueKey":"selected_rate.oneOf.0.estimated_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The estimated number of days for delivery.","uniqueKey":"selected_rate.oneOf.0.estimated_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_rate.oneOf.0.estimated_days","typeLabel":"integer | null"},"provider":{"type":"string","description":"The shipping carrier providing this rate.","uniqueKey":"selected_rate.oneOf.0.provider","typeLabel":"string"},"provider_logo_url":{"oneOf":[{"type":"string","description":"The URL for logo of the shipping carrier providing this rate.","uniqueKey":"selected_rate.oneOf.0.provider_logo_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for logo of the shipping carrier providing this rate.","uniqueKey":"selected_rate.oneOf.0.provider_logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_rate.oneOf.0.provider_logo_url","typeLabel":"string | null"},"service_name":{"type":"string","description":"The name of the shipping service.","uniqueKey":"selected_rate.oneOf.0.service_name","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"selected_rate.oneOf.0.tags.items.[INDEX]","typeLabel":"string"},"description":"An array containing specific attributes of this rate in context of the entire shipment. one of `cheapest`, `fastest`, or `bestvalue`","uniqueKey":"selected_rate.oneOf.0.tags","typeLabel":"string[]"}},"uniqueKey":"selected_rate.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"selected_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_rate","typeLabel":"object | null"},"fulfillment":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated fulfillment ID.","uniqueKey":"fulfillment.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated fulfillment object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.object","typeLabel":"string"},"notifications_enabled":{"type":"boolean","description":"Whether or not notifications should be sent to customers when fulfillments are created and updated.","uniqueKey":"fulfillment.oneOf.1.notifications_enabled","typeLabel":"boolean"},"shipment_status":{"type":"string","description":"The current shipment status of this fulfillment – one of `unshippable`, `unshipped`, `label_purchased`, `shipped`, `in_transit`, `delivered`, `returned`, or `failed`.","uniqueKey":"fulfillment.oneOf.1.shipment_status","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"fulfillment.oneOf.1.metadata","typeLabel":"object"},"g_weight":{"type":"number","description":"Total weight of the entire fulfillment in grams.","uniqueKey":"fulfillment.oneOf.1.g_weight","typeLabel":"number"},"number":{"type":"string","description":"The unique identifier for this fulfillment that is auto generated based on this account's order protocol.","uniqueKey":"fulfillment.oneOf.1.number","typeLabel":"string"},"order":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated order ID.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated order object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.object","typeLabel":"string"},"checkout":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated checkout ID.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated checkout object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.object","typeLabel":"string"},"abandoned_checkout_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true` abandonded checkout reminder emails will be sent to the customer.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true` abandonded checkout reminder emails will be sent to the customer.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled","typeLabel":"boolean | null"},"billing_matches_shipping":{"type":"boolean","description":"If set to `true` the shipping address will be used for the billing address.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.billing_matches_shipping","typeLabel":"boolean"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.currency","typeLabel":"string"},"email":{"oneOf":[{"type":"string","description":"The email of the customer. If customers exists with this email, the most recently active/updated customer will be associated. If no customers exist with this email, a new customer will be created. If a `customer_id` is also passed then this will take precedence and the customer will not be looked up by email.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The email of the customer. If customers exists with this email, the most recently active/updated customer will be associated. If no customers exist with this email, a new customer will be created. If a `customer_id` is also passed then this will take precedence and the customer will not be looked up by email.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.email","typeLabel":"string | null"},"external_url":{"oneOf":[{"type":"string","description":"If set, this URL will be used whenever redirecting to the external checkout portal. If not set, the default `external_url` from the `CheckoutPortalProtocol` will be used.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.external_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"If set, this URL will be used whenever redirecting to the external checkout portal. If not set, the default `external_url` from the `CheckoutPortalProtocol` will be used.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.external_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.external_url","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The customer’s first name.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s first name.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.first_name","typeLabel":"string | null"},"ip_address":{"oneOf":[{"type":"string","description":"The IP address of the customer for this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The IP address of the customer for this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_address","typeLabel":"string | null"},"group_key":{"oneOf":[{"type":"string","description":"A key used to retrieve groups of checkouts dynamically from a static string.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.group_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"A key used to retrieve groups of checkouts dynamically from a static string.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.group_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.group_key","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The customer’s last name.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s last name.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_name","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"number","description":"The latitude captured for this checkout, in decimal degrees.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.latitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"The latitude captured for this checkout, in decimal degrees.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","description":"The longitude captured for this checkout, in decimal degrees.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.longitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"The longitude captured for this checkout, in decimal degrees.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.longitude","typeLabel":"number | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this checkout is in live mode, and set to `false` if it is in test mode.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.live_mode","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.name","typeLabel":"string | null"},"tax_behavior":{"type":"string","description":"The tax behavior for this checkout. One of `exclusive` or `inclusive`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_behavior","typeLabel":"string"},"tax_enabled":{"type":"boolean","description":"Whether or not tax is enabled for this checkout. This will default to the account's `tax_protocol.tax_enabled` value when the checkout is created.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_enabled","typeLabel":"boolean"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.metadata","typeLabel":"object"},"amount_due":{"type":"integer","description":"Total amount due after all adjustments (i.e. trials, credits, proration).","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.amount_due","typeLabel":"integer"},"applied_balance_amount":{"type":"integer","description":"The customer balance amount that was applied to this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.applied_balance_amount","typeLabel":"integer"},"available_countries":{"type":"array","description":"A list of countries available for this checkout, represented in the two-letter (ISO 3166-1 alpha-2) format.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.available_countries","typeLabel":"array"},"billing_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.billing_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.billing_address","typeLabel":"any | null"},"charges":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.charges.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.charges.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.charges","typeLabel":"any | null"},"checkout_fees":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.checkout_fees","typeLabel":"any | null"},"checkout_fees_amount":{"type":"integer","description":"The total amount of checkout fees applied to this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.checkout_fees_amount","typeLabel":"integer"},"credited_balance_amount":{"type":"integer","description":"The amount the customer's balance was credited from this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.credited_balance_amount","typeLabel":"integer"},"current_payment_intent":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_payment_intent","typeLabel":"any | null"},"current_upsell":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.current_upsell","typeLabel":"any | null"},"customer":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.customer.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.customer","typeLabel":"any | null"},"discount":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.discount.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.discount","typeLabel":"any | null"},"discount_amount":{"type":"integer","description":"Total discount amount of all line items.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.discount_amount","typeLabel":"integer"},"geo_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.geo_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.geo_address","typeLabel":"any | null"},"ip_geo_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.ip_geo_address","typeLabel":"any | null"},"free_shipping_choice_shortage_amount":{"oneOf":[{"type":"integer","description":"The amount that needs to be added to the checkout to qualify for free shipping. If `null`, then a free shipping choice is not available or it has already qualified.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount that needs to be added to the checkout to qualify for free shipping. If `null`, then a free shipping choice is not available or it has already qualified.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount","typeLabel":"integer | null"},"full_amount":{"type":"integer","description":"The full amount to be charged across all periods.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.full_amount","typeLabel":"integer"},"g_weight":{"type":"number","description":"Total weight of the entire checkout in grams.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.g_weight","typeLabel":"number"},"inherited_billing_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_billing_address","typeLabel":"any | null"},"inherited_email":{"oneOf":[{"type":"string","description":"The inherited email of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited email of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_email","typeLabel":"string | null"},"inherited_name":{"oneOf":[{"type":"string","description":"The inherited name of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited name of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_name","typeLabel":"string | null"},"inherited_phone":{"oneOf":[{"type":"string","description":"The inherited phone of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited phone of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_phone","typeLabel":"string | null"},"inherited_shipping_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_shipping_address","typeLabel":"any | null"},"inherited_tax_identifier":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.inherited_tax_identifier","typeLabel":"any | null"},"invoice":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.invoice.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.invoice","typeLabel":"any | null"},"last_click":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_click.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_click.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.last_click","typeLabel":"any | null"},"line_items":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.line_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.line_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.line_items","typeLabel":"any | null"},"manual_charges":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_charges","typeLabel":"any | null"},"manual_payment":{"type":"boolean","description":"Whether or not this checkout has been finalized with the `manual_payment=true` option.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_payment","typeLabel":"boolean"},"manual_payment_method":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.manual_payment_method","typeLabel":"any | null"},"remaining_amount_due":{"type":"integer","description":"The remaining amount that is due for this checkout – the `amount_due` - `paid_amount`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.remaining_amount_due","typeLabel":"integer"},"net_paid_amount":{"type":"integer","description":"The net amount that has been paid for this checkout – the `paid_amount` minus the `refunded_amount`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.net_paid_amount","typeLabel":"integer"},"order":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.order.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.order.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.order","typeLabel":"any | null"},"paid_amount":{"type":"integer","description":"The total amount that has been paid for this checkout – the sum of charges and manual charges.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.paid_amount","typeLabel":"integer"},"paid_at":{"oneOf":[{"type":"integer","description":"Time at which the object was paid. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.paid_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was paid. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.paid_at","typeLabel":"integer | null"},"payment_failures":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.payment_failures","typeLabel":"any | null"},"payment_method_required":{"type":"boolean","description":"Whether or not a payment method is required for this checkout. If false, the checkout will immediately transition to the `paid` state when finalized.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.payment_method_required","typeLabel":"boolean"},"phone_required":{"type":"boolean","description":"Whether or not a phone number is required for this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.phone_required","typeLabel":"boolean"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this checkout's correct portal page (hosted or external).","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this checkout's correct portal page (hosted or external).","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.portal_url","typeLabel":"string | null"},"processor_data":{"type":"object","description":"All of the additional data necessary to capture payment with each processor.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.processor_data","typeLabel":"object"},"proration_amount":{"type":"integer","description":"Total amount to be prorated from this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.proration_amount","typeLabel":"integer"},"purchases":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.purchases.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.purchases","typeLabel":"any | null"},"recommended_bumps":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.recommended_bumps","typeLabel":"any | null"},"referral":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.referral.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.referral.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.referral","typeLabel":"any | null"},"refunded_amount":{"type":"integer","description":"The total amount that has been refunded for this checkout – the sum of refunds.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.refunded_amount","typeLabel":"integer"},"reusable_payment_method_required":{"type":"boolean","description":"Whether or not a reusable payment method is required for this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.reusable_payment_method_required","typeLabel":"boolean"},"selected_shipping_choice_required":{"type":"boolean","description":"Whether or not a shipping choice must be selected for this checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.selected_shipping_choice_required","typeLabel":"boolean"},"selected_shipping_choice":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.selected_shipping_choice","typeLabel":"any | null"},"shipping_address":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address","typeLabel":"any | null"},"shipping_address_accuracy_requirement":{"oneOf":[{"type":"string","description":"The required level of accuracy for the shipping address – one of `full`, `tax`, or `none`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement.oneOf.0","typeLabel":"string"},{"type":"null","description":"The required level of accuracy for the shipping address – one of `full`, `tax`, or `none`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement","typeLabel":"string | null"},"shipping_amount":{"type":"integer","description":"Total shipping amount for the checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_amount","typeLabel":"integer"},"shipping_choices":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_choices","typeLabel":"any | null"},"shipping_fees":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_fees","typeLabel":"any | null"},"shipping_enabled":{"type":"boolean","description":"Whether or not this checkout has products with `shipping_enabled=true`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_enabled","typeLabel":"boolean"},"shipping_fees_amount":{"type":"integer","description":"The total amount of shipping fees applied to the shipping_amount.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_fees_amount","typeLabel":"integer"},"shipping_tax_amount":{"type":"number","description":"Total tax from shipping.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_tax_amount","typeLabel":"number"},"shipping_tax_rate":{"type":"number","description":"The tax rate applied to shipping.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.shipping_tax_rate","typeLabel":"number"},"status":{"type":"string","description":"The current status of this checkout, which can be one of `canceled`, `draft`, `finalized`, `paid`, `payment_intent_canceled`, `payment_failed`, or `processing`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.status","typeLabel":"string"},"subtotal_amount":{"type":"integer","description":"Total of all line items and their fees before discounts or taxes are applied.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.subtotal_amount","typeLabel":"integer"},"tax_amount":{"type":"integer","description":"Total tax amount of all line items.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_amount","typeLabel":"integer"},"tax_breakdown":{"type":"array","description":"The tax rate breakdown for this checkout.","items":{"type":"object","properties":{"tax_rate":{"type":"number","description":"The tax rate applied to this portion of the checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_rate","typeLabel":"number"},"tax_label":{"oneOf":[{"type":"string","description":"The type of tax that is applied to this portion of the checkout. For example, in the EU this value will be `VAT` and in the US this value will be `Tax`. This can also reflect a merchant-set tax override label when one applies.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The type of tax that is applied to this portion of the checkout. For example, in the EU this value will be `VAT` and in the US this value will be `Tax`. This can also reflect a merchant-set tax override label when one applies.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label","typeLabel":"string | null"},"taxable_amount":{"type":"integer","description":"The amount this tax rate was applied to.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].taxable_amount","typeLabel":"integer"},"tax_amount":{"type":"integer","description":"The tax amount for this portion of the checkout.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_amount","typeLabel":"integer"}},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_breakdown","typeLabel":"object[]"},"tax_status":{"type":"string","description":"The status of tax calculations for this checkout. One of `address_invalid`, `calculated`, `disabled`, `estimated`, `reverse_charged`, or `tax_zone_not_found`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_status","typeLabel":"string"},"tax_identifier":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.tax_identifier","typeLabel":"any | null"},"total_amount":{"type":"integer","description":"Total of all line items after discounts and taxes are applied.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.total_amount","typeLabel":"integer"},"total_savings_amount":{"type":"integer","description":"The total amount in cents that was saved on this checkout taking into account all negative fees, discounts, and all price `scratch_amount` values.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.total_savings_amount","typeLabel":"integer"},"trial_amount":{"type":"integer","description":"The total amount in cents that is removed from this checkout due to trial periods.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.trial_amount","typeLabel":"integer"},"upsells_expire_at":{"oneOf":[{"type":"integer","description":"The time at which upsells will expire for this checkout. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsells_expire_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which upsells will expire for this checkout. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsells_expire_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsells_expire_at","typeLabel":"integer | null"},"upsell_funnel":{"oneOf":[{"type":"any","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.upsell_funnel","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout.oneOf.1","typeLabel":"object"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.checkout","typeLabel":"string | object"},"fulfillment_status":{"type":"string","description":"The overall fulfillment status of this order based on all fulfillments – one of `fulfilled`, `partially_fulfilled`, or `unfulfilled`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillment_status","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this order is in live mode, and set to `false` if it is in test mode.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.live_mode","typeLabel":"boolean"},"number":{"type":"string","description":"The unique identifier for this order that is auto generated based on this account's order protocol.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.number","typeLabel":"string"},"order_type":{"type":"string","description":"One of either `checkout` or `subscription`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.order_type","typeLabel":"string"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.portal_url","typeLabel":"string | null"},"return_status":{"type":"string","description":"The overall return status of this order based on all return requests – one of `not_returned`, `partially_returned`, `return_request_open`, or `returned`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.return_status","typeLabel":"string"},"shipment_status":{"type":"string","description":"The overall shipment status of this order based on all fulfillments – one of `unshippable`, `unshipped`, `partially_shipped`, `label_purchased`, `shipped`, `in_transit`, or `delivered`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.shipment_status","typeLabel":"string"},"statement_url":{"oneOf":[{"type":"string","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.statement_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.statement_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.statement_url","typeLabel":"string | null"},"status":{"type":"string","description":"The current status of this order, which can be one of `draft`, `paid`, `payment_failed`, `processing`, or `void`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.status","typeLabel":"string"},"fulfillments":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated fulfillment objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments.oneOf.2","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.fulfillments","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.order.oneOf.1","typeLabel":"object"}],"uniqueKey":"fulfillment.oneOf.1.order","typeLabel":"string | object"},"fulfillment_items":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated fulfillment item objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.fulfillment_items.oneOf.2","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.fulfillment_items","typeLabel":"string | object | null"},"trackings":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated tracking objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.trackings.oneOf.2","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.trackings","typeLabel":"string | object | null"},"shipments":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated shipment objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"fulfillment.oneOf.1.shipments.oneOf.2","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.shipments","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"fulfillment.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillment.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"fulfillment.oneOf.1","typeLabel":"object"}],"uniqueKey":"fulfillment","typeLabel":"string | object"},"shipping_provider":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated shipping provider ID.","uniqueKey":"shipping_provider.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated shipping provider object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"shipping_provider.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"shipping_provider.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_provider.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"shipping_provider.oneOf.1.object","typeLabel":"string"},"approved":{"type":"boolean","description":"Whether or not this shipping provider has been verified and approved.","uniqueKey":"shipping_provider.oneOf.1.approved","typeLabel":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this shipping provider is enabled.","uniqueKey":"shipping_provider.oneOf.1.enabled","typeLabel":"boolean"},"live_mode":{"type":"boolean","description":"Whether or not this shipping provider is in live mode.","uniqueKey":"shipping_provider.oneOf.1.live_mode","typeLabel":"boolean"},"provider_type":{"type":"string","description":"The type of shipping provider – currently only `shippo`.","uniqueKey":"shipping_provider.oneOf.1.provider_type","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_provider.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_provider.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_provider.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_provider.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_provider.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_provider.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"shipping_provider.oneOf.1","typeLabel":"object"}],"uniqueKey":"shipping_provider","typeLabel":"string | object"},"from_contact":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated contact ID.","uniqueKey":"from_contact.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated contact object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"from_contact.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"from_contact.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"from_contact.oneOf.1.object","typeLabel":"string"},"name":{"type":"string","description":"The full name of the contact.","uniqueKey":"from_contact.oneOf.1.name","typeLabel":"string"},"email":{"type":"string","description":"The email address of the contact.","uniqueKey":"from_contact.oneOf.1.email","typeLabel":"string"},"company":{"oneOf":[{"type":"string","description":"The company name of the contact.","uniqueKey":"from_contact.oneOf.1.company.oneOf.0","typeLabel":"string"},{"type":"null","description":"The company name of the contact.","uniqueKey":"from_contact.oneOf.1.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number of the contact.","uniqueKey":"from_contact.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number of the contact.","uniqueKey":"from_contact.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.phone","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"from_contact.oneOf.1.address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"from_contact.oneOf.1.address.oneOf.1","typeLabel":"object"}],"uniqueKey":"from_contact.oneOf.1.address","typeLabel":"string | object"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"from_contact.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"from_contact.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"from_contact.oneOf.1","typeLabel":"object"}],"uniqueKey":"from_contact","typeLabel":"string | object"},"to_contact":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated contact ID.","uniqueKey":"to_contact.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated contact object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"to_contact.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"to_contact.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"to_contact.oneOf.1.object","typeLabel":"string"},"name":{"type":"string","description":"The full name of the contact.","uniqueKey":"to_contact.oneOf.1.name","typeLabel":"string"},"email":{"type":"string","description":"The email address of the contact.","uniqueKey":"to_contact.oneOf.1.email","typeLabel":"string"},"company":{"oneOf":[{"type":"string","description":"The company name of the contact.","uniqueKey":"to_contact.oneOf.1.company.oneOf.0","typeLabel":"string"},{"type":"null","description":"The company name of the contact.","uniqueKey":"to_contact.oneOf.1.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number of the contact.","uniqueKey":"to_contact.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number of the contact.","uniqueKey":"to_contact.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.phone","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"to_contact.oneOf.1.address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"to_contact.oneOf.1.address.oneOf.1","typeLabel":"object"}],"uniqueKey":"to_contact.oneOf.1.address","typeLabel":"string | object"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"to_contact.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"to_contact.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"to_contact.oneOf.1","typeLabel":"object"}],"uniqueKey":"to_contact","typeLabel":"string | object"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6874d17a-6f4f-45cd-ac4b-acf2634cb5ba","object":"shipment","carrier":"USPS","carrier_messages":[],"contact_validations":null,"dimensions":{"length":10,"width":8,"height":5,"unit":"in"},"eta":null,"inherit_weight":false,"label_file_type":"PDF","label_url":"https://deliver.goshippo.com/1e3adda1934443079737edb336067106.pdf?Expires=1806494587\u0026Signature=YcAo0uG7lvxdwCmD8KPOui7O~u7KGPKWQszBtrLcdfQg5hdRZlfabsM4zSa69zRVgpEH8Omon0ktgRETyPPoIP9WOyW4CvKa7tEKyoOMi04YQ7JLCNZJXybHoJ9Z31gYqfd5RYfn1SoFTaFUDjQ17Id9RMTGG-JICM7a8fbsKFBoaGEE6zme~POyX~KX2rhlv2XiQFfmXhoJn1tF1yeh0gTJ4Ayefno4u34AeiS2XipX1anBqYyrtsxIXa7gG8NC-QufLNSgBUMcnkDLT04aa8-XXvI7IsVAkml1QqzAHq2Ur-2HVYaxYhA1V3VUjkwv8E6LwkyS~23jEysytNbdNw__\u0026Key-Pair-Id=APKAJRICFXQ2S4YUQRSQ","live_mode":true,"rates":[{"id":"rate_1","amount":550,"currency":"usd","provider":"USPS","service_name":"Priority","estimated_days":3,"tags":["bestvalue"],"duration_terms":null,"provider_logo_url":"https://example.com/usps.png"}],"selected_rate":{"id":"rate_1","amount":550,"currency":"usd","provider":"USPS","service_name":"Priority","estimated_days":3,"tags":["bestvalue"],"duration_terms":null,"provider_logo_url":"https://example.com/usps.png"},"shipping_date":1792368000,"status":"purchased","tracking_number":"9234690396055702568186","tracking_status":null,"tracking_url":"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9234690396055702568186","weight":"2.0","weight_unit":"lb","carrier_parcel_template_token":null,"from_contact":"1f21e26d-0a9c-44b4-8634-c5dce72a16cb","fulfillment":"d1b27f20-43eb-47c0-a224-86a713433280","parcel_template":null,"shipping_provider":"4a688112-eb8b-456f-ba81-fad74c19e7c6","to_contact":"e4d6807b-a449-4256-aaaa-a5b71dc91ebd","created_at":1792401387,"updated_at":1792401387}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0cf46948-8c2a-482c-ac34-25068cba0298":{"bearer_auth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"5fb126e0-9a7e-463d-91f5-4cd758219aff":{"url":"https://{defaultHost}","variables":{"defaultHost":{"default":"api.surecart.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"openapi/v1/shipping.json"},"subdomain":"surecart","siteName":"SureCart","title":"Purchase - SureCart","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T09:57:05.954Z","originalFileLocation":"api-reference/shipments/purchase.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=\"system\"}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=\"Purchases a shipping label for a specific shipment using the selected rate.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SureCart\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Purchase - SureCart\">\u003cmeta data-mint-head property=\"og:description\" content=\"Purchases a shipping label for a specific shipment using the selected rate.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SureCart\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.surecart.com/api-reference/shipments/purchase\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://surecart.mintlify.app/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Purchase\u0026amp;description=Purchases+a+shipping+label+for+a+specific+shipment+using+the+selected+rate.\u0026amp;theme=9b88c4f1d9bfad53237eccf2\u0026amp;signature=5efa952575192d64ebc159b99b1cf94b33090b274cc3809d1793eaca6777a971\">\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=\"Purchase - SureCart\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Purchases a shipping label for a specific shipment using the selected rate.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://surecart.mintlify.app/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Purchase\u0026amp;description=Purchases+a+shipping+label+for+a+specific+shipment+using+the+selected+rate.\u0026amp;theme=9b88c4f1d9bfad53237eccf2\u0026amp;signature=5efa952575192d64ebc159b99b1cf94b33090b274cc3809d1793eaca6777a971\">\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/surecart/5YN85bnU-7QpL9oU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SureCart\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00824c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.surecart.com/api-reference/shipments/purchase\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/shipments/purchase.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.surecart.com/#organization\",\"name\":\"SureCart\",\"url\":\"https://developer.surecart.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-light.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=38315d1a606d0a91773837ea01e08a74\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.surecart.com#website\",\"name\":\"SureCart\",\"url\":\"https://developer.surecart.com\",\"publisher\":{\"@id\":\"https://developer.surecart.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.surecart.com/api-reference/shipments/purchase#webpage\",\"url\":\"https://developer.surecart.com/api-reference/shipments/purchase\",\"name\":\"Purchase\",\"description\":\"Purchases a shipping label for a specific shipment using the selected rate.\",\"dateModified\":\"2026-10-19T09:57:05.954Z\",\"isPartOf\":{\"@id\":\"https://developer.surecart.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.surecart.com/api-reference/shipments/purchase#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.surecart.com/api-reference/shipments/purchase#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shipping \u0026 Fulfillment\",\"item\":\"https://developer.surecart.com/api-reference/fulfillment-items/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Shipments\",\"item\":\"https://developer.surecart.com/api-reference/shipments/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Purchase\",\"item\":\"https://developer.surecart.com/api-reference/shipments/purchase\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.surecart.com/api-reference/shipments/purchase#apireference\",\"headline\":\"Purchase\",\"name\":\"Purchase\",\"description\":\"Purchases a shipping label for a specific shipment using the selected rate.\",\"url\":\"https://developer.surecart.com/api-reference/shipments/purchase\",\"mainEntityOfPage\":{\"@id\":\"https://developer.surecart.com/api-reference/shipments/purchase#webpage\"},\"dateModified\":\"2026-10-19T09:57:05.954Z\",\"publisher\":{\"@id\":\"https://developer.surecart.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.surecart.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SureCart\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SureCart","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Expanding Responses","href":"/api-reference/expanding-responses"},{"title":"Metadata","href":"/api-reference/metadata"},{"title":"Live \u0026 Test Mode","href":"/api-reference/modes"},{"title":"Pagination \u0026 Sorting","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Core Endpoints","expanded":false,"pages":[{"group":"Account Seeds","pages":[{"title":"Seed","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/account/seed","href":"/api-reference/account-seeds/seed"}]},{"group":"Accounts","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/account","href":"/api-reference/accounts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/account","href":"/api-reference/accounts/update"}]},{"group":"Batch Operations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batch_operations","href":"/api-reference/batch-operations/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batch_operations/{id}","href":"/api-reference/batch-operations/retrieve"}]},{"group":"Batches","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batches","href":"/api-reference/batches/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/batches","href":"/api-reference/batches/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batches/{id}","href":"/api-reference/batches/retrieve"}]},{"group":"Brands","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/brand","href":"/api-reference/brands/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/brand","href":"/api-reference/brands/update"}]},{"group":"Bulk Actions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/bulk_actions","href":"/api-reference/bulk-actions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/bulk_actions","href":"/api-reference/bulk-actions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/bulk_actions/{id}","href":"/api-reference/bulk-actions/retrieve"}]},{"group":"Display Currencies","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/display_currencies","href":"/api-reference/display-currencies/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/display_currencies","href":"/api-reference/display-currencies/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/display_currencies/{id}","href":"/api-reference/display-currencies/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/display_currencies/{id}","href":"/api-reference/display-currencies/delete"}]},{"group":"Events","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/events","href":"/api-reference/events/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/events/{id}","href":"/api-reference/events/retrieve"}]},{"group":"Exports","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/exports","href":"/api-reference/exports/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/exports","href":"/api-reference/exports/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/exports/{id}","href":"/api-reference/exports/retrieve"}]},{"group":"Import Rows","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/import_rows","href":"/api-reference/import-rows/list"}]},{"group":"Imports","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/imports","href":"/api-reference/imports/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/imports/{id}","href":"/api-reference/imports/retrieve"},{"title":"Batch Create Products","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/products","href":"/api-reference/imports/batch-create-products"},{"title":"Batch Create Coupons","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/coupons","href":"/api-reference/imports/batch-create-coupons"},{"title":"Batch Create Product Collections","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/product_collections","href":"/api-reference/imports/batch-create-product-collections"}]},{"group":"Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/medias","href":"/api-reference/medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/medias","href":"/api-reference/medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/medias/{id}","href":"/api-reference/medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/medias/{id}","href":"/api-reference/medias/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/medias/{id}","href":"/api-reference/medias/update"}]},{"group":"Notes","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/notes","href":"/api-reference/notes/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/notes","href":"/api-reference/notes/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/notes/{id}","href":"/api-reference/notes/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/notes/{id}","href":"/api-reference/notes/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/notes/{id}","href":"/api-reference/notes/update"}]},{"group":"Processors","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors","href":"/api-reference/processors/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors/{id}","href":"/api-reference/processors/retrieve"},{"title":"Payment Method Types","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors/{id}/payment_method_types","href":"/api-reference/processors/payment-method-types"}]},{"group":"Statistics","pages":[{"title":"Orders","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/stats/orders","href":"/api-reference/statistics/orders"}]},{"group":"Webhook Endpoints","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/webhook_endpoints","href":"/api-reference/webhook-endpoints/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/webhook_endpoints","href":"/api-reference/webhook-endpoints/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/update"},{"title":"Test","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/webhook_endpoints/{id}/test","href":"/api-reference/webhook-endpoints/test"}]}]},{"group":"Customers","pages":[{"group":"Balance Transactions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balance_transactions","href":"/api-reference/balance-transactions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/balance_transactions","href":"/api-reference/balance-transactions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balance_transactions/{id}","href":"/api-reference/balance-transactions/retrieve"}]},{"group":"Balances","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balances","href":"/api-reference/balances/list"}]},{"group":"Customer Notification Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customer_notification_protocol","href":"/api-reference/customer-notification-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customer_notification_protocol","href":"/api-reference/customer-notification-protocols/update"}]},{"group":"Customer Portal Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customer_portal_protocol","href":"/api-reference/customer-portal-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customer_portal_protocol","href":"/api-reference/customer-portal-protocols/update"}]},{"group":"Customers","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/filter_schema","href":"/api-reference/customers/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/customers/filter","href":"/api-reference/customers/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers","href":"/api-reference/customers/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/customers","href":"/api-reference/customers/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/{id}","href":"/api-reference/customers/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/customers/{id}","href":"/api-reference/customers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customers/{id}","href":"/api-reference/customers/update"},{"title":"Expose Media","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/{id}/expose/{media_id}","href":"/api-reference/customers/expose-media"}]},{"group":"Saved Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_items","href":"/api-reference/saved-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_items","href":"/api-reference/saved-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_items/{id}","href":"/api-reference/saved-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/saved_items/{id}","href":"/api-reference/saved-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/saved_items/{id}","href":"/api-reference/saved-items/update"},{"title":"Move to checkout","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_items/{saved_item_id}/line_item","href":"/api-reference/saved-items/move-to-checkout"},{"title":"Save line item","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/line_items/{line_item_id}/saved_item","href":"/api-reference/saved-items/save-line-item"}]},{"group":"Saved Lists","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_lists","href":"/api-reference/saved-lists/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_lists","href":"/api-reference/saved-lists/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_lists/{id}","href":"/api-reference/saved-lists/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/saved_lists/{id}","href":"/api-reference/saved-lists/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/saved_lists/{id}","href":"/api-reference/saved-lists/update"},{"title":"Move to checkout","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_lists/{saved_list_id}/line_items","href":"/api-reference/saved-lists/move-to-checkout"}]},{"group":"Verification Codes","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/verification_codes","href":"/api-reference/verification-codes/create"},{"title":"Verify","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/verification_codes/verify","href":"/api-reference/verification-codes/verify"}]}]},{"group":"Products","pages":[{"group":"Auto Fee Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fee_protocol","href":"/api-reference/auto-fee-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/auto_fee_protocol","href":"/api-reference/auto-fee-protocols/update"}]},{"group":"Auto Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees","href":"/api-reference/auto-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/auto_fees","href":"/api-reference/auto-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees/{id}","href":"/api-reference/auto-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/auto_fees/{id}","href":"/api-reference/auto-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/auto_fees/{id}","href":"/api-reference/auto-fees/update"},{"title":"Rule Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees/rule_schema/{fee_target}","href":"/api-reference/auto-fees/rule-schema"}]},{"group":"Bumps","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bumps","href":"/api-reference/bumps/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bumps","href":"/api-reference/bumps/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bumps/{id}","href":"/api-reference/bumps/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/bumps/{id}","href":"/api-reference/bumps/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/bumps/{id}","href":"/api-reference/bumps/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bumps/{id}/duplicate","href":"/api-reference/bumps/duplicate"}]},{"group":"Bundle Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bundle_items","href":"/api-reference/bundle-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bundle_items","href":"/api-reference/bundle-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bundle_items/{id}","href":"/api-reference/bundle-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/bundle_items/{id}","href":"/api-reference/bundle-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/bundle_items/{id}","href":"/api-reference/bundle-items/update"}]},{"group":"Coupons","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/coupons","href":"/api-reference/coupons/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/coupons","href":"/api-reference/coupons/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/coupons/{id}","href":"/api-reference/coupons/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/coupons/{id}","href":"/api-reference/coupons/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/coupons/{id}","href":"/api-reference/coupons/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/coupons/{id}/duplicate","href":"/api-reference/coupons/duplicate"}]},{"group":"Discounts","pages":[{"title":"List Discounts","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/discounts","href":"/api-reference/discounts/list-discounts"},{"title":"Retrieve Discount","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/discounts/{id}","href":"/api-reference/discounts/retrieve-discount"}]},{"group":"Downloads","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/downloads","href":"/api-reference/downloads/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/downloads","href":"/api-reference/downloads/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/downloads/{id}","href":"/api-reference/downloads/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/downloads/{id}","href":"/api-reference/downloads/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/downloads/{id}","href":"/api-reference/downloads/update"}]},{"group":"Prices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/prices","href":"/api-reference/prices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/prices","href":"/api-reference/prices/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/prices/{id}","href":"/api-reference/prices/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/prices/{id}","href":"/api-reference/prices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/prices/{id}","href":"/api-reference/prices/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/prices/{id}/duplicate","href":"/api-reference/prices/duplicate"}]},{"group":"Product Collections","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_collections","href":"/api-reference/product-collections/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_collections","href":"/api-reference/product-collections/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_collections/{id}","href":"/api-reference/product-collections/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_collections/{id}","href":"/api-reference/product-collections/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_collections/{id}","href":"/api-reference/product-collections/update"}]},{"group":"Product Groups","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_groups","href":"/api-reference/product-groups/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_groups","href":"/api-reference/product-groups/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_groups/{id}","href":"/api-reference/product-groups/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_groups/{id}","href":"/api-reference/product-groups/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_groups/{id}","href":"/api-reference/product-groups/update"}]},{"group":"Product Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_medias","href":"/api-reference/product-medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_medias","href":"/api-reference/product-medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_medias/{id}","href":"/api-reference/product-medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_medias/{id}","href":"/api-reference/product-medias/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_medias/{id}","href":"/api-reference/product-medias/update"}]},{"group":"Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/products","href":"/api-reference/products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/products","href":"/api-reference/products/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/products/{id}","href":"/api-reference/products/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/products/{id}","href":"/api-reference/products/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/products/{id}","href":"/api-reference/products/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/products/{id}/duplicate","href":"/api-reference/products/duplicate"}]},{"group":"Promotions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/promotions","href":"/api-reference/promotions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/promotions","href":"/api-reference/promotions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/promotions/{id}","href":"/api-reference/promotions/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/promotions/{id}","href":"/api-reference/promotions/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/promotions/{id}","href":"/api-reference/promotions/update"}]},{"group":"Review Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_medias","href":"/api-reference/review-medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/review_medias","href":"/api-reference/review-medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_medias/{id}","href":"/api-reference/review-medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/review_medias/{id}","href":"/api-reference/review-medias/delete"}]},{"group":"Review Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_protocol","href":"/api-reference/review-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/review_protocol","href":"/api-reference/review-protocols/update"}]},{"group":"Reviews","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/reviews","href":"/api-reference/reviews/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/reviews","href":"/api-reference/reviews/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/reviews/{id}","href":"/api-reference/reviews/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/reviews/{id}","href":"/api-reference/reviews/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}","href":"/api-reference/reviews/update"},{"title":"Publish","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}/publish","href":"/api-reference/reviews/publish"},{"title":"Unpublish","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}/unpublish","href":"/api-reference/reviews/unpublish"}]},{"group":"Swaps","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/swaps","href":"/api-reference/swaps/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/swaps","href":"/api-reference/swaps/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/swaps/{id}","href":"/api-reference/swaps/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/swaps/{id}","href":"/api-reference/swaps/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/swaps/{id}","href":"/api-reference/swaps/update"}]},{"group":"Upsell Funnels","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsell_funnels","href":"/api-reference/upsell-funnels/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsell_funnels","href":"/api-reference/upsell-funnels/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsell_funnels/{id}/duplicate","href":"/api-reference/upsell-funnels/duplicate"}]},{"group":"Upsells","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsells","href":"/api-reference/upsells/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsells","href":"/api-reference/upsells/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsells/{id}","href":"/api-reference/upsells/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/upsells/{id}","href":"/api-reference/upsells/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/upsells/{id}","href":"/api-reference/upsells/update"}]},{"group":"Variant Options","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variant_options","href":"/api-reference/variant-options/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variant_options/{id}","href":"/api-reference/variant-options/retrieve"}]},{"group":"Variants","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variants","href":"/api-reference/variants/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/variants","href":"/api-reference/variants/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variants/{id}","href":"/api-reference/variants/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/variants/{id}","href":"/api-reference/variants/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/variants/{id}","href":"/api-reference/variants/update"}]}]},{"group":"Orders \u0026 Payments","pages":[{"group":"Abandoned Checkout Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkout_protocol","href":"/api-reference/abandoned-checkout-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/abandoned_checkout_protocol","href":"/api-reference/abandoned-checkout-protocols/update"}]},{"group":"Abandonded Checkouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkouts","href":"/api-reference/abandonded-checkouts/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkouts/{id}","href":"/api-reference/abandonded-checkouts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/abandoned_checkouts/{id}","href":"/api-reference/abandonded-checkouts/update"}]},{"group":"Charges","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/charges","href":"/api-reference/charges/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/charges/{id}","href":"/api-reference/charges/retrieve"}]},{"group":"Checkout Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_fees","href":"/api-reference/checkout-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/checkout_fees","href":"/api-reference/checkout-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/update"}]},{"group":"Checkout Portal Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_portal_protocol","href":"/api-reference/checkout-portal-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkout_portal_protocol","href":"/api-reference/checkout-portal-protocols/update"}]},{"group":"Checkouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkouts","href":"/api-reference/checkouts/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/checkouts","href":"/api-reference/checkouts/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkouts/{id}","href":"/api-reference/checkouts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}","href":"/api-reference/checkouts/update"},{"title":"Finalize","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/finalize","href":"/api-reference/checkouts/finalize"},{"title":"Manually Pay","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/manually_pay","href":"/api-reference/checkouts/manually-pay"},{"title":"Cancel","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/cancel","href":"/api-reference/checkouts/cancel"},{"title":"Offer Bump","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/offer_bump/{bump_id}","href":"/api-reference/checkouts/offer-bump"},{"title":"Offer Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/offer_upsell/{upsell_id}","href":"/api-reference/checkouts/offer-upsell"},{"title":"Decline Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/decline_upsell/{upsell_id}","href":"/api-reference/checkouts/decline-upsell"}]},{"group":"Disputes","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/disputes","href":"/api-reference/disputes/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/disputes/{id}","href":"/api-reference/disputes/retrieve"}]},{"group":"Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/fees","href":"/api-reference/fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/fees","href":"/api-reference/fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/fees/{id}","href":"/api-reference/fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/fees/{id}","href":"/api-reference/fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/fees/{id}","href":"/api-reference/fees/update"}]},{"group":"Invoices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/invoices","href":"/api-reference/invoices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/invoices","href":"/api-reference/invoices/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/invoices/{id}","href":"/api-reference/invoices/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/invoices/{id}","href":"/api-reference/invoices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}","href":"/api-reference/invoices/update"},{"title":"Make Draft","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}/make_draft","href":"/api-reference/invoices/make-draft"},{"title":"Open","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}/open","href":"/api-reference/invoices/open"},{"title":"Resend Notification","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/invoices/{id}/resend_notification","href":"/api-reference/invoices/resend-notification"}]},{"group":"Line Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/line_items","href":"/api-reference/line-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/line_items","href":"/api-reference/line-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/line_items/{id}","href":"/api-reference/line-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/line_items/{id}","href":"/api-reference/line-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}","href":"/api-reference/line-items/update"},{"title":"Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/line_items/upsell","href":"/api-reference/line-items/upsell"},{"title":"Swap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/swap","href":"/api-reference/line-items/swap"},{"title":"Unswap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/unswap","href":"/api-reference/line-items/unswap"},{"title":"Offer Swap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/offer_swap","href":"/api-reference/line-items/offer-swap"}]},{"group":"Manual Charges","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_charges","href":"/api-reference/manual-charges/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_charges/{id}","href":"/api-reference/manual-charges/retrieve"}]},{"group":"Manual Payment Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_payment_methods","href":"/api-reference/manual-payment-methods/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/manual_payment_methods","href":"/api-reference/manual-payment-methods/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/update"}]},{"group":"Order Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/order_protocol","href":"/api-reference/order-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/order_protocol","href":"/api-reference/order-protocols/update"}]},{"group":"Orders","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders/filter_schema","href":"/api-reference/orders/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/orders/filter","href":"/api-reference/orders/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders","href":"/api-reference/orders/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders/{id}","href":"/api-reference/orders/retrieve"},{"title":"Resend Notification","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/orders/{id}/resend_notification","href":"/api-reference/orders/resend-notification"}]},{"group":"Payment Failures","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_failures","href":"/api-reference/payment-failures/list"}]},{"group":"Payment Intents","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_intents","href":"/api-reference/payment-intents/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/payment_intents","href":"/api-reference/payment-intents/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_intents/{id}","href":"/api-reference/payment-intents/retrieve"},{"title":"Capture","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/payment_intents/{id}/capture","href":"/api-reference/payment-intents/capture"}]},{"group":"Payment Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_methods","href":"/api-reference/payment-methods/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_methods/{id}","href":"/api-reference/payment-methods/retrieve"},{"title":"Detach","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/payment_methods/{id}/detach","href":"/api-reference/payment-methods/detach"}]},{"group":"Purchases","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/purchases","href":"/api-reference/purchases/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/purchases","href":"/api-reference/purchases/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/purchases/{id}","href":"/api-reference/purchases/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}","href":"/api-reference/purchases/update"},{"title":"Invoke","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}/invoke","href":"/api-reference/purchases/invoke"},{"title":"Revoke","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}/revoke","href":"/api-reference/purchases/revoke"}]},{"group":"Refund Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refund_items","href":"/api-reference/refund-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refund_items/{id}","href":"/api-reference/refund-items/retrieve"}]},{"group":"Refunds","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refunds","href":"/api-reference/refunds/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/refunds","href":"/api-reference/refunds/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refunds/{id}","href":"/api-reference/refunds/retrieve"}]},{"group":"Shipping Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/shipping_fees","href":"/api-reference/shipping-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/shipping_fees","href":"/api-reference/shipping-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/update"}]}]},{"group":"Subscriptions","pages":[{"group":"Cancellation Acts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_acts","href":"/api-reference/cancellation-acts/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_acts/{id}","href":"/api-reference/cancellation-acts/retrieve"}]},{"group":"Cancellation Reasons","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_reasons","href":"/api-reference/cancellation-reasons/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/cancellation_reasons","href":"/api-reference/cancellation-reasons/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json delete /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/update"}]},{"group":"Periods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/periods","href":"/api-reference/periods/list"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/periods/{id}","href":"/api-reference/periods/update"},{"title":"Retry Payment","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/periods/{id}/retry_payment","href":"/api-reference/periods/retry-payment"}]},{"group":"Subscription Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscription_protocol","href":"/api-reference/subscription-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscription_protocol","href":"/api-reference/subscription-protocols/update"}]},{"group":"Subscriptions","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions/filter_schema","href":"/api-reference/subscriptions/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/subscriptions/filter","href":"/api-reference/subscriptions/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions","href":"/api-reference/subscriptions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/subscriptions","href":"/api-reference/subscriptions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions/{id}","href":"/api-reference/subscriptions/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}","href":"/api-reference/subscriptions/update"},{"title":"Cancel/Pause","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancelpause"},{"title":"Complete","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/complete","href":"/api-reference/subscriptions/complete"},{"title":"Pay Off","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/pay_off","href":"/api-reference/subscriptions/pay-off"},{"title":"Preserve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/preserve","href":"/api-reference/subscriptions/preserve"},{"title":"Restore","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/restore","href":"/api-reference/subscriptions/restore"},{"title":"Upcoming Period","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/upcoming_period","href":"/api-reference/subscriptions/upcoming-period"}]}]},{"group":"Shipping \u0026 Fulfillment","pages":[{"group":"Fulfillment Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillment_items","href":"/api-reference/fulfillment-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillment_items/{id}","href":"/api-reference/fulfillment-items/retrieve"}]},{"group":"Fulfillments","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillments","href":"/api-reference/fulfillments/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/fulfillments","href":"/api-reference/fulfillments/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillments/{id}","href":"/api-reference/fulfillments/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/fulfillments/{id}","href":"/api-reference/fulfillments/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/fulfillments/{id}","href":"/api-reference/fulfillments/update"}]},{"group":"Parcel Templates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/parcel_templates","href":"/api-reference/parcel-templates/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/parcel_templates","href":"/api-reference/parcel-templates/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/update"}]},{"group":"Return Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_items","href":"/api-reference/return-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_items/{id}","href":"/api-reference/return-items/retrieve"}]},{"group":"Return Requests","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_requests","href":"/api-reference/return-requests/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/return_requests","href":"/api-reference/return-requests/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_requests/{id}","href":"/api-reference/return-requests/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/return_requests/{id}","href":"/api-reference/return-requests/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}","href":"/api-reference/return-requests/update"},{"title":"Open","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}/open","href":"/api-reference/return-requests/open"},{"title":"Complete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}/complete","href":"/api-reference/return-requests/complete"},{"title":"List Return Reasons","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_reasons","href":"/api-reference/return-requests/list-return-reasons"}]},{"group":"Shipments","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipments","href":"/api-reference/shipments/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipments","href":"/api-reference/shipments/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipments/{id}","href":"/api-reference/shipments/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}","href":"/api-reference/shipments/update"},{"title":"Quote","description":"Fetches shipping rates for a specific shipment.","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/quote","href":"/api-reference/shipments/quote"},{"title":"Purchase","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/purchase","href":"/api-reference/shipments/purchase"},{"title":"Void","description":"Voids a purchased shipping label for a specific shipment.","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/void","href":"/api-reference/shipments/void"}]},{"group":"Shipping Choices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_choices","href":"/api-reference/shipping-choices/list"}]},{"group":"Shipping Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_methods","href":"/api-reference/shipping-methods/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_methods","href":"/api-reference/shipping-methods/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_methods/{id}","href":"/api-reference/shipping-methods/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_methods/{id}","href":"/api-reference/shipping-methods/update"}]},{"group":"Shipping Profiles","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_profiles","href":"/api-reference/shipping-profiles/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_profiles","href":"/api-reference/shipping-profiles/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/update"}]},{"group":"Shipping Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_protocol","href":"/api-reference/shipping-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_protocol","href":"/api-reference/shipping-protocols/update"}]},{"group":"Carrier Accounts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{shipping_provider_id}/carrier_accounts","href":"/api-reference/carrier-accounts/list"}]},{"group":"Carrier Parcel Templates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates","href":"/api-reference/carrier-parcel-templates/list"}]},{"group":"Shipping Providers","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers","href":"/api-reference/shipping-providers/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{id}","href":"/api-reference/shipping-providers/retrieve"}]},{"group":"Shipping Rates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_rates","href":"/api-reference/shipping-rates/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_rates","href":"/api-reference/shipping-rates/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/update"}]},{"group":"Shipping Zones","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_zones","href":"/api-reference/shipping-zones/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_zones","href":"/api-reference/shipping-zones/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/update"}]},{"group":"Trackings","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/trackings","href":"/api-reference/trackings/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/trackings/{id}","href":"/api-reference/trackings/retrieve"}]},{"group":"Warehouses","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/warehouses","href":"/api-reference/warehouses/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/warehouses","href":"/api-reference/warehouses/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/warehouses/{id}","href":"/api-reference/warehouses/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/warehouses/{id}","href":"/api-reference/warehouses/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/warehouses/{id}","href":"/api-reference/warehouses/update"}]}]},{"group":"Tax","pages":[{"group":"Tax Overrides","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_overrides","href":"/api-reference/tax-overrides/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json post /v1/tax_overrides","href":"/api-reference/tax-overrides/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json delete /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/update"}]},{"group":"Tax Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_protocol","href":"/api-reference/tax-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_protocol","href":"/api-reference/tax-protocols/update"}]},{"group":"Tax Registrations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_registrations","href":"/api-reference/tax-registrations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json post /v1/tax_registrations","href":"/api-reference/tax-registrations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json delete /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/update"}]},{"group":"Tax Zones","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_zones","href":"/api-reference/tax-zones/list"}]}]},{"group":"Affiliates","pages":[{"group":"Affiliation Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_products","href":"/api-reference/affiliation-products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliation_products","href":"/api-reference/affiliation-products/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/update"}]},{"group":"Affiliation Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_protocol","href":"/api-reference/affiliation-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_protocol","href":"/api-reference/affiliation-protocols/update"}]},{"group":"Affiliation Requests","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_requests","href":"/api-reference/affiliation-requests/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliation_requests","href":"/api-reference/affiliation-requests/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/update"},{"title":"Activate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}/approve","href":"/api-reference/affiliation-requests/activate"},{"title":"Deactivate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}/deny","href":"/api-reference/affiliation-requests/deactivate"}]},{"group":"Affiliations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliations","href":"/api-reference/affiliations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliations","href":"/api-reference/affiliations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliations/{id}","href":"/api-reference/affiliations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliations/{id}","href":"/api-reference/affiliations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}","href":"/api-reference/affiliations/update"},{"title":"Activate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}/activate","href":"/api-reference/affiliations/activate"},{"title":"Deactivate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}/deactivate","href":"/api-reference/affiliations/deactivate"}]},{"group":"Clicks","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/clicks","href":"/api-reference/clicks/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/clicks/{id}","href":"/api-reference/clicks/retrieve"}]},{"group":"Payout Groups","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payout_groups","href":"/api-reference/payout-groups/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/payout_groups","href":"/api-reference/payout-groups/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payout_groups/{id}","href":"/api-reference/payout-groups/retrieve"}]},{"group":"Payouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payouts","href":"/api-reference/payouts/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/payouts","href":"/api-reference/payouts/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payouts/{id}","href":"/api-reference/payouts/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/payouts/{id}","href":"/api-reference/payouts/delete"},{"title":"Complete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/payouts/{id}/complete","href":"/api-reference/payouts/complete"},{"title":"Make Processing","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/payouts/{id}/make_processing","href":"/api-reference/payouts/make-processing"}]},{"group":"Referral Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referral_items","href":"/api-reference/referral-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referral_items/{id}","href":"/api-reference/referral-items/retrieve"}]},{"group":"Referrals","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referrals","href":"/api-reference/referrals/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/referrals","href":"/api-reference/referrals/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referrals/{id}","href":"/api-reference/referrals/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/referrals/{id}","href":"/api-reference/referrals/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}","href":"/api-reference/referrals/update"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/approve","href":"/api-reference/referrals/approve"},{"title":"Deny","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/deny","href":"/api-reference/referrals/deny"},{"title":"Make Reviewing","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/make_reviewing","href":"/api-reference/referrals/make-reviewing"}]}]},{"group":"Licensing","pages":[{"group":"Activations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json get /v1/activations","href":"/api-reference/activations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/activations","href":"/api-reference/activations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/activations/{id}","href":"/api-reference/activations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json delete /v1/public/activations/{id}","href":"/api-reference/activations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json patch /v1/public/activations/{id}","href":"/api-reference/activations/update"}]},{"group":"Licenses","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json get /v1/licenses","href":"/api-reference/licenses/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json post /v1/licenses","href":"/api-reference/licenses/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}","href":"/api-reference/licenses/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json delete /v1/licenses/{id}","href":"/api-reference/licenses/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json patch /v1/licenses/{id}","href":"/api-reference/licenses/update"}]}]},{"group":"Public Endpoints","pages":[{"group":"Activations","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/activations","href":"/api-reference/activations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/activations/{id}","href":"/api-reference/activations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json delete /v1/public/activations/{id}","href":"/api-reference/activations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json patch /v1/public/activations/{id}","href":"/api-reference/activations/update"}]},{"group":"Atlas","pages":[{"title":"List Countries","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/atlas","href":"/api-reference/atlas/list-countries"},{"title":"Retrieve Country","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/atlas/{country_code}","href":"/api-reference/atlas/retrieve-country"}]},{"group":"Clicks","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/clicks","href":"/api-reference/clicks/create"}]},{"group":"Licenses","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}","href":"/api-reference/licenses/retrieve"},{"title":"Expose Current Release","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}/expose_current_release","href":"/api-reference/licenses/expose-current-release"}]}]}]}]},"title":"Purchase - SureCart","buildId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","deploymentId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-S3ptrr-V.js","utils-CUxEJy9u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DavhVrxy.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1sOUY6E.js","snippetPresets-C-RLYOrF.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Duz18EdI.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DPsbCc6D.js","shallow-B1dlhlOw.js","getApiPlaygroundDisplay-DvOu-BhE.js","CodeSnippet-By8wd64X.js","CodeSnippets-BxVv6TjI.js","Page-BGh0lBck.js","getPastedJson-DOAt9xJn.js","icon-BYg-qtQ2.js","MethodPill-Dtah8ZSz.js","DuplicateIcon-guWfDmh1.js","createIcon-pTGhj_hk.js","DynamicMarkdown-DpsHMHVL.js","SectionHeading-BbutQCjq.js","axios-vUo_bRtp.js","Markdown-DZ-stgDu.js","clsx-Dfme4k4V.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CPNs0ebX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-3JVAA-i3.js"]}