The variants can be shipped to the provided country
The phone number is valid
The zip code is valid
The taxNumber field
It is supposed to be there for the provided country
It is formatted correctly and passes regex validation
This endpoint does not currently check the validity of the address itself.Phone number validation is done with libphonenumber-js.Here is a demo page of the phone validation for further testing.
Partners must pass in the companyId field in the body
For Brazil, Mexico, China, Italy, and South Korea you must pass in an additional taxNumber field.
For Brazil the tax number field must pass regex validation as follows
new RegExp(`^\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}$`).test(taxNumber)
For Mexico the pattern is 13 characters (4 letters followed by 6 digits and 3 alphanumeric characters).
new RegExp(`^[A-Za-z]{4}\\d{6}[A-Za-z0-9]{3}$`).test(taxNumber)
For China, Italy, and South Korea there is no validation run on the taxNumber field.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starter Kit","colors":{"primary":"#9563FF","light":"#AE87FF","dark":"#0D001D"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/covver/pyAX8F9IMtzATj71/logo/covver_logo_dark.png?fit=max\u0026auto=format\u0026n=pyAX8F9IMtzATj71\u0026q=85\u0026s=896746ec02247bb966cf221bb664bc31","dark":"https://mintcdn.com/covver/pyAX8F9IMtzATj71/logo/covver_logo_light.png?fit=max\u0026auto=format\u0026n=pyAX8F9IMtzATj71\u0026q=85\u0026s=5510ced9777d8137089a8f9f19bf224f"},"api":{"openapi":["partners.json"]},"background":{"decoration":null,"color":{"light":null,"dark":"#090014"}},"navbar":{"links":[{"label":"rnd@covver.io","href":"mailto:rnd@covver.io"}],"primary":{"type":"button","label":"Dashboard","href":"https://admin.covver.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/covver","website":"https://covver.io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"covver","hasAudioNarration":false,"actualSubdomain":"covver","customDomains":["docs.covver.io"],"gitSource":{"type":"github","owner":"snappygifts","repo":"covver-monorepo","deployBranch":"main","contentDirectory":"api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91d78c1eda65a9fe90d9e:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":37},{"language":"default","tag":"Webhooks","count":16},{"language":"default","tag":"Swag Catalog","count":9},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"People","count":6},{"language":"default","tag":"Auth","count":3},{"language":"default","tag":"API Changelog","count":1},{"language":"default","tag":"Introduction","count":1},{"language":"default","tag":"Guides","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/orders/validate-order","slug":"/api-reference/orders/validate-order","pageMetadata":{"openapi":"post /api/ext/v1/collection/{collectionId}/orders/validate-order","title":"Validate an order","description":"Validate an order","href":"/api-reference/orders/validate-order"},"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: \"Validate an order\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This endpoint validates`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The province is correct for the provided country`}),`\n`,_jsx(_components.li,{children:`The variants can be shipped to the provided country`}),`\n`,_jsx(_components.li,{children:`The phone number is valid`}),`\n`,_jsx(_components.li,{children:`The zip code is valid`}),`\n`,_jsxs(_components.li,{children:[`The taxNumber field`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`It is supposed to be there for the provided country`}),`\n`,_jsx(_components.li,{children:`It is formatted correctly and passes regex validation`}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`This endpoint does not currently check the validity of the address itself.`}),`\n`,_jsxs(_components.p,{children:[`Phone number validation is done with `,_jsx(_components.a,{href:`https://www.npmjs.com/package/libphonenumber-js`,children:`libphonenumber-js`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://catamphetamine.gitlab.io/libphonenumber-js/`,children:`Here`}),` is a demo page of the phone validation for further testing.`]}),`\n`,_jsx(Tip,{children:`Partners must pass in the companyId field in the body`}),`\n`,_jsx(Heading,{level:`2`,id:`tax-number`,children:`Tax number`}),`\n`,_jsx(_components.p,{children:`For Brazil, Mexico, China, Italy, and South Korea you must pass in an additional taxNumber field.\nFor Brazil the tax number field must pass regex validation as follows`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` RegExp`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`^\"}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`d{3}`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`d{3}`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`d{3}-`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"d{2}$`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`).`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`test`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`taxNumber`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`For Mexico the pattern is 13 characters (4 letters followed by 6 digits and 3 alphanumeric characters).`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` RegExp`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`^[A-Za-z]{4}\"}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"d{6}[A-Za-z0-9]{3}$`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`).`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`test`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`taxNumber`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`For China, Italy, and South Korea there is no validation run on the taxNumber field.`}),`\n`,_jsx(Heading,{level:`2`,id:`customattributes`,children:`CustomAttributes`}),`\n`,_jsx(_components.p,{children:`Custom attribute field is deprecated. Please use the taxNumber field instead`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /api/ext/v1/collection/{collectionId}/orders/validate-order","title":"Validate an order","description":"Validate an order","href":"/api-reference/orders/validate-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Tax number","slug":"tax-number","depth":2,"children":[]},{"title":"CustomAttributes","slug":"customattributes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Validate an order","tags":["Orders"],"description":"Validate an order","requestBody":"8b2a3a29-1a63-4bbb-9890-5f5c6d7c1238","parameters":["a884bf35-c9b1-462c-ab6a-7db117fc557d"],"responses":{"200":"62985716-d1ed-4ed2-9326-35027db2706f","4XX":"ffd19825-bc2e-49c4-bc42-746efc391bbc","5XX":"1abacbc5-5e3a-4504-8f48-49479509564f"},"method":"post","type":"path","servers":["6b59b2d2-8f3e-4907-b697-b5042da3c286","4db4bd4e-c63b-4c45-8815-4f4abfcea065","6ae92c6d-6b0f-4c1c-98b5-2b24fdbbc639"],"security":["f7ca11a1-af55-4207-9a6c-0c4777d95786"],"path":"/api/ext/v1/collection/{collectionId}/orders/validate-order","baseUrlOptions":["https://staging-api.covver.io","https://api.covver.io","http://localhost:8080"],"title":"Validate an order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a884bf35-c9b1-462c-ab6a-7db117fc557d":{"schema":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"collectionId","required":true}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"address":{"additionalProperties":false,"type":"object","properties":{"address1":{"maxLength":35,"description":"Max length: 35","type":"string","isRequired":true,"uniqueKey":"address.address1","typeLabel":"string"},"city":{"description":"Max length: 35","type":"string","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"countryCode":{"type":"string","isRequired":true,"uniqueKey":"address.countryCode","typeLabel":"string"},"phone":{"type":"string","isRequired":true,"uniqueKey":"address.phone","typeLabel":"string"},"address2":{"maxLength":35,"description":"Max length: 35","default":"","type":"string","isRequired":true,"uniqueKey":"address.address2","typeLabel":"string"},"province":{"type":"string","uniqueKey":"address.province","typeLabel":"string"},"provinceCode":{"type":"string","uniqueKey":"address.provinceCode","typeLabel":"string"},"customAttributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"address.customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"address.customAttributes.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"address.customAttributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"address.customAttributes","typeLabel":"object[]"},"zip":{"maxLength":16,"description":"Max length: 16","default":"","type":"string","uniqueKey":"address.zip","typeLabel":"string"},"country":{"description":"Deprecated, only countryCode is necessary","type":"string","uniqueKey":"address.country","typeLabel":"string"}},"required":["address1","city","countryCode","phone","address2"],"isRequired":true,"uniqueKey":"address","typeLabel":"object"},"companyId":{"description":"Required for partners","type":"string","uniqueKey":"companyId","typeLabel":"string"},"orderItems":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].variantId","typeLabel":"string"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].quantity","typeLabel":"number"}},"required":["variantId","quantity"],"uniqueKey":"orderItems.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orderItems","typeLabel":"object[]"},"taxNumber":{"type":"string","uniqueKey":"taxNumber","typeLabel":"string"},"customAttributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"customAttributes.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"customAttributes.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"customAttributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customAttributes","typeLabel":"object[]"},"orderNumber":{"type":"string","uniqueKey":"orderNumber","typeLabel":"string"},"shouldValidateProvinceCode":{"type":"boolean","uniqueKey":"shouldValidateProvinceCode","typeLabel":"boolean"}},"required":["address"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"address":{"address1":"\u003cstring>","city":"\u003cstring>","countryCode":"\u003cstring>","phone":"\u003cstring>","address2":"","province":"\u003cstring>","provinceCode":"\u003cstring>","customAttributes":[{"key":"\u003cstring>","value":"\u003cstring>"}],"zip":"","country":"\u003cstring>"},"companyId":"\u003cstring>","orderItems":[{"variantId":"\u003cstring>","quantity":123}],"taxNumber":"\u003cstring>","customAttributes":[{"key":"\u003cstring>","value":"\u003cstring>"}],"orderNumber":"\u003cstring>","shouldValidateProvinceCode":true}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"62985716-d1ed-4ed2-9326-35027db2706f":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.success","typeLabel":"boolean"}},"required":["success"],"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"null","properties":{"success":{"type":"boolean"}},"required":["success"],"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"object | null"},"examples":{"Example":{"title":"Example","value":{"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"ffd19825-bc2e-49c4-bc42-746efc391bbc":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errorCode":{"type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"statusCode":{"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"oneOf":[{}],"uniqueKey":"error","typeLabel":"any"}},"required":["message","errorCode","statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errorCode":"\u003cstring>","statusCode":123,"error":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1abacbc5-5e3a-4504-8f48-49479509564f":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errorCode":{"type":"string","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"statusCode":{"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"oneOf":[{}],"uniqueKey":"error","typeLabel":"any"}},"required":["message","errorCode","statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errorCode":"\u003cstring>","statusCode":123,"error":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f7ca11a1-af55-4207-9a6c-0c4777d95786":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"6b59b2d2-8f3e-4907-b697-b5042da3c286":{"url":"https://staging-api.covver.io","description":"Covver Staging Server"},"4db4bd4e-c63b-4c45-8815-4f4abfcea065":{"url":"https://api.covver.io","description":"Covver Production Server"},"6ae92c6d-6b0f-4c1c-98b5-2b24fdbbc639":{"url":"http://localhost:8080","description":"Covver Local Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","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":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"partners.json"},"subdomain":"covver","siteName":"Starter Kit","title":"Validate an order - Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:48:35.627Z","originalFileLocation":"api-reference/orders/validate-order.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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=\"Validate an order\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Validate an order - Starter Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Validate an order\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.covver.io/api-reference/orders/validate-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://covver.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Validate+an+order\u0026amp;description=Validate+an+order\u0026amp;theme=e854b3bb668ea45c6d43280d\u0026amp;signature=63d3d6645164e6eb7f22d214ef01eb924b45df84a01073ca0da578e6203de7a2\">\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=\"Validate an order - Starter Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validate an order\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://covver.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Validate+an+order\u0026amp;description=Validate+an+order\u0026amp;theme=e854b3bb668ea45c6d43280d\u0026amp;signature=63d3d6645164e6eb7f22d214ef01eb924b45df84a01073ca0da578e6203de7a2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/covver/C5WFNTDSc-tnYIGL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9563FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.covver.io/api-reference/orders/validate-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/validate-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.covver.io/#organization\",\"name\":\"Starter Kit\",\"url\":\"https://docs.covver.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/covver/pyAX8F9IMtzATj71/logo/covver_logo_dark.png?fit=max\u0026auto=format\u0026n=pyAX8F9IMtzATj71\u0026q=85\u0026s=896746ec02247bb966cf221bb664bc31\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.covver.io#website\",\"name\":\"Starter Kit\",\"url\":\"https://docs.covver.io\",\"publisher\":{\"@id\":\"https://docs.covver.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.covver.io/api-reference/orders/validate-order#webpage\",\"url\":\"https://docs.covver.io/api-reference/orders/validate-order\",\"name\":\"Validate an order\",\"description\":\"Validate an order\",\"dateModified\":\"2026-01-06T23:48:35.627Z\",\"isPartOf\":{\"@id\":\"https://docs.covver.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.covver.io/api-reference/orders/validate-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.covver.io/api-reference/orders/validate-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.covver.io/api-reference/catalog\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Orders\",\"item\":\"https://docs.covver.io/api-reference/orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Validate an order\",\"item\":\"https://docs.covver.io/api-reference/orders/validate-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.covver.io/api-reference/orders/validate-order#apireference\",\"headline\":\"Validate an order\",\"name\":\"Validate an order\",\"description\":\"Validate an order\",\"url\":\"https://docs.covver.io/api-reference/orders/validate-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.covver.io/api-reference/orders/validate-order#webpage\"},\"dateModified\":\"2026-01-06T23:48:35.627Z\",\"publisher\":{\"@id\":\"https://docs.covver.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.covver.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Starter Kit","nav":{"global":null,"groups":[{"group":"Introduction","pages":[{"title":"Getting Started","href":"/getting-started"}]},{"group":"Auth","pages":[{"title":"Authentication","href":"/api-reference/auth"},{"openapi":"post /api/ext/v1/oauth/tokens","title":"Create OAuth Tokens","href":"/api-reference/auth/create-oauth-tokens"},{"openapi":"post /api/ext/v1/oauth/refresh-token","title":"Refresh the access token","href":"/api-reference/auth/refresh-token"}]},{"group":"Guides","pages":[{"title":"Personalization","href":"/guides/personalization"}]},{"group":"API Reference","pages":[{"group":"Swag Catalog","pages":[{"title":"Company Swag Catalog Overview","href":"/api-reference/catalog"},{"openapi":"post /api/ext/v1/companies","title":"Create a company (deprecated)","href":"/api-reference/catalog/create-company"},{"openapi":"get /api/ext/v1/collections","title":"List Collections","href":"/api-reference/catalog/list-collections"},{"openapi":"get /api/ext/v1/collection/{collectionId}/products","title":"List a Collection Products","href":"/api-reference/catalog/list-a-collection-products"},{"openapi":"get /api/ext/v1/collection/{collectionId}/product/{productId}","title":"Get Product","href":"/api-reference/catalog/get-product"},{"openapi":"put /api/ext/v1/collection/{collectionId}/product/{productId}","title":"Update Product","href":"/api-reference/catalog/update-product"},{"openapi":"post /api/ext/v1/collection","title":"Create a new collection","href":"/api-reference/catalog/create-collection"},{"openapi":"get /api/ext/v1/collection/{collectionId}/status","title":"Get the status of a collection","href":"/api-reference/catalog/get-collection-status"},{"openapi":"post /api/ext/v1/collection/{collectionId}/personalize","title":"Personalize a collection","href":"/api-reference/catalog/personalize-collection-deprecated"}]},{"group":"Orders","pages":[{"title":"Orders Overview","description":"Place and list orders","href":"/api-reference/orders"},{"openapi":"post /api/ext/v1/collection/{collectionId}/orders/validate-order","title":"Validate an order","href":"/api-reference/orders/validate-order"},{"openapi":"post /api/ext/v1/collection/{collectionId}/orders","title":"Place Order","description":"Place a new order","href":"/api-reference/orders/place-order"},{"openapi":"get /api/ext/v1/collection/{collectionId}/orders/{orderId}","title":"Order status","href":"/api-reference/orders/get-order-status"},{"openapi":"post /api/ext/v1/collection/{collectionId}/orders/get","title":"List Orders","href":"/api-reference/orders/list-orders"},{"openapi":"get /api/ext/v1/shipping-regions","title":null,"href":"/api-reference/orders/list-shipping-regions"}]},{"group":"People","pages":[{"title":"People Overview","href":"/api-reference/people"},{"openapi":"post /api/ext/v1/people/get","title":"List People","href":"/api-reference/people/list-people"},{"openapi":"post /api/ext/v1/people","title":"Create People","href":"/api-reference/people/create-people"},{"openapi":"delete /api/ext/v1/people","title":"Delete People","href":"/api-reference/people/delete-people"},{"openapi":"post /api/ext/v1/people/reward","title":"Reward Credits/Points/Gifts","href":"/api-reference/people/reward-credits"},{"openapi":"post /api/ext/v1/people/withdraw","title":"Withdraw Credits/Points/Gifts","href":"/api-reference/people/withdraw-credits"}]},{"group":"Webhooks","pages":[{"title":"Webhook overview","href":"/api-reference/webhooks"},{"openapi":"get /api/ext/v1/webhook","title":null,"href":"/api-reference/webhooks/list-webhooks"},{"openapi":"post /api/ext/v1/webhook","title":null,"href":"/api-reference/webhooks/create-webhook"},{"openapi":"delete /api/ext/v1/webhook/{id}","title":null,"href":"/api-reference/webhooks/delete-webhook"},{"openapi":"put /api/ext/v1/webhook/{id}","title":null,"href":"/api-reference/webhooks/update-webhook"},{"openapi":"post /api/ext/v1/backdoor/webhook","title":null,"href":"/api-reference/webhooks/trigger-webhook"},{"title":"Order placed webhook event","href":"/api-reference/webhooks/order-placed"},{"title":"Order confirmed webhook event","href":"/api-reference/webhooks/order-confirmed"},{"title":"Order fulfilled webhook event","href":"/api-reference/webhooks/order-fulfilled"},{"title":"Collection created webhook event","href":"/api-reference/webhooks/collection-created"},{"title":"Collection updated webhook event","href":"/api-reference/webhooks/collection-updated"},{"title":"Collection deleted webhook event","href":"/api-reference/webhooks/collection-deleted"},{"title":"Product created webhook event","href":"/api-reference/webhooks/product-created"},{"title":"Product updated webhook event","href":"/api-reference/webhooks/product-updated"},{"title":"Product hidden webhook event","href":"/api-reference/webhooks/product-hidden"},{"title":"Product shown webhook event","href":"/api-reference/webhooks/product-shown"}]}]},{"group":"API Changelog","pages":[{"title":"Changelog","href":"/api-reference/change-log"}]}]},"basePath":"","title":"Validate an order - Starter Kit","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}