{
"error": "First Name can't be blank, Last Name can't be blank, Address can't be blank, City can't be blank, Country can't be blank, Zip Code can't be blank, and Phone can't be blank",
"errors": {
"firstname": [
"can't be blank"
],
"lastname": [
"can't be blank"
],
"address1": [
"can't be blank"
],
"city": [
"can't be blank"
],
"country": [
"can't be blank"
],
"zipcode": [
"can't be blank"
],
"phone": [
"can't be blank"
]
}
}
{
"error": "First Name can't be blank, Last Name can't be blank, Address can't be blank, City can't be blank, Country can't be blank, Zip Code can't be blank, and Phone can't be blank",
"errors": {
"firstname": [
"can't be blank"
],
"lastname": [
"can't be blank"
],
"address1": [
"can't be blank"
],
"city": [
"can't be blank"
],
"country": [
"can't be blank"
],
"zipcode": [
"can't be blank"
],
"phone": [
"can't be blank"
]
}
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Spree Commerce documentation","colors":{"primary":"#0077ff","light":"#4d9fff","dark":"#0060ce"},"logo":{"light":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9","dark":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=3aeefb84d53af450ad04b7283e4d661b"},"favicon":"https://mintcdn.com/spreecommerce/OgdQHBPQ0RbaKyDN/favicon.png?fit=max\u0026auto=format\u0026n=OgdQHBPQ0RbaKyDN\u0026q=85\u0026s=dc14ac5e60560349252428b1dde69c74","api":{"openapi":["api-reference/store.yaml","api-reference/storefront.yaml","api-reference/platform.yaml"],"examples":{"languages":["javascript","curl"]},"mdx":{"server":["http://localhost:3000"]}},"navbar":{"links":[{"icon":{"name":"github","library":"lucide"},"href":"https://github.com/spree/spree","label":"16k"},{"icon":{"name":"discord","library":"lucide"},"href":"https://discord.spreecommerce.org","label":"Join Discord"}]},"footer":{"socials":{"github":"https://github.com/spree/spree","x":"https://x.com/spreecommerce"}},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@spreecommerce"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"night-owl"},"latex":true},"integrations":{"ga4":{"measurementId":"G-NCVLCVHL5Y"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spreecommerce","hasAudioNarration":false,"actualSubdomain":"spreecommerce","customDomains":["spreecommerce.org"],"gitSource":{"type":"github","owner":"spree","repo":"spree","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae08a4b898aa086d1dd0cd8","collectionId":"13ca63be-2945-4e57-b998-98d267c9ca3e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae08a4b898aa086d1dd0cd8"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0957d6f3f3032700c8782","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1119},{"language":"default","tag":"Endpoints","count":784},{"language":"default","tag":"Admin API","count":544},{"language":"default","tag":"Legacy API v2","count":313},{"language":"default","tag":"Platform API","count":231},{"language":"default","tag":"Documentation","count":171},{"language":"default","tag":"Develop","count":171},{"language":"default","tag":"User Guide","count":153},{"language":"default","tag":"Seller API","count":138},{"language":"default","tag":"Store API","count":129}]},"assistantConfig":{"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"deflection":{"enabled":true,"email":"hello@spreecommerce.org","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--spree-accent:#0077ff;--spree-accent-strong:#0060ce;--spree-sand-50:#fcfaf7;--spree-sand-100:#f7f5f2;--spree-sand-150:#e9e5dd;--spree-sand-200:#e2dfd8;--spree-dark-sand-500:#32302e;--spree-dark-sand-600:#272626;--spree-dark-sand-700:#1e1c1b;--spree-dark-sand-800:#191818;--spree-neutral-100:#eaeaea;--spree-neutral-200:#d5d5d5;--spree-neutral-400:#999999;--spree-neutral-600:#666666;--spree-neutral-700:#4d4d4d;--spree-neutral-900:#1a1a1a;--spree-ink:#1a1a1a;--spree-heading:#061932;--spree-ink-muted:#666666;--spree-border:#e2dfd8;--spree-sidebar-hover:rgb(0 0 0 / 0.04);--spree-sidebar-active:rgb(0 0 0 / 0.06);--spree-sidebar-radius:0.625rem;--spree-guide:#d8d4cb}.dark{--spree-sidebar-hover:rgb(255 255 255 / 0.06);--spree-sidebar-active:rgb(255 255 255 / 0.10);--spree-border:#3f3e3c;--spree-guide:#3f3e3c}html:not(.dark) body{background:var(--spree-sand-50)}html.dark body{background:var(--spree-dark-sand-800)}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4{color:var(--spree-heading)}.nav-logo{height:32px}#sidebar-content .sidebar-group-header{display:none}#sidebar-content a,#sidebar-content button:not([class*=\"group/search\"]){border-radius:var(--spree-sidebar-radius)!important;padding-top:.3125rem!important;padding-bottom:.3125rem!important}#sidebar-content ul.sidebar-group>li>a,#sidebar-content ul.sidebar-group>li>button{font-weight:500;padding-top:.5rem!important;padding-bottom:.5rem!important}#sidebar-content ul.sidebar-group>li+li{margin-top:.25rem}#sidebar-content li[data-group-tag]>ul{margin-top:.125rem;margin-bottom:.375rem;position:relative}#sidebar-content a:hover,#sidebar-content button:not([class*=\"group/search\"]):hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content li[data-group-tag][data-active=true]>a,#sidebar-content li[data-group-tag][data-active=true]>button{background-color:var(--spree-sidebar-active)!important;color:var(--spree-neutral-900)!important;font-weight:600!important}.dark #sidebar-content a[class*=\"bg-primary-light/10\"],.dark #sidebar-content a[class*=\"bg-primary/10\"],.dark #sidebar-content li[data-group-tag][data-active=true]>a,.dark #sidebar-content li[data-group-tag][data-active=true]>button{color:#fff!important}#sidebar-content a[class*=\"bg-primary-light/10\"],#sidebar-content a[class*=\"bg-primary/10\"]{background-color:transparent!important;color:var(--spree-neutral-900)!important;font-weight:600!important;text-shadow:none!important}#sidebar-content a[class*=\"bg-primary-light/10\"]:hover,#sidebar-content a[class*=\"bg-primary/10\"]:hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:2.25rem;margin-right:.25rem;width:calc(100% - 2.5rem)!important}#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:3.75rem;width:calc(100% - 4rem)!important}#sidebar-content li[data-group-tag]>ul::before{content:\"\";position:absolute;left:1.75rem;top:0;bottom:0;width:1px;background-color:var(--spree-guide)}#sidebar-content li[data-group-tag] li[data-group-tag]>ul::before{left:3.25rem}#sidebar-content a svg[class*=bg-gray-],#sidebar-content button svg[class*=bg-gray-]{background-color:currentColor!important;opacity:.6}#sidebar-content a:hover svg[class*=bg-gray-],#sidebar-content button:hover svg[class*=bg-gray-],#sidebar-content li[data-group-tag][data-active=true]>button svg[class*=bg-gray-]{opacity:1}#content-container{border-color:var(--spree-border)!important}.dark #content-container{border-color:#3f3e3c!important}@media (min-width:1024px){#content-container{padding-left:3rem!important;padding-right:3rem!important}#content-container>.flex.flex-row-reverse{padding-left:0!important;column-gap:2.5rem!important}}#content-container .flex.flex-row-reverse>.max-w-xl{max-width:52rem}#almond-background-color{background-color:transparent!important}#navbar{background-color:var(--spree-sand-50)}.dark #navbar{background-color:var(--spree-dark-sand-800)}#navbar.is-custom{border-bottom:1px solid var(--spree-border)}.dark #navbar.is-custom{border-bottom-color:#3f3e3c}#navbar>.absolute.inset-0{display:none}.home-band{background:#fff}.dark .home-band{background:var(--spree-dark-sand-700)}.home-band-end{border-bottom:1px solid rgb(233 229 221/.8)}.dark .home-band-end{border-bottom-color:#3f3e3c}#content-container .link{border-bottom:0!important;color:var(--spree-accent)!important;text-decoration:none!important}#content-container .link:hover{color:var(--spree-accent-strong)!important}.dark #content-container .link{color:#4d9fff!important}.dark #content-container .link:hover{color:#7fb8ff!important}:has(>.changelog-header){max-width:56rem;margin:0 auto;padding:4rem 1.25rem 6rem}.changelog-header h1{font-size:2.25rem;font-weight:600;letter-spacing:-.02em;margin-bottom:.75rem}.changelog-header>[data-as=p],.changelog-header>p{color:var(--spree-ink-muted);font-size:1.0625rem;margin-bottom:1.25rem}.changelog-header .changelog-rss{display:inline-flex;align-items:center;gap:.5rem;margin-bottom:3.5rem;padding:.375rem .875rem;border:1px solid var(--spree-border);border-radius:9999px;font-size:.875rem;font-weight:500;text-decoration:none}.changelog-header .changelog-rss:hover{border-color:var(--spree-accent)}:has(>.changelog-header) [data-as=p],:has(>.changelog-header) p{display:block!important;margin:0 0 1rem;line-height:1.7}:has(>.changelog-header) ul{list-style:disc;padding-left:1.25rem;margin:0 0 1rem}:has(>.changelog-header) li{margin:.25rem 0;line-height:1.65}:has(>.changelog-header) li::marker{color:var(--spree-neutral-400)}:has(>.changelog-header) a{color:var(--spree-accent)}:has(>.changelog-header) a:hover{color:var(--spree-accent-strong)}.dark :has(>.changelog-header) a{color:#4d9fff}table{border:1px solid #d0d7de!important;border-radius:.5rem!important;border-collapse:separate!important;border-spacing:0!important;overflow:hidden!important;width:100%}table thead{background-color:#f3f4f6!important}table th{font-weight:500!important;text-align:left;color:#4b5563!important;padding:.625rem .875rem!important;border-bottom:1px solid #d0d7de!important}table td+td,table th+th{border-left:1px solid #e8ebee!important}table td{padding:.75rem .875rem!important;border-bottom:1px solid #e8ebee!important;vertical-align:middle}table tbody tr:last-child td{border-bottom:0!important}.dark table{border-color:#3d444d!important}.dark table thead{background-color:#21262d!important}.dark table th{color:#9198a1!important;border-bottom-color:#3d444d!important}.dark table td+td,.dark table th+th{border-left-color:#2a3038!important}.dark table td{border-bottom-color:#2a3038!important}"}],"page":{"pagePath":"api-reference/platform/addresses/create-an-address","slug":"/api-reference/platform/addresses/create-an-address","pageMetadata":{"title":"Create an Address","description":"Creates an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/addresses","href":"/api-reference/platform/addresses/create-an-address","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: \"Creates an Address\"\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":{"codeStyling":{"theme":"night-owl"},"config":{},"pageMetadata":{"title":"Create an Address","description":"Creates an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/addresses","href":"/api-reference/platform/addresses/create-an-address","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create an Address","tags":["Addresses"],"security":["fdcd892f-2809-4739-976c-6f7d4eaea36d"],"description":"Creates an Address","operationId":"create-address","parameters":["0457b718-6e85-4211-8603-e13ea7c03400"],"responses":{"201":"a2f6f8f0-e4ef-4a46-a852-0cee979c58cc","422":"0ccb29e3-e9df-4f93-9119-9468d010c6ad"},"requestBody":"fc4636ce-0d70-4aed-ab5e-6f9bdef4ed2a","method":"post","type":"path","servers":["5f60c09d-1195-4c13-b029-46de025c2471"],"path":"/api/v2/platform/addresses","baseUrlOptions":["http://{defaultHost}"],"title":"Create an Address","codeSamples":[],"requestExampleLanguages":["javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0457b718-6e85-4211-8603-e13ea7c03400":{"name":"include","in":"query","description":"Select which associated resources you would like to fetch, see: \u003ca href=\"https://jsonapi.org/format/#fetching-includes\">https://jsonapi.org/format/#fetching-includes\u003c/a>","example":"user,country,state","schema":{"type":"string","description":"Select which associated resources you would like to fetch, see: \u003ca href=\"https://jsonapi.org/format/#fetching-includes\">https://jsonapi.org/format/#fetching-includes\u003c/a>","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"object","required":["country_id","address1","city","zipcode","phone","firstname","lastname"],"properties":{"country_id":{"type":"string","example":"224","isRequired":true,"uniqueKey":"address.country_id","typeLabel":"string"},"address1":{"type":"string","example":"5th ave","isRequired":true,"uniqueKey":"address.address1","typeLabel":"string"},"city":{"type":"string","example":"NY","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"zipcode":{"type":"string","example":"10001","isRequired":true,"uniqueKey":"address.zipcode","typeLabel":"string"},"phone":{"type":"string","example":"+1 123 456 789","isRequired":true,"uniqueKey":"address.phone","typeLabel":"string"},"firstname":{"type":"string","example":"John","isRequired":true,"uniqueKey":"address.firstname","typeLabel":"string"},"lastname":{"type":"string","example":"Snow","isRequired":true,"uniqueKey":"address.lastname","typeLabel":"string"},"state_id":{"type":"string","example":"516","uniqueKey":"address.state_id","typeLabel":"string"},"state_name":{"type":"string","example":"New York","uniqueKey":"address.state_name","typeLabel":"string"},"address2":{"type":"string","example":"1st suite","uniqueKey":"address.address2","typeLabel":"string"},"alternative_phone":{"type":"string","uniqueKey":"address.alternative_phone","typeLabel":"string"},"label":{"type":"string","example":"My home address","uniqueKey":"address.label","typeLabel":"string"},"company":{"type":"string","example":"Vendo Connect Inc","uniqueKey":"address.company","typeLabel":"string"},"user_id":{"type":"string","uniqueKey":"address.user_id","typeLabel":"string"},"public_metadata":{"type":"object","example":{"distance_from_nearest_city_in_km":10,"location_type":"building"},"uniqueKey":"address.public_metadata","typeLabel":"object"},"private_metadata":{"type":"object","example":{"close_to_shop":true},"uniqueKey":"address.private_metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"address","typeLabel":"object"}},"required":["address"],"x-internal":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"address":{"country_id":"224","address1":"5th ave","city":"NY","zipcode":"10001","phone":"+1 123 456 789","firstname":"John","lastname":"Snow","state_id":"516","state_name":"New York","address2":"1st suite","alternative_phone":"\u003cstring>","label":"My home address","company":"Vendo Connect Inc","user_id":"\u003cstring>","public_metadata":{"distance_from_nearest_city_in_km":10,"location_type":"building"},"private_metadata":{"close_to_shop":true}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a2f6f8f0-e4ef-4a46-a852-0cee979c58cc":{"description":"Record created","content":{"application/vnd.api+json":{"examples":{"Example":{"title":"Example","value":{"data":{"id":"5","type":"address","attributes":{"firstname":"John","lastname":"Doe","address1":"5 Lovely Street","address2":"Northwest","city":"Herndon","zipcode":"35005","phone":"555-555-0199","state_name":null,"alternative_phone":"555-555-0199","company":"Company","created_at":"2022-11-08T19:33:51.471Z","updated_at":"2022-11-08T19:33:51.471Z","deleted_at":null,"label":null,"public_metadata":{},"private_metadata":{}},"relationships":{"country":{"data":{"id":"4","type":"country"}},"state":{"data":{"id":"5","type":"state"}},"user":{"data":{"id":"1","type":"user"}}}}}}},"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"attributes":{"type":"object","isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"},"relationships":{"type":"object","uniqueKey":"data.relationships","typeLabel":"object"}},"required":["id","type","attributes"],"x-internal":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"x-internal":false,"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"0ccb29e3-e9df-4f93-9119-9468d010c6ad":{"description":"Invalid request","content":{"application/vnd.api+json":{"examples":{"Example":{"title":"Example","value":{"error":"First Name can't be blank, Last Name can't be blank, Address can't be blank, City can't be blank, Country can't be blank, Zip Code can't be blank, and Phone can't be blank","errors":{"firstname":["can't be blank"],"lastname":["can't be blank"],"address1":["can't be blank"],"city":["can't be blank"],"country":["can't be blank"],"zipcode":["can't be blank"],"phone":["can't be blank"]}}}},"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errors":{"type":"object","isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["error","errors"],"x-internal":false,"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"fdcd892f-2809-4739-976c-6f7d4eaea36d":{"bearer_auth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"5f60c09d-1195-4c13-b029-46de025c2471":{"url":"http://{defaultHost}","variables":{"defaultHost":{"default":"localhost:3000"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"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":"api-reference/platform.yaml"},"subdomain":"spreecommerce","siteName":"Spree Commerce documentation","title":"Create an Address - Spree Commerce documentation","navMaps":{"firstHrefInVersion":{"v6.x":{"href":"/developer/getting-started/quickstart","matchLevel":4},"v5.x":{"href":"/api-reference/platform/addresses/create-an-address","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-03-04T17:01:27.120Z","originalFileLocation":"api-reference/platform/addresses/create-an-address.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=\"Creates an Address\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_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=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an Address - Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates an Address\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=Create+an+Address\u0026amp;description=Creates+an+Address\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=d43072dbe7a65e2b94866388f754212f2543d174e872b56699e64a6637f4e526\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an Address - Spree Commerce documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates an Address\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Addresses\u0026amp;title=Create+an+Address\u0026amp;description=Creates+an+Address\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=d43072dbe7a65e2b94866388f754212f2543d174e872b56699e64a6637f4e526\">\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=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0077ff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/platform/addresses/create-an-address.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spreecommerce.org/#organization\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spreecommerce.org/docs#website\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org/docs\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address#webpage\",\"url\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address\",\"name\":\"Create an Address\",\"description\":\"Creates an Address\",\"dateModified\":\"2026-03-04T17:01:27.120Z\",\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform API\",\"item\":\"https://spreecommerce.org/docs/api-reference/platform/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Addresses\",\"item\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/return-a-list-of-addresses\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an Address\",\"item\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address#apireference\",\"headline\":\"Create an Address\",\"name\":\"Create an Address\",\"description\":\"Creates an Address\",\"url\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address\",\"mainEntityOfPage\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/platform/addresses/create-an-address#webpage\"},\"dateModified\":\"2026-03-04T17:01:27.120Z\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"},\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spree Commerce documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spree Commerce documentation","nav":{"global":null,"versions":[{"version":"v6.x","default":true,"pages":[{"title":"v6.x","href":"/developer/getting-started/quickstart"}]},{"version":"v5.x","tabs":[{"tab":"Guides","menu":[{"item":"Getting Started","icon":"rocket","description":"Quickstart guide and core concepts","pages":[{"title":"Getting Started","href":"/v5/developer/getting-started/quickstart"}]},{"item":"Building a Storefront","icon":"store","description":"Next.js, custom frontend, or Rails engine","pages":[{"title":"Building a Storefront","href":"/v5/developer/storefront/nextjs/quickstart"}]},{"item":"Use Cases","icon":"book-open","description":"Multi-store/multi-tenant, and marketplace setups","pages":[{"title":"Use Cases","href":"/v5/developer/multi-tenant/quickstart"}]}],"pages":[{"title":"Guides","href":"/v5/developer/getting-started/quickstart"}]},{"tab":"Framework","menu":[{"item":"Extending","icon":"puzzle","description":"Customize admin panel, API, and business logic","pages":[{"title":"Extending","href":"/v5/developer/tutorial/introduction"}]},{"item":"How-to Guides","icon":"book-open","description":"Step-by-step guides for common tasks","pages":[{"title":"How-to Guides","href":"/v5/developer/how-to/custom-order-routing"}]},{"item":"Operations","icon":"server","description":"Deploy, upgrade, and maintain your store","pages":[{"title":"Operations","href":"/v5/developer/deployment/quickstart"}]}],"pages":[{"title":"Framework","href":"/v5/developer/tutorial/introduction"}]},{"tab":"SDK \u0026 Tools","menu":[{"item":"Store SDK","icon":"code","description":"TypeScript SDK for the Store API","pages":[{"title":"Store SDK","href":"/v5/developer/sdk/quickstart"}]},{"item":"Admin SDK","icon":"shield-check","description":"TypeScript SDK for the Admin API","pages":[{"title":"Admin SDK","href":"/v5/developer/sdk/admin/quickstart"}]},{"item":"CLI","icon":"square-terminal","description":"Command-line interface for Spree","pages":[{"title":"CLI","href":"/v5/developer/cli/quickstart"}]},{"item":"create-spree-app","icon":"rocket","description":"Scaffold a new Spree project","pages":[{"title":"create-spree-app","href":"/v5/developer/create-spree-app/quickstart"}]},{"item":"Agentic Development","icon":"bot","description":"Build Spree with AI coding agents","pages":[{"title":"Agentic Development","href":"/v5/developer/agentic/overview"}]}],"pages":[{"title":"SDK \u0026 Tools","href":"/v5/developer/sdk/quickstart"}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","pages":[{"title":"Store API","href":"/api-reference/store-api/introduction"}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","pages":[{"title":"Admin API","href":"/api-reference/admin-api/introduction"}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]},{"item":"Legacy API v2","icon":"clock","description":"Previous-generation Storefront and Platform APIs","groups":[{"group":"API basics","pages":[{"title":"Ecommerce API","href":"/api-reference/v2/introduction"},{"title":null,"href":"/api-reference/v2/pagination"},{"title":null,"href":"/api-reference/v2/filtering-and-sorting"},{"title":null,"href":"/api-reference/v2/fetching-multiple-resources"}]},{"group":"Tutorials","pages":[{"title":"Quick Checkout with Stripe and Storefront API","href":"/api-reference/tutorials/quick-checkout-with-stripe"},{"title":"Adyen Integration Guide for Android","href":"/api-reference/tutorials/adyen-integration-guide-for-android"},{"title":"Adyen Integration Guide for iOS","href":"/api-reference/tutorials/adyen-integration-guide-for-ios"}]},{"group":"Storefront API","pages":[{"title":"Authentication","href":"/api-reference/storefront/authentication"},{"group":"Account","pages":[{"title":"Retrieve an Account","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account","href":"/api-reference/storefront/account/retrieve-an-account"},{"title":"Create an Account","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/account","href":"/api-reference/storefront/account/create-an-account"},{"title":"Update an Account","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/account","href":"/api-reference/storefront/account/update-an-account"}]},{"group":"Account / Address","pages":[{"title":"List all Addresses","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account/addresses","href":"/api-reference/storefront/account-address/list-all-addresses"},{"title":"Create an Address","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/account/addresses","href":"/api-reference/storefront/account-address/create-an-address"},{"title":"Remove an Address","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/account/addresses/{id}","href":"/api-reference/storefront/account-address/remove-an-address"},{"title":"Update an Address","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/account/addresses/{id}","href":"/api-reference/storefront/account-address/update-an-address"}]},{"group":"Account / Credit Cards","pages":[{"title":"List all Credit Cards","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account/credit_cards","href":"/api-reference/storefront/account-credit-cards/list-all-credit-cards"},{"title":"Remove a Credit Card","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/account/credit_cards/{id}","href":"/api-reference/storefront/account-credit-cards/remove-a-credit-card"},{"title":"Retrieve the default Credit Card","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account/credit_cards/default","href":"/api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card"}]},{"group":"Account / Orders","pages":[{"title":"List all Orders","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account/orders","href":"/api-reference/storefront/account-orders/list-all-orders"},{"title":"Retrieve an Order","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/account/orders/{order_number}","href":"/api-reference/storefront/account-orders/retrieve-an-order"}]},{"group":"Order Status","pages":[{"title":"Retrieve an Order Status","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/order_status/{order_number}","href":"/api-reference/storefront/order-status/retrieve-an-order-status"}]},{"group":"Cart","pages":[{"title":"Retrieve a Cart","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/cart","href":"/api-reference/storefront/cart/retrieve-a-cart"},{"title":"Create a Cart","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/cart","href":"/api-reference/storefront/cart/create-a-cart"},{"title":"Delete a Cart","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/cart","href":"/api-reference/storefront/cart/delete-a-cart"}]},{"group":"Cart / Line Items","pages":[{"title":"Add an Item to Cart","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/cart/add_item","href":"/api-reference/storefront/cart-line-items/add-an-item-to-cart"},{"title":"Set Line Item Quantity","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/cart/set_quantity","href":"/api-reference/storefront/cart-line-items/set-line-item-quantity"},{"title":"Remove a Line Item","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/cart/remove_line_item/{id}","href":"/api-reference/storefront/cart-line-items/remove-a-line-item"}]},{"group":"Cart / Other","pages":[{"title":"Empty the Cart","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/cart/empty","href":"/api-reference/storefront/cart-other/empty-the-cart"},{"title":"List Estimated Shipping Rates","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/cart/estimate_shipping_rates","href":"/api-reference/storefront/cart-other/list-estimated-shipping-rates"},{"title":"Associate a Cart with a User","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/cart/associate","href":"/api-reference/storefront/cart-other/associate-a-cart-with-a-user"},{"title":"Change Cart Currency","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/cart/change_currency","href":"/api-reference/storefront/cart-other/change-cart-currency"}]},{"group":"Cart / Coupons","pages":[{"title":"Apply a Coupon Code / Gift Card","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/cart/apply_coupon_code","href":"/api-reference/storefront/cart-coupons/apply-a-coupon-code-gift-card"},{"title":"Remove a Coupon / Gift Card","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/cart/remove_coupon_code/{coupon_code}","href":"/api-reference/storefront/cart-coupons/remove-a-coupon-gift-card"},{"title":"Remove all Coupons","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/cart/remove_coupon_code","href":"/api-reference/storefront/cart-coupons/remove-all-coupons"}]},{"group":"Checkout","pages":[{"title":"Update Checkout","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/checkout","href":"/api-reference/storefront/checkout/update-checkout"},{"title":"Validate order payment","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/checkout/validate_order_for_payment","href":"/api-reference/storefront/checkout/validate-order-payment"}]},{"group":"Checkout / State","pages":[{"title":"Next Checkout Step","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/checkout/next","href":"/api-reference/storefront/checkout-state/next-checkout-step"},{"title":"Advance Checkout","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/checkout/advance","href":"/api-reference/storefront/checkout-state/advance-checkout"},{"title":"Complete Checkout","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/checkout/complete","href":"/api-reference/storefront/checkout-state/complete-checkout"}]},{"group":"Checkout / Shipments","pages":[{"title":"Selects shipping method for shipment(s)","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/checkout/select_shipping_method","href":"/api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments"},{"title":"List Shipping Rates","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/checkout/shipping_rates","href":"/api-reference/storefront/checkout-shipments/list-shipping-rates"}]},{"group":"Checkout / Payments","pages":[{"title":"Create new Payment","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/checkout/create_payment","href":"/api-reference/storefront/checkout-payments/create-new-payment"},{"title":"List Payment Methods","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/checkout/payment_methods","href":"/api-reference/storefront/checkout-payments/list-payment-methods"}]},{"group":"Checkout / Store Credit","pages":[{"title":"Add Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/checkout/add_store_credit","href":"/api-reference/storefront/checkout-store-credit/add-store-credit"},{"title":"Remove Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/checkout/remove_store_credit","href":"/api-reference/storefront/checkout-store-credit/remove-store-credit"}]},{"group":"Products","pages":[{"title":"List all Products","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/products","href":"/api-reference/storefront/products/list-all-products"},{"title":"Retrieve a Product","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/products/{product_slug}","href":"/api-reference/storefront/products/retrieve-a-product"}]},{"group":"Variants","pages":[{"title":"List all Product Variants","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/products/{product_slug}/variants","href":"/api-reference/storefront/variants/list-all-product-variants"}]},{"group":"Stores","pages":[{"title":"Return the current Store","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/store","href":"/api-reference/storefront/stores/return-the-current-store"}]},{"group":"Policies","pages":[{"title":"List all Store Policies","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/policies","href":"/api-reference/storefront/policies/list-all-store-policies"},{"title":"Retrieve a Policy","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/policies/{policy_slug}","href":"/api-reference/storefront/policies/retrieve-a-policy"}]},{"group":"Posts","pages":[{"title":"List all Posts","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/posts","href":"/api-reference/storefront/posts/list-all-posts"},{"title":"Retrieve a Post","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/posts/{id}","href":"/api-reference/storefront/posts/retrieve-a-post"}]},{"group":"Post Categories","pages":[{"title":"List all Post Categories","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/post_categories","href":"/api-reference/storefront/post-categories/list-all-post-categories"},{"title":"Retrieve a Post Category","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/post_categories/{id}","href":"/api-reference/storefront/post-categories/retrieve-a-post-category"}]},{"group":"Taxons","pages":[{"title":"List all Taxons","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/taxons","href":"/api-reference/storefront/taxons/list-all-taxons"},{"title":"Retrieve a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/taxons/{taxon_permalink}","href":"/api-reference/storefront/taxons/retrieve-a-taxon"}]},{"group":"Countries","pages":[{"title":"List all Countries","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/countries","href":"/api-reference/storefront/countries/list-all-countries"},{"title":"Retrieve a Country","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/countries/{iso}","href":"/api-reference/storefront/countries/retrieve-a-country"},{"title":"Get Default Country","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/countries/default","href":"/api-reference/storefront/countries/get-default-country"}]},{"group":"Stripe","pages":[{"title":"Create a Stripe Payment Intent","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/stripe/payment_intents","href":"/api-reference/storefront/stripe/create-a-stripe-payment-intent"},{"title":"Return a Stripe Payment Intent","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/stripe/payment_intents/{id}","href":"/api-reference/storefront/stripe/return-a-stripe-payment-intent"},{"title":"Updates Stripe Payment Intent","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/stripe/payment_intents/{id}","href":"/api-reference/storefront/stripe/updates-stripe-payment-intent"},{"title":"Mark the payment intent as confirmed, and move the order to the complete state","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/stripe/payment_intents/{id}/confirm","href":"/api-reference/storefront/stripe/mark-the-payment-intent-as-confirmed-and-move-the-order-to-the-complete-state"},{"title":"Create a Stripe Setup Intent","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/stripe/setup_intents","href":"/api-reference/storefront/stripe/create-a-stripe-setup-intent"}]},{"group":"Adyen","pages":[{"title":"Create an Adyen Payment Session","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/adyen/payment_sessions","href":"/api-reference/storefront/adyen/create-an-adyen-payment-session"},{"title":"Complete an Adyen payment session and order","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/adyen/payment_sessions/{id}/complete","href":"/api-reference/storefront/adyen/complete-an-adyen-payment-session-and-order"},{"title":"Get Adyen Payment Session","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/adyen/payment_sessions/{id}","href":"/api-reference/storefront/adyen/get-adyen-payment-session"}]},{"group":"Vendors","pages":[{"title":"List all Vendors","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/vendors","href":"/api-reference/storefront/vendors/list-all-vendors"},{"title":"Retrieve a Vendor","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/vendors/{vendor_slug}","href":"/api-reference/storefront/vendors/retrieve-a-vendor"}]},{"group":"Wishlists","pages":[{"title":"List all Wishlists","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/wishlists","href":"/api-reference/storefront/wishlists/list-all-wishlists"},{"title":"Create a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/wishlists","href":"/api-reference/storefront/wishlists/create-a-wishlist"},{"title":"Retrieve a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/wishlists/{token}","href":"/api-reference/storefront/wishlists/retrieve-a-wishlist"},{"title":"Delete a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/wishlists/{token}","href":"/api-reference/storefront/wishlists/delete-a-wishlist"},{"title":"Update a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/wishlists/{token}","href":"/api-reference/storefront/wishlists/update-a-wishlist"},{"title":"Retrieve the default Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/wishlists/default","href":"/api-reference/storefront/wishlists/retrieve-the-default-wishlist"}]},{"group":"Wishlists / Wished Items","pages":[{"title":"Add Item to Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/wishlists/{token}/add_item","href":"/api-reference/storefront/wishlists-wished-items/add-item-to-wishlist"},{"title":"Add Items to Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml post /api/v2/storefront/wishlists/{token}/add_items","href":"/api-reference/storefront/wishlists-wished-items/add-items-to-wishlist"},{"title":"Set Wished Item Quantity","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml patch /api/v2/storefront/wishlists/{token}/set_item_quantity/{item_id}","href":"/api-reference/storefront/wishlists-wished-items/set-wished-item-quantity"},{"title":"Delete Item from Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/wishlists/{token}/remove_item/{item_id}","href":"/api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist"},{"title":"Delete Items from Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml delete /api/v2/storefront/wishlists/{token}/remove_items","href":"/api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist"}]},{"group":"Digital Downloads","pages":[{"title":"Download a Digital Asset","deprecated":null,"version":null,"openapi":"/api-reference/storefront.yaml get /api/v2/storefront/digitals/{token}","href":"/api-reference/storefront/digital-downloads/download-a-digital-asset"}]}]},{"group":"Platform API","pages":[{"title":null,"href":"/api-reference/platform/authentication"},{"group":"Addresses","pages":[{"title":"Return a list of Addresses","description":"Returns a list of Addresses","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/addresses","href":"/api-reference/platform/addresses/return-a-list-of-addresses"},{"title":"Create an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/addresses","href":"/api-reference/platform/addresses/create-an-address"},{"title":"Return an Address","description":"Returns an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/addresses/{id}","href":"/api-reference/platform/addresses/return-an-address"},{"title":"Delete an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/addresses/{id}","href":"/api-reference/platform/addresses/delete-an-address"},{"title":"Update an Address","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/addresses/{id}","href":"/api-reference/platform/addresses/update-an-address"}]},{"group":"Adjustments","pages":[{"title":"Return a list of Adjustments","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/adjustments","href":"/api-reference/platform/adjustments/return-a-list-of-adjustments"},{"title":"Create an Adjustment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/adjustments","href":"/api-reference/platform/adjustments/create-an-adjustment"},{"title":"Return an Adjustment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/adjustments/{id}","href":"/api-reference/platform/adjustments/return-an-adjustment"},{"title":"Delete an Adjustment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/adjustments/{id}","href":"/api-reference/platform/adjustments/delete-an-adjustment"},{"title":"Update an Adjustment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/adjustments/{id}","href":"/api-reference/platform/adjustments/update-an-adjustment"}]},{"group":"Classifications","pages":[{"title":"Return a list of Classifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/classifications","href":"/api-reference/platform/classifications/return-a-list-of-classifications"},{"title":"Create a Classification","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/classifications","href":"/api-reference/platform/classifications/create-a-classification"},{"title":"Return a Classification","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/classifications/{id}","href":"/api-reference/platform/classifications/return-a-classification"},{"title":"Delete a Classification","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/classifications/{id}","href":"/api-reference/platform/classifications/delete-a-classification"},{"title":"Update a Classification","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/classifications/{id}","href":"/api-reference/platform/classifications/update-a-classification"}]},{"group":"CMS Pages","pages":[{"title":"Return a list of CMS Pages","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/cms_pages","href":"/api-reference/platform/cms-pages/return-a-list-of-cms-pages"},{"title":"Create a CMS Page","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/cms_pages","href":"/api-reference/platform/cms-pages/create-a-cms-page"},{"title":"Return a CMS Page","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/cms_pages/{id}","href":"/api-reference/platform/cms-pages/return-a-cms-page"},{"title":"Delete a CMS Page","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/cms_pages/{id}","href":"/api-reference/platform/cms-pages/delete-a-cms-page"},{"title":"Update a CMS Page","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/cms_pages/{id}","href":"/api-reference/platform/cms-pages/update-a-cms-page"}]},{"group":"CMS Sections","pages":[{"title":"Return a list of CMS Sections","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/cms_sections","href":"/api-reference/platform/cms-sections/return-a-list-of-cms-sections"},{"title":"Create a CMS Section","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/cms_sections","href":"/api-reference/platform/cms-sections/create-a-cms-section"},{"title":"Return a CMS Section","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/cms_sections/{id}","href":"/api-reference/platform/cms-sections/return-a-cms-section"},{"title":"Delete a CMS Section","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/cms_sections/{id}","href":"/api-reference/platform/cms-sections/delete-a-cms-section"},{"title":"Update a CMS Section","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/cms_sections/{id}","href":"/api-reference/platform/cms-sections/update-a-cms-section"}]},{"group":"Countries","pages":[{"title":"Returns a list of Countries","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/countries","href":"/api-reference/platform/countries/returns-a-list-of-countries"},{"title":"Returns a Country","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/countries/{id}","href":"/api-reference/platform/countries/returns-a-country"}]},{"group":"Data Feeds","pages":[{"title":"Return a list of Data Feeds","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/data_feeds","href":"/api-reference/platform/data-feeds/return-a-list-of-data-feeds"},{"title":"Create a Data Feed","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/data_feeds","href":"/api-reference/platform/data-feeds/create-a-data-feed"},{"title":"Return a Data Feed","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/data_feeds/{id}","href":"/api-reference/platform/data-feeds/return-a-data-feed"},{"title":"Delete a Data Feed","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/data_feeds/{id}","href":"/api-reference/platform/data-feeds/delete-a-data-feed"},{"title":"Update a Data Feed","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/data_feeds/{id}","href":"/api-reference/platform/data-feeds/update-a-data-feed"}]},{"group":"Digital Links","pages":[{"title":"Return a list of Digital Links","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/digital_links","href":"/api-reference/platform/digital-links/return-a-list-of-digital-links"},{"title":"Create a Digital Link","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/digital_links","href":"/api-reference/platform/digital-links/create-a-digital-link"},{"title":"Return a Digital Link","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/digital_links/{id}","href":"/api-reference/platform/digital-links/return-a-digital-link"},{"title":"Delete a Digital Link","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/digital_links/{id}","href":"/api-reference/platform/digital-links/delete-a-digital-link"},{"title":"Update a Digital Link","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/digital_links/{id}","href":"/api-reference/platform/digital-links/update-a-digital-link"},{"title":"Reset a Digital Link","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/digital_links/{id}/reset","href":"/api-reference/platform/digital-links/reset-a-digital-link"}]},{"group":"Digital Assets","pages":[{"title":"Return a list of Digital Assets","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/digitals","href":"/api-reference/platform/digital-assets/return-a-list-of-digital-assets"},{"title":"Create a Digital Asset","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/digitals","href":"/api-reference/platform/digital-assets/create-a-digital-asset"},{"title":"Return a Digital Asset","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/digitals/{id}","href":"/api-reference/platform/digital-assets/return-a-digital-asset"},{"title":"Delete a Digital Asset","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/digitals/{id}","href":"/api-reference/platform/digital-assets/delete-a-digital-asset"},{"title":"Update a Digital Asset","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/digitals/{id}","href":"/api-reference/platform/digital-assets/update-a-digital-asset"}]},{"group":"Line Items","pages":[{"title":"Return a list of Line Items","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/line_items","href":"/api-reference/platform/line-items/return-a-list-of-line-items"},{"title":"Create a Line Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/line_items","href":"/api-reference/platform/line-items/create-a-line-item"},{"title":"Return a Line Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/line_items/{id}","href":"/api-reference/platform/line-items/return-a-line-item"},{"title":"Delete a Line Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/line_items/{id}","href":"/api-reference/platform/line-items/delete-a-line-item"},{"title":"Update a Line Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/line_items/{id}","href":"/api-reference/platform/line-items/update-a-line-item"}]},{"group":"Menu Items","pages":[{"title":"Return a list of Menu Items","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/menu_items","href":"/api-reference/platform/menu-items/return-a-list-of-menu-items"},{"title":"Create a Menu Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/menu_items","href":"/api-reference/platform/menu-items/create-a-menu-item"},{"title":"Return a Menu Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/menu_items/{id}","href":"/api-reference/platform/menu-items/return-a-menu-item"},{"title":"Delete a Menu Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/menu_items/{id}","href":"/api-reference/platform/menu-items/delete-a-menu-item"},{"title":"Update a Menu Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/menu_items/{id}","href":"/api-reference/platform/menu-items/update-a-menu-item"},{"title":"Reposition a Menu Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/menu_items/{id}/reposition","href":"/api-reference/platform/menu-items/reposition-a-menu-item"}]},{"group":"Menus","pages":[{"title":"Return a list of Menus","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/menus","href":"/api-reference/platform/menus/return-a-list-of-menus"},{"title":"Create a Menu","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/menus","href":"/api-reference/platform/menus/create-a-menu"},{"title":"Return a Menu","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/menus/{id}","href":"/api-reference/platform/menus/return-a-menu"},{"title":"Delete a Menu","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/menus/{id}","href":"/api-reference/platform/menus/delete-a-menu"},{"title":"Update a Menu","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/menus/{id}","href":"/api-reference/platform/menus/update-a-menu"}]},{"group":"Option Types","pages":[{"title":"Return a list of Option Types","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/option_types","href":"/api-reference/platform/option-types/return-a-list-of-option-types"},{"title":"Create an Option Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/option_types","href":"/api-reference/platform/option-types/create-an-option-type"},{"title":"Return an Option Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/option_types/{id}","href":"/api-reference/platform/option-types/return-an-option-type"},{"title":"Delete an Option Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/option_types/{id}","href":"/api-reference/platform/option-types/delete-an-option-type"},{"title":"Update an Option Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/option_types/{id}","href":"/api-reference/platform/option-types/update-an-option-type"}]},{"group":"Option Values","pages":[{"title":"Return a list of Option Values","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/option_values","href":"/api-reference/platform/option-values/return-a-list-of-option-values"},{"title":"Create an Option Value","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/option_values","href":"/api-reference/platform/option-values/create-an-option-value"},{"title":"Return an Option Value","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/option_values/{id}","href":"/api-reference/platform/option-values/return-an-option-value"},{"title":"Delete an Option Value","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/option_values/{id}","href":"/api-reference/platform/option-values/delete-an-option-value"},{"title":"Update an Option Value","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/option_values/{id}","href":"/api-reference/platform/option-values/update-an-option-value"}]},{"group":"Orders","pages":[{"title":"Return a list of Orders","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/orders","href":"/api-reference/platform/orders/return-a-list-of-orders"},{"title":"Creates an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/orders","href":"/api-reference/platform/orders/creates-an-order"},{"title":"Return an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/orders/{id}","href":"/api-reference/platform/orders/return-an-order"},{"title":"Delete an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/orders/{id}","href":"/api-reference/platform/orders/delete-an-order"},{"title":"Update an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}","href":"/api-reference/platform/orders/update-an-order"},{"title":"Advances an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/advance","href":"/api-reference/platform/orders/advances-an-order"},{"title":"Next an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/next","href":"/api-reference/platform/orders/next-an-order"},{"title":"Completes an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/complete","href":"/api-reference/platform/orders/completes-an-order"},{"title":"Empties an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/empty","href":"/api-reference/platform/orders/empties-an-order"},{"title":"Approves an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/approve","href":"/api-reference/platform/orders/approves-an-order"},{"title":"Cancels an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/cancel","href":"/api-reference/platform/orders/cancels-an-order"},{"title":"Use Store Credit for an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/use_store_credit","href":"/api-reference/platform/orders/use-store-credit-for-an-order"},{"title":"Apply Coupon Code for an Order","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/orders/{id}/apply_coupon_code","href":"/api-reference/platform/orders/apply-coupon-code-for-an-order"}]},{"group":"Payment Methods","pages":[{"title":"Return a list of Payment Methods","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/payment_methods","href":"/api-reference/platform/payment-methods/return-a-list-of-payment-methods"},{"title":"Create a Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/payment_methods","href":"/api-reference/platform/payment-methods/create-a-payment-method"},{"title":"Return a Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/payment_methods/{id}","href":"/api-reference/platform/payment-methods/return-a-payment-method"},{"title":"Delete a Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/payment_methods/{id}","href":"/api-reference/platform/payment-methods/delete-a-payment-method"},{"title":"Update a Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/payment_methods/{id}","href":"/api-reference/platform/payment-methods/update-a-payment-method"}]},{"group":"Payments","pages":[{"title":"Return a list of Payments","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/payments","href":"/api-reference/platform/payments/return-a-list-of-payments"},{"title":"Return a Payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/payments/{id}","href":"/api-reference/platform/payments/return-a-payment"},{"title":"Delete a Payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/payments/{id}","href":"/api-reference/platform/payments/delete-a-payment"}]},{"group":"Products","pages":[{"title":"Return a list of Products","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/products","href":"/api-reference/platform/products/return-a-list-of-products"},{"title":"Create a Product","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/products","href":"/api-reference/platform/products/create-a-product"},{"title":"Return a Product","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/products/{id}","href":"/api-reference/platform/products/return-a-product"},{"title":"Delete a Product","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/products/{id}","href":"/api-reference/platform/products/delete-a-product"},{"title":"Update a Product","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/products/{id}","href":"/api-reference/platform/products/update-a-product"}]},{"group":"Promotion Actions","pages":[{"title":"Return a list of Promotion Actions","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_actions","href":"/api-reference/platform/promotion-actions/return-a-list-of-promotion-actions"},{"title":"Create a Promotion Action","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/promotion_actions","href":"/api-reference/platform/promotion-actions/create-a-promotion-action"},{"title":"Return a Promotion Action","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_actions/{id}","href":"/api-reference/platform/promotion-actions/return-a-promotion-action"},{"title":"Delete a Promotion Action","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/promotion_actions/{id}","href":"/api-reference/platform/promotion-actions/delete-a-promotion-action"},{"title":"Update a Promotion Action","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/promotion_actions/{id}","href":"/api-reference/platform/promotion-actions/update-a-promotion-action"}]},{"group":"Promotion Categories","pages":[{"title":"Return a list of Promotion Categories","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_categories","href":"/api-reference/platform/promotion-categories/return-a-list-of-promotion-categories"},{"title":"Create a Promotion Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/promotion_categories","href":"/api-reference/platform/promotion-categories/create-a-promotion-category"},{"title":"Return a Promotion Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_categories/{id}","href":"/api-reference/platform/promotion-categories/return-a-promotion-category"},{"title":"Delete a Promotion Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/promotion_categories/{id}","href":"/api-reference/platform/promotion-categories/delete-a-promotion-category"},{"title":"Update a Promotion Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/promotion_categories/{id}","href":"/api-reference/platform/promotion-categories/update-a-promotion-category"}]},{"group":"Promotion Rules","pages":[{"title":"Return a list of Promotion Rules","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_rules","href":"/api-reference/platform/promotion-rules/return-a-list-of-promotion-rules"},{"title":"Create a Promotion Rule","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/promotion_rules","href":"/api-reference/platform/promotion-rules/create-a-promotion-rule"},{"title":"Return a Promotion Rule","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotion_rules/{id}","href":"/api-reference/platform/promotion-rules/return-a-promotion-rule"},{"title":"Delete a Promotion Rule","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/promotion_rules/{id}","href":"/api-reference/platform/promotion-rules/delete-a-promotion-rule"},{"title":"Update a Promotion Rule","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/promotion_rules/{id}","href":"/api-reference/platform/promotion-rules/update-a-promotion-rule"}]},{"group":"Promotions","pages":[{"title":"Return a list of Promotions","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotions","href":"/api-reference/platform/promotions/return-a-list-of-promotions"},{"title":"Create a Promotion","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/promotions","href":"/api-reference/platform/promotions/create-a-promotion"},{"title":"Return a Promotion","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/promotions/{id}","href":"/api-reference/platform/promotions/return-a-promotion"},{"title":"Delete a Promotion","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/promotions/{id}","href":"/api-reference/platform/promotions/delete-a-promotion"},{"title":"Update a Promotion","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/promotions/{id}","href":"/api-reference/platform/promotions/update-a-promotion"}]},{"group":"Roles","pages":[{"title":"Return a list of Roles","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/roles","href":"/api-reference/platform/roles/return-a-list-of-roles"},{"title":"Create a Role","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/roles","href":"/api-reference/platform/roles/create-a-role"},{"title":"Return a Role","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/roles/{id}","href":"/api-reference/platform/roles/return-a-role"},{"title":"Delete a Role","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/roles/{id}","href":"/api-reference/platform/roles/delete-a-role"},{"title":"Update a Role","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/roles/{id}","href":"/api-reference/platform/roles/update-a-role"}]},{"group":"Shipments","pages":[{"title":"Return a list of Shipments","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipments","href":"/api-reference/platform/shipments/return-a-list-of-shipments"},{"title":"Create a Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/shipments","href":"/api-reference/platform/shipments/create-a-shipment"},{"title":"Return a Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipments/{id}","href":"/api-reference/platform/shipments/return-a-shipment"},{"title":"Delete a Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/shipments/{id}","href":"/api-reference/platform/shipments/delete-a-shipment"},{"title":"Update a Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}","href":"/api-reference/platform/shipments/update-a-shipment"},{"title":"Adds item (Variant) to an existing Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/add_item","href":"/api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment"},{"title":"Removes item (Variant) from Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/remove_item","href":"/api-reference/platform/shipments/removes-item-variant-from-shipment"},{"title":"Mark Shipment as ready to be shipped","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/ready","href":"/api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped"},{"title":"Mark Shipment as shipped","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/ship","href":"/api-reference/platform/shipments/mark-shipment-as-shipped"},{"title":"Cancels the Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/cancel","href":"/api-reference/platform/shipments/cancels-the-shipment"},{"title":"Resumes the Shipment","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/resume","href":"/api-reference/platform/shipments/resumes-the-shipment"},{"title":"Moves Shipment back to pending state","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipments/{id}/pend","href":"/api-reference/platform/shipments/moves-shipment-back-to-pending-state"}]},{"group":"Shipping Categories","pages":[{"title":"Return a list of Shipping Categories","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipping_categories","href":"/api-reference/platform/shipping-categories/return-a-list-of-shipping-categories"},{"title":"Create a Shipping Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/shipping_categories","href":"/api-reference/platform/shipping-categories/create-a-shipping-category"},{"title":"Return a Shipping Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipping_categories/{id}","href":"/api-reference/platform/shipping-categories/return-a-shipping-category"},{"title":"Delete a Shipping Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/shipping_categories/{id}","href":"/api-reference/platform/shipping-categories/delete-a-shipping-category"},{"title":"Update a Shipping Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipping_categories/{id}","href":"/api-reference/platform/shipping-categories/update-a-shipping-category"}]},{"group":"Shipping Methods","pages":[{"title":"Return a list of Shipping Methods","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipping_methods","href":"/api-reference/platform/shipping-methods/return-a-list-of-shipping-methods"},{"title":"Create a Shipping Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/shipping_methods","href":"/api-reference/platform/shipping-methods/create-a-shipping-method"},{"title":"Return a Shipping Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/shipping_methods/{id}","href":"/api-reference/platform/shipping-methods/return-a-shipping-method"},{"title":"Delete a Shipping Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/shipping_methods/{id}","href":"/api-reference/platform/shipping-methods/delete-a-shipping-method"},{"title":"Update a Shipping Method","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/shipping_methods/{id}","href":"/api-reference/platform/shipping-methods/update-a-shipping-method"}]},{"group":"States","pages":[{"title":"Returns a list of States","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/states","href":"/api-reference/platform/states/returns-a-list-of-states"},{"title":"Returns a State","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/states/{id}","href":"/api-reference/platform/states/returns-a-state"}]},{"group":"Stock Items","pages":[{"title":"Return a list of Stock Items","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/stock_items","href":"/api-reference/platform/stock-items/return-a-list-of-stock-items"},{"title":"Create a Stock Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/stock_items","href":"/api-reference/platform/stock-items/create-a-stock-item"},{"title":"Return a Stock Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/stock_items/{id}","href":"/api-reference/platform/stock-items/return-a-stock-item"},{"title":"Delete a Stock Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/stock_items/{id}","href":"/api-reference/platform/stock-items/delete-a-stock-item"},{"title":"Update a Stock Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/stock_items/{id}","href":"/api-reference/platform/stock-items/update-a-stock-item"}]},{"group":"Stock Locations","pages":[{"title":"Return a list of Stock Locations","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/stock_locations","href":"/api-reference/platform/stock-locations/return-a-list-of-stock-locations"},{"title":"Create a Stock Location","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/stock_locations","href":"/api-reference/platform/stock-locations/create-a-stock-location"},{"title":"Return a Stock Location","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/stock_locations/{id}","href":"/api-reference/platform/stock-locations/return-a-stock-location"},{"title":"Delete a Stock Location","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/stock_locations/{id}","href":"/api-reference/platform/stock-locations/delete-a-stock-location"},{"title":"Update a Stock Location","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/stock_locations/{id}","href":"/api-reference/platform/stock-locations/update-a-stock-location"}]},{"group":"Store Credit Categories","pages":[{"title":"Return a list of Store Credit Categories","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credit_categories","href":"/api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories"},{"title":"Create a Store Credit Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/store_credit_categories","href":"/api-reference/platform/store-credit-categories/create-a-store-credit-category"},{"title":"Return a Store Credit Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credit_categories/{id}","href":"/api-reference/platform/store-credit-categories/return-a-store-credit-category"},{"title":"Delete a Store Credit Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/store_credit_categories/{id}","href":"/api-reference/platform/store-credit-categories/delete-a-store-credit-category"},{"title":"Update a Store Credit Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/store_credit_categories/{id}","href":"/api-reference/platform/store-credit-categories/update-a-store-credit-category"}]},{"group":"Store Credit Types","pages":[{"title":"Return a list of Store Credit Types","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credit_types","href":"/api-reference/platform/store-credit-types/return-a-list-of-store-credit-types"},{"title":"Create a Store Credit Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/store_credit_types","href":"/api-reference/platform/store-credit-types/create-a-store-credit-type"},{"title":"Return a Store Credit Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credit_types/{id}","href":"/api-reference/platform/store-credit-types/return-a-store-credit-type"},{"title":"Delete a Store Credit Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/store_credit_types/{id}","href":"/api-reference/platform/store-credit-types/delete-a-store-credit-type"},{"title":"Update a Store Credit Type","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/store_credit_types/{id}","href":"/api-reference/platform/store-credit-types/update-a-store-credit-type"}]},{"group":"Store Credits","pages":[{"title":"Return a list of Store Credits","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credits","href":"/api-reference/platform/store-credits/return-a-list-of-store-credits"},{"title":"Create a Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/store_credits","href":"/api-reference/platform/store-credits/create-a-store-credit"},{"title":"Return a Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/store_credits/{id}","href":"/api-reference/platform/store-credits/return-a-store-credit"},{"title":"Delete a Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/store_credits/{id}","href":"/api-reference/platform/store-credits/delete-a-store-credit"},{"title":"Update a Store Credit","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/store_credits/{id}","href":"/api-reference/platform/store-credits/update-a-store-credit"}]},{"group":"Tax Categories","pages":[{"title":"Return a list of Tax Categories","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/tax_categories","href":"/api-reference/platform/tax-categories/return-a-list-of-tax-categories"},{"title":"Create a Tax Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/tax_categories","href":"/api-reference/platform/tax-categories/create-a-tax-category"},{"title":"Return a Tax Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/tax_categories/{id}","href":"/api-reference/platform/tax-categories/return-a-tax-category"},{"title":"Delete a Tax Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/tax_categories/{id}","href":"/api-reference/platform/tax-categories/delete-a-tax-category"},{"title":"Update a Tax Category","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/tax_categories/{id}","href":"/api-reference/platform/tax-categories/update-a-tax-category"}]},{"group":"Tax Rates","pages":[{"title":"Return a list of Tax Rates","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/tax_rates","href":"/api-reference/platform/tax-rates/return-a-list-of-tax-rates"},{"title":"Create a Tax Rate","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/tax_rates","href":"/api-reference/platform/tax-rates/create-a-tax-rate"},{"title":"Return a Tax Rate","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/tax_rates/{id}","href":"/api-reference/platform/tax-rates/return-a-tax-rate"},{"title":"Delete a Tax Rate","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/tax_rates/{id}","href":"/api-reference/platform/tax-rates/delete-a-tax-rate"},{"title":"Update a Tax Rate","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/tax_rates/{id}","href":"/api-reference/platform/tax-rates/update-a-tax-rate"}]},{"group":"Taxonomies","pages":[{"title":"Return a list of Taxonomies","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/taxonomies","href":"/api-reference/platform/taxonomies/return-a-list-of-taxonomies"},{"title":"Create a Taxonomy","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/taxonomies","href":"/api-reference/platform/taxonomies/create-a-taxonomy"},{"title":"Return a Taxonomy","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/taxonomies/{id}","href":"/api-reference/platform/taxonomies/return-a-taxonomy"},{"title":"Delete a Taxonomy","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/taxonomies/{id}","href":"/api-reference/platform/taxonomies/delete-a-taxonomy"},{"title":"Update a Taxonomy","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/taxonomies/{id}","href":"/api-reference/platform/taxonomies/update-a-taxonomy"}]},{"group":"Taxons","pages":[{"title":"Return a list of Taxons","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/taxons","href":"/api-reference/platform/taxons/return-a-list-of-taxons"},{"title":"Create a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/taxons","href":"/api-reference/platform/taxons/create-a-taxon"},{"title":"Return a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/taxons/{id}","href":"/api-reference/platform/taxons/return-a-taxon"},{"title":"Delete a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/taxons/{id}","href":"/api-reference/platform/taxons/delete-a-taxon"},{"title":"Update a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/taxons/{id}","href":"/api-reference/platform/taxons/update-a-taxon"},{"title":"Reposition a Taxon","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/taxons/{id}/reposition","href":"/api-reference/platform/taxons/reposition-a-taxon"}]},{"group":"Users","pages":[{"title":"Return a list of Users","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/users","href":"/api-reference/platform/users/return-a-list-of-users"},{"title":"Create a User","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/users","href":"/api-reference/platform/users/create-a-user"},{"title":"Return a User","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/users/{id}","href":"/api-reference/platform/users/return-a-user"},{"title":"Delete a User","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/users/{id}","href":"/api-reference/platform/users/delete-a-user"},{"title":"Update a User","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/users/{id}","href":"/api-reference/platform/users/update-a-user"}]},{"group":"Variants","pages":[{"title":"Return a list of Variants","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/variants","href":"/api-reference/platform/variants/return-a-list-of-variants"},{"title":"Return a Variant","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/variants/{id}","href":"/api-reference/platform/variants/return-a-variant"},{"title":"Delete a Variant","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/variants/{id}","href":"/api-reference/platform/variants/delete-a-variant"}]},{"group":"Vendors","pages":[{"title":"Return a list of Vendors","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/vendors","href":"/api-reference/platform/vendors/return-a-list-of-vendors"},{"title":"Create a Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/vendors","href":"/api-reference/platform/vendors/create-a-vendor"},{"title":"Return a Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/vendors/{id}","href":"/api-reference/platform/vendors/return-a-vendor"},{"title":"Delete a Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/vendors/{id}","href":"/api-reference/platform/vendors/delete-a-vendor"},{"title":"Update a Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}","href":"/api-reference/platform/vendors/update-a-vendor"},{"title":"Invites Vendor to the platform","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/invite","href":"/api-reference/platform/vendors/invites-vendor-to-the-platform"},{"title":"Start onboarding process","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/start_onboarding","href":"/api-reference/platform/vendors/start-onboarding-process"},{"title":"Completes onboarding process","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/complete_onboarding","href":"/api-reference/platform/vendors/completes-onboarding-process"},{"title":"Approves Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/approve","href":"/api-reference/platform/vendors/approves-vendor"},{"title":"Rejects Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/reject","href":"/api-reference/platform/vendors/rejects-vendor"},{"title":"Suspends Vendor","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/vendors/{id}/suspend","href":"/api-reference/platform/vendors/suspends-vendor"}]},{"group":"Webhook Events","pages":[{"title":"Return a list of Webhook Events","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/webhooks/events","href":"/api-reference/platform/webhook-events/return-a-list-of-webhook-events"}]},{"group":"Webhook Subscribers","pages":[{"title":"Return a list of Webhook Subscribers","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/webhooks/subscribers","href":"/api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers"},{"title":"Create a Webhook Subscriber","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/webhooks/subscribers","href":"/api-reference/platform/webhook-subscribers/create-a-webhook-subscriber"},{"title":"Return a Webhook Subscriber","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/webhooks/subscribers/{id}","href":"/api-reference/platform/webhook-subscribers/return-a-webhook-subscriber"},{"title":"Delete a Webhook Subscriber","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/webhooks/subscribers/{id}","href":"/api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber"},{"title":"Update a Webhook Subscriber","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/webhooks/subscribers/{id}","href":"/api-reference/platform/webhook-subscribers/update-a-webhook-subscriber"}]},{"group":"Wished Items","pages":[{"title":"Return a list of Wished Items","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/wished_items","href":"/api-reference/platform/wished-items/return-a-list-of-wished-items"},{"title":"Create a Wished Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/wished_items","href":"/api-reference/platform/wished-items/create-a-wished-item"},{"title":"Return a Wished Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/wished_items/{id}","href":"/api-reference/platform/wished-items/return-a-wished-item"},{"title":"Delete a Wished Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/wished_items/{id}","href":"/api-reference/platform/wished-items/delete-a-wished-item"},{"title":"Update a Wished Item","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/wished_items/{id}","href":"/api-reference/platform/wished-items/update-a-wished-item"}]},{"group":"Wishlists","pages":[{"title":"Return a list of Wishlists","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/wishlists","href":"/api-reference/platform/wishlists/return-a-list-of-wishlists"},{"title":"Create a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/wishlists","href":"/api-reference/platform/wishlists/create-a-wishlist"},{"title":"Return a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/wishlists/{id}","href":"/api-reference/platform/wishlists/return-a-wishlist"},{"title":"Delete a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/wishlists/{id}","href":"/api-reference/platform/wishlists/delete-a-wishlist"},{"title":"Update a Wishlist","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/wishlists/{id}","href":"/api-reference/platform/wishlists/update-a-wishlist"}]},{"group":"Zones","pages":[{"title":"Return a list of Zones","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/zones","href":"/api-reference/platform/zones/return-a-list-of-zones"},{"title":"Create a Zone","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml post /api/v2/platform/zones","href":"/api-reference/platform/zones/create-a-zone"},{"title":"Return a Zone","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml get /api/v2/platform/zones/{id}","href":"/api-reference/platform/zones/return-a-zone"},{"title":"Delete a Zone","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml delete /api/v2/platform/zones/{id}","href":"/api-reference/platform/zones/delete-a-zone"},{"title":"Update a Zone","deprecated":null,"version":null,"openapi":"/api-reference/platform.yaml patch /api/v2/platform/zones/{id}","href":"/api-reference/platform/zones/update-a-zone"}]}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/v5/user/what-is-spree-commerce"}]}]}]},"title":"Create an Address - Spree Commerce documentation","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}