npm - @spree/cli - Versions diffs - 3.6.1 → 3.6.2 - Mend

@spree/cli 3.6.1 → 3.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/bin/spree.js +4 -0
package/dist/index.js +3 -3
package/dist/templates/dashboard-starter/AGENTS.md +2 -0
package/dist/templates/seller-dashboard-starter/AGENTS.md +2 -0
package/package.json +4 -8

package/dist/index.js CHANGED Viewed

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { createRequire as __createRequire } from "node:module";
 const require = __createRequire(import.meta.url);
-var Tf=Object.create;var Yd=Object.defineProperty;var Cf=Object.getOwnPropertyDescriptor;var Df=Object.getOwnPropertyNames;var Ef=Object.getPrototypeOf,$f=Object.prototype.hasOwnProperty;var Jd=(e,t,r)=>()=>{if(r)throw r[0];try{return e&&(t=e(e=0)),t}catch(n){throw r=[n],n}};var pe=(e,t)=>()=>{try{return t||e((t={exports:{}}).exports,t),t.exports}catch(r){throw t=0,r}};var If=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of Df(t))!$f.call(e,i)&&i!==r&&Yd(e,i,{get:()=>t[i],enumerable:!(n=Cf(t,i))||n.enumerable});return e};var G=(e,t,r)=>(r=e!=null?Tf(Ef(e)):{},If(t||!e||!e.__esModule?Yd(r,"default",{value:e,enumerable:!0}):r,e));var _,c=Jd(()=>{_={spree_admin_sdk_range:"^6.0.0-0",spree_dashboard_core_range:"^6.0.0-0",spree_dashboard_ui_range:"^6.0.0-0"}});var f,p=Jd(()=>{f={packages:["@spree/sdk","@spree/admin-sdk","@spree/seller-sdk","@spree/core","@spree/dashboard","@spree/dashboard-core","@spree/dashboard-ui","@spree/seller-dashboard"],version:"6.0.1"}});var Q=pe((UD,ts)=>{"use strict";c();p();var Zn=process||{},tc=Zn.argv||[],Vn=Zn.env||{},Gf=!(Vn.NO_COLOR||tc.includes("--no-color"))&&(!!Vn.FORCE_COLOR||tc.includes("--color")||Zn.platform==="win32"||(Zn.stdout||{}).isTTY&&Vn.TERM!=="dumb"||!!Vn.CI),Uf=(e,t,r=e)=>n=>{let i=""+n,a=i.indexOf(t,e.length);return~a?e+Kf(i,t,r,a)+t:e+i+t},Kf=(e,t,r,n)=>{let i="",a=0;do i+=e.substring(a,n)+r,a=n+t.length,n=e.indexOf(t,a);while(~n);return i+e.substring(a)},rc=(e=Gf)=>{let t=e?Uf:()=>String;return{isColorSupported:e,reset:t("\x1B[0m","\x1B[0m"),bold:t("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"),dim:t("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"),italic:t("\x1B[3m","\x1B[23m"),underline:t("\x1B[4m","\x1B[24m"),inverse:t("\x1B[7m","\x1B[27m"),hidden:t("\x1B[8m","\x1B[28m"),strikethrough:t("\x1B[9m","\x1B[29m"),black:t("\x1B[30m","\x1B[39m"),red:t("\x1B[31m","\x1B[39m"),green:t("\x1B[32m","\x1B[39m"),yellow:t("\x1B[33m","\x1B[39m"),blue:t("\x1B[34m","\x1B[39m"),magenta:t("\x1B[35m","\x1B[39m"),cyan:t("\x1B[36m","\x1B[39m"),white:t("\x1B[37m","\x1B[39m"),gray:t("\x1B[90m","\x1B[39m"),bgBlack:t("\x1B[40m","\x1B[49m"),bgRed:t("\x1B[41m","\x1B[49m"),bgGreen:t("\x1B[42m","\x1B[49m"),bgYellow:t("\x1B[43m","\x1B[49m"),bgBlue:t("\x1B[44m","\x1B[49m"),bgMagenta:t("\x1B[45m","\x1B[49m"),bgCyan:t("\x1B[46m","\x1B[49m"),bgWhite:t("\x1B[47m","\x1B[49m"),blackBright:t("\x1B[90m","\x1B[39m"),redBright:t("\x1B[91m","\x1B[39m"),greenBright:t("\x1B[92m","\x1B[39m"),yellowBright:t("\x1B[93m","\x1B[39m"),blueBright:t("\x1B[94m","\x1B[39m"),magentaBright:t("\x1B[95m","\x1B[39m"),cyanBright:t("\x1B[96m","\x1B[39m"),whiteBright:t("\x1B[97m","\x1B[39m"),bgBlackBright:t("\x1B[100m","\x1B[49m"),bgRedBright:t("\x1B[101m","\x1B[49m"),bgGreenBright:t("\x1B[102m","\x1B[49m"),bgYellowBright:t("\x1B[103m","\x1B[49m"),bgBlueBright:t("\x1B[104m","\x1B[49m"),bgMagentaBright:t("\x1B[105m","\x1B[49m"),bgCyanBright:t("\x1B[106m","\x1B[49m"),bgWhiteBright:t("\x1B[107m","\x1B[49m")}};ts.exports=rc();ts.exports.createColors=rc});var ss=pe((oE,fc)=>{"use strict";c();p();var as={to(e,t){return t?`\x1B[${t+1};${e+1}H`:`\x1B[${e+1}G`},move(e,t){let r="";return e<0?r+=`\x1B[${-e}D`:e>0&&(r+=`\x1B[${e}C`),t<0?r+=`\x1B[${-t}A`:t>0&&(r+=`\x1B[${t}B`),r},up:(e=1)=>`\x1B[${e}A`,down:(e=1)=>`\x1B[${e}B`,forward:(e=1)=>`\x1B[${e}C`,backward:(e=1)=>`\x1B[${e}D`,nextLine:(e=1)=>"\x1B[E".repeat(e),prevLine:(e=1)=>"\x1B[F".repeat(e),left:"\x1B[G",hide:"\x1B[?25l",show:"\x1B[?25h",save:"\x1B7",restore:"\x1B8"},ig={up:(e=1)=>"\x1B[S".repeat(e),down:(e=1)=>"\x1B[T".repeat(e)},ag={screen:"\x1B[2J",up:(e=1)=>"\x1B[1J".repeat(e),down:(e=1)=>"\x1B[J".repeat(e),line:"\x1B[2K",lineEnd:"\x1B[K",lineStart:"\x1B[1K",lines(e){let t="";for(let r=0;r<e;r++)t+=this.line+(r<e-1?as.up():"");return e&&(t+=as.left),t}};fc.exports={cursor:as,scroll:ig,erase:ag,beep:"\x07"}});var fd=pe(Dr=>{"use strict";c();p();Object.defineProperty(Dr,"__esModule",{value:!0});Dr.DEFAULT_COLOR_MAP=void 0;Dr.DEFAULT_COLOR_MAP={red:"\x1B[31m",green:"\x1B[32m",yellow:"\x1B[33m",blue:"\x1B[34m",magenta:"\x1B[35m",cyan:"\x1B[36m",white:"\x1B[37m",white_bold:"\x1B[01m",reset:"\x1B[0m"};var _d=class{constructor(t=Dr.DEFAULT_COLOR_MAP){this.text="",this.colorMap=t}addCharsWithColor(t,r){let n=this.colorMap[t];this.text+=n!==void 0?`${n}${r}${this.colorMap.reset}`:r}renderConsole(){return this.text}};Dr.default=_d});var Rn=pe(de=>{"use strict";c();p();Object.defineProperty(de,"__esModule",{value:!0});de.DEFAULT_HEADER_ALIGNMENT=de.DEFAULT_ROW_ALIGNMENT=de.DEFAULT_HEADER_FONT_COLOR=de.DEFAULT_ROW_FONT_COLOR=de.COLORS=de.ALIGNMENTS=de.DEFAULT_TABLE_STYLE=de.DEFAULT_ROW_SEPARATOR=de.DEFAULT_COLUMN_LEN=void 0;de.DEFAULT_COLUMN_LEN=20;de.DEFAULT_ROW_SEPARATOR=!1;de.DEFAULT_TABLE_STYLE={headerTop:{left:"\u250C",mid:"\u252C",right:"\u2510",other:"\u2500"},headerBottom:{left:"\u251C",mid:"\u253C",right:"\u2524",other:"\u2500"},tableBottom:{left:"\u2514",mid:"\u2534",right:"\u2518",other:"\u2500"},vertical:"\u2502",rowSeparator:{left:"\u251C",mid:"\u253C",right:"\u2524",other:"\u2500"}};de.ALIGNMENTS=["right","left","center"];de.COLORS=["red","green","yellow","white","blue","magenta","cyan","white_bold","reset"];de.DEFAULT_ROW_FONT_COLOR="white";de.DEFAULT_HEADER_FONT_COLOR="white_bold";de.DEFAULT_ROW_ALIGNMENT="right";de.DEFAULT_HEADER_ALIGNMENT="center"});var xy=pe(gd=>{"use strict";c();p();Object.defineProperty(gd,"__esModule",{value:!0});var pR=[{first:768,last:879},{first:1155,last:1158},{first:1160,last:1161},{first:1425,last:1469},{first:1471,last:1471},{first:1473,last:1474},{first:1476,last:1477},{first:1479,last:1479},{first:1536,last:1539},{first:1552,last:1557},{first:1611,last:1630},{first:1648,last:1648},{first:1750,last:1764},{first:1767,last:1768},{first:1770,last:1773},{first:1807,last:1807},{first:1809,last:1809},{first:1840,last:1866},{first:1958,last:1968},{first:2027,last:2035},{first:2305,last:2306},{first:2364,last:2364},{first:2369,last:2376},{first:2381,last:2381},{first:2385,last:2388},{first:2402,last:2403},{first:2433,last:2433},{first:2492,last:2492},{first:2497,last:2500},{first:2509,last:2509},{first:2530,last:2531},{first:2561,last:2562},{first:2620,last:2620},{first:2625,last:2626},{first:2631,last:2632},{first:2635,last:2637},{first:2672,last:2673},{first:2689,last:2690},{first:2748,last:2748},{first:2753,last:2757},{first:2759,last:2760},{first:2765,last:2765},{first:2786,last:2787},{first:2817,last:2817},{first:2876,last:2876},{first:2879,last:2879},{first:2881,last:2883},{first:2893,last:2893},{first:2902,last:2902},{first:2946,last:2946},{first:3008,last:3008},{first:3021,last:3021},{first:3134,last:3136},{first:3142,last:3144},{first:3146,last:3149},{first:3157,last:3158},{first:3260,last:3260},{first:3263,last:3263},{first:3270,last:3270},{first:3276,last:3277},{first:3298,last:3299},{first:3393,last:3395},{first:3405,last:3405},{first:3530,last:3530},{first:3538,last:3540},{first:3542,last:3542},{first:3633,last:3633},{first:3636,last:3642},{first:3655,last:3662},{first:3761,last:3761},{first:3764,last:3769},{first:3771,last:3772},{first:3784,last:3789},{first:3864,last:3865},{first:3893,last:3893},{first:3895,last:3895},{first:3897,last:3897},{first:3953,last:3966},{first:3968,last:3972},{first:3974,last:3975},{first:3984,last:3991},{first:3993,last:4028},{first:4038,last:4038},{first:4141,last:4144},{first:4146,last:4146},{first:4150,last:4151},{first:4153,last:4153},{first:4184,last:4185},{first:4448,last:4607},{first:4959,last:4959},{first:5906,last:5908},{first:5938,last:5940},{first:5970,last:5971},{first:6002,last:6003},{first:6068,last:6069},{first:6071,last:6077},{first:6086,last:6086},{first:6089,last:6099},{first:6109,last:6109},{first:6155,last:6157},{first:6313,last:6313},{first:6432,last:6434},{first:6439,last:6440},{first:6450,last:6450},{first:6457,last:6459},{first:6679,last:6680},{first:6912,last:6915},{first:6964,last:6964},{first:6966,last:6970},{first:6972,last:6972},{first:6978,last:6978},{first:7019,last:7027},{first:7616,last:7626},{first:7678,last:7679},{first:8203,last:8207},{first:8234,last:8238},{first:8288,last:8291},{first:8298,last:8303},{first:8400,last:8431},{first:12330,last:12335},{first:12441,last:12442},{first:43014,last:43014},{first:43019,last:43019},{first:43045,last:43046},{first:64286,last:64286},{first:65024,last:65039},{first:65056,last:65059},{first:65279,last:65279},{first:65529,last:65531},{first:68097,last:68099},{first:68101,last:68102},{first:68108,last:68111},{first:68152,last:68154},{first:68159,last:68159},{first:119143,last:119145},{first:119155,last:119170},{first:119173,last:119179},{first:119210,last:119213},{first:119362,last:119364},{first:917505,last:917505},{first:917536,last:917631},{first:917760,last:917999}];gd.default=pR});var Py=pe(bd=>{"use strict";c();p();Object.defineProperty(bd,"__esModule",{value:!0});var lR=(e,t,r)=>{let n=0,i,a=r;if(e<t[0].first||e>t[a].last)return 0;for(;a>=n;)if(i=Math.floor((n+a)/2),e>t[i].last)n=i+1;else if(e<t[i].first)a=i-1;else return 1;return 0};bd.default=lR});var qd=pe(Tn=>{"use strict";c();p();var Sy=Tn&&Tn.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Tn,"__esModule",{value:!0});var wy=Sy(xy()),uR=Sy(Py()),mR=e=>e===0?0:e<32||e>=127&&e<160?-1:(0,uR.default)(e,wy.default,wy.default.length-1)?0:1+ +(e>=4352&&(e<=4447||e===9001||e===9002||e>=11904&&e<=42191&&e!==12351||e>=44032&&e<=55203||e>=63744&&e<=64255||e>=65040&&e<=65049||e>=65072&&e<=65135||e>=65280&&e<=65376||e>=65504&&e<=65510||e>=131072&&e<=196605||e>=196608&&e<=262141));Tn.default=mR});var Ay=pe(Cn=>{"use strict";c();p();var hR=Cn&&Cn.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Cn,"__esModule",{value:!0});var yR=hR(qd()),_R=e=>{let t=0;for(let r=0;r<e.length;r++){let n=e.charCodeAt(r),i=(0,yR.default)(n);if(i<0)return-1;t+=i}return t};Cn.default=_R});var Ty=pe(Et=>{"use strict";c();p();var Ry=Et&&Et.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Et,"__esModule",{value:!0});Et.wcswidth=Et.wcwidth=void 0;var fR=Ry(Ay());Et.wcswidth=fR.default;var gR=Ry(qd());Et.wcwidth=gR.default});var vd=pe(Qt=>{"use strict";c();p();Object.defineProperty(Qt,"__esModule",{value:!0});Qt.findWidthInConsole=Qt.stripAnsi=void 0;var bR=Ty(),qR=/\x1b\[\d{1,3}(;\d{1,3})*m/g,vR=e=>e.replace(qR,"");Qt.stripAnsi=vR;var kR=(e,t)=>{let r=0;return e=(0,Qt.stripAnsi)(e),t&&Object.entries(t).forEach(([n,i])=>{let a=new RegExp(n,"g");r+=(e.match(a)||[]).length*i,e=e.replace(n,"")}),r+=(0,bR.wcswidth)(e),r};Qt.findWidthInConsole=kR});var xd=pe(ot=>{"use strict";c();p();Object.defineProperty(ot,"__esModule",{value:!0});ot.biggestWordInSentence=ot.textWithPadding=ot.splitTextIntoTextsOfMinLen=void 0;var kd=vd(),xR=(e,t,r)=>{let n=[];return e.split(/[\n\r]/).forEach(a=>{let s=a.split(" "),o=[],d=0;s.forEach(l=>{let u=(0,kd.findWidthInConsole)(l,r);d+u<=t?(d+=u+1,o.push(l)):(o.length>0&&n.push(o.join(" ")),o=[l],d=u+1)}),n.push(o.join(" "))}),n};ot.splitTextIntoTextsOfMinLen=xR;var PR=(e,t,r,n)=>{let i=(0,kd.findWidthInConsole)(e,n),a=Math.floor((r-i)/2),s=r-a-i;if(r<i){let o=(0,ot.splitTextIntoTextsOfMinLen)(e,r);return o.length===1?e:o.map(d=>(0,ot.textWithPadding)(d,t,r,n)).join(`
+var Tf=Object.create;var Yd=Object.defineProperty;var Cf=Object.getOwnPropertyDescriptor;var Df=Object.getOwnPropertyNames;var Ef=Object.getPrototypeOf,$f=Object.prototype.hasOwnProperty;var Jd=(e,t,r)=>()=>{if(r)throw r[0];try{return e&&(t=e(e=0)),t}catch(n){throw r=[n],n}};var pe=(e,t)=>()=>{try{return t||e((t={exports:{}}).exports,t),t.exports}catch(r){throw t=0,r}};var If=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of Df(t))!$f.call(e,i)&&i!==r&&Yd(e,i,{get:()=>t[i],enumerable:!(n=Cf(t,i))||n.enumerable});return e};var G=(e,t,r)=>(r=e!=null?Tf(Ef(e)):{},If(t||!e||!e.__esModule?Yd(r,"default",{value:e,enumerable:!0}):r,e));var _,c=Jd(()=>{_={spree_admin_sdk_range:"^6.0.0-0",spree_dashboard_core_range:"^6.0.0-0",spree_dashboard_ui_range:"^6.0.0-0"}});var f,p=Jd(()=>{f={packages:["@spree/sdk","@spree/admin-sdk","@spree/seller-sdk","@spree/core","@spree/dashboard","@spree/dashboard-core","@spree/dashboard-ui","@spree/seller-dashboard"],version:"6.0.2"}});var Q=pe((UD,ts)=>{"use strict";c();p();var Zn=process||{},tc=Zn.argv||[],Vn=Zn.env||{},Gf=!(Vn.NO_COLOR||tc.includes("--no-color"))&&(!!Vn.FORCE_COLOR||tc.includes("--color")||Zn.platform==="win32"||(Zn.stdout||{}).isTTY&&Vn.TERM!=="dumb"||!!Vn.CI),Uf=(e,t,r=e)=>n=>{let i=""+n,a=i.indexOf(t,e.length);return~a?e+Kf(i,t,r,a)+t:e+i+t},Kf=(e,t,r,n)=>{let i="",a=0;do i+=e.substring(a,n)+r,a=n+t.length,n=e.indexOf(t,a);while(~n);return i+e.substring(a)},rc=(e=Gf)=>{let t=e?Uf:()=>String;return{isColorSupported:e,reset:t("\x1B[0m","\x1B[0m"),bold:t("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"),dim:t("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"),italic:t("\x1B[3m","\x1B[23m"),underline:t("\x1B[4m","\x1B[24m"),inverse:t("\x1B[7m","\x1B[27m"),hidden:t("\x1B[8m","\x1B[28m"),strikethrough:t("\x1B[9m","\x1B[29m"),black:t("\x1B[30m","\x1B[39m"),red:t("\x1B[31m","\x1B[39m"),green:t("\x1B[32m","\x1B[39m"),yellow:t("\x1B[33m","\x1B[39m"),blue:t("\x1B[34m","\x1B[39m"),magenta:t("\x1B[35m","\x1B[39m"),cyan:t("\x1B[36m","\x1B[39m"),white:t("\x1B[37m","\x1B[39m"),gray:t("\x1B[90m","\x1B[39m"),bgBlack:t("\x1B[40m","\x1B[49m"),bgRed:t("\x1B[41m","\x1B[49m"),bgGreen:t("\x1B[42m","\x1B[49m"),bgYellow:t("\x1B[43m","\x1B[49m"),bgBlue:t("\x1B[44m","\x1B[49m"),bgMagenta:t("\x1B[45m","\x1B[49m"),bgCyan:t("\x1B[46m","\x1B[49m"),bgWhite:t("\x1B[47m","\x1B[49m"),blackBright:t("\x1B[90m","\x1B[39m"),redBright:t("\x1B[91m","\x1B[39m"),greenBright:t("\x1B[92m","\x1B[39m"),yellowBright:t("\x1B[93m","\x1B[39m"),blueBright:t("\x1B[94m","\x1B[39m"),magentaBright:t("\x1B[95m","\x1B[39m"),cyanBright:t("\x1B[96m","\x1B[39m"),whiteBright:t("\x1B[97m","\x1B[39m"),bgBlackBright:t("\x1B[100m","\x1B[49m"),bgRedBright:t("\x1B[101m","\x1B[49m"),bgGreenBright:t("\x1B[102m","\x1B[49m"),bgYellowBright:t("\x1B[103m","\x1B[49m"),bgBlueBright:t("\x1B[104m","\x1B[49m"),bgMagentaBright:t("\x1B[105m","\x1B[49m"),bgCyanBright:t("\x1B[106m","\x1B[49m"),bgWhiteBright:t("\x1B[107m","\x1B[49m")}};ts.exports=rc();ts.exports.createColors=rc});var ss=pe((oE,fc)=>{"use strict";c();p();var as={to(e,t){return t?`\x1B[${t+1};${e+1}H`:`\x1B[${e+1}G`},move(e,t){let r="";return e<0?r+=`\x1B[${-e}D`:e>0&&(r+=`\x1B[${e}C`),t<0?r+=`\x1B[${-t}A`:t>0&&(r+=`\x1B[${t}B`),r},up:(e=1)=>`\x1B[${e}A`,down:(e=1)=>`\x1B[${e}B`,forward:(e=1)=>`\x1B[${e}C`,backward:(e=1)=>`\x1B[${e}D`,nextLine:(e=1)=>"\x1B[E".repeat(e),prevLine:(e=1)=>"\x1B[F".repeat(e),left:"\x1B[G",hide:"\x1B[?25l",show:"\x1B[?25h",save:"\x1B7",restore:"\x1B8"},ig={up:(e=1)=>"\x1B[S".repeat(e),down:(e=1)=>"\x1B[T".repeat(e)},ag={screen:"\x1B[2J",up:(e=1)=>"\x1B[1J".repeat(e),down:(e=1)=>"\x1B[J".repeat(e),line:"\x1B[2K",lineEnd:"\x1B[K",lineStart:"\x1B[1K",lines(e){let t="";for(let r=0;r<e;r++)t+=this.line+(r<e-1?as.up():"");return e&&(t+=as.left),t}};fc.exports={cursor:as,scroll:ig,erase:ag,beep:"\x07"}});var fd=pe(Dr=>{"use strict";c();p();Object.defineProperty(Dr,"__esModule",{value:!0});Dr.DEFAULT_COLOR_MAP=void 0;Dr.DEFAULT_COLOR_MAP={red:"\x1B[31m",green:"\x1B[32m",yellow:"\x1B[33m",blue:"\x1B[34m",magenta:"\x1B[35m",cyan:"\x1B[36m",white:"\x1B[37m",white_bold:"\x1B[01m",reset:"\x1B[0m"};var _d=class{constructor(t=Dr.DEFAULT_COLOR_MAP){this.text="",this.colorMap=t}addCharsWithColor(t,r){let n=this.colorMap[t];this.text+=n!==void 0?`${n}${r}${this.colorMap.reset}`:r}renderConsole(){return this.text}};Dr.default=_d});var Rn=pe(de=>{"use strict";c();p();Object.defineProperty(de,"__esModule",{value:!0});de.DEFAULT_HEADER_ALIGNMENT=de.DEFAULT_ROW_ALIGNMENT=de.DEFAULT_HEADER_FONT_COLOR=de.DEFAULT_ROW_FONT_COLOR=de.COLORS=de.ALIGNMENTS=de.DEFAULT_TABLE_STYLE=de.DEFAULT_ROW_SEPARATOR=de.DEFAULT_COLUMN_LEN=void 0;de.DEFAULT_COLUMN_LEN=20;de.DEFAULT_ROW_SEPARATOR=!1;de.DEFAULT_TABLE_STYLE={headerTop:{left:"\u250C",mid:"\u252C",right:"\u2510",other:"\u2500"},headerBottom:{left:"\u251C",mid:"\u253C",right:"\u2524",other:"\u2500"},tableBottom:{left:"\u2514",mid:"\u2534",right:"\u2518",other:"\u2500"},vertical:"\u2502",rowSeparator:{left:"\u251C",mid:"\u253C",right:"\u2524",other:"\u2500"}};de.ALIGNMENTS=["right","left","center"];de.COLORS=["red","green","yellow","white","blue","magenta","cyan","white_bold","reset"];de.DEFAULT_ROW_FONT_COLOR="white";de.DEFAULT_HEADER_FONT_COLOR="white_bold";de.DEFAULT_ROW_ALIGNMENT="right";de.DEFAULT_HEADER_ALIGNMENT="center"});var xy=pe(gd=>{"use strict";c();p();Object.defineProperty(gd,"__esModule",{value:!0});var pR=[{first:768,last:879},{first:1155,last:1158},{first:1160,last:1161},{first:1425,last:1469},{first:1471,last:1471},{first:1473,last:1474},{first:1476,last:1477},{first:1479,last:1479},{first:1536,last:1539},{first:1552,last:1557},{first:1611,last:1630},{first:1648,last:1648},{first:1750,last:1764},{first:1767,last:1768},{first:1770,last:1773},{first:1807,last:1807},{first:1809,last:1809},{first:1840,last:1866},{first:1958,last:1968},{first:2027,last:2035},{first:2305,last:2306},{first:2364,last:2364},{first:2369,last:2376},{first:2381,last:2381},{first:2385,last:2388},{first:2402,last:2403},{first:2433,last:2433},{first:2492,last:2492},{first:2497,last:2500},{first:2509,last:2509},{first:2530,last:2531},{first:2561,last:2562},{first:2620,last:2620},{first:2625,last:2626},{first:2631,last:2632},{first:2635,last:2637},{first:2672,last:2673},{first:2689,last:2690},{first:2748,last:2748},{first:2753,last:2757},{first:2759,last:2760},{first:2765,last:2765},{first:2786,last:2787},{first:2817,last:2817},{first:2876,last:2876},{first:2879,last:2879},{first:2881,last:2883},{first:2893,last:2893},{first:2902,last:2902},{first:2946,last:2946},{first:3008,last:3008},{first:3021,last:3021},{first:3134,last:3136},{first:3142,last:3144},{first:3146,last:3149},{first:3157,last:3158},{first:3260,last:3260},{first:3263,last:3263},{first:3270,last:3270},{first:3276,last:3277},{first:3298,last:3299},{first:3393,last:3395},{first:3405,last:3405},{first:3530,last:3530},{first:3538,last:3540},{first:3542,last:3542},{first:3633,last:3633},{first:3636,last:3642},{first:3655,last:3662},{first:3761,last:3761},{first:3764,last:3769},{first:3771,last:3772},{first:3784,last:3789},{first:3864,last:3865},{first:3893,last:3893},{first:3895,last:3895},{first:3897,last:3897},{first:3953,last:3966},{first:3968,last:3972},{first:3974,last:3975},{first:3984,last:3991},{first:3993,last:4028},{first:4038,last:4038},{first:4141,last:4144},{first:4146,last:4146},{first:4150,last:4151},{first:4153,last:4153},{first:4184,last:4185},{first:4448,last:4607},{first:4959,last:4959},{first:5906,last:5908},{first:5938,last:5940},{first:5970,last:5971},{first:6002,last:6003},{first:6068,last:6069},{first:6071,last:6077},{first:6086,last:6086},{first:6089,last:6099},{first:6109,last:6109},{first:6155,last:6157},{first:6313,last:6313},{first:6432,last:6434},{first:6439,last:6440},{first:6450,last:6450},{first:6457,last:6459},{first:6679,last:6680},{first:6912,last:6915},{first:6964,last:6964},{first:6966,last:6970},{first:6972,last:6972},{first:6978,last:6978},{first:7019,last:7027},{first:7616,last:7626},{first:7678,last:7679},{first:8203,last:8207},{first:8234,last:8238},{first:8288,last:8291},{first:8298,last:8303},{first:8400,last:8431},{first:12330,last:12335},{first:12441,last:12442},{first:43014,last:43014},{first:43019,last:43019},{first:43045,last:43046},{first:64286,last:64286},{first:65024,last:65039},{first:65056,last:65059},{first:65279,last:65279},{first:65529,last:65531},{first:68097,last:68099},{first:68101,last:68102},{first:68108,last:68111},{first:68152,last:68154},{first:68159,last:68159},{first:119143,last:119145},{first:119155,last:119170},{first:119173,last:119179},{first:119210,last:119213},{first:119362,last:119364},{first:917505,last:917505},{first:917536,last:917631},{first:917760,last:917999}];gd.default=pR});var Py=pe(bd=>{"use strict";c();p();Object.defineProperty(bd,"__esModule",{value:!0});var lR=(e,t,r)=>{let n=0,i,a=r;if(e<t[0].first||e>t[a].last)return 0;for(;a>=n;)if(i=Math.floor((n+a)/2),e>t[i].last)n=i+1;else if(e<t[i].first)a=i-1;else return 1;return 0};bd.default=lR});var qd=pe(Tn=>{"use strict";c();p();var Sy=Tn&&Tn.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Tn,"__esModule",{value:!0});var wy=Sy(xy()),uR=Sy(Py()),mR=e=>e===0?0:e<32||e>=127&&e<160?-1:(0,uR.default)(e,wy.default,wy.default.length-1)?0:1+ +(e>=4352&&(e<=4447||e===9001||e===9002||e>=11904&&e<=42191&&e!==12351||e>=44032&&e<=55203||e>=63744&&e<=64255||e>=65040&&e<=65049||e>=65072&&e<=65135||e>=65280&&e<=65376||e>=65504&&e<=65510||e>=131072&&e<=196605||e>=196608&&e<=262141));Tn.default=mR});var Ay=pe(Cn=>{"use strict";c();p();var hR=Cn&&Cn.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Cn,"__esModule",{value:!0});var yR=hR(qd()),_R=e=>{let t=0;for(let r=0;r<e.length;r++){let n=e.charCodeAt(r),i=(0,yR.default)(n);if(i<0)return-1;t+=i}return t};Cn.default=_R});var Ty=pe(Et=>{"use strict";c();p();var Ry=Et&&Et.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Et,"__esModule",{value:!0});Et.wcswidth=Et.wcwidth=void 0;var fR=Ry(Ay());Et.wcswidth=fR.default;var gR=Ry(qd());Et.wcwidth=gR.default});var vd=pe(Qt=>{"use strict";c();p();Object.defineProperty(Qt,"__esModule",{value:!0});Qt.findWidthInConsole=Qt.stripAnsi=void 0;var bR=Ty(),qR=/\x1b\[\d{1,3}(;\d{1,3})*m/g,vR=e=>e.replace(qR,"");Qt.stripAnsi=vR;var kR=(e,t)=>{let r=0;return e=(0,Qt.stripAnsi)(e),t&&Object.entries(t).forEach(([n,i])=>{let a=new RegExp(n,"g");r+=(e.match(a)||[]).length*i,e=e.replace(n,"")}),r+=(0,bR.wcswidth)(e),r};Qt.findWidthInConsole=kR});var xd=pe(ot=>{"use strict";c();p();Object.defineProperty(ot,"__esModule",{value:!0});ot.biggestWordInSentence=ot.textWithPadding=ot.splitTextIntoTextsOfMinLen=void 0;var kd=vd(),xR=(e,t,r)=>{let n=[];return e.split(/[\n\r]/).forEach(a=>{let s=a.split(" "),o=[],d=0;s.forEach(l=>{let u=(0,kd.findWidthInConsole)(l,r);d+u<=t?(d+=u+1,o.push(l)):(o.length>0&&n.push(o.join(" ")),o=[l],d=u+1)}),n.push(o.join(" "))}),n};ot.splitTextIntoTextsOfMinLen=xR;var PR=(e,t,r,n)=>{let i=(0,kd.findWidthInConsole)(e,n),a=Math.floor((r-i)/2),s=r-a-i;if(r<i){let o=(0,ot.splitTextIntoTextsOfMinLen)(e,r);return o.length===1?e:o.map(d=>(0,ot.textWithPadding)(d,t,r,n)).join(`
 `)}switch(t){case"left":return e.concat(" ".repeat(r-i));case"center":return" ".repeat(a).concat(e).concat(" ".repeat(s));default:return" ".repeat(r-i).concat(e)}};ot.textWithPadding=PR;var wR=(e,t)=>e.split(" ").reduce((r,n)=>Math.max(r,(0,kd.findWidthInConsole)(n,t)),0);ot.biggestWordInSentence=wR});var Dn=pe(X=>{"use strict";c();p();Object.defineProperty(X,"__esModule",{value:!0});X.getWidthLimitedColumnsArray=X.createHeaderAsRow=X.renderTableHorizontalBorders=X.findLenOfColumn=X.createRow=X.createColumFromOnlyName=X.createTableHorizontalBorders=X.convertRawRowOptionsToStandard=X.evaluateCellText=X.cellText=void 0;var Cy=vd(),Pd=xd(),wd=Rn(),Er=(e,t)=>Math.max(e,t),SR=e=>e==null?"":`${e}`;X.cellText=SR;var AR=(e,t)=>t?`${t(e)}`:(0,X.cellText)(e);X.evaluateCellText=AR;var RR=e=>{if(e)return{color:e.color,separator:e.separator||wd.DEFAULT_ROW_SEPARATOR}};X.convertRawRowOptionsToStandard=RR;var TR=({left:e,mid:t,right:r,other:n},i)=>{let a=e;return i.forEach(s=>{a+=n.repeat(s+2),a+=t}),a=a.slice(0,-t.length),a+=r,a};X.createTableHorizontalBorders=TR;var CR=e=>({name:e,title:e});X.createColumFromOnlyName=CR;var DR=(e,t,r)=>({color:e,separator:r,text:t});X.createRow=DR;var ER=(e,t,r)=>{let n=e.name,i=e.title,a=e.transform,s=Er(0,e.minLen||0);return e.maxLen?(s=Er(s,Er(e.maxLen,(0,Pd.biggestWordInSentence)(i,r))),s=t.reduce((o,d)=>Er(o,(0,Pd.biggestWordInSentence)((0,X.evaluateCellText)(d.text[n],a),r)),s),s):(s=Er(s,(0,Cy.findWidthInConsole)(i,r)),t.forEach(o=>{s=Er(s,(0,Cy.findWidthInConsole)((0,X.evaluateCellText)(o.text[n],a),r))}),s)};X.findLenOfColumn=ER;var $R=(e,t)=>(0,X.createTableHorizontalBorders)(e,t);X.renderTableHorizontalBorders=$R;var IR=(e,t)=>{let r=wd.DEFAULT_HEADER_FONT_COLOR,n=e(r,{},!1);return t.forEach(i=>{n.text[i.name]=i.title}),n};X.createHeaderAsRow=IR;var jR=(e,t,r)=>{let n={};return e.forEach(i=>{n[i.name]=(0,Pd.splitTextIntoTextsOfMinLen)((0,X.cellText)(t.text[i.name]),i.length||wd.DEFAULT_COLUMN_LEN,r)}),n};X.getWidthLimitedColumnsArray=jR});var Dy=pe(bt=>{"use strict";c();p();Object.defineProperty(bt,"__esModule",{value:!0});bt.rawColumnToInternalColumn=bt.objIfExists=void 0;var OR=Rn(),MR=(e,t)=>t?{[e]:t}:{};bt.objIfExists=MR;var LR=(e,t)=>{var r;return Object.assign(Object.assign(Object.assign(Object.assign({name:e.name,title:(r=e.title)!==null&&r!==void 0?r:e.name},(0,bt.objIfExists)("color",e.color||t?.color)),(0,bt.objIfExists)("maxLen",e.maxLen||t?.maxLen)),(0,bt.objIfExists)("minLen",e.minLen||t?.minLen)),{alignment:e.alignment||t?.alignment||OR.DEFAULT_ROW_ALIGNMENT,transform:e.transform})};bt.rawColumnToInternalColumn=LR});var Ey=pe($r=>{"use strict";c();p();Object.defineProperty($r,"__esModule",{value:!0});$r.preProcessRows=$r.preProcessColumns=void 0;var BR=Dn(),NR=e=>{e.computedColumns.length&&e.computedColumns.forEach(t=>{e.columns.some(n=>n.name===t.name)||(e.addColumn(Object.assign(Object.assign({},t),e.defaultColumnOptions)),e.rows.forEach((n,i,a)=>{let s=a.map(o=>o.text);n.text[t.name]=t.function(n.text,i,s)}))})},FR=e=>{e.enabledColumns.length&&(e.columns=e.columns.filter(t=>e.enabledColumns.includes(t.name)))},GR=e=>{e.disabledColumns.length&&(e.columns=e.columns.filter(t=>!e.disabledColumns.includes(t.name)))},UR=e=>{e.columns.forEach(t=>{t.length=(0,BR.findLenOfColumn)(t,e.rows,e.charLength)})},KR=e=>{NR(e),GR(e),FR(e),UR(e)};$r.preProcessColumns=KR;var WR=e=>{let t=e.rows.filter(r=>e.filterFunction(r.text)).sort((r,n)=>e.sortFunction(r.text,n.text));e.rows=t};$r.preProcessRows=WR});var Sd=pe(Be=>{"use strict";c();p();var Iy=Be&&Be.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(Be,"__esModule",{value:!0});Be.printSimpleTable=Be.renderSimpleTable=Be.renderTable=void 0;var jy=Iy(fd()),Oy=xd(),Ve=Rn(),$t=Dn(),HR=Iy(Ad()),$y=Ey(),zR=(e,t,r,n,i,a,s,o)=>{let d=new jy.default(s);return d.addCharsWithColor("",e.vertical),t.forEach(l=>{let y=r<n[l.name].length?(0,$t.cellText)(n[l.name][r]):"";d.addCharsWithColor(Ve.DEFAULT_ROW_FONT_COLOR," "),d.addCharsWithColor(i&&Ve.DEFAULT_HEADER_FONT_COLOR||l.color||a.color,(0,Oy.textWithPadding)(y,l.alignment||Ve.DEFAULT_ROW_ALIGNMENT,l.length||Ve.DEFAULT_COLUMN_LEN,o)),d.addCharsWithColor("",` ${e.vertical}`)}),d.renderConsole()},My=(e,t,r,n,i,a)=>{let s=(0,$t.getWidthLimitedColumnsArray)(t,r,a),o=Object.values(s).reduce((l,u)=>Math.max(l,u.length),0),d=[];for(let l=0;l<o;l+=1){let u=zR(e,t,l,s,i,r,n,a);d.push(u)}return d},VR=(e,t)=>{let r=Object.assign(Object.assign({},e),{text:Object.assign({},e.text)}),n={};return t.filter(i=>!!i.transform).forEach(i=>{n[i.name]=i.transform}),Object.keys(n).forEach(i=>{r.text[i]=n[i](r.text[i])}),r},ZR=(e,t)=>{let r=[],n=VR(t,e.columns);return r=r.concat(My(e.tableStyle,e.columns,n,e.colorMap,void 0,e.charLength)),r},YR=e=>{let t=[];if(e.title===void 0)return t;let r=()=>{let a=(s,o)=>s+o+2+1;return e.columns.map(s=>s.length||Ve.DEFAULT_COLUMN_LEN).reduce(a,1)},n=(0,Oy.textWithPadding)(e.title,Ve.DEFAULT_HEADER_ALIGNMENT,r()),i=new jy.default(e.colorMap);return i.addCharsWithColor(Ve.DEFAULT_HEADER_FONT_COLOR,n),t.push(i.renderConsole()),t},JR=e=>{let t=[];t.push((0,$t.renderTableHorizontalBorders)(e.tableStyle.headerTop,e.columns.map(n=>n.length||Ve.DEFAULT_COLUMN_LEN)));let r=(0,$t.createHeaderAsRow)($t.createRow,e.columns);return t=t.concat(My(e.tableStyle,e.columns,r,e.colorMap,!0)),t.push((0,$t.renderTableHorizontalBorders)(e.tableStyle.headerBottom,e.columns.map(n=>n.length||Ve.DEFAULT_COLUMN_LEN))),t},XR=e=>{let t=[];return t.push((0,$t.renderTableHorizontalBorders)(e.tableStyle.tableBottom,e.columns.map(r=>r.length||Ve.DEFAULT_COLUMN_LEN))),t},QR=(e,t)=>{let r=[],n=e.rows.length-1;return e.rows.indexOf(t)!==n&&t.separator&&r.push((0,$t.renderTableHorizontalBorders)(e.tableStyle.rowSeparator,e.columns.map(a=>a.length||Ve.DEFAULT_COLUMN_LEN))),r},eT=e=>{(0,$y.preProcessColumns)(e),(0,$y.preProcessRows)(e);let t=[];return YR(e).forEach(r=>t.push(r)),JR(e).forEach(r=>t.push(r)),e.rows.forEach(r=>{ZR(e,r).forEach(n=>t.push(n)),QR(e,r).forEach(n=>t.push(n))}),XR(e).forEach(r=>t.push(r)),t.join(`
 `)};Be.renderTable=eT;var tT=(e,t)=>{let r=new HR.default(t);return r.addRows(e),(0,Be.renderTable)(r)};Be.renderSimpleTable=tT;var rT=(e,t)=>{console.log((0,Be.renderSimpleTable)(e,t))};Be.printSimpleTable=rT});var Ad=pe(Dd=>{"use strict";c();p();Object.defineProperty(Dd,"__esModule",{value:!0});var nT=fd(),Ba=Rn(),Rd=Dn(),Td=Dy(),iT=Sd(),aT=()=>0,sT=()=>!0,Cd=class{initSimple(t){this.columns=t.map(r=>({name:r,title:r,alignment:Ba.DEFAULT_ROW_ALIGNMENT}))}initDetailed(t){var r;this.title=t.title||this.title,this.tableStyle=Object.assign(Object.assign({},this.tableStyle),t.style),this.sortFunction=t.sort||this.sortFunction,this.filterFunction=t.filter||this.filterFunction,this.enabledColumns=t.enabledColumns||this.enabledColumns,this.disabledColumns=t.disabledColumns||this.disabledColumns,this.computedColumns=t.computedColumns||this.computedColumns,this.columns=((r=t.columns)===null||r===void 0?void 0:r.map(n=>(0,Td.rawColumnToInternalColumn)(n,t.defaultColumnOptions)))||this.columns,this.rowSeparator=t.rowSeparator||this.rowSeparator,this.charLength=t.charLength||this.charLength,this.defaultColumnOptions=t.defaultColumnOptions||this.defaultColumnOptions,t.shouldDisableColors?this.colorMap={}:t.colorMap&&(this.colorMap=Object.assign(Object.assign({},this.colorMap),t.colorMap)),t.rows!==void 0&&this.addRows(t.rows)}constructor(t){this.rows=[],this.columns=[],this.title=void 0,this.tableStyle=Ba.DEFAULT_TABLE_STYLE,this.filterFunction=sT,this.sortFunction=aT,this.enabledColumns=[],this.disabledColumns=[],this.computedColumns=[],this.rowSeparator=Ba.DEFAULT_ROW_SEPARATOR,this.colorMap=nT.DEFAULT_COLOR_MAP,this.charLength={},this.defaultColumnOptions=void 0,this.transforms={},t instanceof Array?this.initSimple(t):typeof t=="object"&&t!==null&&this.initDetailed(t)}createColumnFromRow(t){let r=this.columns.map(n=>n.name);Object.keys(t).forEach(n=>{r.includes(n)||this.columns.push((0,Td.rawColumnToInternalColumn)((0,Rd.createColumFromOnlyName)(n),this.defaultColumnOptions))})}addColumn(t){let r=typeof t=="string"?(0,Rd.createColumFromOnlyName)(t):t;this.columns.push((0,Td.rawColumnToInternalColumn)(r,this.defaultColumnOptions))}addColumns(t){t.forEach(r=>{this.addColumn(r)})}addRow(t,r){this.createColumnFromRow(t),this.rows.push((0,Rd.createRow)(r?.color||Ba.DEFAULT_ROW_FONT_COLOR,t,r?.separator!==void 0?r.separator:this.rowSeparator))}addRows(t,r){t.forEach(n=>{this.addRow(n,r)})}clearRows(){this.rows=[]}renderTable(){return(0,iT.renderTable)(this)}};Dd.default=Cd});var By=pe(En=>{"use strict";c();p();var oT=En&&En.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(En,"__esModule",{value:!0});var dT=oT(Ad()),Ly=Dn(),Ed=class{constructor(t){this.table=new dT.default(t)}addColumn(t){return this.table.addColumn(t),this}addColumns(t){return this.table.addColumns(t),this}addRow(t,r){return this.table.addRow(t,(0,Ly.convertRawRowOptionsToStandard)(r)),this}addRows(t,r){return this.table.addRows(t,(0,Ly.convertRawRowOptionsToStandard)(r)),this}clearRows(){return this.table.clearRows(),this}printTable(){let t=this.table.renderTable();console.log(t)}render(){return this.table.renderTable()}};En.default=Ed});var $n=pe(dt=>{"use strict";c();p();var cT=dt&&dt.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(dt,"__esModule",{value:!0});dt.renderTable=dt.printTable=dt.Table=void 0;var pT=cT(By());dt.Table=pT.default;var Ny=Sd();Object.defineProperty(dt,"printTable",{enumerable:!0,get:function(){return Ny.printSimpleTable}});Object.defineProperty(dt,"renderTable",{enumerable:!0,get:function(){return Ny.renderSimpleTable}})});c();p();c();p();c();p();c();p();var kt=class extends Error{constructor(t,r,n){super(n),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=r,this.exitCode=t,this.nestedError=void 0}},pt=class extends kt{constructor(t){super(1,"commander.invalidArgument",t),Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name}};var Kr=class{constructor(t,r){switch(this.description=r||"",this.variadic=!1,this.parseArg=void 0,this.defaultValue=void 0,this.defaultValueDescription=void 0,this.argChoices=void 0,t[0]){case"<":this.required=!0,this._name=t.slice(1,-1);break;case"[":this.required=!1,this._name=t.slice(1,-1);break;default:this.required=!0,this._name=t;break}this._name.endsWith("...")&&(this.variadic=!0,this._name=this._name.slice(0,-3))}name(){return this._name}_collectValue(t,r){return r===this.defaultValue||!Array.isArray(r)?[t]:(r.push(t),r)}default(t,r){return this.defaultValue=t,this.defaultValueDescription=r,this}argParser(t){return this.parseArg=t,this}choices(t){return this.argChoices=t.slice(),this.parseArg=(r,n)=>{if(!this.argChoices.includes(r))throw new pt(`Allowed choices are ${this.argChoices.join(", ")}.`);return this.variadic?this._collectValue(r,n):r},this}argRequired(){return this.required=!0,this}argOptional(){return this.required=!1,this}};function Wn(e){let t=e.name()+(e.variadic===!0?"...":"");return e.required?"<"+t+">":"["+t+"]"}c();p();import{EventEmitter as Nf}from"events";import es from"child_process";import lt from"path";import zn from"fs";import U from"process";import{stripVTControlCharacters as Ff}from"util";c();p();import{stripVTControlCharacters as Mf}from"util";var Wr=class{constructor(){this.helpWidth=void 0,this.minWidthToWrap=40,this.sortSubcommands=!1,this.sortOptions=!1,this.showGlobalOptions=!1}prepareContext(t){this.helpWidth=this.helpWidth??t.helpWidth??80}visibleCommands(t){let r=t.commands.filter(i=>!i._hidden),n=t._getHelpCommand();return n&&!n._hidden&&r.push(n),this.sortSubcommands&&r.sort((i,a)=>i.name().localeCompare(a.name())),r}compareOptions(t,r){let n=i=>i.short?i.short.replace(/^-/,""):i.long.replace(/^--/,"");return n(t).localeCompare(n(r))}visibleOptions(t){let r=t.options.filter(i=>!i.hidden),n=t._getHelpOption();if(n&&!n.hidden){let i=n.short&&t._findOption(n.short),a=n.long&&t._findOption(n.long);!i&&!a?r.push(n):n.long&&!a?r.push(t.createOption(n.long,n.description)):n.short&&!i&&r.push(t.createOption(n.short,n.description))}return this.sortOptions&&r.sort(this.compareOptions),r}visibleGlobalOptions(t){if(!this.showGlobalOptions)return[];let r=[];for(let n=t.parent;n;n=n.parent){let i=n.options.filter(a=>!a.hidden);r.push(...i)}return this.sortOptions&&r.sort(this.compareOptions),r}visibleArguments(t){return t._argsDescription&&t.registeredArguments.forEach(r=>{r.description=r.description||t._argsDescription[r.name()]||""}),t.registeredArguments.find(r=>r.description)?t.registeredArguments:[]}subcommandTerm(t){let r=t.registeredArguments.map(n=>Wn(n)).join(" ");return t._name+(t._aliases[0]?"|"+t._aliases[0]:"")+(t.options.length?" [options]":"")+(r?" "+r:"")}optionTerm(t){return t.flags}argumentTerm(t){return t.name()}longestSubcommandTermLength(t,r){return r.visibleCommands(t).reduce((n,i)=>Math.max(n,this.displayWidth(r.styleSubcommandTerm(r.subcommandTerm(i)))),0)}longestOptionTermLength(t,r){return r.visibleOptions(t).reduce((n,i)=>Math.max(n,this.displayWidth(r.styleOptionTerm(r.optionTerm(i)))),0)}longestGlobalOptionTermLength(t,r){return r.visibleGlobalOptions(t).reduce((n,i)=>Math.max(n,this.displayWidth(r.styleOptionTerm(r.optionTerm(i)))),0)}longestArgumentTermLength(t,r){return r.visibleArguments(t).reduce((n,i)=>Math.max(n,this.displayWidth(r.styleArgumentTerm(r.argumentTerm(i)))),0)}commandUsage(t){let r=t._name;t._aliases[0]&&(r=r+"|"+t._aliases[0]);let n="";for(let i=t.parent;i;i=i.parent)n=i.name()+" "+n;return n+r+" "+t.usage()}commandDescription(t){return t.description()}subcommandDescription(t){return t.summary()||t.description()}optionDescription(t){let r=[];if(t.argChoices&&r.push(`choices: ${t.argChoices.map(n=>JSON.stringify(n)).join(", ")}`),t.defaultValue!==void 0&&(t.required||t.optional||t.isBoolean()&&typeof t.defaultValue=="boolean")&&r.push(`default: ${t.defaultValueDescription||JSON.stringify(t.defaultValue)}`),t.presetArg!==void 0&&t.optional&&r.push(`preset: ${JSON.stringify(t.presetArg)}`),t.envVar!==void 0&&r.push(`env: ${t.envVar}`),r.length>0){let n=`(${r.join(", ")})`;return t.description?`${t.description} ${n}`:n}return t.description}argumentDescription(t){let r=[];if(t.argChoices&&r.push(`choices: ${t.argChoices.map(n=>JSON.stringify(n)).join(", ")}`),t.defaultValue!==void 0&&r.push(`default: ${t.defaultValueDescription||JSON.stringify(t.defaultValue)}`),r.length>0){let n=`(${r.join(", ")})`;return t.description?`${t.description} ${n}`:n}return t.description}formatItemList(t,r,n){return r.length===0?[]:[n.styleTitle(t),...r,""]}groupItems(t,r,n){let i=new Map;return t.forEach(a=>{let s=n(a);i.has(s)||i.set(s,[])}),r.forEach(a=>{let s=n(a);i.has(s)||i.set(s,[]),i.get(s).push(a)}),i}formatHelp(t,r){let n=r.padWidth(t,r),i=r.helpWidth??80;function a(y,q){return r.formatItem(y,n,q,r)}let s=[`${r.styleTitle("Usage:")} ${r.styleUsage(r.commandUsage(t))}`,""],o=r.commandDescription(t);o.length>0&&(s=s.concat([r.boxWrap(r.styleCommandDescription(o),i),""]));let d=r.visibleArguments(t).map(y=>a(r.styleArgumentTerm(r.argumentTerm(y)),r.styleArgumentDescription(r.argumentDescription(y))));if(s=s.concat(this.formatItemList("Arguments:",d,r)),this.groupItems(t.options,r.visibleOptions(t),y=>y.helpGroupHeading??"Options:").forEach((y,q)=>{let x=y.map(P=>a(r.styleOptionTerm(r.optionTerm(P)),r.styleOptionDescription(r.optionDescription(P))));s=s.concat(this.formatItemList(q,x,r))}),r.showGlobalOptions){let y=r.visibleGlobalOptions(t).map(q=>a(r.styleOptionTerm(r.optionTerm(q)),r.styleOptionDescription(r.optionDescription(q))));s=s.concat(this.formatItemList("Global Options:",y,r))}return this.groupItems(t.commands,r.visibleCommands(t),y=>y.helpGroup()||"Commands:").forEach((y,q)=>{let x=y.map(P=>a(r.styleSubcommandTerm(r.subcommandTerm(P)),r.styleSubcommandDescription(r.subcommandDescription(P))));s=s.concat(this.formatItemList(q,x,r))}),s.join(`
 `)}displayWidth(t){return Mf(t).length}styleTitle(t){return t}styleUsage(t){return t.split(" ").map(r=>r==="[options]"?this.styleOptionText(r):r==="[command]"?this.styleSubcommandText(r):r[0]==="["||r[0]==="<"?this.styleArgumentText(r):this.styleCommandText(r)).join(" ")}styleCommandDescription(t){return this.styleDescriptionText(t)}styleOptionDescription(t){return this.styleDescriptionText(t)}styleSubcommandDescription(t){return this.styleDescriptionText(t)}styleArgumentDescription(t){return this.styleDescriptionText(t)}styleDescriptionText(t){return t}styleOptionTerm(t){return this.styleOptionText(t)}styleSubcommandTerm(t){return t.split(" ").map(r=>r==="[options]"?this.styleOptionText(r):r[0]==="["||r[0]==="<"?this.styleArgumentText(r):this.styleSubcommandText(r)).join(" ")}styleArgumentTerm(t){return this.styleArgumentText(t)}styleOptionText(t){return t}styleArgumentText(t){return t}styleSubcommandText(t){return t}styleCommandText(t){return t}padWidth(t,r){return Math.max(r.longestOptionTermLength(t,r),r.longestGlobalOptionTermLength(t,r),r.longestSubcommandTermLength(t,r),r.longestArgumentTermLength(t,r))}preformatted(t){return/\n[^\S\r\n]/.test(t)}formatItem(t,r,n,i){let s=" ".repeat(2);if(!n)return s+t;let o=t.padEnd(r+t.length-i.displayWidth(t)),d=2,u=(this.helpWidth??80)-r-d-2,y;return u<this.minWidthToWrap||i.preformatted(n)?y=n:y=i.boxWrap(n,u).replace(/\n/g,`
@@ -578,7 +578,7 @@ answer is kept for a day; a failed check is retried after an hour, so
 the call that retries it waits on it again. \`checked_at\` is null when
 the update check is turned off. Available to signed-in admins who can
 manage the store; a secret API key gets a 404.
-`,parameters:[{name:"Authorization",in:"header",required:!0,description:"Bearer token for admin authentication",schema:{type:"string"}}],responses:{"200":{description:"update status",content:{"application/json":{schema:{$ref:"#/components/schemas/UpdateStatus"}}}},"401":{description:"unauthorized",content:{"application/json":{schema:{$ref:"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/admin_users":{get:{summary:"List staff",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns admin users with at least one role assignment on the current store.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:'## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[email_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `email` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `first_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `last_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n<Accordion title="Filters through associations">\n\nPrefix an associated record\'s attribute with the association, as in `q[spree_roles_id_eq]`. The same predicates apply.\n\n| Prefix | Attributes |\n|---|---|\n| `spree_roles_` | `created_at`, `id`, `name`, `updated_at` |\n\n</Accordion>\n\n**Sort by:** `created_at`, `email`, `first_name`, `id`, `last_name`, `updated_at`. Prefix a field with `-` to sort descending.'},"x-spree-filters":{table:"AdminUser",sortable:["created_at","email","first_name","id","last_name","updated_at"]},responses:{"200":{description:"staff found",content:{"application/json":{}}}}}},"/api/v3/admin/admin_users/{id}":{get:{summary:"Show a staff member",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"staff member found",content:{"application/json":{}}}}},patch:{summary:"Update a staff member",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Updates name fields and reassigns roles for the current store. `role_ids` is a complete replacement \u2014 roles not in the array are removed for this store.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"staff member updated",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/AdminUserUpdateParams"}}},required:!0}},delete:{summary:"Remove a staff member from this store",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Removes the user's role assignments on the current store. The account is preserved \u2014 the user keeps access to any other stores. Removing a role needs the same rights as granting it, and the store always keeps at least one admin.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"204":{description:"staff removed from store"}}}},"/api/v3/admin/invitations":{get:{summary:"List invitations",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns invitations for the current store, including pending and accepted.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:"## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[created_at_eq]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n**Sort by:** `created_at`, `id`, `updated_at`. Prefix a field with `-` to sort descending."},"x-spree-filters":{table:"Invitation",sortable:["created_at","id","updated_at"]},responses:{"200":{description:"invitations found",content:{"application/json":{}}}}},post:{summary:"Create an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Invites a teammate by email. The invitation is scoped to the current store and carries the chosen role; on accept, a `RoleUser` is created via the invitation's `after_accept` callback.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"201":{description:"invitation created",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/InvitationCreateParams"}}},required:!0}}},"/api/v3/admin/invitations/{id}":{delete:{summary:"Revoke an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"204":{description:"invitation revoked"}}}},"/api/v3/admin/invitations/{invitation_id}/acceptance_link":{get:{summary:"Get an invitation acceptance link",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the link the invitee opens to accept a pending invitation. The link carries the invitation token, so it needs write access to staff and the right to grant the invitation's role; invitation listings never include it.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"invitation_id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"acceptance link found",content:{"application/json":{schema:{$ref:"#/components/schemas/InvitationAcceptanceLink"}}}}}}},"/api/v3/admin/invitations/{id}/resend":{patch:{summary:"Resend an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Issues a fresh token and dispatches the invitation email again.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"invitation resent",content:{"application/json":{}}}}}},"/api/v3/admin/permissions":{get:{summary:"List the permission catalog",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the permission catalog \u2014 the grant vocabulary shared by staff role permissions and secret API key scopes. Entries are grouped for permission pickers; labels and descriptions are localized. Readable by any authenticated admin credential.",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"200":{description:"catalog returned",content:{"application/json":{}}}}}},"/api/v3/admin/roles":{get:{summary:"List roles",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns staff roles with their catalog permissions. Roles are global, not per-store; `mutable: false` marks the protected admin role and host-locked rows.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:"## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n**Sort by:** `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending."},"x-spree-filters":{table:"Role",sortable:["created_at","id","name","updated_at"]},responses:{"200":{description:"roles found",content:{"application/json":{}}}}},post:{summary:"Create a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Creates a staff role. `permissions` holds catalog keys (see GET /admin/permissions); a caller may only grant keys they effectively hold.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"201":{description:"role created",content:{"application/json":{}}},"422":{description:"invalid request",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/RoleCreateParams"}}},required:!0}}},"/api/v3/admin/roles/{id}":{parameters:[{name:"id",in:"path",required:!0,schema:{type:"string"}}],patch:{summary:"Update a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Updates a role name, description or permissions. The admin role and host-locked roles (`mutable: false`) reject changes.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"200":{description:"role updated",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/RoleUpdateParams"}}},required:!0}},delete:{summary:"Delete a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Deletes a role. Fails with 422 while the role is protected or still referenced by staff members or pending invitations.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"204":{description:"role deleted"},"422":{description:"role cannot be deleted",content:{"application/json":{}}}}}},"/api/v3/admin/stock_locations":{get:{summary:"List stock locations",tags:["Stock Locations"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the configured stock locations. Stock locations are global\n(shared across stores). Filter with Ransack predicates such as\n`q[active_eq]`, `q[kind_eq]`, `q[pickup_enabled_eq]`, or\n`q[name_cont]`.\n\nPickup-related attributes (`kind`, `pickup_enabled`,\n`pickup_stock_policy`, `pickup_ready_in_minutes`,\n`pickup_instructions`) drive merchant pickup support at checkout \u2014\ncustomers can collect orders from any active location with\n`pickup_enabled: true`.\n\n\n**Required scope:** `read_stock` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,description:"Bearer token for admin authentication",schema:{type:"string"}},{name:"q[search]",in:"query",required:!1,schema:{type:"string"},description:"Matches any of name (partial, case-insensitive)."},{name:"page",in:"query",required:!1,description:"Page number",schema:{type:"integer"}},{name:"limit",in:"query",required:!1,description:"Number of records per page",schema:{type:"integer"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."},{name:"sort",in:"query",required:!1,description:"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).",schema:{type:"string"}},{name:"fields",in:"query",required:!1,description:"Comma-separated list of fields to include. id is always included.",schema:{type:"string"}}],"x-mint":{content:'## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `country_code` | One of the `CountryCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `default` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `kind` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `pickup_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `returns_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `state_code` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n<Accordion title="Filters through associations">\n\nPrefix an associated record\'s attribute with the association, as in `q[seller_id_eq]`. The same predicates apply.\n\n| Prefix | Attributes |\n|---|---|\n| `seller_` | `contact_email`, `created_at`, `id`, `name`, `status`, `updated_at` |\n\n</Accordion>\n\n**Sort by:** `active`, `country_code`, `created_at`, `default`, `id`, `kind`, `name`, `pickup_enabled`, `returns_enabled`, `seller_id`, `state_code`, `updated_at`. Prefix a field with `-` to sort descending.'},"x-spree-filters":{table:"StockLocation",sortable:["active","country_code","created_at","default","id","kind","name","pickup_enabled","returns_enabled","seller_id","state_code","updated_at"]},responses:{"200":{description:"stock locations found",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{$ref:"#/components/schemas/StockLocation"}},meta:{$ref:"#/components/schemas/PaginationMeta"}},required:["data","meta"]}}}},"401":{description:"unauthorized",content:{"application/json":{schema:{$ref:"#/components/schemas/ErrorResponse"}}}}}},post:{summary:"Create a stock location",tags:["Stock Locations"],security:[{api_key:[],bearer_auth:[]}],description:`Creates a new stock location.
+`,parameters:[{name:"Authorization",in:"header",required:!0,description:"Bearer token for admin authentication",schema:{type:"string"}}],responses:{"200":{description:"update status",content:{"application/json":{schema:{$ref:"#/components/schemas/UpdateStatus"}}}},"401":{description:"unauthorized",content:{"application/json":{schema:{$ref:"#/components/schemas/ErrorResponse"}}}}}}},"/api/v3/admin/admin_users":{get:{summary:"List staff",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns admin users with at least one role assignment on the current store.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:'## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[email_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `email` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `first_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `last_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n<Accordion title="Filters through associations">\n\nPrefix an associated record\'s attribute with the association, as in `q[spree_roles_id_eq]`. The same predicates apply.\n\n| Prefix | Attributes |\n|---|---|\n| `spree_roles_` | `created_at`, `id`, `name`, `updated_at` |\n\n</Accordion>\n\n**Sort by:** `created_at`, `email`, `first_name`, `id`, `last_name`, `updated_at`. Prefix a field with `-` to sort descending.'},"x-spree-filters":{table:"AdminUser",sortable:["created_at","email","first_name","id","last_name","updated_at"]},responses:{"200":{description:"staff found",content:{"application/json":{}}}}}},"/api/v3/admin/admin_users/{id}":{get:{summary:"Show a staff member",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}},{name:"expand",in:"query",required:!1,description:"Comma-separated fields to expand: inviter, sessions.",schema:{type:"string"}}],responses:{"200":{description:"staff member found with sessions and inviter",content:{"application/json":{}}}}},patch:{summary:"Update a staff member",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Updates name fields and reassigns roles for the current store. `role_ids` is a complete replacement \u2014 roles not in the array are removed for this store.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"staff member updated",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/AdminUserUpdateParams"}}},required:!0}},delete:{summary:"Remove a staff member from this store",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Removes the user's role assignments on the current store. The account is preserved \u2014 the user keeps access to any other stores. Removing a role needs the same rights as granting it, and the store always keeps at least one admin.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"204":{description:"staff removed from store"}}}},"/api/v3/admin/invitations":{get:{summary:"List invitations",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns invitations for the current store, including pending and accepted.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:"## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[created_at_eq]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n**Sort by:** `created_at`, `id`, `updated_at`. Prefix a field with `-` to sort descending."},"x-spree-filters":{table:"Invitation",sortable:["created_at","id","updated_at"]},responses:{"200":{description:"invitations found",content:{"application/json":{}}}}},post:{summary:"Create an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Invites a teammate by email. The invitation is scoped to the current store and carries the chosen role; on accept, a `RoleUser` is created via the invitation's `after_accept` callback.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"201":{description:"invitation created",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/InvitationCreateParams"}}},required:!0}}},"/api/v3/admin/invitations/{id}":{delete:{summary:"Revoke an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"204":{description:"invitation revoked"}}}},"/api/v3/admin/invitations/{invitation_id}/acceptance_link":{get:{summary:"Get an invitation acceptance link",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the link the invitee opens to accept a pending invitation. The link carries the invitation token, so it needs write access to staff and the right to grant the invitation's role; invitation listings never include it.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"invitation_id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"acceptance link found",content:{"application/json":{schema:{$ref:"#/components/schemas/InvitationAcceptanceLink"}}}}}}},"/api/v3/admin/invitations/{id}/resend":{patch:{summary:"Resend an invitation",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Issues a fresh token and dispatches the invitation email again.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"id",in:"path",required:!0,schema:{type:"string"}}],responses:{"200":{description:"invitation resent",content:{"application/json":{}}}}}},"/api/v3/admin/permissions":{get:{summary:"List the permission catalog",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the permission catalog \u2014 the grant vocabulary shared by staff role permissions and secret API key scopes. Entries are grouped for permission pickers; labels and descriptions are localized. Readable by any authenticated admin credential.",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"200":{description:"catalog returned",content:{"application/json":{}}}}}},"/api/v3/admin/roles":{get:{summary:"List roles",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Returns staff roles with their catalog permissions. Roles are global, not per-store; `mutable: false` marks the protected admin role and host-locked rows.\n\n**Required scope:** `read_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."}],"x-mint":{content:"## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n**Sort by:** `created_at`, `id`, `name`, `updated_at`. Prefix a field with `-` to sort descending."},"x-spree-filters":{table:"Role",sortable:["created_at","id","name","updated_at"]},responses:{"200":{description:"roles found",content:{"application/json":{}}}}},post:{summary:"Create a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Creates a staff role. `permissions` holds catalog keys (see GET /admin/permissions); a caller may only grant keys they effectively hold.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"201":{description:"role created",content:{"application/json":{}}},"422":{description:"invalid request",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/RoleCreateParams"}}},required:!0}}},"/api/v3/admin/roles/{id}":{parameters:[{name:"id",in:"path",required:!0,schema:{type:"string"}}],patch:{summary:"Update a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Updates a role name, description or permissions. The admin role and host-locked roles (`mutable: false`) reject changes.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"200":{description:"role updated",content:{"application/json":{}}}},requestBody:{content:{"application/json":{schema:{$ref:"#/components/schemas/RoleUpdateParams"}}},required:!0}},delete:{summary:"Delete a role",tags:["Staff"],security:[{api_key:[],bearer_auth:[]}],description:"Deletes a role. Fails with 422 while the role is protected or still referenced by staff members or pending invitations.\n\n**Required scope:** `write_staff` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,schema:{type:"string"}}],responses:{"204":{description:"role deleted"},"422":{description:"role cannot be deleted",content:{"application/json":{}}}}}},"/api/v3/admin/stock_locations":{get:{summary:"List stock locations",tags:["Stock Locations"],security:[{api_key:[],bearer_auth:[]}],description:"Returns the configured stock locations. Stock locations are global\n(shared across stores). Filter with Ransack predicates such as\n`q[active_eq]`, `q[kind_eq]`, `q[pickup_enabled_eq]`, or\n`q[name_cont]`.\n\nPickup-related attributes (`kind`, `pickup_enabled`,\n`pickup_stock_policy`, `pickup_ready_in_minutes`,\n`pickup_instructions`) drive merchant pickup support at checkout \u2014\ncustomers can collect orders from any active location with\n`pickup_enabled: true`.\n\n\n**Required scope:** `read_stock` (for API-key authentication).",parameters:[{name:"x-spree-api-key",in:"header",required:!0,schema:{type:"string"}},{name:"Authorization",in:"header",required:!0,description:"Bearer token for admin authentication",schema:{type:"string"}},{name:"q[search]",in:"query",required:!1,schema:{type:"string"},description:"Matches any of name (partial, case-insensitive)."},{name:"page",in:"query",required:!1,description:"Page number",schema:{type:"integer"}},{name:"limit",in:"query",required:!1,description:"Number of records per page",schema:{type:"integer"}},{name:"q",in:"query",required:!1,style:"deepObject",explode:!0,schema:{type:"object",additionalProperties:!0},description:"Attribute filters, as `q[<attribute>_<predicate>]=value`. See Filters above for the list."},{name:"sort",in:"query",required:!1,description:"Sort by field. Prefix with `-` for descending (e.g., `-created_at`).",schema:{type:"string"}},{name:"fields",in:"query",required:!1,description:"Comma-separated list of fields to include. id is always included.",schema:{type:"string"}}],"x-mint":{content:'## Filters\n\nFilter with `q[<attribute>_<predicate>]=value`, for example `q[name_cont]=\u2026`. Send a list as `q[<attribute>_in][]=a&q[<attribute>_in][]=b`. [How filters work](/api-reference/admin-api/querying#which-filters-an-endpoint-accepts).\n\n| Attribute | Kind | Predicates |\n|---|---|---|\n| `active` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `country_code` | One of the `CountryCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n| `default` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `kind` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `pickup_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `returns_enabled` | True or false | `eq` `not_eq` `in` `not_in` `true` `false` `null` |\n| `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` |\n| `state_code` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` |\n| `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` |\n\n<Accordion title="Filters through associations">\n\nPrefix an associated record\'s attribute with the association, as in `q[seller_id_eq]`. The same predicates apply.\n\n| Prefix | Attributes |\n|---|---|\n| `seller_` | `contact_email`, `created_at`, `id`, `name`, `status`, `updated_at` |\n\n</Accordion>\n\n**Sort by:** `active`, `country_code`, `created_at`, `default`, `id`, `kind`, `name`, `pickup_enabled`, `returns_enabled`, `seller_id`, `state_code`, `updated_at`. Prefix a field with `-` to sort descending.'},"x-spree-filters":{table:"StockLocation",sortable:["active","country_code","created_at","default","id","kind","name","pickup_enabled","returns_enabled","seller_id","state_code","updated_at"]},responses:{"200":{description:"stock locations found",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{$ref:"#/components/schemas/StockLocation"}},meta:{$ref:"#/components/schemas/PaginationMeta"}},required:["data","meta"]}}}},"401":{description:"unauthorized",content:{"application/json":{schema:{$ref:"#/components/schemas/ErrorResponse"}}}}}},post:{summary:"Create a stock location",tags:["Stock Locations"],security:[{api_key:[],bearer_auth:[]}],description:`Creates a new stock location.
 Setting \`default: true\` automatically demotes the previous default
 location.
@@ -1081,7 +1081,7 @@ permissions that server accepts.
 Unauthenticated by design: a client has to read it before it holds
 anything.
-`,responses:{"200":{description:"metadata",content:{"application/json":{schema:{$ref:"#/components/schemas/OauthProtectedResource"}}}},"404":{description:"no such protected surface"}}}}},components:{schemas:{PaginationMeta:{type:"object",properties:{page:{type:"integer"},limit:{type:"integer"},count:{type:"integer",description:"Total number of records"},pages:{type:"integer",description:"Total number of pages"},from:{type:"integer",description:"Index of first record on this page"},to:{type:"integer",description:"Index of last record on this page"},in:{type:"integer",description:"Number of records on this page"},previous:{type:"integer",nullable:!0,description:"Previous page number"},next:{type:"integer",nullable:!0,description:"Next page number"}},required:["page","limit","count","pages","from","to","in"]},ErrorResponse:{type:"object",properties:{error:{type:"object",properties:{code:{type:"string"},message:{type:"string"},details:{type:"object",description:"Field-specific validation errors",nullable:!0}},required:["code","message"]}},required:["error"]},AuthResponse:{type:"object",properties:{token:{type:"string",description:"JWT access token"},user:{$ref:"#/components/schemas/AdminUser"}},required:["token","user"]},PermissionRule:{type:"object",description:"A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins.",properties:{allow:{type:"boolean",description:"true for `can`, false for `cannot`"},actions:{type:"array",items:{type:"string"},description:'Action names, e.g. ["read", "update"] or ["manage"]'},subjects:{type:"array",items:{type:"string"},description:'Subject short names, e.g. ["product"] or ["all"]'},has_conditions:{type:"boolean",description:"True if the server-side rule has per-record conditions. The SPA shows the action optimistically and handles 403 from the API."}},required:["allow","actions","subjects","has_conditions"]},ImportSchemaField:{type:"object",description:"A canonical column of an import type, including per-store custom field columns",properties:{name:{type:"string",description:"Canonical field name used in mappings"},label:{type:"string",description:"Human-readable label"},required:{type:"boolean",description:"Whether the field must be mapped before processing"}},required:["name","label","required"]},CheckoutRequirement:{type:"object",properties:{step:{type:"string",description:"Checkout step this requirement belongs to"},field:{type:"string",description:"Field that needs to be satisfied"},message:{type:"string",description:"Human-readable requirement message"}},required:["step","field","message"]},CartWarning:{type:"object",description:"A warning about a cart issue (e.g., item removed due to stock change)",properties:{code:{type:"string",description:"Machine-readable warning code"},message:{type:"string",description:"Human-readable warning message"},line_item_id:{type:"string",nullable:!0,description:"Prefixed line item ID (when applicable)"},variant_id:{type:"string",nullable:!0,description:"Prefixed variant ID (when applicable)"},item_index:{type:"integer",nullable:!0,description:"Position in the submitted items array, for warnings raised while applying a batch of item changes"}},required:["code","message"]},FulfillmentManifestItem:{type:"object",description:"An item within a fulfillment \u2014 which line item and how many units are in this fulfillment",properties:{item_id:{type:"string",description:"Line item ID"},variant_id:{type:"string",description:"Variant ID"},quantity:{type:"integer",description:"Quantity in this fulfillment"}},required:["item_id","variant_id","quantity"]},AdminUserRoleAssignment:{type:"object",description:"A role assignment for the current store on a staff member",properties:{id:{type:"string",description:"Prefixed role ID"},name:{type:"string",description:"Role name"}},required:["id","name"]},AdminUserStore:{type:"object",description:"A store the staff member can access through a role assignment",properties:{id:{type:"string",description:"Prefixed store ID"},name:{type:"string",description:"Store name"},code:{type:"string",description:"Store code"}},required:["id","name","code"]},PreferenceSchema:{type:"object",description:"The JSON Schema (draft 2020-12) of a type's `preferences`: one property per setting, with `format` (`money`, `currency`, `iso-country`, `prefixed-id`, \u2026), `enum`, `default`, `x-spree-secret` for a secret and `x-spree-prefix` for an id list. Unknown keys are refused.",additionalProperties:!0},PromotionActionLineItem:{type:"object",description:"One row in a `create_line_items` action \u2014 the variant added to the order and how many",properties:{variant_id:{type:"string"},quantity:{type:"integer"}},required:["variant_id","quantity"]},MeResponse:{type:"object",description:"Current admin user profile and serialized permissions",properties:{user:{$ref:"#/components/schemas/AdminUser"},permissions:{type:"array",items:{$ref:"#/components/schemas/PermissionRule"}}},required:["user","permissions"]},Actor:{type:"object",properties:{id:{type:"string"},type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},label:{type:"string",nullable:!0}},required:["id","type","label"],"x-typelizer":!0},AddressOwner:{type:"object",properties:{id:{type:"string"},type:{anyOf:[{type:"string",enum:["customer","company","seller"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},name:{type:"string",nullable:!0}},required:["id","type","name"],"x-typelizer":!0},Address:{type:"object",properties:{id:{type:"string"},label:{type:"string",nullable:!0},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},postal_code:{type:"string",nullable:!0},city:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_name:{type:"string"},country_code:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_text:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean"},is_default_shipping:{type:"boolean"},state_name:{type:"string",nullable:!0},owner:{allOf:[{$ref:"#/components/schemas/AddressOwner"}],nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},latitude:{type:"number",nullable:!0},longitude:{type:"number",nullable:!0},customer_id:{type:"string",nullable:!0}},required:["id","label","first_name","last_name","full_name","address1","address2","postal_code","city","phone","company","country_name","country_code","state_text","state_code","quick_checkout","is_default_billing","is_default_shipping","state_name","owner","metadata","created_at","updated_at","latitude","longitude","customer_id"],"x-typelizer":!0},AdminUser:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string",nullable:!0},selected_locale:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},avatar_url:{type:"string",nullable:!0},roles:{type:"array",items:{$ref:"#/components/schemas/AdminUserRoleAssignment"}},stores:{type:"array",items:{$ref:"#/components/schemas/AdminUserStore"}}},required:["id","email","first_name","last_name","full_name","selected_locale","created_at","updated_at","avatar_url","roles","stores"],"x-typelizer":!0},AllowedOrigin:{type:"object",properties:{id:{type:"string"},origin:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","origin","created_at","updated_at"],"x-typelizer":!0},ApiKey:{type:"object",properties:{id:{type:"string"},name:{type:"string"},key_type:{type:"string",enum:["publishable","secret"]},token_prefix:{type:"string",nullable:!0},scopes:{type:"array",items:{type:"string"}},created_at:{type:"string"},updated_at:{type:"string"},revoked_at:{type:"string",nullable:!0},last_used_at:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},plaintext_token:{type:"string",nullable:!0},created_by_email:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by_label:{type:"string",nullable:!0}},required:["id","name","key_type","token_prefix","scopes","created_at","updated_at","revoked_at","last_used_at","channel_id","plaintext_token","created_by_email","created_by_type","created_by_label"],"x-typelizer":!0},AppliedPromotion:{type:"object",properties:{id:{type:"string"},promotion_id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",nullable:!0},amount:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","promotion_id","name","description","code","amount","created_at","updated_at"],"x-typelizer":!0},Cart:{type:"object",properties:{id:{type:"string"},market_id:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},preferred_stock_location_id:{type:"string",nullable:!0},company_id:{type:"string",nullable:!0},company_name:{type:"string",nullable:!0},po_number_required:{type:"boolean"},po_document_filename:{type:"string",nullable:!0},po_document_byte_size:{type:"number",nullable:!0},token:{type:"string"},email:{type:"string",nullable:!0},customer_note:{type:"string",nullable:!0},po_number:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},total_quantity:{type:"number"},warnings:{type:"array",items:{$ref:"#/components/schemas/CartWarning"}},coupon_code:{type:"string",nullable:!0},item_total:{type:"string",nullable:!0,description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",nullable:!0,description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",nullable:!0,description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",nullable:!0,description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",nullable:!0,description:"Tax added on top of the prices."},delivery_total:{type:"string",nullable:!0,description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",nullable:!0,description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",nullable:!0,description:"What a gift card pays."},store_credit_total:{type:"string",nullable:!0,description:"What store credit pays, apart from gift cards."},total:{type:"string",nullable:!0,description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",nullable:!0,description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},adjustment_total:{type:"string",nullable:!0,description:"Every discount, fee and added tax together, as one amount."},current_step:{type:"string"},completed_steps:{type:"array",items:{type:"string"}},requirements:{type:"array",items:{$ref:"#/components/schemas/CheckoutRequirement"}},order_minimum:{type:"string",nullable:!0},order_minimum_shortfall:{type:"string",nullable:!0},below_order_minimum:{type:"boolean",nullable:!0},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0},shipping_eq_billing_address:{type:"boolean"},items:{type:"array",items:{$ref:"#/components/schemas/LineItem"}},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0},completed_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},applied_promotions:{type:"array",items:{$ref:"#/components/schemas/AppliedPromotion"}}},required:["id","market_id","channel_id","preferred_stock_location_id","company_id","company_name","po_number_required","po_document_filename","po_document_byte_size","token","email","customer_note","po_number","currency","locale","total_quantity","warnings","coupon_code","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","adjustment_total","current_step","completed_steps","requirements","order_minimum","order_minimum_shortfall","below_order_minimum","freight_summary","shipping_eq_billing_address","items","billing_address","shipping_address","market","completed_at","created_at","updated_at","applied_promotions"],"x-typelizer":!0},CatalogAssignment:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},catalog_id:{type:"string"},assignable_type:{type:"string",enum:["customer_group","company"]},assignable_id:{type:"string"},assignable_name:{type:"string",nullable:!0}},required:["id","created_at","catalog_id","assignable_type","assignable_id","assignable_name"],"x-typelizer":!0},CatalogOrderMinimum:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"}},required:["id","currency","created_at","updated_at","amount"],"x-typelizer":!0},CatalogPrice:{type:"object",properties:{id:{type:"string",nullable:!0},label:{type:"string",nullable:!0},sku:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},source:{type:"string",enum:["explicit","automatic","base"]},break_count:{type:"number"},amount:{type:"string"},tiers:{type:"array",items:{$ref:"#/components/schemas/CatalogPriceTier"}}},required:["id","label","sku","currency","source","break_count","amount","tiers"],"x-typelizer":!0},CatalogPriceTier:{type:"object",properties:{min_quantity:{type:"number"},amount:{type:"string"}},required:["min_quantity","amount"],"x-typelizer":!0},CatalogProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0},quantity_rule:{allOf:[{$ref:"#/components/schemas/CatalogProductTerm"}],nullable:!0},catalog_variants:{type:"array",items:{$ref:"#/components/schemas/CatalogPrice"}}},required:["id","name","thumbnail_url"],"x-typelizer":!0},CatalogProductTerm:{type:"object",properties:{id:{type:"string"},product_id:{type:"string"},product_name:{type:"string",nullable:!0},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},mixed:{type:"boolean"}},required:["id","product_id","product_name","minimum_order_quantity","order_multiple","mixed"],"x-typelizer":!0},CatalogQuantityRule:{type:"object",properties:{id:{type:"string"},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},variant_id:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},product_name:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0}},required:["id","minimum_order_quantity","order_multiple","created_at","updated_at","variant_id","variant_sku","product_name","options_text"],"x-typelizer":!0},Catalog:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},position:{type:"number",nullable:!0},metadata:{type:"object",nullable:!0},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},products_count:{type:"number"},pricing_strategy:{type:"string"},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimum"}},price_list:{$ref:"#/components/schemas/PriceList"},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignment"}}},required:["id","name","description","active","position","metadata","minimum_order_quantity","order_multiple","created_at","updated_at","products_count","pricing_strategy"],"x-typelizer":!0},Category:{type:"object",properties:{id:{type:"string"},name:{type:"string"},permalink:{type:"string"},position:{type:"number"},depth:{type:"number"},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},children_count:{type:"number"},parent_id:{type:"string",nullable:!0},description:{type:"string"},description_html:{type:"string"},image_url:{type:"string",nullable:!0},square_image_url:{type:"string",nullable:!0},is_root:{type:"boolean"},is_child:{type:"boolean"},is_leaf:{type:"boolean"},parent:{$ref:"#/components/schemas/Category"},children:{type:"array",items:{$ref:"#/components/schemas/Category"}},ancestors:{type:"array",items:{$ref:"#/components/schemas/Category"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},translations:{type:"object"},metadata:{type:"object"},pretty_name:{type:"string"},lft:{type:"number"},rgt:{type:"number"},products_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","name","permalink","position","depth","meta_title","meta_description","meta_keywords","children_count","parent_id","description","description_html","image_url","square_image_url","is_root","is_child","is_leaf","external_references","metadata","pretty_name","lft","rgt","products_count","created_at","updated_at"],"x-typelizer":!0},Channel:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string"},active:{type:"boolean"},default:{type:"boolean"},storefront_access:{type:"string",nullable:!0,enum:["public","prices_hidden","login_required"]},guest_checkout:{type:"boolean",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},order_routing_strategy:{type:"string",nullable:!0,description:"Order routing strategy; null inherits the store setting. Built-in: rules. Extensions may register more."},stock_location_ids:{type:"array",items:{type:"string"}},default_catalog_id:{type:"string",nullable:!0}},required:["id","name","code","active","default","storefront_access","guest_checkout","created_at","updated_at","order_routing_strategy","stock_location_ids","default_catalog_id"],"x-typelizer":!0},ClaimLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},send_replacement:{type:"boolean"},description:{type:"string",nullable:!0},refund_amount:{type:"string"},paid_amount:{type:"string"},pre_tax_amount:{type:"string"},included_tax_total:{type:"string"},additional_tax_total:{type:"string"},tax_total:{type:"string"},variant_id:{type:"string",nullable:!0},replacement_variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"},replacement_variant:{$ref:"#/components/schemas/Variant"}},required:["id","quantity","send_replacement","description","refund_amount","paid_amount","pre_tax_amount","included_tax_total","additional_tax_total","tax_total","variant_id","replacement_variant_id","line_item_id","created_at","updated_at"],"x-typelizer":!0},ClaimReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Claim:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["open","approved","resolved","denied","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},resolution:{type:"string",nullable:!0,enum:["refund","replacement","refund_and_replacement"]},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},refund_total:{type:"string"},approved_at:{type:"string",nullable:!0},resolved_at:{type:"string",nullable:!0},denied_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ClaimReason"},claim_line_items:{type:"array",items:{$ref:"#/components/schemas/ClaimLineItem"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},order:{$ref:"#/components/schemas/Order"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}}},required:["id","number","status","resolution","order_id","reason_id","refund_total","approved_at","resolved_at","denied_at","canceled_at","memo","metadata","created_at","updated_at","created_by_id","created_by_type"],"x-typelizer":!0},CollectionRule:{type:"object",properties:{id:{type:"string"},value:{type:"string",nullable:!0},match_policy:{type:"string",enum:["is_equal_to","is_not_equal_to","contains","does_not_contain"]},type:{type:"string",description:"Rule type. Built-in: tag, available_on, sale. Extensions may register more."}},required:["id","value","match_policy","type"],"x-typelizer":!0},Collection:{type:"object",properties:{id:{type:"string"},name:{type:"string"},permalink:{type:"string"},position:{type:"number"},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"]},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},products_count:{type:"number"},description:{type:"string"},description_html:{type:"string"},image_url:{type:"string",nullable:!0},square_image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},translations:{type:"object"},automatic:{type:"boolean"},rules_match_policy:{type:"string",enum:["all","any"]},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRule"}}},required:["id","name","permalink","position","sort_order","meta_title","meta_description","meta_keywords","products_count","description","description_html","image_url","square_image_url","automatic","rules_match_policy","metadata","created_at","updated_at"],"x-typelizer":!0},CommissionLine:{type:"object",properties:{id:{type:"string"},kind:{type:"string",enum:["percentage","fixed"]},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},taxability_reason:{anyOf:[{type:"string",enum:["standard_rated","reduced_rated","zero_rated","reverse_charge","intra_community_supply","export","customer_exempt","product_exempt","not_collecting","not_subject_to_tax"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},rate:{type:"string"},tax_rate:{type:"string"},amount:{type:"string"},tax_amount:{type:"string"},total:{type:"string"},order_id:{type:"string"},seller_id:{type:"string"},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},commission_rate_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},commission_rate:{$ref:"#/components/schemas/CommissionRate"}},required:["id","kind","currency","taxability_reason","country_code","state_code","created_at","updated_at","rate","tax_rate","amount","tax_amount","total","order_id","seller_id","line_item_id","fulfillment_id","commission_rate_id","seller_name"],"x-typelizer":!0},CommissionRate:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string",nullable:!0},enabled:{type:"boolean"},position:{type:"number"},kind:{type:"string",enum:["percentage","fixed"]},tax_inclusive:{type:"boolean"},include_shipping:{type:"boolean"},metadata:{type:"object",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},value:{type:"string"},commission_tax_rate:{type:"string",nullable:!0},amounts:{type:"object"},bounds:{type:"object"},global:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRule"}}},required:["id","name","code","enabled","position","kind","tax_inclusive","include_shipping","metadata","deleted_at","created_at","updated_at","value","commission_tax_rate","amounts","bounds","global","rules"],"x-typelizer":!0},CommissionRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: seller_rule, category_rule, product_rule, item_total_rule. Extensions may register more."},commission_rate_id:{type:"string"},preferences:{$ref:"#/components/schemas/CommissionRulePreferences"},product_ids:{type:"array",items:{type:"string"},nullable:!0},seller_ids:{type:"array",items:{type:"string"},nullable:!0},category_ids:{type:"array",items:{type:"string"},nullable:!0},sellers:{type:"array",items:{$ref:"#/components/schemas/Seller"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}}},required:["id","created_at","updated_at","type","commission_rate_id","preferences","product_ids","seller_ids","category_ids"],"x-typelizer":!0},CompanyInvitation:{type:"object",properties:{id:{type:"string"},email:{type:"string"},expires_at:{type:"string",nullable:!0},company_id:{type:"string"},status:{type:"string",enum:["pending","accepted","revoked","expired"]},accepted_at:{type:"string",nullable:!0},revoked_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","email","expires_at","company_id","status","accepted_at","revoked_at","created_at","updated_at"],"x-typelizer":!0},CompanyMembership:{type:"object",properties:{id:{type:"string"},company_id:{type:"string"},customer_id:{type:"string"},email:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","company_id","customer_id","email","created_at","updated_at"],"x-typelizer":!0},Company:{type:"object",properties:{id:{type:"string"},name:{type:"string"},kind:{type:"string",enum:["company","division"]},po_number_required:{type:"boolean"},parent_id:{type:"string",nullable:!0},ancestors:{type:"array",items:{type:"object"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},children_count:{type:"number"},members_count:{type:"number"},children:{type:"array",items:{$ref:"#/components/schemas/Company"}},addresses:{type:"array",items:{$ref:"#/components/schemas/Address"}},memberships:{type:"array",items:{$ref:"#/components/schemas/CompanyMembership"}}},required:["id","name","kind","po_number_required","parent_id","ancestors","external_references","metadata","created_at","updated_at","children_count","members_count"],"x-typelizer":!0},ConsentRecord:{type:"object",properties:{id:{type:"string"},purpose:{type:"string"},source:{type:"string",enum:["checkout","registration","account","admin","newsletter","anonymization","unknown","import","storefront"]},accepted:{type:"boolean"},email:{type:"string",nullable:!0},ip_address:{type:"string",nullable:!0},created_at:{type:"string"},recorded_at:{type:"string",nullable:!0},documents:{type:"array",items:{type:"object"}}},required:["id","purpose","source","accepted","email","ip_address","created_at","recorded_at","documents"],"x-typelizer":!0},Country:{type:"object",properties:{iso:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},iso3:{type:"string"},states_required:{type:"boolean"},zipcode_required:{type:"boolean"},states:{type:"array",items:{$ref:"#/components/schemas/State"}},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0}},required:["iso","iso3","states_required","zipcode_required"],"x-typelizer":!0},CouponCode:{type:"object",properties:{id:{type:"string"},code:{type:"string"},state:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},promotion_id:{type:"string"},order_id:{type:"string",nullable:!0}},required:["id","code","state","created_at","updated_at","promotion_id","order_id"],"x-typelizer":!0},CreditCard:{type:"object",properties:{id:{type:"string"},brand:{type:"string"},last4:{type:"string"},month:{type:"number"},year:{type:"number"},name:{type:"string",nullable:!0},default:{type:"boolean"},gateway_payment_profile_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},customer_id:{type:"string",nullable:!0},payment_method_id:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","brand","last4","month","year","name","default","gateway_payment_profile_id","customer_id","payment_method_id","metadata","created_at","updated_at"],"x-typelizer":!0},CustomFieldDefinition:{type:"object",properties:{id:{type:"string"},namespace:{type:"string"},key:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},storefront_visible:{type:"boolean"},searchable:{type:"boolean"},sortable:{type:"boolean"},filter_key:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, for example product, variant, order, customer or category. Discover the full list from the resource_types endpoint; extensions may register more."}},required:["id","namespace","key","label","field_type","storefront_visible","searchable","sortable","filter_key","created_at","updated_at","resource_type"],"x-typelizer":!0},CustomField:{type:"object",properties:{id:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},key:{type:"string"},value:{},created_at:{type:"string"},updated_at:{type:"string"},storefront_visible:{type:"boolean"},custom_field_definition_id:{type:"string"}},required:["id","label","field_type","key","value","created_at","updated_at","storefront_visible","custom_field_definition_id"],"x-typelizer":!0},CustomerGroup:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},customers_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}}},required:["id","name","description","customers_count","created_at","updated_at"],"x-typelizer":!0},Customer:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},accepts_email_marketing:{type:"boolean"},email_marketing_consent_updated_at:{type:"string",nullable:!0},full_name:{type:"string"},available_store_credit_total:{type:"string"},addresses:{type:"array",items:{$ref:"#/components/schemas/Address"}},default_billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},default_shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},newsletter_subscriber:{allOf:[{$ref:"#/components/schemas/NewsletterSubscriber"}],nullable:!0},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},failed_attempts:{type:"number"},metadata:{type:"object"},email_marketing_consent_source:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},anonymized_at:{type:"string",nullable:!0},anonymized:{type:"boolean"},tags:{type:"array",items:{type:"string"}},internal_note:{type:"string",nullable:!0},internal_note_html:{type:"string",nullable:!0},default_billing_address_id:{type:"string",nullable:!0},default_shipping_address_id:{type:"string",nullable:!0},orders_count:{type:"number"},total_spent:{type:"string"},last_order_completed_at:{type:"string",nullable:!0},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}},store_credits:{type:"array",items:{$ref:"#/components/schemas/StoreCredit"}},customer_group_ids:{type:"array",items:{type:"string"}},companies:{type:"array",items:{$ref:"#/components/schemas/Company"}}},required:["id","email","first_name","last_name","phone","accepts_email_marketing","email_marketing_consent_updated_at","full_name","available_store_credit_total","failed_attempts","metadata","email_marketing_consent_source","created_at","updated_at","anonymized_at","anonymized","tags","internal_note","internal_note_html","default_billing_address_id","default_shipping_address_id","orders_count","total_spent","last_order_completed_at","customer_group_ids"],"x-typelizer":!0},DashboardCounter:{type:"object",properties:{key:{type:"string",description:"Registered counter name. The dashboard translates it; built-in: orders_to_fulfill, payments_to_collect, open_returns, open_exchanges, open_claims, low_stock_items, out_of_stock_items."},value:{type:"number"},link:{type:"object",nullable:!0,description:"The list filter that shows exactly the rows counted, or null when no list can."},nav:{type:"string",nullable:!0,description:"Sidebar entry key this count badges, or null."}},required:["key","value","link","nav"],"x-typelizer":!0},DataRequest:{type:"object",properties:{id:{type:"string"},number:{type:"string"},kind:{type:"string",enum:["access","erasure"]},status:{anyOf:[{type:"string",enum:["awaiting_confirmation","pending","processing","completed","failed","lapsed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},requested_at:{type:"string",nullable:!0},completed_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},email:{type:"string"},error_message:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},customer_id:{type:"string",nullable:!0},requested_by_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"}},required:["id","number","kind","status","requested_at","completed_at","expires_at","email","error_message","created_at","updated_at","customer_id","requested_by_id"],"x-typelizer":!0},DeliveryMethodRule:{type:"object",properties:{id:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule, channel_rule, volume_rule, company_rule. Extensions may register more."},preferences:{$ref:"#/components/schemas/DeliveryMethodRulePreferences"},product_ids:{type:"array",items:{type:"string"}}},required:["id","active","created_at","updated_at","type","preferences","product_ids"],"x-typelizer":!0},DeliveryMethod:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"number",nullable:!0},estimated_transit_business_days_max:{type:"number",nullable:!0},digital:{type:"boolean"},pickup:{type:"boolean"},pickup_point:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},admin_name:{type:"string",nullable:!0},storefront_visible:{type:"boolean"},tracking_url:{type:"string",nullable:!0},available_to_sellers:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string"},markup_flat:{type:"string",nullable:!0},markup_percent:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodService"}},rules:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodRule"}},tax_category_id:{type:"string",nullable:!0},delivery_profile_id:{type:"string"},delivery_origin_group_id:{type:"string",nullable:!0},delivery_zone_id:{type:"string",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"}},fulfillment_provider:{type:"string",description:"Fulfillment provider. Built-in: manual, digital, pickup, pickup_point. Provider gems register more (e.g. easy_post)."},pickup_point_provider:{type:"string",nullable:!0,description:"Pickup point network. None built in; provider gems register them."},rate_provider:{type:"string",nullable:!0,description:"Rate provider; null prices through the calculator. Built-in: internal, freight. Provider gems register more (e.g. easy_post)."},calculator:{allOf:[{$ref:"#/components/schemas/DeliveryMethodCalculator"}],nullable:!0}},required:["id","name","code","estimated_transit_business_days_min","estimated_transit_business_days_max","digital","pickup","pickup_point","admin_name","storefront_visible","tracking_url","available_to_sellers","created_at","updated_at","deleted_at","markup_flat","markup_percent","seller_id","seller_name","services","rules","tax_category_id","delivery_profile_id","delivery_origin_group_id","delivery_zone_id","stock_location_ids","fulfillment_provider","pickup_point_provider","rate_provider","calculator"],"x-typelizer":!0},DeliveryMethodService:{type:"object",properties:{id:{type:"string"},carrier:{type:"string"},service:{type:"string"},label:{type:"string",nullable:!0},markup_flat:{type:"string",nullable:!0},markup_percent:{type:"string",nullable:!0},position:{type:"number"}},required:["id","carrier","service","label","markup_flat","markup_percent","position"],"x-typelizer":!0},DeliveryOriginGroup:{type:"object",properties:{id:{type:"string"},name:{type:"string",nullable:!0},position:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string"},stock_location_ids:{type:"array",items:{type:"string"}},delivery_zones_count:{type:"number"},delivery_methods_count:{type:"number"}},required:["id","name","position","created_at","updated_at","delivery_profile_id","stock_location_ids","delivery_zones_count","delivery_methods_count"],"x-typelizer":!0},DeliveryProfile:{type:"object",properties:{id:{type:"string"},name:{type:"string"},default:{type:"boolean"},position:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},kind:{type:"string",description:"Profile kind. Built-in: shipping, digital. Extensions may register more."},digital:{type:"boolean"},offers_pickup:{type:"boolean"},offers_shipping:{type:"boolean"},stock_location_ids:{type:"array",items:{type:"string"}},origin_groups:{type:"array",items:{type:"object"}},products_count:{type:"number"},delivery_methods_count:{type:"number"},delivery_zones_count:{type:"number"}},required:["id","name","default","position","created_at","updated_at","kind","digital","offers_pickup","offers_shipping","stock_location_ids","origin_groups","products_count","delivery_methods_count","delivery_zones_count"],"x-typelizer":!0},DeliveryRate:{type:"object",properties:{id:{type:"string"},delivery_method_id:{type:"string"},name:{type:"string"},selected:{type:"boolean"},cost:{type:"string"},total:{type:"string"},additional_tax_total:{type:"string"},included_tax_total:{type:"string"},tax_total:{type:"string"},carrier:{type:"string",nullable:!0},service_level:{type:"string",nullable:!0},estimated_delivery_date:{type:"string",nullable:!0},unpriced:{type:"boolean"},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0},delivery_method:{$ref:"#/components/schemas/DeliveryMethod"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","delivery_method_id","name","selected","cost","total","additional_tax_total","included_tax_total","tax_total","carrier","service_level","estimated_delivery_date","unpriced","freight_summary","metadata","created_at","updated_at"],"x-typelizer":!0},Delivery:{type:"object",properties:{id:{type:"string"},tracking_number:{type:"string"},carrier:{type:"string",nullable:!0},carrier_name:{type:"string",nullable:!0},service:{type:"string",nullable:!0},status:{type:"string",enum:["pending","pre_transit","in_transit","out_for_delivery","available_for_pickup","delivered","return_to_sender","failure","unknown"]},tracking_url:{type:"string",nullable:!0},estimated_delivery_at:{type:"string",nullable:!0},delivered_at:{type:"string",nullable:!0},details:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},shipping_label_id:{type:"string",nullable:!0}},required:["id","tracking_number","carrier","carrier_name","service","status","tracking_url","estimated_delivery_at","delivered_at","details","created_at","updated_at","shipping_label_id"],"x-typelizer":!0},DeliveryZoneMember:{type:"object",properties:{id:{type:"string"},member_type:{type:"string",enum:["country","state","postal_code"]},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},postal_code_prefix:{type:"string",nullable:!0},postal_code_from:{type:"string",nullable:!0},postal_code_to:{type:"string",nullable:!0},country_name:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","member_type","country_code","state_code","postal_code_prefix","postal_code_from","postal_code_to","country_name","state_name","created_at","updated_at"],"x-typelizer":!0},DeliveryZone:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMember"}},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string"},delivery_origin_group_id:{type:"string",nullable:!0},delivery_method_ids:{type:"array",items:{type:"string"}}},required:["id","name","description","created_at","updated_at","delivery_profile_id","delivery_origin_group_id","delivery_method_ids"],"x-typelizer":!0},DigitalAsset:{type:"object",properties:{id:{type:"string"},variant_id:{type:"string",nullable:!0},filename:{type:"string",nullable:!0},content_type:{type:"string",nullable:!0},authorized_clicks:{type:"number",nullable:!0},authorized_days:{type:"number",nullable:!0},byte_size:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},provider_type:{type:"string",nullable:!0,description:"Digital asset provider; null is an uploaded file. Built-in: file. Extensions may register more."},provider_name:{type:"string",description:"Digital asset provider name. Built-in: File. Extensions may register more."},download_url:{type:"string",nullable:!0},effective_authorized_clicks:{type:"number"},effective_authorized_days:{type:"number"},provider_settings:{type:"object"}},required:["id","variant_id","filename","content_type","authorized_clicks","authorized_days","byte_size","created_at","updated_at","provider_type","provider_name","download_url","effective_authorized_clicks","effective_authorized_days","provider_settings"],"x-typelizer":!0},DigitalLink:{type:"object",properties:{id:{type:"string"},access_counter:{type:"number"},filename:{type:"string"},content_type:{type:"string"},download_url:{type:"string"},expires_at:{type:"string",nullable:!0},authorizable:{type:"boolean"},expired:{type:"boolean"},access_limit_exceeded:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","access_counter","filename","content_type","download_url","expires_at","authorizable","expired","access_limit_exceeded","created_at","updated_at"],"x-typelizer":!0},Discount:{type:"object",properties:{id:{type:"string"},label:{type:"string"},kind:{type:"string",enum:["promotion","manual"]},code:{type:"string",nullable:!0},value_type:{type:"string",nullable:!0},value:{type:"string",nullable:!0},promotion_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},amount:{type:"string"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","label","kind","code","value_type","value","promotion_id","line_item_id","fulfillment_id","amount","metadata","created_at","updated_at"],"x-typelizer":!0},EmailTemplateDraft:{type:"object",properties:{id:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},lock_version:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},updated_by_id:{type:"string",nullable:!0},updated_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},updated_by:{$ref:"#/components/schemas/Actor"}},required:["id","subject","body","lock_version","created_at","updated_at","updated_by_id","updated_by_type"],"x-typelizer":!0},EmailTemplatePreview:{type:"object",properties:{id:{type:"string",nullable:!0},subject:{type:"string"},html:{type:"string"},text:{type:"string"},email_key:{type:"string"},variables:{type:"object"}},required:["id","subject","html","text","email_key","variables"],"x-typelizer":!0},EmailTemplateRevision:{type:"object",properties:{id:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},created_at:{type:"string"},published_by_id:{type:"string",nullable:!0},published_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},published_by:{$ref:"#/components/schemas/Actor"}},required:["id","subject","body","created_at","published_by_id","published_by_type"],"x-typelizer":!0},EmailTemplateSampleRecord:{type:"object",properties:{id:{type:"string"},label:{type:"string"},created_at:{type:"string"}},required:["id","label","created_at"],"x-typelizer":!0},EmailTemplate:{type:"object",properties:{id:{type:"string"},key:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},language:{type:"string"},customized_languages:{type:"array",items:{type:"string"}},kind:{type:"string",enum:["email","layout","partial"]},customized:{type:"boolean"},published_at:{type:"string",nullable:!0},default_subject:{type:"string",nullable:!0},default_body:{type:"string"},published_language:{type:"string",nullable:!0},default_changed:{type:"boolean"},base_subject:{type:"string",nullable:!0},base_body:{type:"string",nullable:!0},draft:{allOf:[{$ref:"#/components/schemas/EmailTemplateDraft"}],nullable:!0}},required:["id","key","subject","body","language","customized_languages","kind","customized","published_at","default_subject","default_body","published_language","default_changed","base_subject","base_body","draft"],"x-typelizer":!0},ExchangeLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},received_quantity:{type:"number"},resellable:{type:"boolean"},original_price:{type:"string"},new_variant_price:{type:"string"},price_difference:{type:"string"},original_tax_total:{type:"string"},new_tax_total:{type:"string"},original_variant_id:{type:"string",nullable:!0},new_variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_item_id:{type:"string",nullable:!0},original_variant:{$ref:"#/components/schemas/Variant"},new_variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","quantity","received_quantity","resellable","original_price","new_variant_price","price_difference","original_tax_total","new_tax_total","original_variant_id","new_variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":!0},Exchange:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["requested","approved","received","fulfilled","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},price_difference:{type:"string"},approved_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},fulfilled_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ReturnReason"},exchange_line_items:{type:"array",items:{$ref:"#/components/schemas/ExchangeLineItem"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},stock_location_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},order:{$ref:"#/components/schemas/Order"},stock_location:{$ref:"#/components/schemas/StockLocation"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}}},required:["id","number","status","order_id","reason_id","price_difference","approved_at","received_at","fulfilled_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","created_by_type"],"x-typelizer":!0},Export:{type:"object",properties:{id:{type:"string"},number:{type:"string"},format:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",nullable:!0},user_id:{type:"string",nullable:!0},done:{type:"boolean"},store_id:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},filename:{type:"string",nullable:!0},byte_size:{type:"number",nullable:!0},download_url:{type:"string",nullable:!0}},required:["id","number","format","created_at","updated_at","type","user_id","done","store_id","seller_id","seller_name","filename","byte_size","download_url"],"x-typelizer":!0},Fee:{type:"object",properties:{id:{type:"string"},label:{type:"string"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"What sort of charge this is. `duty` is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds."},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},amount:{type:"string"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","label","kind","line_item_id","fulfillment_id","amount","metadata","created_at","updated_at"],"x-typelizer":!0},FileUpload:{type:"object",properties:{signed_id:{type:"string"},filename:{type:"string"},content_type:{type:"string"},byte_size:{type:"number"},visibility:{type:"string",enum:["public","private"]},expires_at:{type:"string"},upload:{allOf:[{$ref:"#/components/schemas/FileUploadTarget"}],nullable:!0}},required:["signed_id","filename","content_type","byte_size","visibility","expires_at","upload"],"x-typelizer":!0},FileUploadTarget:{type:"object",properties:{method:{type:"string"},url:{type:"string"},headers:{type:"object"}},required:["method","url","headers"],"x-typelizer":!0},FreightSummaryLine:{type:"object",properties:{variant_id:{type:"string",nullable:!0},sku:{type:"string",nullable:!0},name:{type:"string",nullable:!0},units:{type:"number"},cartons:{type:"number",nullable:!0},pallets:{type:"number",nullable:!0},units_per_carton:{type:"number",nullable:!0},cartons_per_pallet:{type:"number",nullable:!0},complete:{type:"boolean"},weight_per_carton:{type:"string",nullable:!0},volume:{type:"string"},weight:{type:"string"}},required:["variant_id","sku","name","units","cartons","pallets","units_per_carton","cartons_per_pallet","complete","weight_per_carton","volume","weight"],"x-typelizer":!0},FreightSummary:{type:"object",properties:{total_units:{type:"number"},total_cartons:{type:"number"},total_pallets:{type:"number",nullable:!0},total_volume:{type:"string"},total_weight:{type:"string"},complete:{type:"boolean"},lines:{type:"array",items:{$ref:"#/components/schemas/FreightSummaryLine"}}},required:["total_units","total_cartons","total_pallets","total_volume","total_weight","complete","lines"],"x-typelizer":!0},FulfillmentItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},status:{anyOf:[{type:"string",enum:["on_hand","backordered","shipped","returned"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},name:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0}},required:["id","quantity","status","variant_id","line_item_id","name","options_text"],"x-typelizer":!0},Fulfillment:{type:"object",properties:{id:{type:"string"},number:{type:"string"},tracking:{type:"string",nullable:!0},tracking_url:{type:"string",nullable:!0},pickup_point_data:{type:"object",nullable:!0},selected_delivery_rate_id:{type:"string",nullable:!0},unpriced:{type:"boolean"},cost:{type:"string"},total:{type:"string"},discount_total:{type:"string"},additional_tax_total:{type:"string"},included_tax_total:{type:"string"},tax_total:{type:"string"},status:{anyOf:[{type:"string",enum:["unfulfilled","fulfilled","delivered","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},fulfillment_type:{type:"string",enum:["shipping","digital","pickup","pickup_point"]},fulfilled_at:{type:"string",nullable:!0},delivered_at:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/FulfillmentManifestItem"}},deliveries:{type:"array",items:{$ref:"#/components/schemas/Delivery"}},delivery_method:{$ref:"#/components/schemas/DeliveryMethod"},stock_location:{$ref:"#/components/schemas/StockLocation"},delivery_rates:{type:"array",items:{$ref:"#/components/schemas/DeliveryRate"}},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},adjustment_total:{type:"string"},pre_tax_amount:{type:"string"},order_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},documents:{type:"array",items:{type:"object"}},labels:{type:"array",items:{$ref:"#/components/schemas/ShippingLabel"}},provider_generates_labels:{type:"boolean"},fulfillment_items:{type:"array",items:{$ref:"#/components/schemas/FulfillmentItem"}},order:{$ref:"#/components/schemas/Order"}},required:["id","number","tracking","tracking_url","pickup_point_data","selected_delivery_rate_id","unpriced","cost","total","discount_total","additional_tax_total","included_tax_total","tax_total","status","fulfillment_type","fulfilled_at","delivered_at","items","deliveries","external_references","metadata","created_at","updated_at","adjustment_total","pre_tax_amount","order_id","stock_location_id","documents","labels","provider_generates_labels"],"x-typelizer":!0},GiftCardBatch:{type:"object",properties:{id:{type:"string"},codes_count:{type:"number"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},prefix:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0}},required:["id","codes_count","currency","prefix","created_at","updated_at","amount","expires_at","created_by_id"],"x-typelizer":!0},GiftCard:{type:"object",properties:{id:{type:"string"},code:{type:"string"},status:{anyOf:[{type:"string",enum:["active","partially_redeemed","redeemed","canceled","expired"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string"},amount_used:{type:"string"},amount_authorized:{type:"string"},amount_remaining:{type:"string"},expires_at:{type:"string",nullable:!0},redeemed_at:{type:"string",nullable:!0},expired:{type:"boolean"},active:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},created_at:{type:"string"},updated_at:{type:"string"},customer_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"},created_by:{$ref:"#/components/schemas/AdminUser"},gift_card_batch:{$ref:"#/components/schemas/GiftCardBatch"},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}}},required:["id","code","status","currency","amount","amount_used","amount_authorized","amount_remaining","expires_at","redeemed_at","expired","active","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":!0},ImportMapping:{type:"object",properties:{id:{type:"string"},schema_field:{type:"string"},file_column:{type:"string",nullable:!0},required:{type:"boolean"}},required:["id","schema_field","file_column","required"],"x-typelizer":!0},ImportRow:{type:"object",properties:{id:{type:"string"},row_number:{type:"number"},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},validation_errors:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},import_id:{type:"string",nullable:!0},item_type:{type:"string",nullable:!0},item_id:{type:"string",nullable:!0},data:{type:"object"}},required:["id","row_number","status","validation_errors","created_at","updated_at","import_id","item_type","item_id","data"],"x-typelizer":!0},Import:{type:"object",properties:{id:{type:"string"},number:{type:"string"},rows_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",nullable:!0,description:"Import type. Built-in: products, product_translations, customers, price_list_prices. Extensions may register more."},status:{anyOf:[{type:"string",enum:["pending","mapping","completed_mapping","processing","completed","failed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},store_id:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},user_id:{type:"string",nullable:!0},processing_errors:{type:"string",nullable:!0},delimiter:{type:"string"},price_list_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},original_filename:{type:"string",nullable:!0},original_byte_size:{type:"number",nullable:!0},original_file_url:{type:"string",nullable:!0},completed_rows_count:{type:"number"},failed_rows_count:{type:"number"},schema_fields:{type:"array",items:{$ref:"#/components/schemas/ImportSchemaField"}},csv_headers:{type:"array",items:{type:"string"}},sample_row:{type:"object"},mappings:{type:"array",items:{$ref:"#/components/schemas/ImportMapping"}}},required:["id","number","rows_count","created_at","updated_at","type","status","store_id","seller_id","user_id","processing_errors","delimiter","price_list_id","seller_name","original_filename","original_byte_size","original_file_url","completed_rows_count","failed_rows_count","schema_fields","csv_headers","sample_row","mappings"],"x-typelizer":!0},Integration:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Integration type, registered by the provider gem that owns it (for example the EasyPost provider). Core ships none."},group:{type:"string",nullable:!0},preferences:{$ref:"#/components/schemas/IntegrationPreferences"}},required:["id","name","active","created_at","updated_at","type","group","preferences"],"x-typelizer":!0},InvitationAcceptanceLink:{type:"object",properties:{id:{type:"string"},acceptance_url:{type:"string"}},required:["id","acceptance_url"],"x-typelizer":!0},Invitation:{type:"object",properties:{id:{type:"string"},email:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","accepted"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},created_at:{type:"string"},updated_at:{type:"string"},expires_at:{type:"string"},role_id:{type:"string"},role_name:{type:"string"},inviter_email:{type:"string"},invitee_exists:{type:"boolean"},store:{type:"object"}},required:["id","email","status","created_at","updated_at","expires_at","role_id","role_name","inviter_email","invitee_exists","store"],"x-typelizer":!0},LineItem:{type:"object",properties:{id:{type:"string"},variant_id:{type:"string"},seller_id:{type:"string",nullable:!0},preorder:{type:"boolean"},preorder_ships_at:{type:"string",nullable:!0},quantity:{type:"number"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},name:{type:"string"},slug:{type:"string"},options_text:{type:"string"},price:{type:"string",description:"The price of one unit."},total:{type:"string",description:"What this line costs: price times quantity, with its discounts, fees and added tax."},adjustment_total:{type:"string",description:"This line's discounts, fees and added tax together."},additional_tax_total:{type:"string",description:"Tax added on top of the price."},included_tax_total:{type:"string",description:"Tax already included in the price."},discount_total:{type:"string",description:"What promotions take off this line, as a negative amount."},pre_tax_amount:{type:"string",description:"This line after discounts, without tax."},discounted_amount:{type:"string",description:"Price times quantity, after discounts."},compare_at_amount:{type:"string",nullable:!0,description:"The compare-at price times quantity, or null when the variant has none."},thumbnail_url:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},digital_links:{type:"array",items:{$ref:"#/components/schemas/DigitalLink"}},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object"},price_source:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},catalog_price:{type:"string",nullable:!0},price_list_id:{type:"string",nullable:!0},price_list_name:{type:"string",nullable:!0},catalog_id:{type:"string",nullable:!0},catalog_name:{type:"string",nullable:!0},cost_price:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},tax_category:{$ref:"#/components/schemas/TaxCategory"}},required:["id","variant_id","seller_id","preorder","preorder_ships_at","quantity","currency","name","slug","options_text","price","total","adjustment_total","additional_tax_total","included_tax_total","discount_total","pre_tax_amount","discounted_amount","compare_at_amount","thumbnail_url","option_values","digital_links","external_references","metadata","price_source","created_at","updated_at","catalog_price","price_list_id","price_list_name","catalog_id","catalog_name","cost_price","tax_category_id"],"x-typelizer":!0},Locale:{type:"object",properties:{code:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},default:{type:"boolean"},rtl:{type:"boolean"}},required:["code","default","rtl"],"x-typelizer":!0},MaintenanceTaskRun:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["enqueued","running","interrupted","cancelling","cancelled","succeeded","errored"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},dry_run:{type:"boolean"},initiated_via:{type:"string"},tick_count:{type:"number"},tick_total:{type:"number",nullable:!0},error_class:{type:"string",nullable:!0},error_message:{type:"string",nullable:!0},started_at:{type:"string",nullable:!0},ended_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},task_name:{type:"string"},duration:{type:"number",nullable:!0},tallies:{type:"object"},arguments:{type:"object"},error_backtrace:{type:"string",nullable:!0},active:{type:"boolean"},admin_user_id:{type:"string",nullable:!0},admin_user:{$ref:"#/components/schemas/AdminUser"}},required:["id","status","dry_run","initiated_via","tick_count","tick_total","error_class","error_message","started_at","ended_at","created_at","updated_at","task_name","duration","tallies","arguments","error_backtrace","active","admin_user_id"],"x-typelizer":!0},Market:{type:"object",properties:{id:{type:"string"},name:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},default_locale:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},tax_inclusive:{type:"boolean"},default:{type:"boolean"},country_codes:{type:"array",items:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},supported_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},countries:{type:"array",items:{$ref:"#/components/schemas/Country"}},created_at:{type:"string"},updated_at:{type:"string"},tax_provider:{type:"string",nullable:!0,description:"Tax provider; null uses the store default. Built-in: internal. Provider gems register more."}},required:["id","name","currency","default_locale","tax_inclusive","default","country_codes","supported_locales","created_at","updated_at","tax_provider"],"x-typelizer":!0},Media:{type:"object",properties:{id:{type:"string"},product_id:{type:"string",nullable:!0},variant_ids:{type:"array",items:{type:"string"}},position:{type:"number"},alt:{type:"string",nullable:!0},media_type:{type:"string",enum:["image","video","external_video"]},external_video_url:{type:"string",nullable:!0},focal_point_x:{type:"number",nullable:!0},focal_point_y:{type:"number",nullable:!0},video_provider:{type:"string",nullable:!0},video_embed_url:{type:"string",nullable:!0},video_url:{type:"string",nullable:!0},poster_url:{type:"string",nullable:!0},original_url:{type:"string",nullable:!0},mini_url:{type:"string",nullable:!0},small_url:{type:"string",nullable:!0},medium_url:{type:"string",nullable:!0},large_url:{type:"string",nullable:!0},xlarge_url:{type:"string",nullable:!0},og_image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},attached:{type:"boolean"},filename:{type:"string",nullable:!0},content_type:{type:"string",nullable:!0},byte_size:{type:"number",nullable:!0},embed_url:{type:"string",nullable:!0},signed_id:{type:"string",nullable:!0},viewable_id:{type:"string",nullable:!0},download_url:{type:"string",nullable:!0},metadata:{type:"object"},viewable_type:{type:"string",nullable:!0}},required:["id","product_id","variant_ids","position","alt","media_type","external_video_url","focal_point_x","focal_point_y","video_provider","video_embed_url","video_url","poster_url","original_url","mini_url","small_url","medium_url","large_url","xlarge_url","og_image_url","external_references","created_at","updated_at","attached","filename","content_type","byte_size","embed_url","signed_id","viewable_id","download_url","metadata","viewable_type"],"x-typelizer":!0},MembershipProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0}},required:["id","name","thumbnail_url"],"x-typelizer":!0},NewsletterSubscriber:{type:"object",properties:{id:{type:"string"},email:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},verified:{type:"boolean"},verified_at:{type:"string",nullable:!0},customer_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}}},required:["id","email","created_at","updated_at","verified","verified_at","customer_id"],"x-typelizer":!0},OauthAccessToken:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},owner_id:{type:"string",nullable:!0},owner_type:{type:"string",nullable:!0},owner:{$ref:"#/components/schemas/AdminUser"},scopes:{type:"array",items:{type:"string"}},expired:{type:"boolean"}},required:["id","created_at","owner_id","owner_type","scopes","expired"],"x-typelizer":!0},OauthApplication:{type:"object",properties:{id:{type:"string"},name:{type:"string"},redirect_uri:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},client_id:{type:"string"},connected:{type:"boolean"},scopes:{type:"array",items:{type:"string"}},last_authorized_at:{type:"string",nullable:!0},authorized_at:{type:"string",nullable:!0},authorized_by:{type:"string",nullable:!0}},required:["id","name","redirect_uri","created_at","updated_at","client_id","connected","scopes","last_authorized_at","authorized_at","authorized_by"],"x-typelizer":!0},OauthConsentRequest:{type:"object",properties:{client_name:{type:"string"},scopes:{type:"array",items:{type:"string"}},grantable_scopes:{type:"array",items:{type:"string"}},resource:{type:"string",nullable:!0},redirect_uri:{type:"string"}},required:["client_name","scopes","grantable_scopes","resource","redirect_uri"],"x-typelizer":!0},OauthProtectedResource:{type:"object",properties:{resource:{type:"string"},authorization_servers:{type:"array",items:{type:"string"}},scopes_supported:{type:"array",items:{type:"string"}},bearer_methods_supported:{type:"array",items:{type:"string"}},resource_documentation:{type:"string"}},required:["resource","authorization_servers","scopes_supported","bearer_methods_supported","resource_documentation"],"x-typelizer":!0},OauthRedirect:{type:"object",properties:{redirect_uri:{type:"string"}},required:["redirect_uri"],"x-typelizer":!0},OptionType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},label:{type:"string"},position:{type:"number"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},translations:{type:"object"},metadata:{type:"object"},filterable:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}}},required:["id","name","label","position","kind","metadata","filterable","created_at","updated_at"],"x-typelizer":!0},OptionValue:{type:"object",properties:{id:{type:"string"},option_type_id:{type:"string"},name:{type:"string"},label:{type:"string"},position:{type:"number"},color_code:{type:"string",nullable:!0},option_type_name:{type:"string"},option_type_label:{type:"string"},image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},option_type:{$ref:"#/components/schemas/OptionType"}},required:["id","option_type_id","name","label","position","color_code","option_type_name","option_type_label","image_url","metadata","created_at","updated_at"],"x-typelizer":!0},OrderCancellationReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},OrderGroup:{type:"object",properties:{id:{type:"string"},number:{type:"string"},email:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},item_total:{type:"string",nullable:!0,description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",nullable:!0,description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",nullable:!0,description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",nullable:!0,description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",nullable:!0,description:"Tax added on top of the prices."},delivery_total:{type:"string",nullable:!0,description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",nullable:!0,description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",nullable:!0,description:"What a gift card pays."},store_credit_total:{type:"string",nullable:!0,description:"What store credit pays, apart from gift cards."},total:{type:"string",nullable:!0,description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",nullable:!0,description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},payments:{type:"array",items:{$ref:"#/components/schemas/Payment"}},fulfillment_status:{type:"string",nullable:!0,enum:["backorder","canceled","partial","unfulfilled","fulfilled","delivered","pending","ready","shipped"]},payment_status:{type:"string",nullable:!0,enum:["none","authorized","partially_paid","paid","partially_refunded","refunded","overcharged","voided"]},completed_at:{type:"string",nullable:!0},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}},customer_id:{type:"string",nullable:!0},cart_id:{type:"string",nullable:!0},seller_count:{type:"number"},includes_first_party:{type:"boolean"},confirmation_delivered:{type:"boolean"},store_owner_notification_delivered:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","number","email","currency","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","payments","fulfillment_status","payment_status","completed_at","billing_address","shipping_address","orders","customer_id","cart_id","seller_count","includes_first_party","confirmation_delivered","store_owner_notification_delivered","created_at","updated_at"],"x-typelizer":!0},OrderRoutingRule:{type:"object",properties:{id:{type:"string"},position:{type:"number"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: preferred_location, default_location, minimize_splits. Extensions may register more."},channel_id:{type:"string"},preferences:{$ref:"#/components/schemas/OrderRoutingRulePreferences"}},required:["id","position","active","created_at","updated_at","type","channel_id","preferences"],"x-typelizer":!0},Order:{type:"object",properties:{id:{type:"string"},market_id:{type:"string",nullable:!0},withdrawal_period_ends_at:{type:"string",nullable:!0},within_withdrawal_period:{type:"boolean"},shipping_eq_billing_address:{type:"boolean"},cart_id:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},company_id:{type:"string",nullable:!0},company_name:{type:"string",nullable:!0},po_document_filename:{type:"string",nullable:!0},po_document_byte_size:{type:"number",nullable:!0},number:{type:"string"},email:{type:"string"},customer_note:{type:"string",nullable:!0},po_number:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},total_quantity:{type:"number"},coupon_code:{type:"string",nullable:!0},fulfillment_status:{type:"string",nullable:!0,enum:["backorder","canceled","partial","unfulfilled","fulfilled","delivered","pending","ready","shipped"]},payment_status:{type:"string",nullable:!0,enum:["none","authorized","partially_paid","paid","partially_refunded","refunded","overcharged","voided"]},completed_at:{type:"string",nullable:!0},item_total:{type:"string",description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",description:"Tax added on top of the prices."},delivery_total:{type:"string",description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",description:"What a gift card pays."},store_credit_total:{type:"string",description:"What store credit pays, apart from gift cards."},total:{type:"string",description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},payments:{type:"array",items:{$ref:"#/components/schemas/Payment"}},adjustment_total:{type:"string",description:"Every discount, fee and added tax together, as one amount."},items:{type:"array",items:{$ref:"#/components/schemas/LineItem"}},fulfillments:{type:"array",items:{$ref:"#/components/schemas/Fulfillment"}},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},gift_card:{allOf:[{$ref:"#/components/schemas/GiftCard"}],nullable:!0},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},status:{type:"string",enum:["draft","placed","canceled"]},last_ip_address:{type:"string",nullable:!0},considered_risky:{type:"boolean"},confirmation_delivered:{type:"boolean"},store_owner_notification_delivered:{type:"boolean",nullable:!0},metadata:{type:"object"},cancel_note:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},approved_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},payment_total:{type:"string"},commission_amount_total:{type:"string"},commission_tax_total:{type:"string"},commission_total:{type:"string"},preferred_stock_location_id:{type:"string",nullable:!0},po_document_url:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},order_group_id:{type:"string",nullable:!0},tags:{type:"array",items:{type:"string"}},internal_note:{type:"string",nullable:!0},internal_note_html:{type:"string",nullable:!0},approver_id:{type:"string",nullable:!0},approver_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},approver:{$ref:"#/components/schemas/Actor"},canceler_id:{type:"string",nullable:!0},canceler_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},canceler:{$ref:"#/components/schemas/Actor"},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},cancel_reason_id:{type:"string",nullable:!0},cancel_reason_name:{type:"string",nullable:!0},customer_id:{type:"string",nullable:!0},applied_promotions:{type:"array",items:{$ref:"#/components/schemas/AppliedPromotion"}},payment_splits:{type:"array",items:{$ref:"#/components/schemas/PaymentSplit"}},cart:{$ref:"#/components/schemas/Cart"},channel:{$ref:"#/components/schemas/Channel"},preferred_stock_location:{$ref:"#/components/schemas/StockLocation"},payment_methods:{type:"array",items:{$ref:"#/components/schemas/PaymentMethod"}},customer:{$ref:"#/components/schemas/Customer"},cancel_reason:{$ref:"#/components/schemas/OrderCancellationReason"},returns:{type:"array",items:{$ref:"#/components/schemas/Return"}},exchanges:{type:"array",items:{$ref:"#/components/schemas/Exchange"}},claims:{type:"array",items:{$ref:"#/components/schemas/Claim"}},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0}},required:["id","market_id","withdrawal_period_ends_at","within_withdrawal_period","shipping_eq_billing_address","cart_id","channel_id","company_id","company_name","po_document_filename","po_document_byte_size","number","email","customer_note","po_number","currency","locale","total_quantity","coupon_code","fulfillment_status","payment_status","completed_at","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","adjustment_total","gift_card","market","external_references","status","last_ip_address","considered_risky","confirmation_delivered","store_owner_notification_delivered","metadata","cancel_note","canceled_at","approved_at","created_at","updated_at","payment_total","commission_amount_total","commission_tax_total","commission_total","preferred_stock_location_id","po_document_url","seller_id","order_group_id","tags","internal_note","internal_note_html","approver_id","approver_type","canceler_id","canceler_type","created_by_id","created_by_type","cancel_reason_id","cancel_reason_name","customer_id","freight_summary"],"x-typelizer":!0},PackageType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},kind:{type:"string",enum:["box","envelope","carton","pallet","container"]},length:{type:"string",nullable:!0},width:{type:"string",nullable:!0},height:{type:"string",nullable:!0},weight:{type:"string",nullable:!0},max_weight:{type:"string",nullable:!0},default:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},dimensions_unit:{type:"string",enum:["mm","cm","in","ft"]},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},volume:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0}},required:["id","name","kind","length","width","height","weight","max_weight","default","metadata","created_at","updated_at","dimensions_unit","weight_unit","volume","seller_id","seller_name"],"x-typelizer":!0},PaymentCaptureEvent:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"}},required:["id","created_at","updated_at","amount"],"x-typelizer":!0},PaymentMethod:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},type:{type:"string",description:"Payment method type. Built-in: check, store_credit, custom_payment_source_method, bogus (test only); payment provider gems register their own, for example stripe."},session_required:{type:"boolean"},source_required:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},active:{type:"boolean"},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],nullable:!0},resolved_capture_method:{type:"string",enum:["checkout","on_dispatch","manual"]},storefront_visible:{type:"boolean"},position:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},preferences:{$ref:"#/components/schemas/PaymentMethodPreferences"},logo_url:{type:"string",nullable:!0},docs_url:{type:"string",nullable:!0},third_party:{type:"boolean"}},required:["id","name","description","type","session_required","source_required","metadata","active","capture_method","resolved_capture_method","storefront_visible","position","created_at","updated_at","preferences","logo_url","docs_url","third_party"],"x-typelizer":!0},Payment:{type:"object",properties:{id:{type:"string"},payment_method_id:{type:"string"},response_code:{type:"string",nullable:!0},number:{type:"string"},status:{anyOf:[{type:"string",enum:["checkout","processing","pending","completed","failed","void","invalid"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},amount:{type:"string"},source_type:{type:"string",nullable:!0,enum:["credit_card","store_credit","payment_source"]},source_id:{type:"string",nullable:!0},source:{anyOf:[{$ref:"#/components/schemas/CreditCard"},{$ref:"#/components/schemas/StoreCredit"},{$ref:"#/components/schemas/PaymentSource"}],nullable:!0},payment_method:{$ref:"#/components/schemas/PaymentMethod"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},avs_response:{type:"string",nullable:!0},cvv_response_code:{type:"string",nullable:!0},cvv_response_message:{type:"string",nullable:!0},gateway_dashboard_payment_url:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},avs_risky:{type:"boolean",description:"Whether the card issuer reported that the billing address did not match."},cvv_risky:{type:"boolean",description:"Whether the card issuer reported that the security code did not match."},captured_amount:{type:"string"},order_id:{type:"string",nullable:!0},capture_events:{type:"array",items:{$ref:"#/components/schemas/PaymentCaptureEvent"}},order:{$ref:"#/components/schemas/Order"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}},payment_splits:{type:"array",items:{$ref:"#/components/schemas/PaymentSplit"}}},required:["id","payment_method_id","response_code","number","status","amount","source_type","source_id","source","metadata","avs_response","cvv_response_code","cvv_response_message","gateway_dashboard_payment_url","created_at","updated_at","avs_risky","cvv_risky","captured_amount","order_id"],"x-typelizer":!0},PaymentSource:{type:"object",properties:{id:{type:"string"},gateway_payment_profile_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","gateway_payment_profile_id","metadata","created_at","updated_at"],"x-typelizer":!0},PaymentSplit:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},authorized_amount:{type:"string"},captured_amount:{type:"string"},refunded_amount:{type:"string"},claimed_amount:{type:"string"},net_captured_amount:{type:"string"},refundable_amount:{type:"string"},payment_id:{type:"string"},payment_number:{type:"string",nullable:!0},order_id:{type:"string"},order_number:{type:"string",nullable:!0}},required:["id","currency","created_at","updated_at","authorized_amount","captured_amount","refunded_amount","claimed_amount","net_captured_amount","refundable_amount","payment_id","payment_number","order_id","order_number"],"x-typelizer":!0},Permission:{type:"object",properties:{key:{type:"string"},resource:{type:"string"},kind:{type:"string",enum:["read","write"]},group:{type:"string"},group_label:{type:"string"},label:{type:"string"},description:{type:"string"}},required:["key","resource","kind","group","group_label","label","description"],"x-typelizer":!0},Policy:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0},body_html:{type:"string",nullable:!0},updated_at:{type:"string"},created_at:{type:"string"}},required:["id","name","slug","body","body_html","updated_at","created_at"],"x-typelizer":!0},PriceAdjustmentTier:{type:"object",properties:{id:{type:"string"},min_quantity:{type:"number"},percentage:{type:"string"}},required:["id","min_quantity","percentage"],"x-typelizer":!0},PriceHistory:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string",nullable:!0},recorded_at:{type:"string"},variant_id:{type:"string"},price_id:{type:"string"},compare_at_amount:{type:"string",nullable:!0},created_at:{type:"string"}},required:["id","currency","amount","recorded_at","variant_id","price_id","compare_at_amount","created_at"],"x-typelizer":!0},PriceListProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0},price_list_variants:{type:"array",items:{$ref:"#/components/schemas/CatalogPrice"}}},required:["id","name","thumbnail_url"],"x-typelizer":!0},PriceList:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},status:{anyOf:[{type:"string",enum:["draft","active","inactive","scheduled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},position:{type:"number"},match_policy:{type:"string",enum:["all","any"]},adjust_compare_at:{type:"boolean"},starts_at:{type:"string",nullable:!0},ends_at:{type:"string",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},price_adjustment_percentage:{type:"string",nullable:!0},automatic_pricing:{type:"boolean"},currently_active:{type:"boolean"},products_count:{type:"number"},prices_count:{type:"number"},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTier"}},price_rules:{type:"array",items:{$ref:"#/components/schemas/PriceRule"}}},required:["id","name","description","status","position","match_policy","adjust_compare_at","starts_at","ends_at","deleted_at","created_at","updated_at","price_adjustment_percentage","automatic_pricing","currently_active","products_count","prices_count","price_adjustment_tiers"],"x-typelizer":!0},PriceRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: channel_rule, customer_group_rule, market_rule, user_rule, volume_rule, zone_rule. Extensions may register more."},price_list_id:{type:"string"},preferences:{$ref:"#/components/schemas/PriceRulePreferences"},markets:{type:"array",items:{$ref:"#/components/schemas/Market"}},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}}},required:["id","created_at","updated_at","type","price_list_id","preferences"],"x-typelizer":!0},Price:{type:"object",properties:{id:{type:"string"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string",nullable:!0},compare_at_amount:{type:"string",nullable:!0},price_list_id:{type:"string",nullable:!0},min_quantity:{type:"number"},variant_id:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},variant:{$ref:"#/components/schemas/Variant"}},required:["id","currency","amount","compare_at_amount","price_list_id","min_quantity","variant_id","created_at","updated_at"],"x-typelizer":!0},ProductPublication:{type:"object",properties:{id:{type:"string"},published_at:{type:"string",nullable:!0},unpublished_at:{type:"string",nullable:!0},product_id:{type:"string"},channel_id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","published_at","unpublished_at","product_id","channel_id","created_at","updated_at"],"x-typelizer":!0},Product:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},variant_count:{type:"number"},available_on:{type:"string",nullable:!0},preorder_ships_at:{type:"string",nullable:!0},purchasable:{type:"boolean"},preorder:{type:"boolean"},in_stock:{type:"boolean"},backorderable:{type:"boolean"},available:{type:"boolean"},description:{type:"string",nullable:!0},description_html:{type:"string",nullable:!0},default_variant_id:{type:"string"},buy_box_variant_id:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},tags:{type:"array",items:{type:"string"}},price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},original_price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},primary_media:{$ref:"#/components/schemas/Media"},media:{type:"array",items:{$ref:"#/components/schemas/Media"}},variants:{type:"array",items:{$ref:"#/components/schemas/Variant"}},default_variant:{$ref:"#/components/schemas/Variant"},option_types:{type:"array",items:{$ref:"#/components/schemas/OptionType"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},prior_price:{allOf:[{$ref:"#/components/schemas/PriceHistory"}],nullable:!0},external_references:{type:"object"},translations:{type:"object"},status:{anyOf:[{type:"string",enum:["draft","active","archived","proposed","rejected"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},metadata:{type:"object"},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},submission:{allOf:[{$ref:"#/components/schemas/ProductSubmission"}],nullable:!0},seller_name:{type:"string",nullable:!0},product_type_id:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},digital_assets:{type:"array",items:{$ref:"#/components/schemas/DigitalAsset"}},collections:{type:"array",items:{$ref:"#/components/schemas/Collection"}},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublication"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},product_type:{$ref:"#/components/schemas/ProductType"}},required:["id","name","slug","meta_title","meta_description","meta_keywords","variant_count","available_on","preorder_ships_at","purchasable","preorder","in_stock","backorderable","available","description","description_html","default_variant_id","buy_box_variant_id","thumbnail_url","tags","price","original_price","seller_id","external_references","status","metadata","deleted_at","created_at","updated_at","delivery_profile_id","seller_name","product_type_id","tax_category_id"],"x-typelizer":!0},ProductSubmission:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","approved","rejected","withdrawn"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},review_note:{type:"string",nullable:!0},reviewed_at:{type:"string",nullable:!0},created_at:{type:"string"},product_id:{type:"string"},metadata:{type:"object",nullable:!0},updated_at:{type:"string"},submitted_by_id:{type:"string",nullable:!0},reviewed_by_id:{type:"string",nullable:!0},reviewed_by_name:{type:"string",nullable:!0},auto_approved:{type:"boolean"}},required:["id","status","review_note","reviewed_at","created_at","product_id","metadata","updated_at","submitted_by_id","reviewed_by_id","reviewed_by_name","auto_approved"],"x-typelizer":!0},ProductTypeCustomFieldDefinition:{type:"object",properties:{id:{type:"string"},key:{type:"string"},namespace:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},required:{type:"boolean"},sort_order:{type:"number"}},required:["id","key","namespace","label","field_type","required","sort_order"],"x-typelizer":!0},ProductType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},translations:{type:"object"},products_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},option_type_ids:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinition"}}},required:["id","name","products_count","created_at","updated_at","delivery_profile_id","option_type_ids","category_ids","custom_field_definitions"],"x-typelizer":!0},PromotionAction:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Action type. Built-in: create_adjustment, create_item_adjustments, create_line_items, free_shipping. Extensions may register more."},promotion_id:{type:"string"},preferences:{type:"object"},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculator"}],nullable:!0},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItem"},nullable:!0}},required:["id","created_at","updated_at","type","promotion_id","preferences","calculator","line_items"],"x-typelizer":!0},PromotionRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: currency, country, channel, market, item_total, product, customer, customer_group, first_order, customer_logged_in, one_use_per_user, category, option_value. Extensions may register more."},promotion_id:{type:"string"},preferences:{$ref:"#/components/schemas/PromotionRulePreferences"},product_ids:{type:"array",items:{type:"string"},nullable:!0},category_ids:{type:"array",items:{type:"string"},nullable:!0},customer_ids:{type:"array",items:{type:"string"},nullable:!0},option_value_ids:{type:"array",items:{type:"string"},nullable:!0},products:{type:"array",items:{$ref:"#/components/schemas/Product"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},countries:{type:"array",items:{$ref:"#/components/schemas/Country"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},markets:{type:"array",items:{$ref:"#/components/schemas/Market"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}}},required:["id","created_at","updated_at","type","promotion_id","preferences","product_ids","category_ids","customer_ids","option_value_ids"],"x-typelizer":!0},Promotion:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",nullable:!0},starts_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},usage_limit:{type:"number",nullable:!0},match_policy:{type:"string",enum:["all","any"]},path:{type:"string",nullable:!0},kind:{type:"string",enum:["coupon_code","automatic"]},multi_codes:{type:"boolean"},number_of_codes:{type:"number",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},action_ids:{type:"array",items:{type:"string"}},rule_ids:{type:"array",items:{type:"string"}}},required:["id","name","description","code","starts_at","expires_at","usage_limit","match_policy","path","kind","multi_codes","number_of_codes","code_prefix","promotion_category_id","metadata","created_at","updated_at","action_ids","rule_ids"],"x-typelizer":!0},PurchaseOrderItem:{type:"object",properties:{id:{type:"string"},quantity_ordered:{type:"number"},quantity_received:{type:"number"},quantity_rejected:{type:"number"},quantity_over:{type:"number"},outstanding:{type:"number"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},unit_cost:{type:"string"},total_cost:{type:"string"},purchase_order_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_ordered","quantity_received","quantity_rejected","quantity_over","outstanding","currency","created_at","updated_at","unit_cost","total_cost","purchase_order_id","variant_id","product_id","variant_name","variant_sku","options_text","thumbnail_url"],"x-typelizer":!0},PurchaseOrder:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","ordered","partially_received","received","over_received","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},metadata:{type:"object"},close_reason:{type:"string",nullable:!0},items_count:{type:"number"},quantity_received_total:{type:"number"},quantity_rejected_total:{type:"number"},ordered_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},closed_short_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},expected_at:{type:"string",nullable:!0},cancel_by:{type:"string",nullable:!0},closed_short:{type:"boolean"},quantity_ordered_total:{type:"number"},editable:{type:"boolean"},subtotal:{type:"string"},supplier_id:{type:"string",nullable:!0},destination_location_id:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItem"}},stock_receipts:{type:"array",items:{$ref:"#/components/schemas/StockReceipt"}},supplier:{$ref:"#/components/schemas/Supplier"},destination_location:{$ref:"#/components/schemas/StockLocation"}},required:["id","number","status","currency","reference","notes","metadata","close_reason","items_count","quantity_received_total","quantity_rejected_total","ordered_at","received_at","closed_short_at","created_at","updated_at","expected_at","cancel_by","closed_short","quantity_ordered_total","editable","subtotal","supplier_id","destination_location_id"],"x-typelizer":!0},RefundReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Refund:{type:"object",properties:{id:{type:"string"},transaction_id:{type:"string",nullable:!0},amount:{type:"string",nullable:!0},payment_id:{type:"string",nullable:!0},refund_reason_id:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0},originator_type:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},tax_amount:{type:"string"},refunder_id:{type:"string",nullable:!0},refunder_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},refunder:{$ref:"#/components/schemas/Actor"},payment:{$ref:"#/components/schemas/Payment"}},required:["id","transaction_id","amount","payment_id","refund_reason_id","originator_id","originator_type","metadata","created_at","updated_at","tax_amount","refunder_id","refunder_type"],"x-typelizer":!0},ReturnLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},received_quantity:{type:"number"},resellable:{type:"boolean"},pre_tax_amount:{type:"string"},included_tax_total:{type:"string"},additional_tax_total:{type:"string"},tax_total:{type:"string"},refund_amount:{type:"string"},variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_item_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"},line_item:{$ref:"#/components/schemas/LineItem"},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}}},required:["id","quantity","received_quantity","resellable","pre_tax_amount","included_tax_total","additional_tax_total","tax_total","refund_amount","variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":!0},ReturnReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Return:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["requested","approved","received","refunded","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},refund_total:{type:"string"},refund_tax_total:{type:"string"},approved_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},refunded_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ReturnReason"},return_line_items:{type:"array",items:{$ref:"#/components/schemas/ReturnLineItem"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},stock_location_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},refunded_total:{type:"string"},refundable_total:{type:"string"},order:{$ref:"#/components/schemas/Order"},stock_location:{$ref:"#/components/schemas/StockLocation"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}},documents:{type:"array",items:{type:"object"}},labels:{type:"array",items:{$ref:"#/components/schemas/ShippingLabel"}},deliveries:{type:"array",items:{$ref:"#/components/schemas/Delivery"}}},required:["id","number","status","order_id","reason_id","refund_total","refund_tax_total","approved_at","received_at","refunded_at","canceled_at","external_references","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","created_by_type","refunded_total","refundable_total","documents","labels","deliveries"],"x-typelizer":!0},Role:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},permissions:{type:"array",items:{type:"string"}},mutable:{type:"boolean"},users_count:{type:"number"}},required:["id","name","description","created_at","updated_at","permissions","mutable","users_count"],"x-typelizer":!0},SavedReport:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object"},seeded:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},user_id:{type:"string",nullable:!0},author_name:{type:"string",nullable:!0}},required:["id","name","description","query","seeded","created_at","updated_at","user_id","author_name"],"x-typelizer":!0},SellerBalance:{type:"object",properties:{currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},settlement_currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},converted:{type:"boolean"},seller_id:{type:"string"},earned:{type:"string"},pending:{type:"string"},payable:{type:"string"},paid:{type:"string"},balance:{type:"string"}},required:["currency","settlement_currency","converted","seller_id","earned","pending","payable","paid","balance"],"x-typelizer":!0},SellerPayout:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed","unresolved"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},metadata:{type:"object"},period_start:{type:"string",nullable:!0},period_end:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"},seller_id:{type:"string"},seller_name:{type:"string",nullable:!0},transfers_count:{type:"number"},provider:{type:"string",description:"Payout provider. Built-in: system. Provider gems register more (e.g. stripe)."}},required:["id","status","currency","reference","metadata","period_start","period_end","created_at","updated_at","amount","seller_id","seller_name","transfers_count","provider"],"x-typelizer":!0},SellerRequirement:{type:"object",properties:{id:{type:"string"},position:{type:"number"},active:{type:"boolean"},required:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},kind:{type:"string",description:"Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more."},name:{type:"string"},description:{type:"string",nullable:!0},preferences:{$ref:"#/components/schemas/SellerRequirementPreferences"},custom_field_definition_ids:{type:"array",items:{type:"string"}},allow_multiple:{type:"boolean"},accepts_submissions:{type:"boolean"},reviewed_by_operator:{type:"boolean"}},required:["id","position","active","required","metadata","created_at","updated_at","kind","name","description","preferences","custom_field_definition_ids","allow_multiple","accepts_submissions","reviewed_by_operator"],"x-typelizer":!0},SellerRequirementStatus:{type:"object",properties:{id:{type:"string"},kind:{type:"string",description:"Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more."},name:{type:"string"},description:{type:"string",nullable:!0},required:{type:"boolean"},position:{type:"number"},status:{type:"string",enum:["complete","incomplete","pending","rejected"]},action_url:{type:"string",nullable:!0},blocker:{type:"object",nullable:!0},blocking:{type:"boolean"},required_policy_name:{type:"string",nullable:!0},submission:{$ref:"#/components/schemas/SellerRequirementSubmission"},published_policy:{$ref:"#/components/schemas/Policy"}},required:["id","kind","name","description","required","position","status","action_url","blocker","blocking","required_policy_name"],"x-typelizer":!0},SellerRequirementSubmission:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","accepted","rejected","waived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},note:{type:"string",nullable:!0},review_note:{type:"string",nullable:!0},reference:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},reviewed_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},seller_id:{type:"string"},requirement_id:{type:"string"},requirement_name:{type:"string"},file_url:{type:"string",nullable:!0},file_name:{type:"string",nullable:!0}},required:["id","status","note","review_note","reference","metadata","reviewed_at","created_at","updated_at","seller_id","requirement_id","requirement_name","file_url","file_name"],"x-typelizer":!0},Seller:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},about:{type:"string"},about_html:{type:"string"},logo_url:{type:"string",nullable:!0},square_logo_url:{type:"string",nullable:!0},cover_photo_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},status:{anyOf:[{type:"string",enum:["pending","invited","canceled","onboarding","ready_for_review","approved","rejected","suspended"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",nullable:!0,enum:["daily","weekly","biweekly","monthly","manual"]},metadata:{type:"object",nullable:!0},holiday_mode_until:{type:"string",nullable:!0},terms_accepted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},minimum_payout_amount:{type:"string",nullable:!0},on_holiday:{type:"boolean"},sellable:{type:"boolean"},products_count:{type:"number"},users_count:{type:"number"},onboarding_progress:{type:"object"},onboarding_complete:{type:"boolean"},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},billing_address:{$ref:"#/components/schemas/Address"},returns_address:{$ref:"#/components/schemas/Address"}},required:["id","name","slug","about","about_html","logo_url","square_logo_url","cover_photo_url","external_references","status","contact_email","billing_email","tax_remittance","payouts_schedule_interval","metadata","holiday_mode_until","terms_accepted_at","created_at","updated_at","deleted_at","minimum_payout_amount","on_holiday","sellable","products_count","users_count","onboarding_progress","onboarding_complete","legal_name","registration_number"],"x-typelizer":!0},SellerTeamMember:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},avatar_url:{type:"string",nullable:!0}},required:["id","email","first_name","last_name","full_name","created_at","updated_at","avatar_url"],"x-typelizer":!0},SellerTransfer:{type:"object",properties:{id:{type:"string"},kind:{type:"string",enum:["earning","refund_reversal"]},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed","unresolved"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"},settled_amount:{type:"string",nullable:!0},settled_currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},converted:{type:"boolean"},seller_id:{type:"string"},order_id:{type:"string",nullable:!0},payout_id:{type:"string",nullable:!0},reversed_from_id:{type:"string",nullable:!0},refund_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},order_number:{type:"string",nullable:!0},provider:{type:"string",description:"Payout provider. Built-in: system. Provider gems register more (e.g. stripe)."}},required:["id","kind","status","currency","reference","metadata","created_at","updated_at","amount","settled_amount","settled_currency","converted","seller_id","order_id","payout_id","reversed_from_id","refund_id","seller_name","order_number","provider"],"x-typelizer":!0},SetupTask:{type:"object",properties:{name:{type:"string"},done:{type:"boolean"}},required:["name","done"],"x-typelizer":!0},ShippingLabel:{type:"object",properties:{id:{type:"string"},source:{type:"string",enum:["purchased","uploaded"]},status:{anyOf:[{type:"string",enum:["purchased","refund_requested","refunded"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},carrier:{type:"string",nullable:!0},carrier_name:{type:"string",nullable:!0},service:{type:"string",nullable:!0},tracking_number:{type:"string",nullable:!0},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},format:{type:"string",nullable:!0,enum:["pdf","png","zpl"]},external_id:{type:"string",nullable:!0},metadata:{type:"object"},refunded_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},owner_id:{type:"string"},owner_type:{type:"string",enum:["fulfillment","return"]},cost:{type:"string"},integration_id:{type:"string",nullable:!0},file_pending:{type:"boolean"},download_url:{type:"string",nullable:!0}},required:["id","source","status","carrier","carrier_name","service","tracking_number","currency","format","external_id","metadata","refunded_at","created_at","updated_at","owner_id","owner_type","cost","integration_id","file_pending","download_url"],"x-typelizer":!0},State:{type:"object",properties:{abbr:{type:"string"},name:{type:"string"}},required:["abbr","name"],"x-typelizer":!0},StockLevel:{type:"object",properties:{id:{type:"string"},count_on_hand:{type:"number"},backorderable:{type:"boolean"},stock_location_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},external_references:{type:"object"},metadata:{type:"object"},reserved_count:{type:"number"},incoming_count:{type:"number"},purchasable_count:{type:"number"},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},stock_location_name:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},allocated_count:{type:"number"},available_count:{type:"number"},stock_location:{$ref:"#/components/schemas/StockLocation"},variant:{$ref:"#/components/schemas/Variant"}},required:["id","count_on_hand","backorderable","stock_location_id","variant_id","external_references","metadata","reserved_count","incoming_count","purchasable_count","variant_name","variant_sku","created_at","updated_at","stock_location_name","product_id","options_text","thumbnail_url","allocated_count","available_count"],"x-typelizer":!0},StockLocation:{type:"object",properties:{id:{type:"string"},name:{type:"string"},address1:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},country_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},state_text:{type:"string",nullable:!0},pickup_ready_in_minutes:{type:"number",nullable:!0},pickup_instructions:{type:"string",nullable:!0},external_references:{type:"object"},admin_name:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},active:{type:"boolean"},default:{type:"boolean"},backorderable_default:{type:"boolean"},propagate_all_variants:{type:"boolean"},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"]},returns_enabled:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"}},required:["id","name","address1","city","zipcode","country_code","country_name","state_code","state_text","pickup_ready_in_minutes","pickup_instructions","external_references","admin_name","address2","state_name","phone","company","active","default","backorderable_default","propagate_all_variants","kind","pickup_enabled","pickup_stock_policy","returns_enabled","created_at","updated_at","seller_id","seller_name"],"x-typelizer":!0},StockMovement:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},kind:{type:"string",nullable:!0,enum:["received","allocated","shipped","released","adjusted"]},reason:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},stock_level_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},stock_location_name:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},order_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},return_id:{type:"string",nullable:!0},exchange_id:{type:"string",nullable:!0},stock_transfer_id:{type:"string",nullable:!0},stock_receipt_id:{type:"string",nullable:!0},purchase_order_id:{type:"string",nullable:!0},order_number:{type:"string",nullable:!0},return_number:{type:"string",nullable:!0},exchange_number:{type:"string",nullable:!0},stock_transfer_number:{type:"string",nullable:!0},purchase_order_number:{type:"string",nullable:!0},unit_cost:{type:"string",nullable:!0}},required:["id","quantity","kind","reason","created_at","updated_at","stock_level_id","stock_location_id","stock_location_name","variant_id","variant_name","variant_sku","order_id","fulfillment_id","return_id","exchange_id","stock_transfer_id","stock_receipt_id","purchase_order_id","order_number","return_number","exchange_number","stock_transfer_number","purchase_order_number","unit_cost"],"x-typelizer":!0},StockReceiptItem:{type:"object",properties:{id:{type:"string"},quantity_accepted:{type:"number"},quantity_rejected:{type:"number"},rejection_reason:{type:"string",nullable:!0,enum:["damaged","wrong_item","expired","other"]},notes:{type:"string",nullable:!0},line_type:{type:"string",enum:["purchase_order_item","stock_transfer_item"]},line_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_accepted","quantity_rejected","rejection_reason","notes","line_type","line_id","variant_id","product_id","variant_name","variant_sku","thumbnail_url"],"x-typelizer":!0},StockReceipt:{type:"object",properties:{id:{type:"string"},number:{type:"string"},reference:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},metadata:{type:"object"},quantity_accepted_total:{type:"number"},quantity_rejected_total:{type:"number"},received_at:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},receivable_type:{type:"string",enum:["purchase_order","stock_transfer"]},receivable_id:{type:"string"},received_by_id:{type:"string",nullable:!0},received_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},received_by:{$ref:"#/components/schemas/Actor"},items_count:{type:"number"},items:{type:"array",items:{$ref:"#/components/schemas/StockReceiptItem"}}},required:["id","number","reference","notes","metadata","quantity_accepted_total","quantity_rejected_total","received_at","created_at","updated_at","receivable_type","receivable_id","received_by_id","received_by_type","items_count"],"x-typelizer":!0},StockReservation:{type:"object",properties:{id:{type:"string"},stock_level_id:{type:"string"},line_item_id:{type:"string"},order_id:{type:"string"},variant_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},quantity:{type:"number"},expires_at:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","stock_level_id","line_item_id","order_id","variant_id","stock_location_id","quantity","expires_at","active","created_at","updated_at"],"x-typelizer":!0},StockTransferItem:{type:"object",properties:{id:{type:"string"},quantity_shipped:{type:"number"},quantity_received:{type:"number"},quantity_rejected:{type:"number"},quantity_over:{type:"number"},outstanding:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},stock_transfer_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_shipped","quantity_received","quantity_rejected","quantity_over","outstanding","created_at","updated_at","stock_transfer_id","variant_id","product_id","variant_name","variant_sku","options_text","thumbnail_url"],"x-typelizer":!0},StockTransfer:{type:"object",properties:{id:{type:"string"},number:{type:"string"},reference:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},source_location_id:{type:"string"},destination_location_id:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","ready_to_ship","in_transit","partially_received","received","over_received","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},notes:{type:"string",nullable:!0},metadata:{type:"object"},close_reason:{type:"string",nullable:!0},items_count:{type:"number"},quantity_received_total:{type:"number"},quantity_rejected_total:{type:"number"},shipped_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},closed_short_at:{type:"string",nullable:!0},deleted_at:{type:"string",nullable:!0},closed_short:{type:"boolean"},quantity_shipped_total:{type:"number"},editable:{type:"boolean"},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItem"}},stock_receipts:{type:"array",items:{$ref:"#/components/schemas/StockReceipt"}},source_location:{$ref:"#/components/schemas/StockLocation"},destination_location:{$ref:"#/components/schemas/StockLocation"}},required:["id","number","reference","created_at","updated_at","source_location_id","destination_location_id","status","notes","metadata","close_reason","items_count","quantity_received_total","quantity_rejected_total","shipped_at","received_at","closed_short_at","deleted_at","closed_short","quantity_shipped_total","editable"],"x-typelizer":!0},StoreCreditEvent:{type:"object",properties:{id:{type:"string"},action:{type:"string"},authorization_code:{type:"string",nullable:!0},display_action:{type:"string",nullable:!0},amount:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},store_credit_id:{type:"string"},originator_type:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0}},required:["id","action","authorization_code","display_action","amount","created_at","updated_at","store_credit_id","originator_type","originator_id"],"x-typelizer":!0},StoreCredit:{type:"object",properties:{id:{type:"string"},amount:{type:"string"},amount_used:{type:"string"},amount_remaining:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},amount_authorized:{type:"string"},outstanding:{type:"boolean"},customer_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},originator_type:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"}},required:["id","amount","amount_used","amount_remaining","currency","memo","metadata","created_at","updated_at","amount_authorized","outstanding","customer_id","created_by_id","created_by_type","originator_type","originator_id"],"x-typelizer":!0},Store:{type:"object",properties:{id:{type:"string"},name:{type:"string"},seo_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},metadata:{type:"object"},code:{type:"string"},default_currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},default_locale:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},default_country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},mail_from_address:{type:"string",nullable:!0},customer_support_email:{type:"string",nullable:!0},new_order_notifications_email:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},order_routing_strategy:{type:"string",description:"Order routing strategy. Built-in: rules. Extensions may register more."},payout_provider:{type:"string",nullable:!0,description:"Payout provider; null uses the installation default. Built-in: system. Provider gems register more (e.g. stripe)."},admin_locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},timezone:{anyOf:[{type:"string",enum:["Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Asuncion","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Nuuk","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Canberra","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Etc/GMT+12","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu","UTC"]},{type:"string"}],description:"Common IANA time zones; any other IANA time zone identifier is accepted too."},storefront_url:{type:"string",nullable:!0},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},unit_system:{type:"string",enum:["metric","imperial"]},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"]},guest_checkout:{type:"boolean"},always_include_confirm_step:{type:"boolean"},company_field_enabled:{type:"boolean"},address_requires_company:{type:"boolean"},address_requires_phone:{type:"boolean"},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"]},track_inventory_levels:{type:"boolean"},stock_reservations_enabled:{type:"boolean"},low_stock_threshold:{type:"number"},tax_using_ship_address:{type:"boolean"},track_price_history:{type:"boolean"},show_products_without_price:{type:"boolean"},disable_sku_validation:{type:"boolean"},pricing_provider:{type:"string"},inventory_provider:{type:"string"},pricing_provider_failure_policy:{type:"string",enum:["fallback","strict"]},inventory_provider_failure_policy:{type:"string",enum:["fallback","strict"]},default_payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"]},auto_approve_sellers:{type:"boolean"},auto_approve_seller_products:{type:"boolean"},seller_digital_assets_enabled:{type:"boolean"},seller_digital_asset_content_types:{type:"array",items:{type:"string"}},review_seller_digital_asset_changes:{type:"boolean"},send_seller_transactional_emails:{type:"boolean"},document_number_format:{type:"string",enum:["sequential","random"]},order_number_prefix:{type:"string"},order_number_suffix:{type:"string"},order_number_sequence_start:{type:"number"},limit_digital_download_count:{type:"boolean"},digital_asset_authorized_clicks:{type:"number"},limit_digital_download_days:{type:"boolean"},digital_asset_authorized_days:{type:"number"},send_consumer_transactional_emails:{type:"boolean"},email_accent_color:{type:"string",nullable:!0},email_background_color:{type:"string",nullable:!0},email_card_color:{type:"string",nullable:!0},email_text_color:{type:"string",nullable:!0},email_heading_color:{type:"string",nullable:!0},email_font:{type:"string",nullable:!0,enum:["inter","system","helvetica","georgia","roboto","lato","merriweather"]},order_number_sequence_started:{type:"boolean"},default_minimum_payout_amount:{type:"string",nullable:!0},default_commission_tax_rate:{type:"string",nullable:!0},url:{type:"string"},api_url:{type:"string"},setup_tasks:{type:"array",items:{$ref:"#/components/schemas/SetupTask"}},supported_currencies:{type:"array",items:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]}},supported_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},available_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},logo_url:{type:"string",nullable:!0},mailer_logo_url:{type:"string",nullable:!0}},required:["id","name","seo_title","meta_description","metadata","code","default_currency","default_locale","default_country_code","mail_from_address","customer_support_email","new_order_notifications_email","created_at","updated_at","order_routing_strategy","payout_provider","admin_locale","timezone","storefront_url","weight_unit","unit_system","storefront_access","guest_checkout","always_include_confirm_step","company_field_enabled","address_requires_company","address_requires_phone","capture_method","track_inventory_levels","stock_reservations_enabled","low_stock_threshold","tax_using_ship_address","track_price_history","show_products_without_price","disable_sku_validation","pricing_provider","inventory_provider","pricing_provider_failure_policy","inventory_provider_failure_policy","default_payouts_schedule_interval","auto_approve_sellers","auto_approve_seller_products","seller_digital_assets_enabled","seller_digital_asset_content_types","review_seller_digital_asset_changes","send_seller_transactional_emails","document_number_format","order_number_prefix","order_number_suffix","order_number_sequence_start","limit_digital_download_count","digital_asset_authorized_clicks","limit_digital_download_days","digital_asset_authorized_days","send_consumer_transactional_emails","email_accent_color","email_background_color","email_card_color","email_text_color","email_heading_color","email_font","order_number_sequence_started","default_minimum_payout_amount","default_commission_tax_rate","url","api_url","setup_tasks","supported_currencies","supported_locales","available_locales","logo_url","mailer_logo_url"],"x-typelizer":!0},Supplier:{type:"object",properties:{id:{type:"string"},name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},postal_code:{type:"string",nullable:!0},purchase_orders_count:{type:"number"},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},can_be_deleted:{type:"boolean"}},required:["id","name","contact_name","email","phone","notes","address1","address2","city","state_name","state_code","country_code","postal_code","purchase_orders_count","metadata","created_at","updated_at","deleted_at","can_be_deleted"],"x-typelizer":!0},TaxCategory:{type:"object",properties:{id:{type:"string"},name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","name","tax_code","description","is_default","created_at","updated_at"],"x-typelizer":!0},TaxExemptionCertificate:{type:"object",properties:{id:{type:"string"},certificate_number:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","verified","expired","revoked"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},issuing_authority:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},issued_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},verified_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},company_id:{type:"string"},tax_exemption_reason_id:{type:"string"},tax_exemption_reason:{$ref:"#/components/schemas/TaxExemptionReason"},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},active:{type:"boolean"},lapsed:{type:"boolean"},can_be_deleted:{type:"boolean"},document_filename:{type:"string",nullable:!0},document_byte_size:{type:"number",nullable:!0},document_url:{type:"string",nullable:!0}},required:["id","certificate_number","status","issuing_authority","metadata","issued_at","expires_at","verified_at","created_at","updated_at","company_id","tax_exemption_reason_id","country_code","state_code","active","lapsed","can_be_deleted","document_filename","document_byte_size","document_url"],"x-typelizer":!0},TaxExemptionReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string"},active:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","code","active","metadata","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},TaxIdentifier:{type:"object",properties:{id:{type:"string"},kind:{type:"string",description:"Tax identifier kind, keyed to a registered validator. Built-in: eu_vat. Extensions may register more."},value:{type:"string"},validation_status:{type:"string",nullable:!0,enum:["pending","verified","unverified","unavailable","unsupported"]},validation_evidence:{type:"object",nullable:!0},source:{type:"string",nullable:!0,enum:["override","company","customer"]},validated_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},validatable:{type:"boolean"},customer_id:{type:"string",nullable:!0},cart_id:{type:"string",nullable:!0},order_id:{type:"string",nullable:!0}},required:["id","kind","value","validation_status","validation_evidence","source","validated_at","created_at","updated_at","validatable","customer_id","cart_id","order_id"],"x-typelizer":!0},TaxLine:{type:"object",properties:{id:{type:"string"},label:{type:"string"},included:{type:"boolean"},credit:{type:"boolean"},rate:{type:"string",nullable:!0},tax_rate_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},fee_id:{type:"string",nullable:!0},return_line_item_id:{type:"string",nullable:!0},claim_line_item_id:{type:"string",nullable:!0},exchange_line_item_id:{type:"string",nullable:!0},amount:{type:"string"},provider_id:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},taxability_reason:{anyOf:[{type:"string",enum:["standard_rated","reduced_rated","zero_rated","reverse_charge","intra_community_supply","export","customer_exempt","product_exempt","not_collecting","not_subject_to_tax"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},data:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},original_tax_line_id:{type:"string",nullable:!0}},required:["id","label","included","credit","rate","tax_rate_id","line_item_id","fulfillment_id","fee_id","return_line_item_id","claim_line_item_id","exchange_line_item_id","amount","provider_id","metadata","taxability_reason","country_code","state_code","data","created_at","updated_at","original_tax_line_id"],"x-typelizer":!0},TaxRate:{type:"object",properties:{id:{type:"string"},name:{type:"string"},show_rate_in_label:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},rate:{type:"string",nullable:!0},rate_percent:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},store_id:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0}},required:["id","name","show_rate_in_label","metadata","created_at","updated_at","deleted_at","rate","rate_percent","tax_category_id","store_id","country_code","state_code"],"x-typelizer":!0},UpdateStatus:{type:"object",properties:{current_version:{type:"string"},enabled:{type:"boolean"},checked_at:{type:"string",nullable:!0},update_available:{type:"boolean"},latest_version:{type:"string",nullable:!0},latest_release_url:{type:"string",nullable:!0},latest_release_published_at:{type:"string",nullable:!0}},required:["current_version","enabled","checked_at","update_available","latest_version","latest_release_url","latest_release_published_at"],"x-typelizer":!0},Variant:{type:"object",properties:{id:{type:"string"},product_id:{type:"string"},sku:{type:"string",nullable:!0},options_text:{type:"string"},track_inventory:{type:"boolean"},media_count:{type:"number"},preorder_ships_at:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},purchasable:{type:"boolean"},in_stock:{type:"boolean"},backorderable:{type:"boolean"},preorder:{type:"boolean"},weight:{type:"number",nullable:!0},height:{type:"number",nullable:!0},width:{type:"number",nullable:!0},depth:{type:"number",nullable:!0},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},dimensions_unit:{type:"string",enum:["mm","cm","in","ft"]},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},purchase_unit:{type:"string",nullable:!0,enum:["unit","carton"]},units_per_carton:{type:"number",nullable:!0},price:{$ref:"#/components/schemas/Price"},original_price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},primary_media:{$ref:"#/components/schemas/Media"},media:{type:"array",items:{$ref:"#/components/schemas/Media"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},prior_price:{allOf:[{$ref:"#/components/schemas/PriceHistory"}],nullable:!0},external_references:{type:"object"},metadata:{type:"object"},position:{type:"number"},cost_currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},barcode:{type:"string",nullable:!0},backorder_limit:{type:"number",nullable:!0},hs_code:{type:"string",nullable:!0},country_of_origin:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},customs_description:{type:"string",nullable:!0},carton_weight:{type:"string",nullable:!0},cartons_per_pallet:{type:"number",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},cost_price:{type:"string",nullable:!0},preorderable:{type:"boolean"},tax_category_id:{type:"string",nullable:!0},carton_package_type_id:{type:"string",nullable:!0},units_per_pallet:{type:"number",nullable:!0},available_stock:{type:"number",nullable:!0},reserved_quantity:{type:"number"},total_on_hand:{type:"number",nullable:!0},product_name:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},prices:{type:"array",items:{$ref:"#/components/schemas/Price"}},stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevel"}}},required:["id","product_id","sku","options_text","track_inventory","media_count","preorder_ships_at","thumbnail_url","purchasable","in_stock","backorderable","preorder","weight","height","width","depth","weight_unit","dimensions_unit","minimum_order_quantity","order_multiple","purchase_unit","units_per_carton","price","original_price","seller_id","option_values","external_references","metadata","position","cost_currency","barcode","backorder_limit","hs_code","country_of_origin","customs_description","carton_weight","cartons_per_pallet","deleted_at","created_at","updated_at","cost_price","preorderable","tax_category_id","carton_package_type_id","units_per_pallet","available_stock","reserved_quantity","total_on_hand","product_name","delivery_profile_id"],"x-typelizer":!0},WebhookDelivery:{type:"object",properties:{id:{type:"string"},event_name:{type:"string"},event_id:{type:"string",nullable:!0},response_code:{type:"number",nullable:!0},execution_time:{type:"number",nullable:!0},error_type:{type:"string",nullable:!0},request_errors:{type:"string",nullable:!0},response_body:{type:"string",nullable:!0},success:{type:"boolean",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivered_at:{type:"string",nullable:!0},payload:{type:"object",nullable:!0},webhook_endpoint_id:{type:"string"},webhook_endpoint_url:{type:"string"}},required:["id","event_name","event_id","response_code","execution_time","error_type","request_errors","response_body","success","created_at","updated_at","delivered_at","payload","webhook_endpoint_id","webhook_endpoint_url"],"x-typelizer":!0},WebhookEndpoint:{type:"object",properties:{id:{type:"string"},name:{type:"string",nullable:!0},url:{type:"string"},active:{type:"boolean"},subscriptions:{type:"array",items:{type:"string"}},disabled_reason:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},disabled_at:{type:"string",nullable:!0},secret_key:{type:"string",nullable:!0},last_delivery_at:{type:"string",nullable:!0},recent_delivery_count:{type:"number"},recent_failure_count:{type:"number"},total_delivery_count:{type:"number"},successful_delivery_count:{type:"number"},failed_delivery_count:{type:"number"}},required:["id","name","url","active","subscriptions","disabled_reason","created_at","updated_at","disabled_at","secret_key","last_delivery_at","recent_delivery_count","recent_failure_count","total_delivery_count","successful_delivery_count","failed_delivery_count"],"x-typelizer":!0},WebhookEvent:{type:"object",properties:{name:{type:"string"},group:{type:"string"},credential_permission:{type:"string",nullable:!0},credential:{type:"boolean"},deprecated:{type:"boolean"},replaced_by:{type:"string",nullable:!0}},required:["name","group","credential_permission","credential","deprecated","replaced_by"],"x-typelizer":!0},CommissionRuleCategoryRulePreferences:{type:"object",properties:{category_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ctg_[A-Za-z0-9]+$","x-spree-prefix":"ctg"},default:[]}},additionalProperties:!1},CommissionRuleItemTotalRulePreferences:{type:"object",properties:{min_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},max_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},CommissionRuleProductRulePreferences:{type:"object",properties:{},additionalProperties:!1},CommissionRuleSellerRulePreferences:{type:"object",properties:{seller_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^sel_[A-Za-z0-9]+$","x-spree-prefix":"sel"},default:[]}},additionalProperties:!1},CommissionRulePreferences:{description:"Settings of a commission rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/CommissionRuleCategoryRulePreferences"},{$ref:"#/components/schemas/CommissionRuleItemTotalRulePreferences"},{$ref:"#/components/schemas/CommissionRuleProductRulePreferences"},{$ref:"#/components/schemas/CommissionRuleSellerRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{category_rule:"#/components/schemas/CommissionRuleCategoryRulePreferences",item_total_rule:"#/components/schemas/CommissionRuleItemTotalRulePreferences",product_rule:"#/components/schemas/CommissionRuleProductRulePreferences",seller_rule:"#/components/schemas/CommissionRuleSellerRulePreferences"}},DeliveryCalculatorDigitalDeliveryPreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorFlatPercentItemTotalPreferences:{type:"object",properties:{flat_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},DeliveryCalculatorFlatRatePreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorFlexiRatePreferences:{type:"object",properties:{first_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},additional_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},max_items:{type:"integer",default:0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPerItemPreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPriceSackPreferences:{type:"object",properties:{minimal_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},normal_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},discount_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPreferences:{description:"Settings of a delivery calculator, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlatRatePreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlexiRatePreferences"},{$ref:"#/components/schemas/DeliveryCalculatorPerItemPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorPriceSackPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{digital_delivery:"#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences",flat_percent_item_total:"#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences",flat_rate:"#/components/schemas/DeliveryCalculatorFlatRatePreferences",flexi_rate:"#/components/schemas/DeliveryCalculatorFlexiRatePreferences",per_item:"#/components/schemas/DeliveryCalculatorPerItemPreferences",price_sack:"#/components/schemas/DeliveryCalculatorPriceSackPreferences"}},DeliveryMethodRuleChannelRulePreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},DeliveryMethodRuleCompanyRulePreferences:{type:"object",properties:{company_orders_only:{type:"boolean",default:!0}},additionalProperties:!1},DeliveryMethodRuleExcludedProductsRulePreferences:{type:"object",properties:{},additionalProperties:!1},DeliveryMethodRuleItemTotalRulePreferences:{type:"object",properties:{minimum_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRuleVolumeRulePreferences:{type:"object",properties:{minimum_volume:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_volume:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRuleWeightRulePreferences:{type:"object",properties:{minimum_weight:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_weight:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRulePreferences:{description:"Settings of a delivery method rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/DeliveryMethodRuleChannelRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleCompanyRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleVolumeRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleWeightRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{channel_rule:"#/components/schemas/DeliveryMethodRuleChannelRulePreferences",company_rule:"#/components/schemas/DeliveryMethodRuleCompanyRulePreferences",excluded_products_rule:"#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences",item_total_rule:"#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences",volume_rule:"#/components/schemas/DeliveryMethodRuleVolumeRulePreferences",weight_rule:"#/components/schemas/DeliveryMethodRuleWeightRulePreferences"}},IntegrationPreferences:{description:"Settings of a integration, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{}},OrderRoutingRuleDefaultLocationPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRuleMinimizeSplitsPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRulePreferredLocationPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRulePreferences:{description:"Settings of a order routing rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/OrderRoutingRuleDefaultLocationPreferences"},{$ref:"#/components/schemas/OrderRoutingRuleMinimizeSplitsPreferences"},{$ref:"#/components/schemas/OrderRoutingRulePreferredLocationPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{default_location:"#/components/schemas/OrderRoutingRuleDefaultLocationPreferences",minimize_splits:"#/components/schemas/OrderRoutingRuleMinimizeSplitsPreferences",preferred_location:"#/components/schemas/OrderRoutingRulePreferredLocationPreferences"}},PaymentMethodBogusPreferences:{type:"object",properties:{dummy_key:{type:"string",default:"PUBLICKEY123"},dummy_secret_key:{type:"string","x-spree-secret":!0,nullable:!0}},additionalProperties:!1},PaymentMethodCheckPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodCustomPaymentSourceMethodPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodStoreCreditPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodPreferences:{description:"Settings of a payment method, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PaymentMethodBogusPreferences"},{$ref:"#/components/schemas/PaymentMethodCheckPreferences"},{$ref:"#/components/schemas/PaymentMethodCustomPaymentSourceMethodPreferences"},{$ref:"#/components/schemas/PaymentMethodStoreCreditPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{bogus:"#/components/schemas/PaymentMethodBogusPreferences",check:"#/components/schemas/PaymentMethodCheckPreferences",custom_payment_source_method:"#/components/schemas/PaymentMethodCustomPaymentSourceMethodPreferences",store_credit:"#/components/schemas/PaymentMethodStoreCreditPreferences"}},PriceRuleChannelRulePreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},PriceRuleCustomerGroupRulePreferences:{type:"object",properties:{customer_group_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cg_[A-Za-z0-9]+$","x-spree-prefix":"cg"},default:[]}},additionalProperties:!1},PriceRuleMarketRulePreferences:{type:"object",properties:{market_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^mkt_[A-Za-z0-9]+$","x-spree-prefix":"mkt"},default:[]}},additionalProperties:!1},PriceRuleUserRulePreferences:{type:"object",properties:{user_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cust_[A-Za-z0-9]+$","x-spree-prefix":"cust"},default:[]}},additionalProperties:!1},PriceRuleVolumeRulePreferences:{type:"object",properties:{min_quantity:{type:"integer",default:1},max_quantity:{type:"integer",nullable:!0}},additionalProperties:!1},PriceRulePreferences:{description:"Settings of a price rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PriceRuleChannelRulePreferences"},{$ref:"#/components/schemas/PriceRuleCustomerGroupRulePreferences"},{$ref:"#/components/schemas/PriceRuleMarketRulePreferences"},{$ref:"#/components/schemas/PriceRuleUserRulePreferences"},{$ref:"#/components/schemas/PriceRuleVolumeRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{channel_rule:"#/components/schemas/PriceRuleChannelRulePreferences",customer_group_rule:"#/components/schemas/PriceRuleCustomerGroupRulePreferences",market_rule:"#/components/schemas/PriceRuleMarketRulePreferences",user_rule:"#/components/schemas/PriceRuleUserRulePreferences",volume_rule:"#/components/schemas/PriceRuleVolumeRulePreferences"}},PromotionCalculatorFlatPercentItemTotalPreferences:{type:"object",properties:{flat_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},PromotionCalculatorFlatRatePreferences:{type:"object",properties:{amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorFlexiRatePreferences:{type:"object",properties:{first_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},additional_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},max_items:{type:"integer",default:0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorPercentOnLineItemPreferences:{type:"object",properties:{percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorTieredFlatRatePreferences:{type:"object",properties:{tiers:{type:"array",items:{type:"object",properties:{threshold:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},value:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["threshold","value"],additionalProperties:!1},default:[]},base_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},PromotionCalculatorTieredPercentPreferences:{type:"object",properties:{tiers:{type:"array",items:{type:"object",properties:{threshold:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},value:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["threshold","value"],additionalProperties:!1},default:[]},base_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},PromotionCalculatorPreferences:{description:"Settings of a promotion calculator, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PromotionCalculatorFlatPercentItemTotalPreferences"},{$ref:"#/components/schemas/PromotionCalculatorFlatRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorFlexiRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorPercentOnLineItemPreferences"},{$ref:"#/components/schemas/PromotionCalculatorTieredFlatRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorTieredPercentPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{flat_percent_item_total:"#/components/schemas/PromotionCalculatorFlatPercentItemTotalPreferences",flat_rate:"#/components/schemas/PromotionCalculatorFlatRatePreferences",flexi_rate:"#/components/schemas/PromotionCalculatorFlexiRatePreferences",percent_on_line_item:"#/components/schemas/PromotionCalculatorPercentOnLineItemPreferences",tiered_flat_rate:"#/components/schemas/PromotionCalculatorTieredFlatRatePreferences",tiered_percent:"#/components/schemas/PromotionCalculatorTieredPercentPreferences"}},PromotionRuleCategoryPreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any","all"],default:"any"}},additionalProperties:!1},PromotionRuleChannelPreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},PromotionRuleCountryPreferences:{type:"object",properties:{country_codes:{type:"array",items:{type:"string",format:"iso-country",pattern:"^[A-Z]{2}$"},default:[]},country_id:{type:"integer",nullable:!0},country_code:{type:"string",format:"iso-country",pattern:"^[A-Z]{2}$",nullable:!0}},additionalProperties:!1},PromotionRuleCurrencyPreferences:{type:"object",properties:{currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$",nullable:!0}},additionalProperties:!1},PromotionRuleCustomerPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleCustomerGroupPreferences:{type:"object",properties:{customer_group_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cg_[A-Za-z0-9]+$","x-spree-prefix":"cg"},default:[]}},additionalProperties:!1},PromotionRuleCustomerLoggedInPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleFirstOrderPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleItemTotalPreferences:{type:"object",properties:{amount_min:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"100"},operator_min:{type:"string",default:">"},amount_max:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},operator_max:{type:"string",default:"<"}},additionalProperties:!1},PromotionRuleMarketPreferences:{type:"object",properties:{market_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^mkt_[A-Za-z0-9]+$","x-spree-prefix":"mkt"},default:[]}},additionalProperties:!1},PromotionRuleOneUsePerUserPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleOptionValuePreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any"],default:"any"},eligible_values:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^optval_[A-Za-z0-9]+$","x-spree-prefix":"optval"},default:[]}},additionalProperties:!1},PromotionRuleProductPreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any","all","none"],default:"any"}},additionalProperties:!1},PromotionRulePreferences:{description:"Settings of a promotion rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PromotionRuleCategoryPreferences"},{$ref:"#/components/schemas/PromotionRuleChannelPreferences"},{$ref:"#/components/schemas/PromotionRuleCountryPreferences"},{$ref:"#/components/schemas/PromotionRuleCurrencyPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerGroupPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerLoggedInPreferences"},{$ref:"#/components/schemas/PromotionRuleFirstOrderPreferences"},{$ref:"#/components/schemas/PromotionRuleItemTotalPreferences"},{$ref:"#/components/schemas/PromotionRuleMarketPreferences"},{$ref:"#/components/schemas/PromotionRuleOneUsePerUserPreferences"},{$ref:"#/components/schemas/PromotionRuleOptionValuePreferences"},{$ref:"#/components/schemas/PromotionRuleProductPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{category:"#/components/schemas/PromotionRuleCategoryPreferences",channel:"#/components/schemas/PromotionRuleChannelPreferences",country:"#/components/schemas/PromotionRuleCountryPreferences",currency:"#/components/schemas/PromotionRuleCurrencyPreferences",customer:"#/components/schemas/PromotionRuleCustomerPreferences",customer_group:"#/components/schemas/PromotionRuleCustomerGroupPreferences",customer_logged_in:"#/components/schemas/PromotionRuleCustomerLoggedInPreferences",first_order:"#/components/schemas/PromotionRuleFirstOrderPreferences",item_total:"#/components/schemas/PromotionRuleItemTotalPreferences",market:"#/components/schemas/PromotionRuleMarketPreferences",one_use_per_user:"#/components/schemas/PromotionRuleOneUsePerUserPreferences",option_value:"#/components/schemas/PromotionRuleOptionValuePreferences",product:"#/components/schemas/PromotionRuleProductPreferences"}},SellerRequirementAcceptTermsPreferences:{type:"object",properties:{terms_body:{type:"string","x-spree-widget":"textarea",nullable:!0},terms_effective_from:{type:"string",format:"date",nullable:!0},terms_url:{type:"string",nullable:!0}},additionalProperties:!1},SellerRequirementAttestationPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementBillingAddressPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementCompleteProfilePreferences:{type:"object",properties:{require_about:{type:"boolean",default:!0},require_logo:{type:"boolean",default:!0},require_cover_photo:{type:"boolean",default:!1},require_contact_email:{type:"boolean",default:!0}},additionalProperties:!1},SellerRequirementDeliveryMethodPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementDocumentPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementMinimumProductsPreferences:{type:"object",properties:{minimum_count:{type:"integer",default:1}},additionalProperties:!1},SellerRequirementOperatorReviewPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPackageTypePreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPayoutAccountPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPolicyPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementRequiredCustomFieldsPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementReturnsAddressPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPreferences:{description:"Settings of a seller requirement, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/SellerRequirementAcceptTermsPreferences"},{$ref:"#/components/schemas/SellerRequirementAttestationPreferences"},{$ref:"#/components/schemas/SellerRequirementBillingAddressPreferences"},{$ref:"#/components/schemas/SellerRequirementCompleteProfilePreferences"},{$ref:"#/components/schemas/SellerRequirementDeliveryMethodPreferences"},{$ref:"#/components/schemas/SellerRequirementDocumentPreferences"},{$ref:"#/components/schemas/SellerRequirementMinimumProductsPreferences"},{$ref:"#/components/schemas/SellerRequirementOperatorReviewPreferences"},{$ref:"#/components/schemas/SellerRequirementPackageTypePreferences"},{$ref:"#/components/schemas/SellerRequirementPayoutAccountPreferences"},{$ref:"#/components/schemas/SellerRequirementPolicyPreferences"},{$ref:"#/components/schemas/SellerRequirementRequiredCustomFieldsPreferences"},{$ref:"#/components/schemas/SellerRequirementReturnsAddressPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{accept_terms:"#/components/schemas/SellerRequirementAcceptTermsPreferences",attestation:"#/components/schemas/SellerRequirementAttestationPreferences",billing_address:"#/components/schemas/SellerRequirementBillingAddressPreferences",complete_profile:"#/components/schemas/SellerRequirementCompleteProfilePreferences",delivery_method:"#/components/schemas/SellerRequirementDeliveryMethodPreferences",document:"#/components/schemas/SellerRequirementDocumentPreferences",minimum_products:"#/components/schemas/SellerRequirementMinimumProductsPreferences",operator_review:"#/components/schemas/SellerRequirementOperatorReviewPreferences",package_type:"#/components/schemas/SellerRequirementPackageTypePreferences",payout_account:"#/components/schemas/SellerRequirementPayoutAccountPreferences",policy:"#/components/schemas/SellerRequirementPolicyPreferences",required_custom_fields:"#/components/schemas/SellerRequirementRequiredCustomFieldsPreferences",returns_address:"#/components/schemas/SellerRequirementReturnsAddressPreferences"}},DeliveryMethodCalculator:{type:"object",description:"How the delivery method prices a shipment",properties:{type:{type:"string",description:"Wire shorthand for the calculator subclass"},preferences:{$ref:"#/components/schemas/DeliveryCalculatorPreferences"}},required:["type","preferences"]},PromotionActionCalculator:{type:"object",description:"The action's nested calculator (when the action carries one \u2014 null for actions like `free_shipping`)",properties:{type:{type:"string",description:"Wire shorthand for the calculator subclass"},preferences:{$ref:"#/components/schemas/PromotionCalculatorPreferences"}},required:["type","preferences"]},CurrencyCode:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},CountryCode:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},LocaleCode:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},TimeZone:{anyOf:[{type:"string",enum:["Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Asuncion","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Nuuk","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Canberra","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Etc/GMT+12","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu","UTC"]},{type:"string"}],description:"Common IANA time zones; any other IANA time zone identifier is accepted too."},DimensionUnit:{type:"string",enum:["mm","cm","in","ft"]},WeightUnit:{type:"string",enum:["g","kg","lb","oz"]},AddressInputParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"}}},AdminUserUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},role_ids:{type:"array",items:{type:"string"},description:"Role IDs of the current store the user should hold. Replaces the user's roles on this store; an empty list removes them all."}}},AllowedOriginCreateParams:{type:"object",properties:{origin:{type:"string",description:"Origin to allow in admin CORS preflight checks: a bare `scheme://host[:port]` (no path, query or fragment) using `http` or `https`."}},required:["origin"]},AllowedOriginUpdateParams:{type:"object",properties:{origin:{type:"string",description:"Origin to allow in admin CORS preflight checks: a bare `scheme://host[:port]` (no path, query or fragment) using `http` or `https`."}}},ApiKeyCreateParams:{type:"object",properties:{name:{type:"string"},key_type:{type:"string",enum:["publishable","secret"]},scopes:{type:"array",items:{type:"string"},description:"Required for secret keys. You can only grant scopes you hold yourself. Fixed once created: to change them, create a new key and revoke the old one."},channel_id:{type:"string",description:"Binds a publishable key to one channel of the store (`ch_...`), so it rejects requests for other channels. Fixed once created; omit it for a store-wide key."}},required:["name","key_type"]},ApiKeyUpdateParams:{type:"object",properties:{name:{type:"string"}},required:["name"]},BulkTagsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"},description:"The records to change. Records the caller cannot update are skipped; an empty list changes nothing."},tags:{type:"array",items:{type:"string"}}},required:["ids","tags"]},CatalogAssignParams:{type:"object",properties:{assignable_type:{type:"string",enum:["customer_group","company"],description:"Buyer audiences only. A company assignment covers its subtree."},assignable_id:{type:"string"}},required:["assignable_type","assignable_id"]},CatalogAssignmentParams:{type:"object",properties:{assignable_type:{type:"string",enum:["customer_group","company"],description:"Buyer audiences only. A company assignment covers its subtree."},assignable_id:{type:"string"}},required:["assignable_type","assignable_id"]},CatalogCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Internal note on what the agreement is, never shown to shoppers.",nullable:!0},active:{type:"boolean"},position:{type:"integer"},minimum_order_quantity:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},order_multiple:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},metadata:{type:"object",additionalProperties:!0},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignmentParams"},description:"The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone."},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimumParams"},description:"The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone."},price_list:{allOf:[{$ref:"#/components/schemas/CatalogPriceListParams"}],description:"The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send `{}`, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive.",nullable:!0}},required:["name"]},CatalogOrderMinimumParams:{type:"object",properties:{currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 code. Required on create; one minimum per currency."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"}}},CatalogPriceListParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},status:{type:"string"},match_policy:{type:"string"},starts_at:{type:"string",format:"date-time",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"Contextual rules, in practice a `volume_rule`. Audience rules are left as they are, and an empty list clears the contextual rules."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Explicit per-variant amounts. An empty list clears them, which is what switching to a percentage sends."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the percentage. The payload is the whole ladder, so an empty list clears it."}}},CatalogProductTermsParams:{type:"object",properties:{terms:{type:"object",additionalProperties:!0,description:"Quantity terms keyed by product: `{ minimum_order_quantity, order_multiple }`, each a whole number or null. A product whose pair is both null has its terms cleared; a product not yet in the assortment is added."}},required:["terms"]},CatalogUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Internal note on what the agreement is, never shown to shoppers.",nullable:!0},active:{type:"boolean"},position:{type:"integer"},minimum_order_quantity:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},order_multiple:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},metadata:{type:"object",additionalProperties:!0},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignmentParams"},description:"The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone."},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimumParams"},description:"The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone."},price_list:{allOf:[{$ref:"#/components/schemas/CatalogPriceListParams"}],description:"The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send `{}`, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive.",nullable:!0}}},CategoryCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},parent_id:{type:"string",description:"The parent category. Omitted or null, a new category goes to the top level and an existing one keeps its parent: moving one to the top level is the reposition endpoint.",nullable:!0},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},CategoryRepositionParams:{type:"object",properties:{new_parent_id:{type:"string",description:"The new parent. Omit or null to move the category to the top level.",nullable:!0},new_position:{type:"integer",description:"0-based index among the new parent's children."}},required:["new_position"]},CategoryUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},parent_id:{type:"string",description:"The parent category. Omitted or null, a new category goes to the top level and an existing one keeps its parent: moving one to the top level is the reposition endpoint.",nullable:!0},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},ChannelAddProductsParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"}},published_at:{type:"string",format:"date-time",description:"When the publications go live. Null means immediately.",nullable:!0},unpublished_at:{type:"string",format:"date-time",description:"When the publications come down. Null means never.",nullable:!0}},required:["product_ids"]},ChannelCreateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"URL-safe slug, derived from `name` when blank (`Point of Sale` becomes `point-of-sale`)."},active:{type:"boolean"},default:{type:"boolean"},order_routing_strategy:{type:"string",description:"Order routing strategy shorthand (built-in: `rules`). Null inherits the store setting.",nullable:!0},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"What anonymous visitors can see. Null inherits the store setting.",nullable:!0},guest_checkout:{type:"boolean",description:"Whether guests can check out without an account. Null inherits the store setting.",nullable:!0},default_catalog_id:{type:"string",description:"Catalog (`cat_...`) shown to shoppers no company or customer group catalog covers. Null means every product published on the channel.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Stock locations (`sloc_...`) that fulfill this channel. Replaces the whole set; an empty list means every location of the store."}},required:["name"]},ChannelRemoveProductsParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"}}},required:["product_ids"]},ChannelUpdateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"URL-safe slug, derived from `name` when blank (`Point of Sale` becomes `point-of-sale`)."},active:{type:"boolean"},default:{type:"boolean"},order_routing_strategy:{type:"string",description:"Order routing strategy shorthand (built-in: `rules`). Null inherits the store setting.",nullable:!0},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"What anonymous visitors can see. Null inherits the store setting.",nullable:!0},guest_checkout:{type:"boolean",description:"Whether guests can check out without an account. Null inherits the store setting.",nullable:!0},default_catalog_id:{type:"string",description:"Catalog (`cat_...`) shown to shoppers no company or customer group catalog covers. Null means every product published on the channel.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Stock locations (`sloc_...`) that fulfill this channel. Replaces the whole set; an empty list means every location of the store."}}},ClaimCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the claim was canceled."}}},ClaimCreateParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{line_item_id:{type:"string"},quantity:{type:"integer"},description:{type:"string"},send_replacement:{type:"boolean"},replacement_variant_id:{type:"string",description:"Defaults to the variant that was bought."},refund_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["line_item_id","quantity"]},description:"Affected items, and how each should be made right."},reason_id:{type:"string",description:"One of the store's claim reasons."},memo:{type:"string"}},required:["items"]},ClaimDenyParams:{type:"object",properties:{reason:{type:"string",description:"Recorded on the claim for the customer."}}},ClaimResolveParams:{type:"object",properties:{resolution:{type:"string",enum:["refund","replacement","refund_and_replacement"],description:"Money back, a replacement shipment, or both."},refund_method:{type:"string",enum:["original_payment","store_credit"],description:"Defaults to `store_credit`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the claim total."},replacement_line_item_ids:{type:"array",items:{type:"string"},description:"Which claim lines to send a replacement for. Omit to keep what the claim was opened with."}},required:["resolution"]},ClaimUpdateParams:{type:"object",properties:{reason_id:{type:"string",description:"One of the store's claim reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},CollectionCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},position:{type:"integer",description:"1-based position among the store's collections; the server shifts its siblings. The nested products reposition endpoints, unlike this, take 0-based indexes."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},automatic:{type:"boolean",description:"When true, membership is materialized from `rules` instead of curated by hand."},rules_match_policy:{type:"string",enum:["all","any"],description:"Whether a product must match all rules or any of them. Defaults to `all`."},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"],description:"Default product sort for the storefront listing; a shopper's own sort wins. Defaults to `manual`."},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRuleParams"},description:"The complete desired rule set. Entries with an `id` update, entries without one are created, and existing rules left out are removed."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},CollectionRuleParams:{type:"object",properties:{id:{type:"string",description:"Omit to create a new rule."},type:{type:"string",description:"Wire shorthand for the rule kind, from the collection rule types endpoint."},value:{type:"string"},match_policy:{type:"string",enum:["is_equal_to","is_not_equal_to","contains","does_not_contain"]}}},CollectionUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},position:{type:"integer",description:"1-based position among the store's collections; the server shifts its siblings. The nested products reposition endpoints, unlike this, take 0-based indexes."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},automatic:{type:"boolean",description:"When true, membership is materialized from `rules` instead of curated by hand."},rules_match_policy:{type:"string",enum:["all","any"],description:"Whether a product must match all rules or any of them. Defaults to `all`."},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"],description:"Default product sort for the storefront listing; a shopper's own sort wins. Defaults to `manual`."},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRuleParams"},description:"The complete desired rule set. Entries with an `id` update, entries without one are created, and existing rules left out are removed."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},CommissionRateCreateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"Your own identifier for this rate; unique per store.",nullable:!0},enabled:{type:"boolean"},position:{type:"integer",description:"Place in the list. Rates resolve top-down and the first whose rules match wins, so 1 is tried first. New rates are created at the top; send this to move one. A rate with no rules matches every sale, so the marketplace default belongs at the bottom."},kind:{type:"string",enum:["percentage","fixed"],description:"`percentage` charges a share of the sale; `fixed` charges a flat fee."},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"A percentage (10 = 10%) or a flat amount, per `kind`."},tax_inclusive:{type:"boolean",description:"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},include_shipping:{type:"boolean",description:"Also charge commission on the seller's delivery revenue. Percentage rates only."},commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"VAT on the commission itself, as a fraction rather than a percentage. Null lets the store's tax engine answer for the seller's jurisdiction.",nullable:!0},metadata:{type:"object",additionalProperties:!0},amounts:{type:"object",additionalProperties:!0,description:"What a flat fee charges, keyed by currency, as decimal strings. A sale in a currency with no amount falls to the next matching rate. Replaces the whole set."},bounds:{type:"object",additionalProperties:!0,description:"The floor and cap a percentage charges within, keyed by currency: `{ min_amount, max_amount }` decimal strings. A sale in a currency with no bounds is charged unbounded. Replaces the whole set."},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRuleDraftParams"},description:"The full targeting; what you send replaces what the rate holds."}},required:["name","kind","value"]},CommissionRateUpdateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"Your own identifier for this rate; unique per store.",nullable:!0},enabled:{type:"boolean"},position:{type:"integer",description:"Place in the list. Rates resolve top-down and the first whose rules match wins, so 1 is tried first. New rates are created at the top; send this to move one. A rate with no rules matches every sale, so the marketplace default belongs at the bottom."},kind:{type:"string",enum:["percentage","fixed"],description:"`percentage` charges a share of the sale; `fixed` charges a flat fee."},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"A percentage (10 = 10%) or a flat amount, per `kind`."},tax_inclusive:{type:"boolean",description:"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},include_shipping:{type:"boolean",description:"Also charge commission on the seller's delivery revenue. Percentage rates only."},commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"VAT on the commission itself, as a fraction rather than a percentage. Null lets the store's tax engine answer for the seller's jurisdiction.",nullable:!0},metadata:{type:"object",additionalProperties:!0},amounts:{type:"object",additionalProperties:!0,description:"What a flat fee charges, keyed by currency, as decimal strings. A sale in a currency with no amount falls to the next matching rate. Replaces the whole set."},bounds:{type:"object",additionalProperties:!0,description:"The floor and cap a percentage charges within, keyed by currency: `{ min_amount, max_amount }` decimal strings. A sale in a currency with no bounds is charged unbounded. Replaces the whole set."},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRuleDraftParams"},description:"The full targeting; what you send replaces what the rate holds."}}},CommissionRuleDraftParams:{type:"object",properties:{id:{type:"string",description:"Present for an existing rule; omit to create one.",nullable:!0},type:{type:"string",description:"A kind from `GET /commission_rates/rule_types`."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for the kind, per its type's `schema`."},product_ids:{type:"array",items:{type:"string"},description:"For kinds that name products, which are kept outside preferences."}},required:["type"]},CompanyAddressCreateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},default_billing:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."},default_shipping:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."}},required:["first_name","last_name","address1","city","country_code"]},CompanyAddressUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},default_billing:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."},default_shipping:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."}}},CompanyCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},kind:{type:"string",enum:["company","division"],description:"`company` is a legal entity (may hold tax registrations), `division` an organizational unit. Roots must be `company`."},parent_id:{type:"string",description:"The parent node. Omit or null for a root.",nullable:!0},po_number_required:{type:"boolean",description:"Whether this buyer's own procurement process demands a PO reference on every order: checkout asks for one and refuses to complete without it."},metadata:{type:"object",additionalProperties:!0}},required:["name"]},CompanyMembershipCreateParams:{type:"object",properties:{customer_email:{type:"string",description:"An existing customer becomes a member immediately; an unknown email becomes an invitation, and the response is an invitation instead of a membership."},metadata:{type:"object",additionalProperties:!0}},required:["customer_email"]},CompanyUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},kind:{type:"string",enum:["company","division"],description:"`company` is a legal entity (may hold tax registrations), `division` an organizational unit. Roots must be `company`."},parent_id:{type:"string",description:"The parent node. Omit or null for a root.",nullable:!0},po_number_required:{type:"boolean",description:"Whether this buyer's own procurement process demands a PO reference on every order: checkout asks for one and refuses to complete without it."},metadata:{type:"object",additionalProperties:!0}}},CustomFieldCreateParams:{type:"object",properties:{custom_field_definition_id:{type:"string"},value:{description:"A value matching the definition's `field_type`: a scalar for text, number and boolean fields; a list or a hash for JSON fields."}},required:["custom_field_definition_id","value"]},CustomFieldDefinitionCreateParams:{type:"object",properties:{namespace:{type:"string",description:"Defaults to `custom`."},key:{type:"string"},label:{type:"string",description:"Human-readable name; defaults to the titleized `key`."},field_type:{type:"string",description:"Custom field type token (`short_text`, `long_text`, `rich_text`, `number`, \u2026). An extension type that has no token is named by its registered class instead."},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, from the resource types endpoint."},storefront_visible:{type:"boolean",description:"When false, the definition is admin-only and never exposed in the Store API."},searchable:{type:"boolean",description:"Include values in storefront product text search. Supported for `short_text`, `long_text` and `number` fields; other types are refused."},sortable:{type:"boolean",description:"Allow storefront product listings to sort by this field (`sort=cf_{namespace}_{key}`). Supported for `short_text` and `number` fields; other types are refused."}},required:["key","field_type","resource_type"]},CustomFieldDefinitionUpdateParams:{type:"object",properties:{namespace:{type:"string",description:"Defaults to `custom`."},key:{type:"string"},label:{type:"string",description:"Human-readable name; defaults to the titleized `key`."},field_type:{type:"string",description:"Custom field type token (`short_text`, `long_text`, `rich_text`, `number`, \u2026). An extension type that has no token is named by its registered class instead."},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, from the resource types endpoint."},storefront_visible:{type:"boolean",description:"When false, the definition is admin-only and never exposed in the Store API."},searchable:{type:"boolean",description:"Include values in storefront product text search. Supported for `short_text`, `long_text` and `number` fields; other types are refused."},sortable:{type:"boolean",description:"Allow storefront product listings to sort by this field (`sort=cf_{namespace}_{key}`). Supported for `short_text` and `number` fields; other types are refused."}}},CustomFieldUpdateParams:{type:"object",properties:{value:{description:"A value matching the definition's `field_type`: a scalar for text, number and boolean fields; a list or a hash for JSON fields."}},required:["value"]},CustomFieldValueParams:{type:"object",properties:{id:{type:"string"},custom_field_definition_id:{type:"string"},value:{description:"A scalar for text, number and boolean fields; a list or a hash for JSON fields."}}},CustomerAddressCreateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean",description:"Makes this the customer's default address of that kind."},is_default_shipping:{type:"boolean",description:"Makes this the customer's default address of that kind."}},required:["first_name","last_name","address1","city","country_code"]},CustomerAddressUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean",description:"Makes this the customer's default address of that kind."},is_default_shipping:{type:"boolean",description:"Makes this the customer's default address of that kind."}}},CustomerBulkGroupsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Groups from other stores are ignored."}},required:["ids","customer_group_ids"]},CustomerCreateParams:{type:"object",properties:{email:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},phone:{type:"string"},password:{type:"string",description:"Optional: a customer created without one claims the account through a password reset."},password_confirmation:{type:"string",description:"Optional: a customer created without one claims the account through a password reset."},selected_locale:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},accepts_email_marketing:{type:"boolean"},internal_note:{type:"string",description:"Rich text HTML. Reads come back as this plus `internal_note_html`."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Replaces the customer's group membership."}},required:["email"]},CustomerGroupCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},customer_ids:{type:"array",items:{type:"string"},description:"Replaces the group's members."}},required:["name"]},CustomerGroupUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},customer_ids:{type:"array",items:{type:"string"},description:"Replaces the group's members."}}},CustomerStoreCreditCreateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},memo:{type:"string"}},required:["amount","currency"]},CustomerStoreCreditUpdateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},memo:{type:"string"}}},CustomerUpdateParams:{type:"object",properties:{email:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},phone:{type:"string"},selected_locale:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},accepts_email_marketing:{type:"boolean"},internal_note:{type:"string",description:"Rich text HTML. Reads come back as this plus `internal_note_html`."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Replaces the customer's group membership."}}},DataRequestCreateParams:{type:"object",properties:{customer_id:{type:"string"},kind:{type:"string",enum:["access","erasure"],description:"`access` asks for a copy of the customer's personal data; `erasure` asks for it to be erased."}},required:["customer_id","kind"]},DeliveryCreateParams:{type:"object",properties:{tracking_number:{type:"string",description:"A carrier tracking number, a freight PRO or container number, or a full tracking link. A corrected number resets the carrier status to `pending`."},carrier:{type:"string",description:"Free text; detected from the number's format when omitted."},service:{type:"string"},tracking_url:{type:"string"}},required:["tracking_number"]},DeliveryMarkDeliveredParams:{type:"object",properties:{delivered_at:{type:"string",format:"date-time",description:"When it arrived. Defaults to now."},notify_customer:{type:"boolean",description:"Whether the customer gets a delivery notification once the parcel completes. Defaults to true."}}},DeliveryMethodCreateParams:{type:"object",properties:{name:{type:"string"},admin_name:{type:"string",nullable:!0},code:{type:"string",nullable:!0},fulfillment_provider:{type:"string",description:"Fulfillment provider shorthand (see the fulfillment providers endpoint), e.g. `manual`."},pickup_point_provider:{type:"string",nullable:!0},rate_provider:{type:"string",description:"Rate provider shorthand (see the rate providers endpoint), e.g. `easy_post`. Omit or send null for the built-in provider, which prices through the method's calculator.",nullable:!0},storefront_visible:{type:"boolean"},available_to_sellers:{type:"boolean",description:"Marketplace only: whether a seller's packages may be quoted by this method. Off by default, and refused on a method that belongs to a seller."},tracking_url:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"integer",nullable:!0},estimated_transit_business_days_max:{type:"integer",nullable:!0},tax_category_id:{type:"string",description:"Prefixed tax category ID (`taxcat_...`), or null to clear.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level flat handling fee added on top of provider-quoted rates.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level percentage handling fee added on top of provider-quoted rates. Ignored for calculator-priced methods.",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this method belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group offering this method (`og_...`); defaults to the zone's group, else the profile's default group."},delivery_zone_id:{type:"string",description:"Delivery zone narrowing destinations (`dz_...`), or null for no restriction. Must belong to the method's profile.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Pickup locations (`sloc_...`); replaces the full set."},calculator:{type:"object",properties:{type:{type:"string"},preferences:{type:"object",additionalProperties:!0}},description:"How the method prices a shipment: a type from the calculators endpoint and its preferences, matching that type's `schema`."},rules:{type:"array",items:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean"},preferences:{type:"object",additionalProperties:!0},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to."}}},description:"Eligibility rules. Replaces the full set: omitted rules are removed."},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodServiceParams"},description:"Carrier service rows: which provider services this method offers. Replaces the full set: omitted rows are removed; no rows means every service the provider returns is offered."}},required:["name"]},DeliveryMethodRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean",description:"Defaults to true on create."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to. An empty list clears them."}},required:["type"]},DeliveryMethodRuleUpdateParams:{type:"object",properties:{active:{type:"boolean",description:"Defaults to true on create."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to. An empty list clears them."}}},DeliveryMethodServiceParams:{type:"object",properties:{id:{type:"string",description:"Prefixed row ID (`dms_...`) when updating an existing row."},carrier:{type:"string",description:"Carrier identifier as the provider's API knows it."},service:{type:"string",description:"Service identifier as the provider's API knows it."},label:{type:"string",description:"Display label shown to customers instead of the carrier-derived name.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Overrides the method-level flat markup for this service.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Overrides the method-level percentage markup for this service.",nullable:!0},position:{type:"integer"}},required:["carrier","service"]},DeliveryMethodUpdateParams:{type:"object",properties:{name:{type:"string"},admin_name:{type:"string",nullable:!0},code:{type:"string",nullable:!0},fulfillment_provider:{type:"string",description:"Fulfillment provider shorthand (see the fulfillment providers endpoint), e.g. `manual`."},pickup_point_provider:{type:"string",nullable:!0},rate_provider:{type:"string",description:"Rate provider shorthand (see the rate providers endpoint), e.g. `easy_post`. Omit or send null for the built-in provider, which prices through the method's calculator.",nullable:!0},storefront_visible:{type:"boolean"},available_to_sellers:{type:"boolean",description:"Marketplace only: whether a seller's packages may be quoted by this method. Off by default, and refused on a method that belongs to a seller."},tracking_url:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"integer",nullable:!0},estimated_transit_business_days_max:{type:"integer",nullable:!0},tax_category_id:{type:"string",description:"Prefixed tax category ID (`taxcat_...`), or null to clear.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level flat handling fee added on top of provider-quoted rates.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level percentage handling fee added on top of provider-quoted rates. Ignored for calculator-priced methods.",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this method belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group offering this method (`og_...`); defaults to the zone's group, else the profile's default group."},delivery_zone_id:{type:"string",description:"Delivery zone narrowing destinations (`dz_...`), or null for no restriction. Must belong to the method's profile.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Pickup locations (`sloc_...`); replaces the full set."},calculator:{type:"object",properties:{type:{type:"string"},preferences:{type:"object",additionalProperties:!0}},description:"How the method prices a shipment: a type from the calculators endpoint and its preferences, matching that type's `schema`."},rules:{type:"array",items:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean"},preferences:{type:"object",additionalProperties:!0},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to."}}},description:"Eligibility rules. Replaces the full set: omitted rules are removed."},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodServiceParams"},description:"Carrier service rows: which provider services this method offers. Replaces the full set: omitted rows are removed; no rows means every service the provider returns is offered."}}},DeliveryOriginGroupParams:{type:"object",properties:{name:{type:"string",nullable:!0},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}}},DeliveryProfileCreateParams:{type:"object",properties:{name:{type:"string"},kind:{type:"string",description:"Registered profile kind (`shipping`, `digital`, extension kinds) from the kinds endpoint. Read on create only; defaults to shipping."},default:{type:"boolean",description:"Promotes this profile to the store default; the previous default is demoted."},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}},required:["name"]},DeliveryProfileUpdateParams:{type:"object",properties:{name:{type:"string"},kind:{type:"string",description:"Registered profile kind (`shipping`, `digital`, extension kinds) from the kinds endpoint. Read on create only; defaults to shipping."},default:{type:"boolean",description:"Promotes this profile to the store default; the previous default is demoted."},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}}},DeliveryUpdateParams:{type:"object",properties:{tracking_number:{type:"string",description:"A carrier tracking number, a freight PRO or container number, or a full tracking link. A corrected number resets the carrier status to `pending`."},carrier:{type:"string",description:"Free text; detected from the number's format when omitted."},service:{type:"string"},tracking_url:{type:"string"}}},DeliveryZoneCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this zone belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group this zone belongs to (`og_...`)."},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMemberParams"},description:"Replaces the zone's full member set atomically."}},required:["name"]},DeliveryZoneMemberParams:{type:"object",properties:{member_type:{type:"string",enum:["country","state","postal_code"]},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}]},state_code:{type:"string",description:"A subdivision code or name. Without `country_code` the country is inferred when only one country matches."},postal_code_prefix:{type:"string"},postal_code_from:{type:"string"},postal_code_to:{type:"string"}},required:["member_type"]},DeliveryZoneUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this zone belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group this zone belongs to (`og_...`)."},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMemberParams"},description:"Replaces the zone's full member set atomically."}}},DigitalAssetCreateParams:{type:"object",properties:{signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`. On update it replaces the file for everyone who already bought it. A seller's file must be of a content type the marketplace accepts, checked against the file's own signature where it has one."},variant_id:{type:"string",description:"On create, defaults to the product's default variant when omitted. On update, omitting it keeps the current variant."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},provider_type:{type:"string",description:"A provider shorthand from the providers endpoint. Omit for an uploaded file; a provider-backed asset sends no `signed_id`."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."}}},DigitalAssetUpdateParams:{type:"object",properties:{signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`. On update it replaces the file for everyone who already bought it. A seller's file must be of a content type the marketplace accepts, checked against the file's own signature where it has one."},variant_id:{type:"string",description:"On create, defaults to the product's default variant when omitted. On update, omitting it keeps the current variant."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},provider_type:{type:"string",description:"A provider shorthand from the providers endpoint. Omit for an uploaded file; a provider-backed asset sends no `signed_id`."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."}}},DiscountCodeApplyParams:{type:"object",properties:{code:{type:"string"}},required:["code"]},DiscountCreateParams:{type:"object",properties:{label:{type:"string"},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"An amount in the order currency for a `flat` discount, or a percentage for a `percent` one."},value_type:{type:"string",enum:["flat","percent"],description:"Defaults to `flat`."},line_item_id:{type:"string",description:"The line item the discount applies to. Omitted, the value is distributed across the line items.",nullable:!0}},required:["label","value"]},DiscountUpdateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The new amount of the row, in the order currency."}}},EmailTemplateDraftParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},subject:{type:"string",nullable:!0},body:{type:"string"},lock_version:{type:"integer",description:"The `lock_version` the draft was loaded with, or null when there was no draft; a save from an older copy is refused with 409. Omit it to save without checking.",nullable:!0},rebase:{type:"boolean",description:"Marks the draft as based on Spree's current default, after reviewing what changed in it."}}},EmailTemplatePreviewParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},subject:{type:"string",description:"An unsaved subject, in place of the current one.",nullable:!0},body:{type:"string",description:"An unsaved body, in place of the current one."},record_id:{type:"string",description:"The record to build sample data from; the store's latest matching record otherwise."},email_key:{type:"string",description:"For the layout or a partial, the email to show it in."},branding:{type:"object",properties:{accent_color:{type:"string",nullable:!0},background_color:{type:"string",nullable:!0},card_color:{type:"string",nullable:!0},text_color:{type:"string",nullable:!0},heading_color:{type:"string",nullable:!0},font:{type:"string",enum:["inter","system","helvetica","georgia","roboto","lato","merriweather"],nullable:!0}},description:"Unsaved colors and font to preview, named like the store's `email_*` settings."},mailer_logo_signed_id:{type:"string",description:"An unsaved email logo: the signed id of an uploaded image, or null to preview without one.",nullable:!0}}},EmailTemplateRestoreParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},lock_version:{type:"integer",description:"The open draft's `lock_version`, or null when there is none; checked as when saving.",nullable:!0}}},EmailTemplateVersionParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},lock_version:{type:"integer",description:"The draft's `lock_version` as reviewed. A draft saved since is refused with 409."}}},ExchangeCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the exchange was canceled."}}},ExchangeCreateParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{fulfillment_item_id:{type:"string"},new_variant_id:{type:"string"},quantity:{type:"integer"}},required:["fulfillment_item_id","new_variant_id","quantity"]},description:"Items coming back, and what goes out in their place."},stock_location_id:{type:"string",description:"Where the goods come back to."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"}},required:["items"]},ExchangeFulfillParams:{type:"object",properties:{refund_method:{type:"string",enum:["original_payment","store_credit"],description:"How a credit is returned when the replacements cost less than what came back. Defaults to `store_credit`. A balance the customer owes is left for the merchant to collect."}}},ExchangeReceiveParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{exchange_line_item_id:{type:"string"},quantity:{type:"integer"},resellable:{type:"boolean",description:"Goods that cannot be resold are received but never restocked. Defaults to true."}},required:["exchange_line_item_id","quantity"]},description:"What actually arrived. Omit to receive everything as requested and resellable."}}},ExchangeUpdateParams:{type:"object",properties:{stock_location_id:{type:"string",description:"Where the goods come back to."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},ExportCreateParams:{type:"object",properties:{type:{type:"string",description:"Which dataset to export, as its shorthand: `products`, `orders`, `customers`, `product_translations`, `gift_cards`, `coupon_codes`, `newsletter_subscribers`, `price_list_prices`, `purchase_orders`, or a type an extension registers."},record_selection:{type:"string",enum:["filtered","all"],description:"`filtered` (the default) keeps `search_params`; `all` ignores them and exports every record in scope."},results_url:{type:"string",description:"Absolute URL of your admin exports view; the export-done email uses it as the download button target. Only honored when it matches one of the store's allowed origins."},search_params:{type:"object",additionalProperties:!0,description:'A Ransack query, with the predicates the list endpoint accepts. A `price_list_prices` export requires `price_list_id_eq` naming a price list of the current store, and refuses `record_selection: "all"`.'}},required:["type"]},FeeCreateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"Defaults to `surcharge`. The values listed are the built-in ones; extensions may add more."},line_item_id:{type:"string",description:"The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.",nullable:!0},fulfillment_id:{type:"string",description:"The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.",nullable:!0}},required:["label","amount"]},FeeUpdateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"Defaults to `surcharge`. The values listed are the built-in ones; extensions may add more."}}},FileUploadCreateParams:{type:"object",properties:{filename:{type:"string"},content_type:{type:"string"},byte_size:{type:"integer"},checksum:{type:"string",description:"Base64-encoded MD5 digest of the file; the storage service checks the bytes against it."},visibility:{type:"string",enum:["public","private"],description:"`public` (the default) for images, videos and CSV files anyone may fetch, `private` for any type."},file:{type:"string",format:"binary",description:"The bytes, for a multipart upload."}},required:["filename","content_type"]},FulfillmentCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"The location the fulfillment ships from. On update, moving it re-prices the fulfillment against that location's rates."},source_fulfillment_id:{type:"string",description:"The only fulfillment of this order to move units from, its exchange and claim replacements included: how a canceled replacement is sent again. Omitted, the customer's bought units are taken from every unshipped fulfillment."},tracking:{type:"string",description:"Carrier tracking number, or a full `https://` tracking link, which is served back as `tracking_url` unchanged."},delivery_method_id:{type:"string",description:"Delivery method attached as the selected rate. Defaults to the delivery method of the fully drained source fulfillments."},cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Explicit shipping cost, such as the 3PL price. Defaults to the summed cost of the fully drained source fulfillments, which keeps the order total unchanged. Persists only with `status: shipped`; pending fulfillments are re-priced by the rate engine."},status:{type:"string",enum:["shipped"],description:"Pass `shipped` to register an already-shipped external fulfillment."},metadata:{type:"object",additionalProperties:!0},items:{type:"array",items:{type:"object",properties:{item_id:{type:"string"},quantity:{type:"integer"}},required:["item_id","quantity"]},description:"Line item quantities to fulfill. Omit to fulfill every unit not yet shipped."}},required:["stock_location_id"]},FulfillmentFulfillParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{item_id:{type:"string"},quantity:{type:"integer"}},required:["item_id","quantity"]},description:"Line item quantities to ship. Omit to ship everything the fulfillment holds; a subset is split onto a new fulfillment, which is the one that ships."},tracking:{type:"string",description:"Carrier tracking number or a full `https://` tracking link, stored on the fulfillment that ships."},tracking_carrier:{type:"string",description:"Which carrier the number belongs to; detected from the number when omitted."},notify_customer:{type:"boolean",description:"Whether the customer gets the shipment email. Defaults to true; pass false to suppress it for this dispatch only."},force:{type:"boolean",description:"Hand the goods over even though the order is unpaid or holds backordered units."}}},FulfillmentMarkDeliveredParams:{type:"object",properties:{delivered_at:{type:"string",format:"date-time",description:"When it arrived. Defaults to now; return windows run from this time."},notify_customer:{type:"boolean",description:"Whether the customer gets a delivery notification. Defaults to true."}}},FulfillmentSplitParams:{type:"object",properties:{variant_id:{type:"string",description:"The variant being moved out."},quantity:{type:"integer"},stock_location_id:{type:"string",description:"Origin of the new fulfillment. Defaults to the source fulfillment's location."}},required:["variant_id","quantity"]},FulfillmentUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"The location the fulfillment ships from. On update, moving it re-prices the fulfillment against that location's rates."},tracking:{type:"string",description:"Carrier tracking number, or a full `https://` tracking link, which is served back as `tracking_url` unchanged."},tracking_carrier:{type:"string",description:"Which carrier the tracking number belongs to: a slug from the tracking carriers endpoint. Left blank, it is detected from the number's format where possible."},selected_delivery_rate_id:{type:"string"}}},GiftCardApplyParams:{type:"object",properties:{code:{type:"string",description:"The gift card code; matched case-insensitively."}},required:["code"]},GiftCardBatchCreateParams:{type:"object",properties:{prefix:{type:"string",description:"Lowercased and prepended to every generated code."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The amount of each card, greater than zero."},codes_count:{type:"integer",description:"How many cards to generate. Capped at `gift_card_batch_limit`; batches over `gift_card_batch_web_limit` generate in the background."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},expires_at:{type:"string",format:"date",nullable:!0}},required:["prefix","amount","codes_count"]},GiftCardCreateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Greater than zero."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},code:{type:"string",description:"Generated when omitted."},expires_at:{type:"string",format:"date",nullable:!0},customer_id:{type:"string",description:"The customer the card belongs to. Needs the `read_customers` permission; null detaches it.",nullable:!0}},required:["amount"]},GiftCardUpdateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Greater than zero."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},code:{type:"string",description:"Generated when omitted."},expires_at:{type:"string",format:"date",nullable:!0},customer_id:{type:"string",description:"The customer the card belongs to. Needs the `read_customers` permission; null detaches it.",nullable:!0}}},ImportCompleteMappingParams:{type:"object",properties:{mappings:{type:"array",items:{type:"object",properties:{schema_field:{type:"string",description:"A schema field name from the import's `schema_fields`."},file_column:{type:"string",description:"The CSV header to read the field from; null unmaps the field.",nullable:!0}},required:["schema_field"]},description:"Column assignments to apply before processing starts. Omit to accept the ones assigned on create."}}},ImportCreateParams:{type:"object",properties:{type:{type:"string",description:"Which dataset to import, as its shorthand: `products`, `customers`, `product_translations`, `price_list_prices`, `purchase_orders`, or a type an extension registers."},attachment_signed_id:{type:"string",description:'The `signed_id` of the uploaded CSV, from `files.upload()` with `visibility: "private"`.'},delimiter:{type:"string",enum:[",",";","|","	"],description:"CSV column separator. Defaults to a comma."},results_url:{type:"string",description:"Absolute URL of your admin imports view; the import-done email links back to it with `?import=<id>` appended. Only honored when it matches one of the store's allowed origins."},price_list_id:{type:"string",description:"For `price_list_prices` imports: the price list the rows are merged into. Must belong to the current store; other types ignore it."}},required:["type","attachment_signed_id"]},IntegrationCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand from the integration types endpoint."},active:{type:"boolean",description:"Activating runs the connection check, and a failed check is a 422."},preferences:{type:"object",additionalProperties:!0,description:"Credential values. Secret preferences come back masked, and sending a masked value back keeps the stored secret."}},required:["type"]},IntegrationUpdateParams:{type:"object",properties:{active:{type:"boolean",description:"Activating runs the connection check, and a failed check is a 422."},preferences:{type:"object",additionalProperties:!0,description:"Credential values. Secret preferences come back masked, and sending a masked value back keeps the stored secret."}}},InvitationAcceptParams:{type:"object",properties:{password:{type:"string",description:"Creates the account when the invitee has none yet. An existing account confirms it is theirs with it, unless the request is already signed in as that account."},password_confirmation:{type:"string"},first_name:{type:"string"},last_name:{type:"string"}}},InvitationCreateParams:{type:"object",properties:{email:{type:"string"},role_id:{type:"string",description:"The role (`role_...`) the invitee gets on accepting."}},required:["email","role_id"]},LineItemCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},variant_id:{type:"string"},quantity:{type:"integer",description:"Defaults to 1 when adding an item."},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price. Stamps the line `price_source: 'manual'`, so quantity changes and recalculation never re-price it; an explicit null reverts the line to catalog pricing. Omit to leave pricing alone. Draft (incomplete) orders only.",nullable:!0},options:{type:"object",additionalProperties:!0}},required:["variant_id"]},LineItemUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},quantity:{type:"integer",description:"Defaults to 1 when adding an item."},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price. Stamps the line `price_source: 'manual'`, so quantity changes and recalculation never re-price it; an explicit null reverts the line to catalog pricing. Omit to leave pricing alone. Draft (incomplete) orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}}},MaintenanceTaskRunCreateParams:{type:"object",properties:{task_name:{type:"string",description:"The task to run, as `task_name` from `GET /upgrade_steps`."},arguments:{type:"object",additionalProperties:!0,description:"Values for the task's declared parameters, keyed by parameter name. A key the task does not declare is rejected."},dry_run:{type:"boolean",description:"Report what would change without writing. Ignored by tasks that do not support a dry run, which run for real."}},required:["task_name"]},MarketCreateParams:{type:"object",properties:{name:{type:"string",description:"Display name, unique within the store."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code."},default_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Locale used as the market default. Always part of `supported_locales`."},tax_inclusive:{type:"boolean",description:"Whether the prices entered for this market include tax. True charges every customer the price as entered, with their tax inside it; false adds tax at checkout."},tax_provider:{type:"string",description:"Shorthand of the tax engine that prices this market, from the tax providers endpoint. Null uses the installation default.",nullable:!0},default:{type:"boolean",description:"Setting true demotes the previous default market of the store."},position:{type:"integer",description:"Sort order within the store; lower comes first."},supported_locales:{type:"array",items:{$ref:"#/components/schemas/LocaleCode"},description:"Locales available in this market. The default locale is always included."},country_codes:{type:"array",items:{$ref:"#/components/schemas/CountryCode"},description:"ISO 3166-1 alpha-2 codes of the countries in this market. At least one is required."}},required:["name","currency","default_locale","country_codes"]},MarketUpdateParams:{type:"object",properties:{name:{type:"string",description:"Display name, unique within the store."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code."},default_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Locale used as the market default. Always part of `supported_locales`."},tax_inclusive:{type:"boolean",description:"Whether the prices entered for this market include tax. True charges every customer the price as entered, with their tax inside it; false adds tax at checkout."},tax_provider:{type:"string",description:"Shorthand of the tax engine that prices this market, from the tax providers endpoint. Null uses the installation default.",nullable:!0},default:{type:"boolean",description:"Setting true demotes the previous default market of the store."},position:{type:"integer",description:"Sort order within the store; lower comes first."},supported_locales:{type:"array",items:{$ref:"#/components/schemas/LocaleCode"},description:"Locales available in this market. The default locale is always included."},country_codes:{type:"array",items:{$ref:"#/components/schemas/CountryCode"},description:"ISO 3166-1 alpha-2 codes of the countries in this market. At least one is required."}}},MeUpdateParams:{type:"object",properties:{selected_locale:{type:"string",description:"The dashboard display language."},first_name:{type:"string"},last_name:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` to set the avatar, or null to remove it. Omit it to keep the current photo.",nullable:!0}}},MediaCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},url:{type:"string",description:"Fetch an image from this URL, in the background. Images only: an external video uses `external_video_url`."},signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the media file itself."},source_media_id:{type:"string",description:"Place a file that is already in the library. The new row shares the source file rather than copying it, and takes its own alt, position and variant links from here."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaLibraryCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},url:{type:"string",description:"Fetch an image from this URL, in the background. Images only: an external video uses `external_video_url`."},signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the media file itself."},source_media_id:{type:"string",description:"Place a file that is already in the library. The new row shares the source file rather than copying it, and takes its own alt, position and variant links from here."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaLibraryUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},OauthApplicationCreateParams:{type:"object",properties:{name:{type:"string"},redirect_uri:{type:"string",description:"Where the authorization server sends the browser back to."}},required:["name"]},OauthApplicationUpdateParams:{type:"object",properties:{name:{type:"string"},redirect_uri:{type:"string",description:"Where the authorization server sends the browser back to."}},required:["name"]},OptionTypeCreateParams:{type:"object",properties:{name:{type:"string"},label:{type:"string"},position:{type:"integer"},filterable:{type:"boolean"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValueParams"},description:"Inline option values. Values left out of the list on update are destroyed, so send the full set every time."}},required:["name","label"]},OptionTypeUpdateParams:{type:"object",properties:{name:{type:"string"},label:{type:"string"},position:{type:"integer"},filterable:{type:"boolean"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValueParams"},description:"Inline option values. Values left out of the list on update are destroyed, so send the full set every time."}}},OptionValueParams:{type:"object",properties:{id:{type:"string",description:"Present for existing values. Omit to create a new one."},name:{type:"string"},label:{type:"string"},position:{type:"integer"},color_code:{type:"string",description:"Hex color. Only meaningful when the option type's `kind` is `color_swatch`.",nullable:!0},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`, or null to remove the image.",nullable:!0}}},OrderCancelParams:{type:"object",properties:{cancel_reason_id:{type:"string",description:"Why the order was canceled: the id of one of the store's cancellation reasons."},cancel_note:{type:"string",description:"Staff-facing note about the cancellation."},refund_payments:{type:"boolean",description:"Whether this order's share of a payment shared across a split checkout is handed back."},refund_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"How much of that share to return. Defaults to all of it; refused on an order whose payment is not shared."},notify_customer:{type:"boolean",description:"Send the order cancellation email after canceling."}}},OrderCompleteParams:{type:"object",properties:{payment_pending:{type:"boolean"},notify_customer:{type:"boolean",description:"Send the order confirmation email after completion."}}},OrderCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},email:{type:"string"},customer_id:{type:"string",description:"Null detaches the customer, leaving a guest order under its `email`.",nullable:!0},use_customer_default_address:{type:"boolean",description:"Copies the saved default billing and shipping addresses onto the order. Sent with `company_id`, it takes that company's defaults, inherited from its parent nodes when the company holds none of its own; otherwise it takes the customer's."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},market_id:{type:"string"},channel_id:{type:"string",description:"Defaults to the store primary channel when omitted."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}]},customer_note:{type:"string",description:"Public, customer-visible note."},internal_note:{type:"string",description:"Staff-only note. Rich text HTML; reads come back as this plus `internal_note_html`."},po_number:{type:"string",description:"The buyer's own purchase-order reference. Searchable alongside the order number, and rendered on every order-facing document."},po_document_signed_id:{type:"string",description:"The `signed_id` of the buyer's purchase order, from `files.upload()` with `visibility: 'private'`. Null removes the document the order carries.",nullable:!0},shipping_address_id:{type:"string",description:"An existing address from the customer's address book, or from the address book of the company the order is for."},billing_address_id:{type:"string",description:"An existing address from the customer's address book, or from the address book of the company the order is for."},preferred_stock_location_id:{type:"string",description:"Stock location to prefer for fulfillment. Order Routing's built-in preferred-location rule ranks it first; routing falls back to the next rule when the location can't cover the cart."},company_id:{type:"string",description:"Makes the order a company purchase, with that company's catalog prices and tax treatment. Null makes a draft a plain customer order again.",nullable:!0},coupon_code:{type:"string",description:"Applied non-fatally: an invalid code does not block creation."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},shipping_address:{$ref:"#/components/schemas/AddressInputParams"},billing_address:{$ref:"#/components/schemas/AddressInputParams"},use_shipping:{type:"boolean",description:"When true, copies the shipping address to the billing address."},items:{type:"array",items:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price; stamps `price_source: 'manual'`. Null reverts the line to catalog pricing. Draft orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["variant_id"]},description:"Line items to upsert, keyed by variant. An entry sets that variant's quantity, creating the line item when the order has none; `quantity: 0` removes it. Variants you do not send are left alone."}}},OrderRoutingRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand for the rule kind, from the order routing rule types endpoint."},active:{type:"boolean"},position:{type:"integer",description:"1-based priority in the channel's rule list. Omitted on create, the rule goes last; a new position reorders the rest of the list around it."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."}},required:["type"]},OrderRoutingRuleUpdateParams:{type:"object",properties:{active:{type:"boolean"},position:{type:"integer",description:"1-based priority in the channel's rule list. Omitted on create, the rule goes last; a new position reorders the rest of the list around it."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."}}},OrderUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},email:{type:"string"},customer_id:{type:"string",description:"Null detaches the customer, leaving a guest order under its `email`.",nullable:!0},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},market_id:{type:"string"},channel_id:{type:"string",description:"Defaults to the store primary channel when omitted."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}]},customer_note:{type:"string",description:"Public, customer-visible note."},internal_note:{type:"string",description:"Staff-only note. Rich text HTML; reads come back as this plus `internal_note_html`."},po_number:{type:"string",description:"The buyer's own purchase-order reference. Searchable alongside the order number, and rendered on every order-facing document."},po_document_signed_id:{type:"string",description:"The `signed_id` of the buyer's purchase order, from `files.upload()` with `visibility: 'private'`. Null removes the document the order carries.",nullable:!0},preferred_stock_location_id:{type:"string",description:"Stock location to prefer for fulfillment. Order Routing's built-in preferred-location rule ranks it first; routing falls back to the next rule when the location can't cover the cart."},company_id:{type:"string",description:"Makes the order a company purchase, with that company's catalog prices and tax treatment. Null makes a draft a plain customer order again.",nullable:!0},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},shipping_address:{$ref:"#/components/schemas/AddressInputParams"},billing_address:{$ref:"#/components/schemas/AddressInputParams"},use_shipping:{type:"boolean",description:"When true, copies the shipping address to the billing address."},items:{type:"array",items:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price; stamps `price_source: 'manual'`. Null reverts the line to catalog pricing. Draft orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["variant_id"]},description:"Line items to upsert, keyed by variant. An entry sets that variant's quantity, creating the line item when the order has none; `quantity: 0` removes it. Variants you do not send are left alone."}}},PackageTypeCreateParams:{type:"object",properties:{name:{type:"string",description:"Unique within the store."},kind:{type:"string",enum:["box","envelope","carton","pallet","container"],description:"What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on."},length:{type:"number",nullable:!0},width:{type:"number",nullable:!0},height:{type:"number",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Unit the three dimensions are in; falls back to the store's unit system.",nullable:!0},weight:{type:"number",description:"The empty package's own weight, added to content weight on every quote.",nullable:!0},max_weight:{type:"number",description:"What the package can hold, not the same as its own weight.",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],nullable:!0},default:{type:"boolean",description:"The box every parcel quote is built on. Setting this demotes whichever row held it."},metadata:{type:"object",additionalProperties:!0}},required:["name","kind"]},PackageTypeUpdateParams:{type:"object",properties:{name:{type:"string",description:"Unique within the store."},kind:{type:"string",enum:["box","envelope","carton","pallet","container"],description:"What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on."},length:{type:"number",nullable:!0},width:{type:"number",nullable:!0},height:{type:"number",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Unit the three dimensions are in; falls back to the store's unit system.",nullable:!0},weight:{type:"number",description:"The empty package's own weight, added to content weight on every quote.",nullable:!0},max_weight:{type:"number",description:"What the package can hold, not the same as its own weight.",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],nullable:!0},default:{type:"boolean",description:"The box every parcel quote is built on. Setting this demotes whichever row held it."},metadata:{type:"object",additionalProperties:!0}}},PasswordResetParams:{type:"object",properties:{password:{type:"string"},password_confirmation:{type:"string"}},required:["password","password_confirmation"]},PasswordResetRequestParams:{type:"object",properties:{email:{type:"string",format:"email"},redirect_url:{type:"string",description:"The page the emailed reset link points at, with the reset token appended. Honored only on the dashboard origin, for an account that is staff of the store; ignored otherwise."}},required:["email"]},PaymentCaptureParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Captures part of the authorized amount. Defaults to all of it."}}},PaymentCreateParams:{type:"object",properties:{payment_method_id:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the order total left after store credit."},source_id:{type:"string",description:"A saved payment source of the order's customer (a credit card), for an off-session charge. Used only by payment methods that require a source."}},required:["payment_method_id"]},PaymentMethodCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand from the payment method types endpoint."},name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},storefront_visible:{type:"boolean",description:"False keeps the method to the dashboard; true also offers it on the storefront."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"When customers are charged for this method. Null inherits the store setting.",nullable:!0},position:{type:"integer"},metadata:{type:"object",additionalProperties:!0},preferences:{type:"object",additionalProperties:!0,description:"Values for the provider's preference schema, from the payment method types endpoint."}},required:["type","name"]},PaymentMethodUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},storefront_visible:{type:"boolean",description:"False keeps the method to the dashboard; true also offers it on the storefront."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"When customers are charged for this method. Null inherits the store setting.",nullable:!0},position:{type:"integer"},metadata:{type:"object",additionalProperties:!0},preferences:{type:"object",additionalProperties:!0,description:"Values for the provider's preference schema, from the payment method types endpoint."}}},PolicyCreateParams:{type:"object",properties:{name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0}},required:["name"]},PolicyUpdateParams:{type:"object",properties:{name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0}}},PriceAdjustmentTierParams:{type:"object",properties:{min_quantity:{type:"integer",description:"Above 1; quantity 1 is the list's own `price_adjustment_percentage`."},percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts, positive marks up."}},required:["min_quantity","percentage"]},PriceBulkDestroyParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}}},required:["ids"]},PriceBulkUpsertParams:{type:"object",properties:{prices:{type:"array",items:{$ref:"#/components/schemas/PriceBulkUpsertRowParams"},description:"Send an empty list to change nothing."}},required:["prices"]},PriceBulkUpsertRowParams:{type:"object",properties:{id:{type:"string",description:"Present: updates that row. Absent: upserts on `(variant_id, currency, price_list_id, min_quantity)`.",nullable:!0},variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},price_list_id:{type:"string",description:"Omit or null for a base price.",nullable:!0},min_quantity:{type:"integer",description:"The rung of the variant's ladder. Omit for the bottom rung; anything above 1 requires a `price_list_id`. A variant carries at most ten rungs on one list per currency."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},required:["variant_id","currency"]},PriceCreateParams:{type:"object",properties:{variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The quantity a line must reach for this price to apply. Omit for the bottom rung of the ladder. Anything above 1 requires a `price_list_id`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},price_list_id:{type:"string",description:"Omit or null for a base price; a price list for a list override.",nullable:!0}},required:["variant_id","currency"]},PriceListCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},position:{type:"integer"},starts_at:{type:"string",format:"date-time",description:"Pair with `ends_at` to schedule the list: activating a list whose start is in the future marks it `scheduled`.",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},match_policy:{type:"string",enum:["all","any"],description:"`all`: every rule must match. `any`: one matching rule is enough."},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"The complete rule set: rules are matched by `id` and updated, new ones are built, and rules left out are removed."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the list's percentage. The payload is the whole ladder: a band left out is removed."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Per-variant price overrides. Each row upserts, so the variants it names become part of the list. Curating whole products goes through the nested products endpoint instead."}},required:["name"]},PriceListPriceOverrideParams:{type:"object",properties:{id:{type:"string",description:"Updates this price row. Without it, the row upserts on `(variant_id, currency, min_quantity)`."},variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The rung of the variant's ladder. Omit for the bottom rung."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}}},PriceListRuleParams:{type:"object",properties:{id:{type:"string",description:"Present for existing rules. Omit to create a new one.",nullable:!0},type:{type:"string",description:"Wire shorthand for the rule kind, from the price rule types endpoint."},preferences:{type:"object",additionalProperties:!0,description:"The rule kind's settings, keyed by preference name."}},required:["type"]},PriceListUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},position:{type:"integer"},starts_at:{type:"string",format:"date-time",description:"Pair with `ends_at` to schedule the list: activating a list whose start is in the future marks it `scheduled`.",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},match_policy:{type:"string",enum:["all","any"],description:"`all`: every rule must match. `any`: one matching rule is enough."},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"The complete rule set: rules are matched by `id` and updated, new ones are built, and rules left out are removed."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the list's percentage. The payload is the whole ladder: a band left out is removed."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Per-variant price overrides. Each row upserts, so the variants it names become part of the list. Curating whole products goes through the nested products endpoint instead."}}},PriceParams:{type:"object",properties:{currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:'A canonical decimal string (`"1234.56"`: period decimal, no grouping). The API does not parse localized input.'},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},required:["currency","amount"]},PriceUpdateParams:{type:"object",properties:{variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The quantity a line must reach for this price to apply. Omit for the bottom rung of the ladder. Anything above 1 requires a `price_list_id`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},price_list_id:{type:"string",description:"Omit or null for a base price; a price list for a list override.",nullable:!0}}},ProductBulkCategoriesParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}}},required:["ids","category_ids"]},ProductBulkChannelsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},channel_ids:{type:"array",items:{type:"string"}}},required:["ids","channel_ids"]},ProductBulkCollectionsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"}}},required:["ids","collection_ids"]},ProductBulkDestroyParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"},description:"Products the caller cannot delete are skipped."}},required:["ids"]},ProductBulkStatusParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},status:{type:"string",enum:["draft","active","archived"],description:"Products in review are skipped and counted in `skipped_in_review_count`."}},required:["ids","status"]},ProductCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},slug:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","active","archived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},tax_category_id:{type:"string"},product_type_id:{type:"string",description:"The product type this product is created from (`pt_...`). Its option types and categories seed onto the product and its custom field definitions drive the product form. Editing the type later never rewrites existing products.",nullable:!0},delivery_profile_id:{type:"string",description:"The delivery profile deciding how this product ships (`fp_...`); null falls back to the store default.",nullable:!0},promotionable:{type:"boolean"},tags:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"},description:"Manual collections this product belongs to. Automatic collections are kept as they are, since their rules decide membership."},metadata:{type:"object",additionalProperties:!0},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants` instead. Don't pass both."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."},media:{type:"array",items:{$ref:"#/components/schemas/ProductMediaParams"},description:"Media written with the product. Entries with `id` update an existing asset; entries with `signed_id` attach a fresh upload; an external video needs only its URL."},digital_assets:{type:"array",items:{$ref:"#/components/schemas/ProductDigitalAssetParams"},description:"Downloadable files written with the product. Each entry carries a `signed_id` (an upload to private storage) or a `provider_type` (a provider-backed asset), and attaches to the default variant unless `variant_id` is given. An `id` updates that asset in place, so replaying the list does not duplicate it; removal uses the nested digital assets endpoint."},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublicationParams"}},variants:{type:"array",items:{$ref:"#/components/schemas/ProductVariantParams"},description:"Every purchasable attribute (sku, prices, stock, weight, dimensions) lives on variants. An entry without `options` upserts onto the default variant of a simple product; pass `id` to update an existing variant."}},required:["name"]},ProductDigitalAssetParams:{type:"object",properties:{id:{type:"string"},signed_id:{type:"string"},variant_id:{type:"string"},provider_type:{type:"string",description:"A provider shorthand from the digital asset providers endpoint."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0}}},ProductMediaParams:{type:"object",properties:{id:{type:"string"},signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},source_media_id:{type:"string",description:"Copies an asset from the media library."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},variant_ids:{type:"array",items:{type:"string"},description:"Replaces the variants this media is linked to. An empty list clears them."}}},ProductMembershipParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"},description:"Products from other stores, or ones the caller cannot see, are ignored."}},required:["product_ids"]},ProductMembershipRepositionParams:{type:"object",properties:{new_position:{type:"integer",description:"0-based index among the parent's products."}},required:["new_position"]},ProductPublicationParams:{type:"object",properties:{id:{type:"string"},channel_id:{type:"string"},published_at:{type:"string",format:"date-time",nullable:!0},unpublished_at:{type:"string",format:"date-time",nullable:!0}}},ProductRejectParams:{type:"object",properties:{reason:{type:"string",description:"Why the submission was turned down. Sent back to the seller."}}},ProductTypeCreateParams:{type:"object",properties:{name:{type:"string"},delivery_profile_id:{type:"string",description:"Delivery profile stamped onto products created with this type. Null leaves new products on the store default profile.",nullable:!0},option_type_ids:{type:"array",items:{type:"string"},description:"Option types seeded onto products that get this type. Use apply to products to backfill existing ones."},category_ids:{type:"array",items:{type:"string"},description:"Categories seeded onto products that get this type. Categories from other stores are ignored."},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinitionParams"},description:"The custom field definitions the product form shows. Definitions not listed are removed from the type."}},required:["name"]},ProductTypeCustomFieldDefinitionParams:{type:"object",properties:{id:{type:"string",description:"The custom field definition."},required:{type:"boolean"},sort_order:{type:"integer"}},required:["id"]},ProductTypeUpdateParams:{type:"object",properties:{name:{type:"string"},delivery_profile_id:{type:"string",description:"Delivery profile stamped onto products created with this type. Null leaves new products on the store default profile.",nullable:!0},option_type_ids:{type:"array",items:{type:"string"},description:"Option types seeded onto products that get this type. Use apply to products to backfill existing ones."},category_ids:{type:"array",items:{type:"string"},description:"Categories seeded onto products that get this type. Categories from other stores are ignored."},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinitionParams"},description:"The custom field definitions the product form shows. Definitions not listed are removed from the type."}}},ProductUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},slug:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","active","archived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},tax_category_id:{type:"string"},product_type_id:{type:"string",description:"The product type this product is created from (`pt_...`). Its option types and categories seed onto the product and its custom field definitions drive the product form. Editing the type later never rewrites existing products.",nullable:!0},delivery_profile_id:{type:"string",description:"The delivery profile deciding how this product ships (`fp_...`); null falls back to the store default.",nullable:!0},promotionable:{type:"boolean"},tags:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"},description:"Manual collections this product belongs to. Automatic collections are kept as they are, since their rules decide membership."},metadata:{type:"object",additionalProperties:!0},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants` instead. Don't pass both."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."},media:{type:"array",items:{$ref:"#/components/schemas/ProductMediaParams"},description:"Media written with the product. Entries with `id` update an existing asset; entries with `signed_id` attach a fresh upload; an external video needs only its URL."},digital_assets:{type:"array",items:{$ref:"#/components/schemas/ProductDigitalAssetParams"},description:"Downloadable files written with the product. Each entry carries a `signed_id` (an upload to private storage) or a `provider_type` (a provider-backed asset), and attaches to the default variant unless `variant_id` is given. An `id` updates that asset in place, so replaying the list does not duplicate it; removal uses the nested digital assets endpoint."},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublicationParams"}},variants:{type:"array",items:{$ref:"#/components/schemas/ProductVariantParams"},description:"Every purchasable attribute (sku, prices, stock, weight, dimensions) lives on variants. An entry without `options` upserts onto the default variant of a simple product; pass `id` to update an existing variant."}}},ProductVariantParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{id:{type:"string"}}}]},PromotionActionCalculatorParams:{type:"object",properties:{type:{type:"string",description:"The calculator kind, from `GET /promotion_actions/calculators`. Changing it swaps the calculator."},preferences:{type:"object",additionalProperties:!0,description:"Values for the calculator's settings, such as `amount` or `flat_percent`."}}},PromotionActionCreateParams:{type:"object",properties:{type:{type:"string",description:"The action kind, from `GET /promotion_actions/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}},required:["type"]},PromotionActionDraftParams:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"The action kind, from `GET /promotion_actions/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}},required:["type"]},PromotionActionLineItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"}},required:["variant_id","quantity"]},PromotionActionUpdateParams:{type:"object",properties:{preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}}},PromotionCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",description:"Required for single-code coupon promotions. Ignored when `multi_codes` is true.",nullable:!0},path:{type:"string",nullable:!0},starts_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},usage_limit:{type:"integer",nullable:!0},match_policy:{type:"string",enum:["all","any"]},kind:{type:"string",enum:["coupon_code","automatic"],description:"`coupon_code` needs a code (or `multi_codes`); `automatic` applies without one."},multi_codes:{type:"boolean",description:"Generates `number_of_codes` codes starting with `code_prefix`."},number_of_codes:{type:"integer",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},rules:{type:"array",items:{$ref:"#/components/schemas/PromotionRuleDraftParams"},description:"The rules the promotion should have: entries with `id` update, entries without are created, and rules left out are removed."},actions:{type:"array",items:{$ref:"#/components/schemas/PromotionActionDraftParams"},description:"The actions the promotion should have, matched the same way as `rules`."}},required:["name"]},PromotionRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"The rule kind, from `GET /promotion_rules/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}},required:["type"]},PromotionRuleDraftParams:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"The rule kind, from `GET /promotion_rules/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}},required:["type"]},PromotionRuleUpdateParams:{type:"object",properties:{preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}}},PromotionUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",description:"Required for single-code coupon promotions. Ignored when `multi_codes` is true.",nullable:!0},path:{type:"string",nullable:!0},starts_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},usage_limit:{type:"integer",nullable:!0},match_policy:{type:"string",enum:["all","any"]},kind:{type:"string",enum:["coupon_code","automatic"],description:"`coupon_code` needs a code (or `multi_codes`); `automatic` applies without one."},multi_codes:{type:"boolean",description:"Generates `number_of_codes` codes starting with `code_prefix`."},number_of_codes:{type:"integer",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},rules:{type:"array",items:{$ref:"#/components/schemas/PromotionRuleDraftParams"},description:"The rules the promotion should have: entries with `id` update, entries without are created, and rules left out are removed."},actions:{type:"array",items:{$ref:"#/components/schemas/PromotionActionDraftParams"},description:"The actions the promotion should have, matched the same way as `rules`."}}},PurchaseOrderCancelParams:{type:"object",properties:{reason:{type:"string",description:"Appended to the order's notes."}}},PurchaseOrderCreateParams:{type:"object",properties:{supplier_id:{type:"string"},destination_location_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Defaults to the store's currency; set it for a foreign-currency order.",nullable:!0},expected_at:{type:"string",format:"date",description:"The day the supplier promised. `null` clears it.",nullable:!0},cancel_by:{type:"string",format:"date",description:"The day after which the goods are no longer wanted. `null` clears it.",nullable:!0},reference:{type:"string",description:"The supplier's own order number. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItemParams"},description:"Sending the list replaces whatever the order currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["supplier_id","destination_location_id"]},PurchaseOrderItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity_ordered:{type:"integer"},unit_cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"What the merchant agreed to pay per unit."}},required:["variant_id","quantity_ordered","unit_cost"]},PurchaseOrderUpdateParams:{type:"object",properties:{supplier_id:{type:"string"},destination_location_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Defaults to the store's currency; set it for a foreign-currency order.",nullable:!0},expected_at:{type:"string",format:"date",description:"The day the supplier promised. `null` clears it.",nullable:!0},cancel_by:{type:"string",format:"date",description:"The day after which the goods are no longer wanted. `null` clears it.",nullable:!0},reference:{type:"string",description:"The supplier's own order number. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItemParams"},description:"Sending the list replaces whatever the order currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},ReasonCreateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."}},required:["name"]},ReasonUpdateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."}}},ReceivableCloseParams:{type:"object",properties:{reason:{type:"string",description:"Why the balance is not coming.",nullable:!0}}},RefundCreateParams:{type:"object",properties:{payment_id:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},refund_reason_id:{type:"string",description:"Defaults to the store's first refund reason."}},required:["payment_id","amount"]},ReportingQueryParams:{type:"object",properties:{metrics:{type:"array",items:{type:"string"},description:"Registered metric names, from the reporting schema endpoint."},dimensions:{type:"array",items:{},description:"Up to 2 dimensions to break the metrics down by. Each is a dimension name, or `{ name, grain, include_empty }`: `grain` (`hour`, `day`, `week`, `month`) buckets a time dimension, and `include_empty` lists members with no matching rows where the schema entry supports it."},filters:{type:"array",items:{type:"object",properties:{dimension:{type:"string"},op:{type:"string",enum:["eq","in"]},value:{description:"One value for `eq`, a list for `in`."}},required:["dimension","op","value"]},description:"Narrows the rows by dimension value."},metric_filters:{type:"array",items:{type:"object",properties:{metric:{type:"string"},op:{type:"string",enum:["eq","gt","gte","lt","lte"]},value:{type:"number"}},required:["metric","op","value"]},description:"Filters on an aggregate, such as `units_sold = 0`. Narrows the rows only; the totals stay the period's real figure. The metric must also appear in `metrics`, and cannot be a derived one."},time_range:{type:"object",properties:{preset:{type:"string"},since:{type:"string"},until:{type:"string"}},description:"A named preset (`last_month`, `week_to_date`, any `last_<n>_<days|weeks|months>`), or ISO 8601 dates or times in `since` and `until` (a bare date covers the store's whole day). Defaults to the last 30 days, in the store's time zone."},compare:{type:"string",enum:["previous_period","previous_year"]},sort:{type:"string",description:"A metric name; prefix it with `-` to sort descending."},limit:{type:"integer",description:"At most 1000."},currency:{$ref:"#/components/schemas/CurrencyCode"}},required:["metrics"]},ReturnCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the return was canceled."}}},ReturnCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},items:{type:"array",items:{type:"object",properties:{fulfillment_item_id:{type:"string"},quantity:{type:"integer"}},required:["fulfillment_item_id","quantity"]},description:"Fulfilled units coming back, and how many of each."},stock_location_id:{type:"string",description:"Where the goods come back to. Defaults to the location that shipped them."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"}},required:["items"]},ReturnReceiveParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{return_line_item_id:{type:"string"},quantity:{type:"integer"},resellable:{type:"boolean",description:"Goods that cannot be resold are received but never restocked. Defaults to true."}},required:["return_line_item_id","quantity"]},description:"What actually arrived. Omit to receive everything as requested and resellable; send rows for a partial or damaged receipt."}}},ReturnRefundParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the value of what was actually received."},refund_method:{type:"string",enum:["original_payment","store_credit"],description:"`store_credit` issues credit immediately; `original_payment` (the default) refunds through the gateway that took the money."}}},ReturnUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"Where the goods come back to. Defaults to the location that shipped them."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},RoleCreateParams:{type:"object",properties:{name:{type:"string",description:"Unique role name, the machine identifier shown capitalized in the dashboard."},description:{type:"string",nullable:!0},permissions:{type:"array",items:{type:"string"},description:"Permission keys (`read_orders`, `write_products`, ...) from the permissions endpoint. You can only grant keys you hold yourself."}},required:["name"]},RoleUpdateParams:{type:"object",properties:{name:{type:"string",description:"Unique role name, the machine identifier shown capitalized in the dashboard."},description:{type:"string",nullable:!0},permissions:{type:"array",items:{type:"string"},description:"Permission keys (`read_orders`, `write_products`, ...) from the permissions endpoint. You can only grant keys you hold yourself."}}},SavedReportCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object",additionalProperties:!0,description:"A reporting query, validated against the reporting registry on save."}},required:["name","query"]},SavedReportUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object",additionalProperties:!0,description:"A reporting query, validated against the reporting registry on save."}}},SellerAddressParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."}}},SellerApproveParams:{type:"object",properties:{override_requirements:{type:"boolean",description:"Admits a seller whose onboarding checklist is unfinished: the operator's deliberate exception, which the `seller.approved` event records along with what was outstanding."}}},SellerCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},slug:{type:"string",description:"URL-safe slug, derived from the name when omitted."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},about:{type:"string",description:"Sanitized HTML: the seller's public description.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from the files upload endpoint to set the image, `null` to remove it, or omit the key to leave it untouched. The same applies to `square_logo_signed_id` and `cover_photo_signed_id`.",nullable:!0},square_logo_signed_id:{type:"string",nullable:!0},cover_photo_signed_id:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"],nullable:!0},minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},holiday_mode_until:{type:"string",format:"date-time",description:"Set while the seller is away: the catalog stays but stops selling.",nullable:!0},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0},billing_address:{allOf:[{$ref:"#/components/schemas/SellerAddressParams"}],description:"The seller's own billing address, written inline. There is no `billing_address_id`: an address belongs to whoever it was created for, so it is never referenced by id."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},SellerInviteParams:{type:"object",properties:{email:{type:"string"},role_id:{type:"string",description:"A role this seller owns; defaults to the seller's own admin role.",nullable:!0}},required:["email"]},SellerPayoutCompleteParams:{type:"object",properties:{reference:{type:"string",description:"The provider's own id for the settlement, when one made it."}}},SellerRejectParams:{type:"object",properties:{reason:{type:"string"}}},SellerReopenOnboardingParams:{type:"object",properties:{note:{type:"string",description:"What the seller has to fix."}}},SellerRequirementCreateParams:{type:"object",properties:{type:{type:"string",description:"The kind, from the seller requirement types endpoint."},name:{type:"string",description:"What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself."},description:{type:"string",description:"Instructions shown to the seller."},position:{type:"integer",description:"Place in the checklist."},active:{type:"boolean"},required:{type:"boolean",description:"Whether this blocks approval. Off means recommended."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for this kind, per its type's `schema`."},metadata:{type:"object",additionalProperties:!0},custom_field_definition_ids:{type:"array",items:{type:"string"},description:"Custom field definitions this requirement asks the seller to fill in (`required_custom_fields` kind)."}},required:["type"]},SellerRequirementReviewParams:{type:"object",properties:{review_note:{type:"string",description:"Kept with the decision. On a rejection it is the reason sent back to the seller."}}},SellerRequirementUpdateParams:{type:"object",properties:{name:{type:"string",description:"What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself."},description:{type:"string",description:"Instructions shown to the seller."},position:{type:"integer",description:"Place in the checklist."},active:{type:"boolean"},required:{type:"boolean",description:"Whether this blocks approval. Off means recommended."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for this kind, per its type's `schema`."},metadata:{type:"object",additionalProperties:!0},custom_field_definition_ids:{type:"array",items:{type:"string"},description:"Custom field definitions this requirement asks the seller to fill in (`required_custom_fields` kind)."}}},SellerRequirementWaiveParams:{type:"object",properties:{requirement_id:{type:"string",description:"The requirement the seller is excused from."},review_note:{type:"string",description:"Why the seller is excused. Kept with the decision."}},required:["requirement_id"]},SellerSuspendParams:{type:"object",properties:{reason:{type:"string"}}},SellerUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},slug:{type:"string",description:"URL-safe slug, derived from the name when omitted."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},about:{type:"string",description:"Sanitized HTML: the seller's public description.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from the files upload endpoint to set the image, `null` to remove it, or omit the key to leave it untouched. The same applies to `square_logo_signed_id` and `cover_photo_signed_id`.",nullable:!0},square_logo_signed_id:{type:"string",nullable:!0},cover_photo_signed_id:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"],nullable:!0},minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},holiday_mode_until:{type:"string",format:"date-time",description:"Set while the seller is away: the catalog stays but stops selling.",nullable:!0},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0},billing_address:{allOf:[{$ref:"#/components/schemas/SellerAddressParams"}],description:"The seller's own billing address, written inline. There is no `billing_address_id`: an address belongs to whoever it was created for, so it is never referenced by id."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},SetupParams:{type:"object",properties:{setup_token:{type:"string",description:"The one-time token from the install output."},email:{type:"string",format:"email"},password:{type:"string"},password_confirmation:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},store_name:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 country the store sells from. It determines the default market, the warehouse, the delivery zones and the currency."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Storefront locale. Defaults to the country's own language."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency. Defaults to the country's own currency: pass one only when the store prices in something else."},sample_data:{type:"boolean",description:"Load the demo catalog, customers and orders in the background once the admin account exists. The load takes minutes, so the response does not wait for it."}},required:["setup_token","email","password","country_code"]},ShippingLabelCreateParams:{type:"object",properties:{file_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`. Its presence records a label bought elsewhere instead of buying one; without it the body is ignored and the label is bought through the carrier."},tracking_number:{type:"string",description:"The number printed on an uploaded label. Required with `file_signed_id`."},carrier:{type:"string",description:"Free text; a forwarder's name is as valid as a carrier slug. Detected from the number when omitted."},service:{type:"string",description:"Carrier service the label was bought at."},cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"What the merchant paid the carrier. Accounting data only; it never touches the order's shipping charge."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Currency of the cost."},file_format:{type:"string",enum:["pdf","png","zpl"],description:"Taken from the file when omitted."},tracking_url:{type:"string",description:"Tracking page for the consignment the label mints."}}},StockLevelBulkUpsertParams:{type:"object",properties:{stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevelBulkUpsertRowParams"},description:"Send an empty list to change nothing."}},required:["stock_levels"]},StockLevelBulkUpsertRowParams:{type:"object",properties:{variant_id:{type:"string"},stock_location_id:{type:"string"},count_on_hand:{type:"integer",description:"The absolute level the external system reports.",nullable:!0},adjustment:{type:"integer",description:"A relative change, for feeds that report movements rather than levels. Each row needs `count_on_hand` or `adjustment`.",nullable:!0},backorderable:{type:"boolean",nullable:!0}},required:["variant_id","stock_location_id"]},StockLevelParams:{type:"object",properties:{stock_location_id:{type:"string",description:"The location holding the stock (`sloc_...`)."},count_on_hand:{type:"integer",description:"Units physically at the location, not units available to sell: stock promised to placed orders counts until it ships. Sent as the count the shelf should end at; the API records the difference as an adjustment in the stock history."},backorderable:{type:"boolean",description:"Whether this location sells the variant beyond what it holds."}},required:["stock_location_id","count_on_hand"]},StockLevelUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},count_on_hand:{type:"integer",description:"The count the shelf should end at: a whole number of zero or more. The API records the difference as an `adjusted` movement, so the correction appears in the stock history."},adjustment:{type:"integer",description:"A signed change to the shelf instead of a target count, applied to the count the API holds at that moment and recorded the same way. Cannot be sent together with `count_on_hand`."},backorderable:{type:"boolean",description:"Whether this location sells the variant beyond what it holds."},reason:{type:"string",description:'Labels the correction in the stock history. Defaults to "Manual adjustment".'},metadata:{type:"object",additionalProperties:!0}}},StockLocationCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},admin_name:{type:"string",description:"Internal name shown only in the admin.",nullable:!0},active:{type:"boolean"},default:{type:"boolean",description:"Setting to true demotes the previous default."},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"Categorizes the location. The values listed are the built-in ones; extensions may add more."},propagate_all_variants:{type:"boolean"},backorderable_default:{type:"boolean"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO-3166 alpha-2 country code.",nullable:!0},state_code:{type:"string",description:"State or province abbreviation, resolved against the selected country's states.",nullable:!0},state_name:{type:"string",description:"Free-text state for countries that don't have a states list.",nullable:!0},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"],description:"`local` collects only items at this location; `any` lets items transfer in from other locations (ship-to-store)."},pickup_ready_in_minutes:{type:"integer",nullable:!0},returns_enabled:{type:"boolean",description:"Whether customers may send returns to this location."},pickup_instructions:{type:"string",nullable:!0}},required:["name"]},StockLocationUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},admin_name:{type:"string",description:"Internal name shown only in the admin.",nullable:!0},active:{type:"boolean"},default:{type:"boolean",description:"Setting to true demotes the previous default."},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"Categorizes the location. The values listed are the built-in ones; extensions may add more."},propagate_all_variants:{type:"boolean"},backorderable_default:{type:"boolean"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO-3166 alpha-2 country code.",nullable:!0},state_code:{type:"string",description:"State or province abbreviation, resolved against the selected country's states.",nullable:!0},state_name:{type:"string",description:"Free-text state for countries that don't have a states list.",nullable:!0},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"],description:"`local` collects only items at this location; `any` lets items transfer in from other locations (ship-to-store)."},pickup_ready_in_minutes:{type:"integer",nullable:!0},returns_enabled:{type:"boolean",description:"Whether customers may send returns to this location."},pickup_instructions:{type:"string",nullable:!0}}},StockReceiptCreateParams:{type:"object",properties:{reference:{type:"string",description:"The supplier's delivery note, or the carrier's reference.",nullable:!0},received_at:{type:"string",format:"date-time",description:"When the goods were counted in. Defaults to now.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockReceiptItemParams"},description:"Omit to book in everything still outstanding, intact. Naming lines, even none, records exactly what the dock counted: `quantity_accepted` reaches the shelf; `quantity_rejected` is refused, recorded with a `rejection_reason` and never stocked."}}},StockReceiptItemParams:{type:"object",properties:{id:{type:"string",description:"The purchase order or transfer line."},quantity_accepted:{type:"integer"},quantity_rejected:{type:"integer"},rejection_reason:{type:"string",enum:["damaged","wrong_item","expired","other"],nullable:!0},notes:{type:"string",nullable:!0}},required:["id"]},StockTransferCancelParams:{type:"object",properties:{on_in_transit:{type:"string",enum:["restock","write_off"],description:"Required once the units have left the source: either they come back (`restock`) or they are written off as lost (`write_off`)."},reason:{type:"string",description:"Recorded against the written-off lines.",nullable:!0}}},StockTransferCreateParams:{type:"object",properties:{source_location_id:{type:"string"},destination_location_id:{type:"string"},reference:{type:"string",description:"The merchant's own label for the trip. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItemParams"},description:"A draft may open empty and gain lines as the merchant packs. Sending the list replaces whatever the draft currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["source_location_id","destination_location_id"]},StockTransferItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity_shipped:{type:"integer"}},required:["variant_id","quantity_shipped"]},StockTransferMarkInTransitParams:{type:"object",properties:{force:{type:"boolean",description:"Ship even if it drives the source below zero."}}},StockTransferUpdateParams:{type:"object",properties:{source_location_id:{type:"string"},destination_location_id:{type:"string"},reference:{type:"string",description:"The merchant's own label for the trip. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItemParams"},description:"A draft may open empty and gain lines as the merchant packs. Sending the list replaces whatever the draft currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},StoreCreditApplyParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the customer's available store credit, up to the order total."}}},StoreUpdateParams:{type:"object",properties:{name:{type:"string"},seo_title:{type:"string",description:"The storefront's default page title, in the store's default language. Translate it through the translations endpoints.",nullable:!0},meta_description:{type:"string",description:"The storefront's default meta description, in the store's default language.",nullable:!0},admin_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"The language the dashboard opens in for every staff member; null lets each use their own.",nullable:!0},timezone:{allOf:[{$ref:"#/components/schemas/TimeZone"}]},weight_unit:{$ref:"#/components/schemas/WeightUnit"},unit_system:{type:"string",enum:["metric","imperial"]},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"The store-wide default for what anonymous visitors can see. Channels fall back to it when they don't set their own."},storefront_url:{type:"string",description:"The storefront's public URL, the base for links in customer emails. Saving it also completes the storefront setup task.",nullable:!0},guest_checkout:{type:"boolean",description:"The store-wide default for guest checkout. Channels fall back to it."},always_include_confirm_step:{type:"boolean",description:"Always show a confirmation step in checkout, even when no payment method requires one."},company_field_enabled:{type:"boolean",description:"Shows a company field on address forms."},address_requires_company:{type:"boolean",description:"Makes a company name mandatory on addresses."},address_requires_phone:{type:"boolean",description:"Makes a phone number mandatory on customer addresses."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"The store-wide default for when a customer is charged rather than only authorized. A payment method's own setting wins when set."},track_inventory_levels:{type:"boolean",description:"Counts on-hand quantities. Off means everything is treated as always available."},stock_reservations_enabled:{type:"boolean",description:"Holds stock for shoppers while they check out, so the same item can't be sold twice."},low_stock_threshold:{type:"integer",description:"On-hand units at or below which a tracked variant counts as low stock on the home screen; 0 turns the warning off."},tax_using_ship_address:{type:"boolean",description:"Calculates tax from the shipping address. When false, tax is calculated from the billing address."},track_price_history:{type:"boolean",description:"Records price changes for the EU Omnibus lowest-price-in-30-days display."},show_products_without_price:{type:"boolean",description:"Whether products with no price in the shopper's currency still appear in listings."},disable_sku_validation:{type:"boolean",description:"Lets more than one variant share the same SKU."},order_routing_strategy:{type:"string",description:"The store-wide order routing strategy shorthand. Channels fall back to it."},pricing_provider:{type:"string",description:"Where prices come from: a registered provider key, or `internal`."},inventory_provider:{type:"string",description:"Where stock levels come from: a registered provider key, or `internal`."},pricing_provider_failure_policy:{type:"string",enum:["fallback","strict"],description:"`strict` refuses to price when the provider cannot answer; `fallback` uses the catalog."},inventory_provider_failure_policy:{type:"string",enum:["fallback","strict"],description:"`fallback` sells on the local stock snapshot when the provider cannot answer; `strict` refuses."},payout_provider:{type:"string",description:"Blank means the built-in provider: the marketplace settles by hand."},default_payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"]},default_minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"In the store's currency."},auto_approve_sellers:{type:"boolean",description:"Admits a seller as soon as they finish onboarding, with no operator review."},auto_approve_seller_products:{type:"boolean",description:"Puts a seller product on sale the moment it is submitted, with no review."},seller_digital_assets_enabled:{type:"boolean",description:"Lets sellers attach downloadable files to their own products."},seller_digital_asset_content_types:{type:"array",items:{type:"string"},description:"The content types a seller's file may have, checked against the file's own signature where it has one. An entry names one type or, with `*` as the subtype, a whole family. The operator's own uploads are not restricted."},review_seller_digital_asset_changes:{type:"boolean",description:"Sends a seller product already on sale back to review when the seller adds or replaces a file on it."},send_seller_transactional_emails:{type:"boolean",description:"When false, transactional seller emails (approval, payouts and so on) are not sent."},default_commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:'Tax charged on commission as a fraction (`"0.23"` is 23%), when neither the commission rate nor the tax provider names one.'},document_number_format:{type:"string",description:"How document numbers are produced: `sequential` or `random`. Applies to every numbered document."},order_number_prefix:{type:"string",description:"Leads every order number. Uppercase letters, digits, dashes and # only."},order_number_suffix:{type:"string",description:"Ends every order number. Uppercase letters, digits, dashes and # only."},order_number_sequence_start:{type:"integer",description:"The first sequential order number. Only applies before the store's first order."},limit_digital_download_count:{type:"boolean",description:"Whether a digital download link stops working after a number of clicks."},digital_asset_authorized_clicks:{type:"integer",description:"How many clicks a download link allows, unless the file sets its own."},limit_digital_download_days:{type:"boolean",description:"Whether a digital download link expires after a number of days."},digital_asset_authorized_days:{type:"integer",description:"How many days a download link stays valid, unless the file sets its own."},mail_from_address:{type:"string",description:"Sender address of every transactional email."},customer_support_email:{type:"string",description:"Customer-facing reply-to address shown in the storefront and email footers.",nullable:!0},new_order_notifications_email:{type:"string",description:'Recipient of "new order placed" staff notifications.',nullable:!0},send_consumer_transactional_emails:{type:"boolean",description:"When false, transactional customer emails (order confirmation and so on) are not sent."},email_accent_color:{type:"string",description:"Customer email buttons and links, as `#RRGGBB`. Blank keeps the outlined buttons emails ship with.",nullable:!0},email_background_color:{type:"string",description:"Customer email page background, as `#RRGGBB`.",nullable:!0},email_card_color:{type:"string",description:"Customer email card behind the content, as `#RRGGBB`.",nullable:!0},email_text_color:{type:"string",description:"Customer email body text, as `#RRGGBB`.",nullable:!0},email_heading_color:{type:"string",description:"Customer email headings and emphasized text, as `#RRGGBB`.",nullable:!0},email_font:{type:"string",description:"Customer email font: `inter`, `system`, `helvetica`, `georgia`, `roboto`, `lato` or `merriweather`.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the store logo, or null to remove it.",nullable:!0},mailer_logo_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the logo in transactional emails, or null to remove it.",nullable:!0}}},SupplierCreateParams:{type:"object",properties:{name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],nullable:!0},postal_code:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["name"]},SupplierUpdateParams:{type:"object",properties:{name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],nullable:!0},postal_code:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},TaxCategoryCreateParams:{type:"object",properties:{name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"}},required:["name"]},TaxCategoryUpdateParams:{type:"object",properties:{name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"}}},TaxExemptionCertificateCreateParams:{type:"object",properties:{certificate_number:{type:"string"},tax_exemption_reason_id:{type:"string",description:"One of the store's active tax exemption reasons. The tax provider receives its `code`."},issuing_authority:{type:"string",nullable:!0},issued_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"Where the certificate holds. Omit it and `state_code` for one valid everywhere.",nullable:!0},state_code:{type:"string",nullable:!0},document_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`."},metadata:{type:"object",additionalProperties:!0}},required:["certificate_number","tax_exemption_reason_id"]},TaxExemptionCertificateUpdateParams:{type:"object",properties:{certificate_number:{type:"string"},tax_exemption_reason_id:{type:"string",description:"One of the store's active tax exemption reasons. The tax provider receives its `code`."},issuing_authority:{type:"string",nullable:!0},issued_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"Where the certificate holds. Omit it and `state_code` for one valid everywhere.",nullable:!0},state_code:{type:"string",nullable:!0},document_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`."},metadata:{type:"object",additionalProperties:!0}}},TaxExemptionReasonCreateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."},code:{type:"string",description:"What the tax provider receives for every certificate holding this reason \u2014 for Avalara, an entity use code such as `G`. Saved in capitals. Changing it changes what those certificates send from then on."},metadata:{type:"object",additionalProperties:!0}},required:["name","code"]},TaxExemptionReasonUpdateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."},code:{type:"string",description:"What the tax provider receives for every certificate holding this reason \u2014 for Avalara, an entity use code such as `G`. Saved in capitals. Changing it changes what those certificates send from then on."},metadata:{type:"object",additionalProperties:!0}}},TaxIdentifierCreateParams:{type:"object",properties:{kind:{type:"string",description:"The registration the number belongs to, such as `eu_vat` or `gb_vat`. Any kind is accepted; one with a registered validator is checked by it. Built-in: `eu_vat`. Extensions may register more."},value:{type:"string"}},required:["kind","value"]},TaxIdentifierUpdateParams:{type:"object",properties:{kind:{type:"string",description:"The registration the number belongs to, such as `eu_vat` or `gb_vat`. Any kind is accepted; one with a registered validator is checked by it. Built-in: `eu_vat`. Extensions may register more."},value:{type:"string"}}},TaxRateCreateParams:{type:"object",properties:{name:{type:"string",description:"Customer-facing rate name."},rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a fraction. Send this or `rate_percent`."},rate_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a percentage."},show_rate_in_label:{type:"boolean"},tax_category_id:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO country code. A rate naming no country taxes everywhere.",nullable:!0},state_code:{type:"string",description:"State abbreviation within that country.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["name","tax_category_id"]},TaxRateUpdateParams:{type:"object",properties:{name:{type:"string",description:"Customer-facing rate name."},rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a fraction. Send this or `rate_percent`."},rate_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a percentage."},show_rate_in_label:{type:"boolean"},tax_category_id:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO country code. A rate naming no country taxes everywhere.",nullable:!0},state_code:{type:"string",description:"State abbreviation within that country.",nullable:!0},metadata:{type:"object",additionalProperties:!0}}},TranslationBatchEntryParams:{type:"object",properties:{resource_type:{type:"string",description:"Translatable resource type token, e.g. `option_type`."},resource_id:{type:"string"},values:{type:"object",additionalProperties:!0,description:"Translated fields keyed by locale code, then by field name."}},required:["resource_type","resource_id","values"]},TranslationBatchParams:{type:"object",properties:{translations:{type:"array",items:{$ref:"#/components/schemas/TranslationBatchEntryParams"},description:"At least one entry. All entries are saved, or none are."}},required:["translations"]},VariantCreateParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing. On update, omit to leave the option values untouched."},external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."}},required:["options"]}]},VariantOptionParams:{type:"object",properties:{name:{type:"string"},value:{type:"string"}},required:["name","value"]},VariantParams:{type:"object",properties:{sku:{type:"string"},barcode:{type:"string"},cost_price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},cost_currency:{$ref:"#/components/schemas/CurrencyCode"},weight:{type:"number",nullable:!0},height:{type:"number",nullable:!0},width:{type:"number",nullable:!0},depth:{type:"number",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],description:"Null falls back to the store's weight unit.",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Null falls back to the store's unit system.",nullable:!0},hs_code:{type:"string"},customs_description:{type:"string"},country_of_origin:{$ref:"#/components/schemas/CountryCode"},minimum_order_quantity:{type:"integer",nullable:!0},order_multiple:{type:"integer",nullable:!0},purchase_unit:{type:"string",enum:["unit","carton"],nullable:!0},units_per_carton:{type:"integer",description:"How many units fill one carton.",nullable:!0},carton_package_type_id:{type:"string",description:"The carton this variant is packed into: a package type of kind `carton`. Its dimensions are shared by every product packed the same way, so a corrected carton size fixes all of them at once.",nullable:!0},carton_weight:{type:"number",description:"What one packed carton weighs, in the variant's weight unit.",nullable:!0},cartons_per_pallet:{type:"integer",description:"How many cartons stack on one pallet.",nullable:!0},track_inventory:{type:"boolean"},preorderable:{type:"boolean",description:"Sell this variant before it's in stock. Adds the pre-order label and ships-by promise; the cap comes from `backorder_limit`, an incoming stock count, or backorder."},preorder_ships_at:{type:"string",format:"date-time",description:'The "ships by" date shown to customers while the variant is a pre-order. Once it passes, the variant is no longer a pre-order. Null clears it.',nullable:!0},backorder_limit:{type:"integer",description:"Maximum units sellable beyond available stock, capping backorders and pre-orders. Null is unlimited.",nullable:!0},position:{type:"integer"},options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing."},seller_id:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},tax_category_id:{type:"string"},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Per-currency prices. Upserted by currency."},stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevelParams"},description:"Stock per location. Upserted by location; omitted locations are removed."}}},VariantSalesContextParams:{type:"object",properties:{order_id:{type:"string",description:"A draft order to sell to: lists only what its buyer can be sold on its channel, priced in its market. Needs `read_orders`, and cannot be combined with the fields below."},market_id:{type:"string",description:"Prices in this market and lists only variants with a price in its currency."},channel_id:{type:"string",description:"Lists only variants published on this channel. When a market, customer, company or currency is given without it, the store default channel applies; an order uses its own."},customer_id:{type:"string",description:"Narrows to the customer's catalogs and prices as they would pay. Needs `read_customers`."},company_id:{type:"string",description:"Narrows to the company's catalogs and prices under its agreement. Needs `read_customers`."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Lists only variants with a price in this currency. With `market_id` it must be the market's currency."}}},VariantUpdateParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing. On update, omit to leave the option values untouched."},external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."}}}]},WebhookEndpointCreateParams:{type:"object",properties:{name:{type:"string",description:"A label shown in the dashboard list.",nullable:!0},url:{type:"string",description:"HTTPS destination URL. It cannot resolve to a private IP address outside development."},active:{type:"boolean",description:"Defaults to true on create. Prefer the disable and enable endpoints to pause one."},subscriptions:{type:"array",items:{type:"string"},description:'Event names this endpoint receives. An empty list or `["*"]` subscribes to every event; otherwise list exact names (`order.completed`) or patterns with `*` in place of a segment (`order.*`, `*.created`). At most 200 entries of up to 100 characters.'}},required:["url"]},WebhookEndpointDisableParams:{type:"object",properties:{reason:{type:"string",description:'Shown next to the disabled indicator. Defaults to "Manually disabled".'}}},WebhookEndpointUpdateParams:{type:"object",properties:{name:{type:"string",description:"A label shown in the dashboard list.",nullable:!0},url:{type:"string",description:"HTTPS destination URL. It cannot resolve to a private IP address outside development."},active:{type:"boolean",description:"Defaults to true on create. Prefer the disable and enable endpoints to pause one."},subscriptions:{type:"array",items:{type:"string"},description:'Event names this endpoint receives. An empty list or `["*"]` subscribes to every event; otherwise list exact names (`order.completed`) or patterns with `*` in place of a segment (`order.*`, `*.created`). At most 200 entries of up to 100 characters.'}}}}}};var Zy=new Set(["get","post","put","patch","delete"]);function Ga(){return zy}function fT(e){let t=e.description?.match(/\*\*Required scope:\*\* (.+?) \(for API-key authentication\)\./);return t?t[1].replaceAll("`",""):"\u2014"}function Yy(e,t={}){let r=[];for(let[n,i]of Object.entries(e.paths)){let a=n.replace("/api/v3/admin","")||"/";for(let[s,o]of Object.entries(i)){if(!Zy.has(s))continue;if(t.resource){let l=a.split("/")[1]??"";if(l!==t.resource&&!l.startsWith(t.resource))continue}let d=o.summary??"";t.search&&!`${s} ${a} ${d}`.toLowerCase().includes(t.search.toLowerCase())||r.push({method:s.toUpperCase(),path:a,scope:fT(o),summary:d})}}return r}function Jy(e,t){let r=t.trim().split(/\s+/),n=r.length>1?r[0].toLowerCase():void 0,i=r.length>1?r[1]:r[0],a=In(i),s=Vy(e,n,o=>o===a);return s.length>0?s:Vy(e,n,o=>gT(o,a))}function Vy(e,t,r){let n=[];for(let[i,a]of Object.entries(e.paths)){let s=i.replace("/api/v3/admin","")||"/";if(r(s))for(let[o,d]of Object.entries(a))Zy.has(o)&&(t&&o!==t||n.push({method:o.toUpperCase(),path:s,summary:d.summary,description:d.description,parameters:Or(d.parameters,e),requestBody:Or(d.requestBody,e),responses:Or(d.responses,e)}))}return n}function gT(e,t){if(e===t)return!0;let r=e.split("/"),n=t.split("/");return r.length!==n.length?!1:r.every((i,a)=>i.startsWith("{")&&i.endsWith("}")?n[a].length>0:i===n[a])}var bT=8;function Or(e,t,r=[]){if(Array.isArray(e))return e.map(s=>Or(s,t,r));if(!e||typeof e!="object")return e;let n=e,i=n.$ref;if(typeof i=="string"){let s=i.replace("#/components/schemas/","");return r.includes(s)||r.length>=bT||!(s in t.components.schemas)?{$ref:i}:Or(t.components.schemas[s],t,[...r,s])}let a={};for(let[s,o]of Object.entries(n))a[s]=Or(o,t,r);return a}function kT(e,t){return[...t,e]}function Qy(e){return e.option("--profile <name>","use a saved profile (see `spree auth`)").option("--base-url <url>","store URL (overrides profile/env/project)").option("--api-key <key>","secret API key (prefer SPREE_API_KEY \u2014 flags leak into shell history)").option("--store-id <id>","X-Spree-Store-Id for hosts serving multiple stores")}function e_(){return new Ae("--format <format>","output format").choices(["json","table"]).default("json")}function jd(e){return Qy(e).addOption(e_())}async function Od(e){let t=await xn({baseUrl:e.baseUrl,apiKey:e.apiKey,profile:e.profile});return{client:An({baseUrl:t.baseUrl,secretKey:t.apiKey,...e.storeId?{storeId:e.storeId}:{}}),credentials:t}}function t_(e){let t=e.command("api").description("Call the Admin API directly (generic get/post/patch/delete)");t.addHelpText("after",["","Examples:","  spree api get /products -q status_eq=active --limit 10",`  spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'`,"  spree api get /orders/ord_x8k2J9aQ --expand items,payments","  spree api upload ./products.csv --private   # prints a signed_id to pass to another endpoint","","Discover the surface (offline, no server needed):","  spree api endpoints --search <term>   # find endpoints + required scopes",'  spree api schema "POST /orders"       # request/response schema for one operation',"  spree completion zsh                  # tab-completion for paths, filters, scopes"].join(`
+`,responses:{"200":{description:"metadata",content:{"application/json":{schema:{$ref:"#/components/schemas/OauthProtectedResource"}}}},"404":{description:"no such protected surface"}}}}},components:{schemas:{PaginationMeta:{type:"object",properties:{page:{type:"integer"},limit:{type:"integer"},count:{type:"integer",description:"Total number of records"},pages:{type:"integer",description:"Total number of pages"},from:{type:"integer",description:"Index of first record on this page"},to:{type:"integer",description:"Index of last record on this page"},in:{type:"integer",description:"Number of records on this page"},previous:{type:"integer",nullable:!0,description:"Previous page number"},next:{type:"integer",nullable:!0,description:"Next page number"}},required:["page","limit","count","pages","from","to","in"]},ErrorResponse:{type:"object",properties:{error:{type:"object",properties:{code:{type:"string"},message:{type:"string"},details:{type:"object",description:"Field-specific validation errors",nullable:!0}},required:["code","message"]}},required:["error"]},AuthResponse:{type:"object",properties:{token:{type:"string",description:"JWT access token"},user:{$ref:"#/components/schemas/AdminUser"}},required:["token","user"]},PermissionRule:{type:"object",description:"A single permission rule (CanCanCan rule). Rules are applied in order, last-matching-wins.",properties:{allow:{type:"boolean",description:"true for `can`, false for `cannot`"},actions:{type:"array",items:{type:"string"},description:'Action names, e.g. ["read", "update"] or ["manage"]'},subjects:{type:"array",items:{type:"string"},description:'Subject short names, e.g. ["product"] or ["all"]'},has_conditions:{type:"boolean",description:"True if the server-side rule has per-record conditions. The SPA shows the action optimistically and handles 403 from the API."}},required:["allow","actions","subjects","has_conditions"]},ImportSchemaField:{type:"object",description:"A canonical column of an import type, including per-store custom field columns",properties:{name:{type:"string",description:"Canonical field name used in mappings"},label:{type:"string",description:"Human-readable label"},required:{type:"boolean",description:"Whether the field must be mapped before processing"}},required:["name","label","required"]},CheckoutRequirement:{type:"object",properties:{step:{type:"string",description:"Checkout step this requirement belongs to"},field:{type:"string",description:"Field that needs to be satisfied"},message:{type:"string",description:"Human-readable requirement message"}},required:["step","field","message"]},CartWarning:{type:"object",description:"A warning about a cart issue (e.g., item removed due to stock change)",properties:{code:{type:"string",description:"Machine-readable warning code"},message:{type:"string",description:"Human-readable warning message"},line_item_id:{type:"string",nullable:!0,description:"Prefixed line item ID (when applicable)"},variant_id:{type:"string",nullable:!0,description:"Prefixed variant ID (when applicable)"},item_index:{type:"integer",nullable:!0,description:"Position in the submitted items array, for warnings raised while applying a batch of item changes"}},required:["code","message"]},FulfillmentManifestItem:{type:"object",description:"An item within a fulfillment \u2014 which line item and how many units are in this fulfillment",properties:{item_id:{type:"string",description:"Line item ID"},variant_id:{type:"string",description:"Variant ID"},quantity:{type:"integer",description:"Quantity in this fulfillment"}},required:["item_id","variant_id","quantity"]},AdminUserRoleAssignment:{type:"object",description:"A role assignment for the current store on a staff member",properties:{id:{type:"string",description:"Prefixed role ID"},name:{type:"string",description:"Role name"}},required:["id","name"]},AdminUserStore:{type:"object",description:"A store the staff member can access through a role assignment",properties:{id:{type:"string",description:"Prefixed store ID"},name:{type:"string",description:"Store name"},code:{type:"string",description:"Store code"}},required:["id","name","code"]},PreferenceSchema:{type:"object",description:"The JSON Schema (draft 2020-12) of a type's `preferences`: one property per setting, with `format` (`money`, `currency`, `iso-country`, `prefixed-id`, \u2026), `enum`, `default`, `x-spree-secret` for a secret and `x-spree-prefix` for an id list. Unknown keys are refused.",additionalProperties:!0},PromotionActionLineItem:{type:"object",description:"One row in a `create_line_items` action \u2014 the variant added to the order and how many",properties:{variant_id:{type:"string"},quantity:{type:"integer"}},required:["variant_id","quantity"]},MeResponse:{type:"object",description:"Current admin user profile and serialized permissions",properties:{user:{$ref:"#/components/schemas/AdminUser"},permissions:{type:"array",items:{$ref:"#/components/schemas/PermissionRule"}}},required:["user","permissions"]},Actor:{type:"object",properties:{id:{type:"string"},type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},label:{type:"string",nullable:!0}},required:["id","type","label"],"x-typelizer":!0},AddressOwner:{type:"object",properties:{id:{type:"string"},type:{anyOf:[{type:"string",enum:["customer","company","seller"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},name:{type:"string",nullable:!0}},required:["id","type","name"],"x-typelizer":!0},Address:{type:"object",properties:{id:{type:"string"},label:{type:"string",nullable:!0},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},postal_code:{type:"string",nullable:!0},city:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_name:{type:"string"},country_code:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_text:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean"},is_default_shipping:{type:"boolean"},state_name:{type:"string",nullable:!0},owner:{allOf:[{$ref:"#/components/schemas/AddressOwner"}],nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},latitude:{type:"number",nullable:!0},longitude:{type:"number",nullable:!0},customer_id:{type:"string",nullable:!0}},required:["id","label","first_name","last_name","full_name","address1","address2","postal_code","city","phone","company","country_name","country_code","state_text","state_code","quick_checkout","is_default_billing","is_default_shipping","state_name","owner","metadata","created_at","updated_at","latitude","longitude","customer_id"],"x-typelizer":!0},AdminUser:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string",nullable:!0},selected_locale:{type:"string",nullable:!0},status:{type:"string",enum:["active","locked","deactivated"]},created_at:{type:"string"},updated_at:{type:"string"},last_active_at:{type:"string",nullable:!0},sessions:{type:"array",items:{$ref:"#/components/schemas/Session"}},inviter:{allOf:[{$ref:"#/components/schemas/Actor"}],nullable:!0},avatar_url:{type:"string",nullable:!0},roles:{type:"array",items:{$ref:"#/components/schemas/AdminUserRoleAssignment"}},stores:{type:"array",items:{$ref:"#/components/schemas/AdminUserStore"}}},required:["id","email","first_name","last_name","full_name","selected_locale","status","created_at","updated_at","last_active_at","avatar_url","roles","stores"],"x-typelizer":!0},AllowedOrigin:{type:"object",properties:{id:{type:"string"},origin:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","origin","created_at","updated_at"],"x-typelizer":!0},ApiKey:{type:"object",properties:{id:{type:"string"},name:{type:"string"},key_type:{type:"string",enum:["publishable","secret"]},token_prefix:{type:"string",nullable:!0},scopes:{type:"array",items:{type:"string"}},created_at:{type:"string"},updated_at:{type:"string"},revoked_at:{type:"string",nullable:!0},last_used_at:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},plaintext_token:{type:"string",nullable:!0},created_by_email:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by_label:{type:"string",nullable:!0}},required:["id","name","key_type","token_prefix","scopes","created_at","updated_at","revoked_at","last_used_at","channel_id","plaintext_token","created_by_email","created_by_type","created_by_label"],"x-typelizer":!0},AppliedPromotion:{type:"object",properties:{id:{type:"string"},promotion_id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",nullable:!0},amount:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","promotion_id","name","description","code","amount","created_at","updated_at"],"x-typelizer":!0},Cart:{type:"object",properties:{id:{type:"string"},market_id:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},preferred_stock_location_id:{type:"string",nullable:!0},company_id:{type:"string",nullable:!0},company_name:{type:"string",nullable:!0},po_number_required:{type:"boolean"},po_document_filename:{type:"string",nullable:!0},po_document_byte_size:{type:"number",nullable:!0},token:{type:"string"},email:{type:"string",nullable:!0},customer_note:{type:"string",nullable:!0},po_number:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},total_quantity:{type:"number"},warnings:{type:"array",items:{$ref:"#/components/schemas/CartWarning"}},coupon_code:{type:"string",nullable:!0},item_total:{type:"string",nullable:!0,description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",nullable:!0,description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",nullable:!0,description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",nullable:!0,description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",nullable:!0,description:"Tax added on top of the prices."},delivery_total:{type:"string",nullable:!0,description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",nullable:!0,description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",nullable:!0,description:"What a gift card pays."},store_credit_total:{type:"string",nullable:!0,description:"What store credit pays, apart from gift cards."},total:{type:"string",nullable:!0,description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",nullable:!0,description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},adjustment_total:{type:"string",nullable:!0,description:"Every discount, fee and added tax together, as one amount."},current_step:{type:"string"},completed_steps:{type:"array",items:{type:"string"}},requirements:{type:"array",items:{$ref:"#/components/schemas/CheckoutRequirement"}},order_minimum:{type:"string",nullable:!0},order_minimum_shortfall:{type:"string",nullable:!0},below_order_minimum:{type:"boolean",nullable:!0},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0},shipping_eq_billing_address:{type:"boolean"},items:{type:"array",items:{$ref:"#/components/schemas/LineItem"}},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0},completed_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},applied_promotions:{type:"array",items:{$ref:"#/components/schemas/AppliedPromotion"}}},required:["id","market_id","channel_id","preferred_stock_location_id","company_id","company_name","po_number_required","po_document_filename","po_document_byte_size","token","email","customer_note","po_number","currency","locale","total_quantity","warnings","coupon_code","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","adjustment_total","current_step","completed_steps","requirements","order_minimum","order_minimum_shortfall","below_order_minimum","freight_summary","shipping_eq_billing_address","items","billing_address","shipping_address","market","completed_at","created_at","updated_at","applied_promotions"],"x-typelizer":!0},CatalogAssignment:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},catalog_id:{type:"string"},assignable_type:{type:"string",enum:["customer_group","company"]},assignable_id:{type:"string"},assignable_name:{type:"string",nullable:!0}},required:["id","created_at","catalog_id","assignable_type","assignable_id","assignable_name"],"x-typelizer":!0},CatalogOrderMinimum:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"}},required:["id","currency","created_at","updated_at","amount"],"x-typelizer":!0},CatalogPrice:{type:"object",properties:{id:{type:"string",nullable:!0},label:{type:"string",nullable:!0},sku:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},source:{type:"string",enum:["explicit","automatic","base"]},break_count:{type:"number"},amount:{type:"string"},tiers:{type:"array",items:{$ref:"#/components/schemas/CatalogPriceTier"}}},required:["id","label","sku","currency","source","break_count","amount","tiers"],"x-typelizer":!0},CatalogPriceTier:{type:"object",properties:{min_quantity:{type:"number"},amount:{type:"string"}},required:["min_quantity","amount"],"x-typelizer":!0},CatalogProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0},quantity_rule:{allOf:[{$ref:"#/components/schemas/CatalogProductTerm"}],nullable:!0},catalog_variants:{type:"array",items:{$ref:"#/components/schemas/CatalogPrice"}}},required:["id","name","thumbnail_url"],"x-typelizer":!0},CatalogProductTerm:{type:"object",properties:{id:{type:"string"},product_id:{type:"string"},product_name:{type:"string",nullable:!0},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},mixed:{type:"boolean"}},required:["id","product_id","product_name","minimum_order_quantity","order_multiple","mixed"],"x-typelizer":!0},CatalogQuantityRule:{type:"object",properties:{id:{type:"string"},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},variant_id:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},product_name:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0}},required:["id","minimum_order_quantity","order_multiple","created_at","updated_at","variant_id","variant_sku","product_name","options_text"],"x-typelizer":!0},Catalog:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},position:{type:"number",nullable:!0},metadata:{type:"object",nullable:!0},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},products_count:{type:"number"},pricing_strategy:{type:"string"},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimum"}},price_list:{$ref:"#/components/schemas/PriceList"},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignment"}}},required:["id","name","description","active","position","metadata","minimum_order_quantity","order_multiple","created_at","updated_at","products_count","pricing_strategy"],"x-typelizer":!0},Category:{type:"object",properties:{id:{type:"string"},name:{type:"string"},permalink:{type:"string"},position:{type:"number"},depth:{type:"number"},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},children_count:{type:"number"},parent_id:{type:"string",nullable:!0},description:{type:"string"},description_html:{type:"string"},image_url:{type:"string",nullable:!0},square_image_url:{type:"string",nullable:!0},is_root:{type:"boolean"},is_child:{type:"boolean"},is_leaf:{type:"boolean"},parent:{$ref:"#/components/schemas/Category"},children:{type:"array",items:{$ref:"#/components/schemas/Category"}},ancestors:{type:"array",items:{$ref:"#/components/schemas/Category"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},translations:{type:"object"},metadata:{type:"object"},pretty_name:{type:"string"},lft:{type:"number"},rgt:{type:"number"},products_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","name","permalink","position","depth","meta_title","meta_description","meta_keywords","children_count","parent_id","description","description_html","image_url","square_image_url","is_root","is_child","is_leaf","external_references","metadata","pretty_name","lft","rgt","products_count","created_at","updated_at"],"x-typelizer":!0},Channel:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string"},active:{type:"boolean"},default:{type:"boolean"},storefront_access:{type:"string",nullable:!0,enum:["public","prices_hidden","login_required"]},guest_checkout:{type:"boolean",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},order_routing_strategy:{type:"string",nullable:!0,description:"Order routing strategy; null inherits the store setting. Built-in: rules. Extensions may register more."},stock_location_ids:{type:"array",items:{type:"string"}},default_catalog_id:{type:"string",nullable:!0}},required:["id","name","code","active","default","storefront_access","guest_checkout","created_at","updated_at","order_routing_strategy","stock_location_ids","default_catalog_id"],"x-typelizer":!0},ClaimLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},send_replacement:{type:"boolean"},description:{type:"string",nullable:!0},refund_amount:{type:"string"},paid_amount:{type:"string"},pre_tax_amount:{type:"string"},included_tax_total:{type:"string"},additional_tax_total:{type:"string"},tax_total:{type:"string"},variant_id:{type:"string",nullable:!0},replacement_variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"},replacement_variant:{$ref:"#/components/schemas/Variant"}},required:["id","quantity","send_replacement","description","refund_amount","paid_amount","pre_tax_amount","included_tax_total","additional_tax_total","tax_total","variant_id","replacement_variant_id","line_item_id","created_at","updated_at"],"x-typelizer":!0},ClaimReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Claim:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["open","approved","resolved","denied","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},resolution:{type:"string",nullable:!0,enum:["refund","replacement","refund_and_replacement"]},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},refund_total:{type:"string"},approved_at:{type:"string",nullable:!0},resolved_at:{type:"string",nullable:!0},denied_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ClaimReason"},claim_line_items:{type:"array",items:{$ref:"#/components/schemas/ClaimLineItem"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},order:{$ref:"#/components/schemas/Order"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}}},required:["id","number","status","resolution","order_id","reason_id","refund_total","approved_at","resolved_at","denied_at","canceled_at","memo","metadata","created_at","updated_at","created_by_id","created_by_type"],"x-typelizer":!0},CollectionRule:{type:"object",properties:{id:{type:"string"},value:{type:"string",nullable:!0},match_policy:{type:"string",enum:["is_equal_to","is_not_equal_to","contains","does_not_contain"]},type:{type:"string",description:"Rule type. Built-in: tag, available_on, sale. Extensions may register more."}},required:["id","value","match_policy","type"],"x-typelizer":!0},Collection:{type:"object",properties:{id:{type:"string"},name:{type:"string"},permalink:{type:"string"},position:{type:"number"},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"]},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},products_count:{type:"number"},description:{type:"string"},description_html:{type:"string"},image_url:{type:"string",nullable:!0},square_image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},translations:{type:"object"},automatic:{type:"boolean"},rules_match_policy:{type:"string",enum:["all","any"]},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRule"}}},required:["id","name","permalink","position","sort_order","meta_title","meta_description","meta_keywords","products_count","description","description_html","image_url","square_image_url","automatic","rules_match_policy","metadata","created_at","updated_at"],"x-typelizer":!0},CommissionLine:{type:"object",properties:{id:{type:"string"},kind:{type:"string",enum:["percentage","fixed"]},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},taxability_reason:{anyOf:[{type:"string",enum:["standard_rated","reduced_rated","zero_rated","reverse_charge","intra_community_supply","export","customer_exempt","product_exempt","not_collecting","not_subject_to_tax"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},rate:{type:"string"},tax_rate:{type:"string"},amount:{type:"string"},tax_amount:{type:"string"},total:{type:"string"},order_id:{type:"string"},seller_id:{type:"string"},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},commission_rate_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},commission_rate:{$ref:"#/components/schemas/CommissionRate"}},required:["id","kind","currency","taxability_reason","country_code","state_code","created_at","updated_at","rate","tax_rate","amount","tax_amount","total","order_id","seller_id","line_item_id","fulfillment_id","commission_rate_id","seller_name"],"x-typelizer":!0},CommissionRate:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string",nullable:!0},enabled:{type:"boolean"},position:{type:"number"},kind:{type:"string",enum:["percentage","fixed"]},tax_inclusive:{type:"boolean"},include_shipping:{type:"boolean"},metadata:{type:"object",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},value:{type:"string"},commission_tax_rate:{type:"string",nullable:!0},amounts:{type:"object"},bounds:{type:"object"},global:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRule"}}},required:["id","name","code","enabled","position","kind","tax_inclusive","include_shipping","metadata","deleted_at","created_at","updated_at","value","commission_tax_rate","amounts","bounds","global","rules"],"x-typelizer":!0},CommissionRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: seller_rule, category_rule, product_rule, item_total_rule. Extensions may register more."},commission_rate_id:{type:"string"},preferences:{$ref:"#/components/schemas/CommissionRulePreferences"},product_ids:{type:"array",items:{type:"string"},nullable:!0},seller_ids:{type:"array",items:{type:"string"},nullable:!0},category_ids:{type:"array",items:{type:"string"},nullable:!0},sellers:{type:"array",items:{$ref:"#/components/schemas/Seller"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}}},required:["id","created_at","updated_at","type","commission_rate_id","preferences","product_ids","seller_ids","category_ids"],"x-typelizer":!0},CompanyInvitation:{type:"object",properties:{id:{type:"string"},email:{type:"string"},expires_at:{type:"string",nullable:!0},company_id:{type:"string"},status:{type:"string",enum:["pending","accepted","revoked","expired"]},accepted_at:{type:"string",nullable:!0},revoked_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","email","expires_at","company_id","status","accepted_at","revoked_at","created_at","updated_at"],"x-typelizer":!0},CompanyMembership:{type:"object",properties:{id:{type:"string"},company_id:{type:"string"},customer_id:{type:"string"},email:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","company_id","customer_id","email","created_at","updated_at"],"x-typelizer":!0},Company:{type:"object",properties:{id:{type:"string"},name:{type:"string"},kind:{type:"string",enum:["company","division"]},po_number_required:{type:"boolean"},parent_id:{type:"string",nullable:!0},ancestors:{type:"array",items:{type:"object"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},children_count:{type:"number"},members_count:{type:"number"},children:{type:"array",items:{$ref:"#/components/schemas/Company"}},addresses:{type:"array",items:{$ref:"#/components/schemas/Address"}},memberships:{type:"array",items:{$ref:"#/components/schemas/CompanyMembership"}}},required:["id","name","kind","po_number_required","parent_id","ancestors","external_references","metadata","created_at","updated_at","children_count","members_count"],"x-typelizer":!0},ConsentRecord:{type:"object",properties:{id:{type:"string"},purpose:{type:"string"},source:{type:"string",enum:["checkout","registration","account","admin","newsletter","anonymization","unknown","import","storefront"]},accepted:{type:"boolean"},email:{type:"string",nullable:!0},ip_address:{type:"string",nullable:!0},created_at:{type:"string"},recorded_at:{type:"string",nullable:!0},documents:{type:"array",items:{type:"object"}}},required:["id","purpose","source","accepted","email","ip_address","created_at","recorded_at","documents"],"x-typelizer":!0},Country:{type:"object",properties:{iso:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},iso3:{type:"string"},states_required:{type:"boolean"},zipcode_required:{type:"boolean"},states:{type:"array",items:{$ref:"#/components/schemas/State"}},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0}},required:["iso","iso3","states_required","zipcode_required"],"x-typelizer":!0},CouponCode:{type:"object",properties:{id:{type:"string"},code:{type:"string"},state:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},promotion_id:{type:"string"},order_id:{type:"string",nullable:!0}},required:["id","code","state","created_at","updated_at","promotion_id","order_id"],"x-typelizer":!0},CreditCard:{type:"object",properties:{id:{type:"string"},brand:{type:"string"},last4:{type:"string"},month:{type:"number"},year:{type:"number"},name:{type:"string",nullable:!0},default:{type:"boolean"},gateway_payment_profile_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},customer_id:{type:"string",nullable:!0},payment_method_id:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","brand","last4","month","year","name","default","gateway_payment_profile_id","customer_id","payment_method_id","metadata","created_at","updated_at"],"x-typelizer":!0},CustomFieldDefinition:{type:"object",properties:{id:{type:"string"},namespace:{type:"string"},key:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},storefront_visible:{type:"boolean"},searchable:{type:"boolean"},sortable:{type:"boolean"},filter_key:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, for example product, variant, order, customer or category. Discover the full list from the resource_types endpoint; extensions may register more."}},required:["id","namespace","key","label","field_type","storefront_visible","searchable","sortable","filter_key","created_at","updated_at","resource_type"],"x-typelizer":!0},CustomField:{type:"object",properties:{id:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},key:{type:"string"},value:{},created_at:{type:"string"},updated_at:{type:"string"},storefront_visible:{type:"boolean"},custom_field_definition_id:{type:"string"}},required:["id","label","field_type","key","value","created_at","updated_at","storefront_visible","custom_field_definition_id"],"x-typelizer":!0},CustomerGroup:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},customers_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}}},required:["id","name","description","customers_count","created_at","updated_at"],"x-typelizer":!0},Customer:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},accepts_email_marketing:{type:"boolean"},email_marketing_consent_updated_at:{type:"string",nullable:!0},full_name:{type:"string"},available_store_credit_total:{type:"string"},addresses:{type:"array",items:{$ref:"#/components/schemas/Address"}},default_billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},default_shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},newsletter_subscriber:{allOf:[{$ref:"#/components/schemas/NewsletterSubscriber"}],nullable:!0},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},failed_attempts:{type:"number"},metadata:{type:"object"},email_marketing_consent_source:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},anonymized_at:{type:"string",nullable:!0},anonymized:{type:"boolean"},tags:{type:"array",items:{type:"string"}},internal_note:{type:"string",nullable:!0},internal_note_html:{type:"string",nullable:!0},default_billing_address_id:{type:"string",nullable:!0},default_shipping_address_id:{type:"string",nullable:!0},orders_count:{type:"number"},total_spent:{type:"string"},last_order_completed_at:{type:"string",nullable:!0},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}},store_credits:{type:"array",items:{$ref:"#/components/schemas/StoreCredit"}},customer_group_ids:{type:"array",items:{type:"string"}},companies:{type:"array",items:{$ref:"#/components/schemas/Company"}}},required:["id","email","first_name","last_name","phone","accepts_email_marketing","email_marketing_consent_updated_at","full_name","available_store_credit_total","failed_attempts","metadata","email_marketing_consent_source","created_at","updated_at","anonymized_at","anonymized","tags","internal_note","internal_note_html","default_billing_address_id","default_shipping_address_id","orders_count","total_spent","last_order_completed_at","customer_group_ids"],"x-typelizer":!0},DashboardCounter:{type:"object",properties:{key:{type:"string",description:"Registered counter name. The dashboard translates it; built-in: orders_to_fulfill, payments_to_collect, open_returns, open_exchanges, open_claims, low_stock_items, out_of_stock_items."},value:{type:"number"},link:{type:"object",nullable:!0,description:"The list filter that shows exactly the rows counted, or null when no list can."},nav:{type:"string",nullable:!0,description:"Sidebar entry key this count badges, or null."}},required:["key","value","link","nav"],"x-typelizer":!0},DataRequest:{type:"object",properties:{id:{type:"string"},number:{type:"string"},kind:{type:"string",enum:["access","erasure"]},status:{anyOf:[{type:"string",enum:["awaiting_confirmation","pending","processing","completed","failed","lapsed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},requested_at:{type:"string",nullable:!0},completed_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},email:{type:"string"},error_message:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},customer_id:{type:"string",nullable:!0},requested_by_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"}},required:["id","number","kind","status","requested_at","completed_at","expires_at","email","error_message","created_at","updated_at","customer_id","requested_by_id"],"x-typelizer":!0},DeliveryMethodRule:{type:"object",properties:{id:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule, channel_rule, volume_rule, company_rule. Extensions may register more."},preferences:{$ref:"#/components/schemas/DeliveryMethodRulePreferences"},product_ids:{type:"array",items:{type:"string"}}},required:["id","active","created_at","updated_at","type","preferences","product_ids"],"x-typelizer":!0},DeliveryMethod:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"number",nullable:!0},estimated_transit_business_days_max:{type:"number",nullable:!0},digital:{type:"boolean"},pickup:{type:"boolean"},pickup_point:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},admin_name:{type:"string",nullable:!0},storefront_visible:{type:"boolean"},tracking_url:{type:"string",nullable:!0},available_to_sellers:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string"},markup_flat:{type:"string",nullable:!0},markup_percent:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodService"}},rules:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodRule"}},tax_category_id:{type:"string",nullable:!0},delivery_profile_id:{type:"string"},delivery_origin_group_id:{type:"string",nullable:!0},delivery_zone_id:{type:"string",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"}},fulfillment_provider:{type:"string",description:"Fulfillment provider. Built-in: manual, digital, pickup, pickup_point. Provider gems register more (e.g. easy_post)."},pickup_point_provider:{type:"string",nullable:!0,description:"Pickup point network. None built in; provider gems register them."},rate_provider:{type:"string",nullable:!0,description:"Rate provider; null prices through the calculator. Built-in: internal, freight. Provider gems register more (e.g. easy_post)."},calculator:{allOf:[{$ref:"#/components/schemas/DeliveryMethodCalculator"}],nullable:!0}},required:["id","name","code","estimated_transit_business_days_min","estimated_transit_business_days_max","digital","pickup","pickup_point","admin_name","storefront_visible","tracking_url","available_to_sellers","created_at","updated_at","deleted_at","markup_flat","markup_percent","seller_id","seller_name","services","rules","tax_category_id","delivery_profile_id","delivery_origin_group_id","delivery_zone_id","stock_location_ids","fulfillment_provider","pickup_point_provider","rate_provider","calculator"],"x-typelizer":!0},DeliveryMethodService:{type:"object",properties:{id:{type:"string"},carrier:{type:"string"},service:{type:"string"},label:{type:"string",nullable:!0},markup_flat:{type:"string",nullable:!0},markup_percent:{type:"string",nullable:!0},position:{type:"number"}},required:["id","carrier","service","label","markup_flat","markup_percent","position"],"x-typelizer":!0},DeliveryOriginGroup:{type:"object",properties:{id:{type:"string"},name:{type:"string",nullable:!0},position:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string"},stock_location_ids:{type:"array",items:{type:"string"}},delivery_zones_count:{type:"number"},delivery_methods_count:{type:"number"}},required:["id","name","position","created_at","updated_at","delivery_profile_id","stock_location_ids","delivery_zones_count","delivery_methods_count"],"x-typelizer":!0},DeliveryProfile:{type:"object",properties:{id:{type:"string"},name:{type:"string"},default:{type:"boolean"},position:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},kind:{type:"string",description:"Profile kind. Built-in: shipping, digital. Extensions may register more."},digital:{type:"boolean"},offers_pickup:{type:"boolean"},offers_shipping:{type:"boolean"},stock_location_ids:{type:"array",items:{type:"string"}},origin_groups:{type:"array",items:{type:"object"}},products_count:{type:"number"},delivery_methods_count:{type:"number"},delivery_zones_count:{type:"number"}},required:["id","name","default","position","created_at","updated_at","kind","digital","offers_pickup","offers_shipping","stock_location_ids","origin_groups","products_count","delivery_methods_count","delivery_zones_count"],"x-typelizer":!0},DeliveryRate:{type:"object",properties:{id:{type:"string"},delivery_method_id:{type:"string"},name:{type:"string"},selected:{type:"boolean"},cost:{type:"string"},total:{type:"string"},additional_tax_total:{type:"string"},included_tax_total:{type:"string"},tax_total:{type:"string"},carrier:{type:"string",nullable:!0},service_level:{type:"string",nullable:!0},estimated_delivery_date:{type:"string",nullable:!0},unpriced:{type:"boolean"},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0},delivery_method:{$ref:"#/components/schemas/DeliveryMethod"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","delivery_method_id","name","selected","cost","total","additional_tax_total","included_tax_total","tax_total","carrier","service_level","estimated_delivery_date","unpriced","freight_summary","metadata","created_at","updated_at"],"x-typelizer":!0},Delivery:{type:"object",properties:{id:{type:"string"},tracking_number:{type:"string"},carrier:{type:"string",nullable:!0},carrier_name:{type:"string",nullable:!0},service:{type:"string",nullable:!0},status:{type:"string",enum:["pending","pre_transit","in_transit","out_for_delivery","available_for_pickup","delivered","return_to_sender","failure","unknown"]},tracking_url:{type:"string",nullable:!0},estimated_delivery_at:{type:"string",nullable:!0},delivered_at:{type:"string",nullable:!0},details:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},shipping_label_id:{type:"string",nullable:!0}},required:["id","tracking_number","carrier","carrier_name","service","status","tracking_url","estimated_delivery_at","delivered_at","details","created_at","updated_at","shipping_label_id"],"x-typelizer":!0},DeliveryZoneMember:{type:"object",properties:{id:{type:"string"},member_type:{type:"string",enum:["country","state","postal_code"]},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},postal_code_prefix:{type:"string",nullable:!0},postal_code_from:{type:"string",nullable:!0},postal_code_to:{type:"string",nullable:!0},country_name:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","member_type","country_code","state_code","postal_code_prefix","postal_code_from","postal_code_to","country_name","state_name","created_at","updated_at"],"x-typelizer":!0},DeliveryZone:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMember"}},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string"},delivery_origin_group_id:{type:"string",nullable:!0},delivery_method_ids:{type:"array",items:{type:"string"}}},required:["id","name","description","created_at","updated_at","delivery_profile_id","delivery_origin_group_id","delivery_method_ids"],"x-typelizer":!0},DigitalAsset:{type:"object",properties:{id:{type:"string"},variant_id:{type:"string",nullable:!0},filename:{type:"string",nullable:!0},content_type:{type:"string",nullable:!0},authorized_clicks:{type:"number",nullable:!0},authorized_days:{type:"number",nullable:!0},byte_size:{type:"number",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},provider_type:{type:"string",nullable:!0,description:"Digital asset provider; null is an uploaded file. Built-in: file. Extensions may register more."},provider_name:{type:"string",description:"Digital asset provider name. Built-in: File. Extensions may register more."},download_url:{type:"string",nullable:!0},effective_authorized_clicks:{type:"number"},effective_authorized_days:{type:"number"},provider_settings:{type:"object"}},required:["id","variant_id","filename","content_type","authorized_clicks","authorized_days","byte_size","created_at","updated_at","provider_type","provider_name","download_url","effective_authorized_clicks","effective_authorized_days","provider_settings"],"x-typelizer":!0},DigitalLink:{type:"object",properties:{id:{type:"string"},access_counter:{type:"number"},filename:{type:"string"},content_type:{type:"string"},download_url:{type:"string"},expires_at:{type:"string",nullable:!0},authorizable:{type:"boolean"},expired:{type:"boolean"},access_limit_exceeded:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","access_counter","filename","content_type","download_url","expires_at","authorizable","expired","access_limit_exceeded","created_at","updated_at"],"x-typelizer":!0},Discount:{type:"object",properties:{id:{type:"string"},label:{type:"string"},kind:{type:"string",enum:["promotion","manual"]},code:{type:"string",nullable:!0},value_type:{type:"string",nullable:!0},value:{type:"string",nullable:!0},promotion_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},amount:{type:"string"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","label","kind","code","value_type","value","promotion_id","line_item_id","fulfillment_id","amount","metadata","created_at","updated_at"],"x-typelizer":!0},EmailTemplateDraft:{type:"object",properties:{id:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},lock_version:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},updated_by_id:{type:"string",nullable:!0},updated_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},updated_by:{$ref:"#/components/schemas/Actor"}},required:["id","subject","body","lock_version","created_at","updated_at","updated_by_id","updated_by_type"],"x-typelizer":!0},EmailTemplatePreview:{type:"object",properties:{id:{type:"string",nullable:!0},subject:{type:"string"},html:{type:"string"},text:{type:"string"},email_key:{type:"string"},variables:{type:"object"}},required:["id","subject","html","text","email_key","variables"],"x-typelizer":!0},EmailTemplateRevision:{type:"object",properties:{id:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},created_at:{type:"string"},published_by_id:{type:"string",nullable:!0},published_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},published_by:{$ref:"#/components/schemas/Actor"}},required:["id","subject","body","created_at","published_by_id","published_by_type"],"x-typelizer":!0},EmailTemplateSampleRecord:{type:"object",properties:{id:{type:"string"},label:{type:"string"},created_at:{type:"string"}},required:["id","label","created_at"],"x-typelizer":!0},EmailTemplate:{type:"object",properties:{id:{type:"string"},key:{type:"string"},subject:{type:"string",nullable:!0},body:{type:"string"},language:{type:"string"},customized_languages:{type:"array",items:{type:"string"}},kind:{type:"string",enum:["email","layout","partial"]},customized:{type:"boolean"},published_at:{type:"string",nullable:!0},default_subject:{type:"string",nullable:!0},default_body:{type:"string"},published_language:{type:"string",nullable:!0},default_changed:{type:"boolean"},base_subject:{type:"string",nullable:!0},base_body:{type:"string",nullable:!0},draft:{allOf:[{$ref:"#/components/schemas/EmailTemplateDraft"}],nullable:!0}},required:["id","key","subject","body","language","customized_languages","kind","customized","published_at","default_subject","default_body","published_language","default_changed","base_subject","base_body","draft"],"x-typelizer":!0},ExchangeLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},received_quantity:{type:"number"},resellable:{type:"boolean"},original_price:{type:"string"},new_variant_price:{type:"string"},price_difference:{type:"string"},original_tax_total:{type:"string"},new_tax_total:{type:"string"},original_variant_id:{type:"string",nullable:!0},new_variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_item_id:{type:"string",nullable:!0},original_variant:{$ref:"#/components/schemas/Variant"},new_variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","quantity","received_quantity","resellable","original_price","new_variant_price","price_difference","original_tax_total","new_tax_total","original_variant_id","new_variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":!0},Exchange:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["requested","approved","received","fulfilled","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},price_difference:{type:"string"},approved_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},fulfilled_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ReturnReason"},exchange_line_items:{type:"array",items:{$ref:"#/components/schemas/ExchangeLineItem"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},stock_location_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},order:{$ref:"#/components/schemas/Order"},stock_location:{$ref:"#/components/schemas/StockLocation"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}}},required:["id","number","status","order_id","reason_id","price_difference","approved_at","received_at","fulfilled_at","canceled_at","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","created_by_type"],"x-typelizer":!0},Export:{type:"object",properties:{id:{type:"string"},number:{type:"string"},format:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",nullable:!0},user_id:{type:"string",nullable:!0},done:{type:"boolean"},store_id:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},filename:{type:"string",nullable:!0},byte_size:{type:"number",nullable:!0},download_url:{type:"string",nullable:!0}},required:["id","number","format","created_at","updated_at","type","user_id","done","store_id","seller_id","seller_name","filename","byte_size","download_url"],"x-typelizer":!0},Fee:{type:"object",properties:{id:{type:"string"},label:{type:"string"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"What sort of charge this is. `duty` is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds."},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},amount:{type:"string"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","label","kind","line_item_id","fulfillment_id","amount","metadata","created_at","updated_at"],"x-typelizer":!0},FileUpload:{type:"object",properties:{signed_id:{type:"string"},filename:{type:"string"},content_type:{type:"string"},byte_size:{type:"number"},visibility:{type:"string",enum:["public","private"]},expires_at:{type:"string"},upload:{allOf:[{$ref:"#/components/schemas/FileUploadTarget"}],nullable:!0}},required:["signed_id","filename","content_type","byte_size","visibility","expires_at","upload"],"x-typelizer":!0},FileUploadTarget:{type:"object",properties:{method:{type:"string"},url:{type:"string"},headers:{type:"object"}},required:["method","url","headers"],"x-typelizer":!0},FreightSummaryLine:{type:"object",properties:{variant_id:{type:"string",nullable:!0},sku:{type:"string",nullable:!0},name:{type:"string",nullable:!0},units:{type:"number"},cartons:{type:"number",nullable:!0},pallets:{type:"number",nullable:!0},units_per_carton:{type:"number",nullable:!0},cartons_per_pallet:{type:"number",nullable:!0},complete:{type:"boolean"},weight_per_carton:{type:"string",nullable:!0},volume:{type:"string"},weight:{type:"string"}},required:["variant_id","sku","name","units","cartons","pallets","units_per_carton","cartons_per_pallet","complete","weight_per_carton","volume","weight"],"x-typelizer":!0},FreightSummary:{type:"object",properties:{total_units:{type:"number"},total_cartons:{type:"number"},total_pallets:{type:"number",nullable:!0},total_volume:{type:"string"},total_weight:{type:"string"},complete:{type:"boolean"},lines:{type:"array",items:{$ref:"#/components/schemas/FreightSummaryLine"}}},required:["total_units","total_cartons","total_pallets","total_volume","total_weight","complete","lines"],"x-typelizer":!0},FulfillmentItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},status:{anyOf:[{type:"string",enum:["on_hand","backordered","shipped","returned"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},name:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0}},required:["id","quantity","status","variant_id","line_item_id","name","options_text"],"x-typelizer":!0},Fulfillment:{type:"object",properties:{id:{type:"string"},number:{type:"string"},tracking:{type:"string",nullable:!0},tracking_url:{type:"string",nullable:!0},pickup_point_data:{type:"object",nullable:!0},selected_delivery_rate_id:{type:"string",nullable:!0},unpriced:{type:"boolean"},cost:{type:"string"},total:{type:"string"},discount_total:{type:"string"},additional_tax_total:{type:"string"},included_tax_total:{type:"string"},tax_total:{type:"string"},status:{anyOf:[{type:"string",enum:["unfulfilled","fulfilled","delivered","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},fulfillment_type:{type:"string",enum:["shipping","digital","pickup","pickup_point"]},fulfilled_at:{type:"string",nullable:!0},delivered_at:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/FulfillmentManifestItem"}},deliveries:{type:"array",items:{$ref:"#/components/schemas/Delivery"}},delivery_method:{$ref:"#/components/schemas/DeliveryMethod"},stock_location:{$ref:"#/components/schemas/StockLocation"},delivery_rates:{type:"array",items:{$ref:"#/components/schemas/DeliveryRate"}},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},adjustment_total:{type:"string"},pre_tax_amount:{type:"string"},order_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},documents:{type:"array",items:{type:"object"}},labels:{type:"array",items:{$ref:"#/components/schemas/ShippingLabel"}},provider_generates_labels:{type:"boolean"},fulfillment_items:{type:"array",items:{$ref:"#/components/schemas/FulfillmentItem"}},order:{$ref:"#/components/schemas/Order"}},required:["id","number","tracking","tracking_url","pickup_point_data","selected_delivery_rate_id","unpriced","cost","total","discount_total","additional_tax_total","included_tax_total","tax_total","status","fulfillment_type","fulfilled_at","delivered_at","items","deliveries","external_references","metadata","created_at","updated_at","adjustment_total","pre_tax_amount","order_id","stock_location_id","documents","labels","provider_generates_labels"],"x-typelizer":!0},GiftCardBatch:{type:"object",properties:{id:{type:"string"},codes_count:{type:"number"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},prefix:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0}},required:["id","codes_count","currency","prefix","created_at","updated_at","amount","expires_at","created_by_id"],"x-typelizer":!0},GiftCard:{type:"object",properties:{id:{type:"string"},code:{type:"string"},status:{anyOf:[{type:"string",enum:["active","partially_redeemed","redeemed","canceled","expired"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string"},amount_used:{type:"string"},amount_authorized:{type:"string"},amount_remaining:{type:"string"},expires_at:{type:"string",nullable:!0},redeemed_at:{type:"string",nullable:!0},expired:{type:"boolean"},active:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},created_at:{type:"string"},updated_at:{type:"string"},customer_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"},created_by:{$ref:"#/components/schemas/AdminUser"},gift_card_batch:{$ref:"#/components/schemas/GiftCardBatch"},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}}},required:["id","code","status","currency","amount","amount_used","amount_authorized","amount_remaining","expires_at","redeemed_at","expired","active","created_at","updated_at","customer_id","created_by_id"],"x-typelizer":!0},ImportMapping:{type:"object",properties:{id:{type:"string"},schema_field:{type:"string"},file_column:{type:"string",nullable:!0},required:{type:"boolean"}},required:["id","schema_field","file_column","required"],"x-typelizer":!0},ImportRow:{type:"object",properties:{id:{type:"string"},row_number:{type:"number"},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},validation_errors:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},import_id:{type:"string",nullable:!0},item_type:{type:"string",nullable:!0},item_id:{type:"string",nullable:!0},data:{type:"object"}},required:["id","row_number","status","validation_errors","created_at","updated_at","import_id","item_type","item_id","data"],"x-typelizer":!0},Import:{type:"object",properties:{id:{type:"string"},number:{type:"string"},rows_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",nullable:!0,description:"Import type. Built-in: products, product_translations, customers, price_list_prices. Extensions may register more."},status:{anyOf:[{type:"string",enum:["pending","mapping","completed_mapping","processing","completed","failed"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},store_id:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},user_id:{type:"string",nullable:!0},processing_errors:{type:"string",nullable:!0},delimiter:{type:"string"},price_list_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},original_filename:{type:"string",nullable:!0},original_byte_size:{type:"number",nullable:!0},original_file_url:{type:"string",nullable:!0},completed_rows_count:{type:"number"},failed_rows_count:{type:"number"},schema_fields:{type:"array",items:{$ref:"#/components/schemas/ImportSchemaField"}},csv_headers:{type:"array",items:{type:"string"}},sample_row:{type:"object"},mappings:{type:"array",items:{$ref:"#/components/schemas/ImportMapping"}}},required:["id","number","rows_count","created_at","updated_at","type","status","store_id","seller_id","user_id","processing_errors","delimiter","price_list_id","seller_name","original_filename","original_byte_size","original_file_url","completed_rows_count","failed_rows_count","schema_fields","csv_headers","sample_row","mappings"],"x-typelizer":!0},Integration:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Integration type, registered by the provider gem that owns it (for example the EasyPost provider). Core ships none."},group:{type:"string",nullable:!0},preferences:{$ref:"#/components/schemas/IntegrationPreferences"}},required:["id","name","active","created_at","updated_at","type","group","preferences"],"x-typelizer":!0},InvitationAcceptanceLink:{type:"object",properties:{id:{type:"string"},acceptance_url:{type:"string"}},required:["id","acceptance_url"],"x-typelizer":!0},Invitation:{type:"object",properties:{id:{type:"string"},email:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","accepted"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},created_at:{type:"string"},updated_at:{type:"string"},expires_at:{type:"string"},role_id:{type:"string"},role_name:{type:"string"},inviter_email:{type:"string"},invitee_exists:{type:"boolean"},store:{type:"object"}},required:["id","email","status","created_at","updated_at","expires_at","role_id","role_name","inviter_email","invitee_exists","store"],"x-typelizer":!0},LineItem:{type:"object",properties:{id:{type:"string"},variant_id:{type:"string"},seller_id:{type:"string",nullable:!0},preorder:{type:"boolean"},preorder_ships_at:{type:"string",nullable:!0},quantity:{type:"number"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},name:{type:"string"},slug:{type:"string"},options_text:{type:"string"},price:{type:"string",description:"The price of one unit."},total:{type:"string",description:"What this line costs: price times quantity, with its discounts, fees and added tax."},adjustment_total:{type:"string",description:"This line's discounts, fees and added tax together."},additional_tax_total:{type:"string",description:"Tax added on top of the price."},included_tax_total:{type:"string",description:"Tax already included in the price."},discount_total:{type:"string",description:"What promotions take off this line, as a negative amount."},pre_tax_amount:{type:"string",description:"This line after discounts, without tax."},discounted_amount:{type:"string",description:"Price times quantity, after discounts."},compare_at_amount:{type:"string",nullable:!0,description:"The compare-at price times quantity, or null when the variant has none."},thumbnail_url:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},digital_links:{type:"array",items:{$ref:"#/components/schemas/DigitalLink"}},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},metadata:{type:"object"},price_source:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},catalog_price:{type:"string",nullable:!0},price_list_id:{type:"string",nullable:!0},price_list_name:{type:"string",nullable:!0},catalog_id:{type:"string",nullable:!0},catalog_name:{type:"string",nullable:!0},cost_price:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},tax_category:{$ref:"#/components/schemas/TaxCategory"}},required:["id","variant_id","seller_id","preorder","preorder_ships_at","quantity","currency","name","slug","options_text","price","total","adjustment_total","additional_tax_total","included_tax_total","discount_total","pre_tax_amount","discounted_amount","compare_at_amount","thumbnail_url","option_values","digital_links","external_references","metadata","price_source","created_at","updated_at","catalog_price","price_list_id","price_list_name","catalog_id","catalog_name","cost_price","tax_category_id"],"x-typelizer":!0},Locale:{type:"object",properties:{code:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},default:{type:"boolean"},rtl:{type:"boolean"}},required:["code","default","rtl"],"x-typelizer":!0},MaintenanceTaskRun:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["enqueued","running","interrupted","cancelling","cancelled","succeeded","errored"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},dry_run:{type:"boolean"},initiated_via:{type:"string"},tick_count:{type:"number"},tick_total:{type:"number",nullable:!0},error_class:{type:"string",nullable:!0},error_message:{type:"string",nullable:!0},started_at:{type:"string",nullable:!0},ended_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},task_name:{type:"string"},duration:{type:"number",nullable:!0},tallies:{type:"object"},arguments:{type:"object"},error_backtrace:{type:"string",nullable:!0},active:{type:"boolean"},admin_user_id:{type:"string",nullable:!0},admin_user:{$ref:"#/components/schemas/AdminUser"}},required:["id","status","dry_run","initiated_via","tick_count","tick_total","error_class","error_message","started_at","ended_at","created_at","updated_at","task_name","duration","tallies","arguments","error_backtrace","active","admin_user_id"],"x-typelizer":!0},Market:{type:"object",properties:{id:{type:"string"},name:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},default_locale:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},tax_inclusive:{type:"boolean"},default:{type:"boolean"},country_codes:{type:"array",items:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},supported_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},countries:{type:"array",items:{$ref:"#/components/schemas/Country"}},created_at:{type:"string"},updated_at:{type:"string"},tax_provider:{type:"string",nullable:!0,description:"Tax provider; null uses the store default. Built-in: internal. Provider gems register more."}},required:["id","name","currency","default_locale","tax_inclusive","default","country_codes","supported_locales","created_at","updated_at","tax_provider"],"x-typelizer":!0},Media:{type:"object",properties:{id:{type:"string"},product_id:{type:"string",nullable:!0},variant_ids:{type:"array",items:{type:"string"}},position:{type:"number"},alt:{type:"string",nullable:!0},media_type:{type:"string",enum:["image","video","external_video"]},external_video_url:{type:"string",nullable:!0},focal_point_x:{type:"number",nullable:!0},focal_point_y:{type:"number",nullable:!0},video_provider:{type:"string",nullable:!0},video_embed_url:{type:"string",nullable:!0},video_url:{type:"string",nullable:!0},poster_url:{type:"string",nullable:!0},original_url:{type:"string",nullable:!0},mini_url:{type:"string",nullable:!0},small_url:{type:"string",nullable:!0},medium_url:{type:"string",nullable:!0},large_url:{type:"string",nullable:!0},xlarge_url:{type:"string",nullable:!0},og_image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},attached:{type:"boolean"},filename:{type:"string",nullable:!0},content_type:{type:"string",nullable:!0},byte_size:{type:"number",nullable:!0},embed_url:{type:"string",nullable:!0},signed_id:{type:"string",nullable:!0},viewable_id:{type:"string",nullable:!0},download_url:{type:"string",nullable:!0},metadata:{type:"object"},viewable_type:{type:"string",nullable:!0}},required:["id","product_id","variant_ids","position","alt","media_type","external_video_url","focal_point_x","focal_point_y","video_provider","video_embed_url","video_url","poster_url","original_url","mini_url","small_url","medium_url","large_url","xlarge_url","og_image_url","external_references","created_at","updated_at","attached","filename","content_type","byte_size","embed_url","signed_id","viewable_id","download_url","metadata","viewable_type"],"x-typelizer":!0},MembershipProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0}},required:["id","name","thumbnail_url"],"x-typelizer":!0},NewsletterSubscriber:{type:"object",properties:{id:{type:"string"},email:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},verified:{type:"boolean"},verified_at:{type:"string",nullable:!0},customer_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}}},required:["id","email","created_at","updated_at","verified","verified_at","customer_id"],"x-typelizer":!0},OauthAccessToken:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},owner_id:{type:"string",nullable:!0},owner_type:{type:"string",nullable:!0},owner:{$ref:"#/components/schemas/AdminUser"},scopes:{type:"array",items:{type:"string"}},expired:{type:"boolean"}},required:["id","created_at","owner_id","owner_type","scopes","expired"],"x-typelizer":!0},OauthApplication:{type:"object",properties:{id:{type:"string"},name:{type:"string"},redirect_uri:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},client_id:{type:"string"},connected:{type:"boolean"},scopes:{type:"array",items:{type:"string"}},last_authorized_at:{type:"string",nullable:!0},authorized_at:{type:"string",nullable:!0},authorized_by:{type:"string",nullable:!0}},required:["id","name","redirect_uri","created_at","updated_at","client_id","connected","scopes","last_authorized_at","authorized_at","authorized_by"],"x-typelizer":!0},OauthConsentRequest:{type:"object",properties:{client_name:{type:"string"},scopes:{type:"array",items:{type:"string"}},grantable_scopes:{type:"array",items:{type:"string"}},resource:{type:"string",nullable:!0},redirect_uri:{type:"string"}},required:["client_name","scopes","grantable_scopes","resource","redirect_uri"],"x-typelizer":!0},OauthProtectedResource:{type:"object",properties:{resource:{type:"string"},authorization_servers:{type:"array",items:{type:"string"}},scopes_supported:{type:"array",items:{type:"string"}},bearer_methods_supported:{type:"array",items:{type:"string"}},resource_documentation:{type:"string"}},required:["resource","authorization_servers","scopes_supported","bearer_methods_supported","resource_documentation"],"x-typelizer":!0},OauthRedirect:{type:"object",properties:{redirect_uri:{type:"string"}},required:["redirect_uri"],"x-typelizer":!0},OptionType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},label:{type:"string"},position:{type:"number"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},translations:{type:"object"},metadata:{type:"object"},filterable:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}}},required:["id","name","label","position","kind","metadata","filterable","created_at","updated_at"],"x-typelizer":!0},OptionValue:{type:"object",properties:{id:{type:"string"},option_type_id:{type:"string"},name:{type:"string"},label:{type:"string"},position:{type:"number"},color_code:{type:"string",nullable:!0},option_type_name:{type:"string"},option_type_label:{type:"string"},image_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},option_type:{$ref:"#/components/schemas/OptionType"}},required:["id","option_type_id","name","label","position","color_code","option_type_name","option_type_label","image_url","metadata","created_at","updated_at"],"x-typelizer":!0},OrderCancellationReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},OrderGroup:{type:"object",properties:{id:{type:"string"},number:{type:"string"},email:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},item_total:{type:"string",nullable:!0,description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",nullable:!0,description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",nullable:!0,description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",nullable:!0,description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",nullable:!0,description:"Tax added on top of the prices."},delivery_total:{type:"string",nullable:!0,description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",nullable:!0,description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",nullable:!0,description:"What a gift card pays."},store_credit_total:{type:"string",nullable:!0,description:"What store credit pays, apart from gift cards."},total:{type:"string",nullable:!0,description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",nullable:!0,description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},payments:{type:"array",items:{$ref:"#/components/schemas/Payment"}},fulfillment_status:{type:"string",nullable:!0,enum:["backorder","canceled","partial","unfulfilled","fulfilled","delivered","pending","ready","shipped"]},payment_status:{type:"string",nullable:!0,enum:["none","authorized","partially_paid","paid","partially_refunded","refunded","overcharged","voided"]},completed_at:{type:"string",nullable:!0},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},orders:{type:"array",items:{$ref:"#/components/schemas/Order"}},customer_id:{type:"string",nullable:!0},cart_id:{type:"string",nullable:!0},seller_count:{type:"number"},includes_first_party:{type:"boolean"},confirmation_delivered:{type:"boolean"},store_owner_notification_delivered:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","number","email","currency","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","payments","fulfillment_status","payment_status","completed_at","billing_address","shipping_address","orders","customer_id","cart_id","seller_count","includes_first_party","confirmation_delivered","store_owner_notification_delivered","created_at","updated_at"],"x-typelizer":!0},OrderRoutingRule:{type:"object",properties:{id:{type:"string"},position:{type:"number"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: preferred_location, default_location, minimize_splits. Extensions may register more."},channel_id:{type:"string"},preferences:{$ref:"#/components/schemas/OrderRoutingRulePreferences"}},required:["id","position","active","created_at","updated_at","type","channel_id","preferences"],"x-typelizer":!0},Order:{type:"object",properties:{id:{type:"string"},market_id:{type:"string",nullable:!0},withdrawal_period_ends_at:{type:"string",nullable:!0},within_withdrawal_period:{type:"boolean"},shipping_eq_billing_address:{type:"boolean"},cart_id:{type:"string",nullable:!0},channel_id:{type:"string",nullable:!0},company_id:{type:"string",nullable:!0},company_name:{type:"string",nullable:!0},po_document_filename:{type:"string",nullable:!0},po_document_byte_size:{type:"number",nullable:!0},number:{type:"string"},email:{type:"string"},customer_note:{type:"string",nullable:!0},po_number:{type:"string",nullable:!0},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},total_quantity:{type:"number"},coupon_code:{type:"string",nullable:!0},fulfillment_status:{type:"string",nullable:!0,enum:["backorder","canceled","partial","unfulfilled","fulfilled","delivered","pending","ready","shipped"]},payment_status:{type:"string",nullable:!0,enum:["none","authorized","partially_paid","paid","partially_refunded","refunded","overcharged","voided"]},completed_at:{type:"string",nullable:!0},item_total:{type:"string",description:"The line items: each price times its quantity, before discounts, fees and delivery."},discount_total:{type:"string",description:"What promotions take off, as a negative amount. Manual discounts are not included."},tax_total:{type:"string",description:"All tax, both included in prices and added on top."},included_tax_total:{type:"string",description:"Tax already included in the prices, as in a store whose prices are tax-inclusive."},additional_tax_total:{type:"string",description:"Tax added on top of the prices."},delivery_total:{type:"string",description:"What delivery costs, before delivery discounts."},fee_total:{type:"string",description:"Every fee charged, such as handling or a customs duty."},gift_card_total:{type:"string",description:"What a gift card pays."},store_credit_total:{type:"string",description:"What store credit pays, apart from gift cards."},total:{type:"string",description:"What the customer pays in all: items, delivery, fees and added tax, less discounts."},amount_due:{type:"string",description:"What is left to pay after payments and store credit."},covered_by_store_credit:{type:"boolean"},payments:{type:"array",items:{$ref:"#/components/schemas/Payment"}},adjustment_total:{type:"string",description:"Every discount, fee and added tax together, as one amount."},items:{type:"array",items:{$ref:"#/components/schemas/LineItem"}},fulfillments:{type:"array",items:{$ref:"#/components/schemas/Fulfillment"}},billing_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},shipping_address:{allOf:[{$ref:"#/components/schemas/Address"}],nullable:!0},gift_card:{allOf:[{$ref:"#/components/schemas/GiftCard"}],nullable:!0},market:{allOf:[{$ref:"#/components/schemas/Market"}],nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},status:{type:"string",enum:["draft","placed","canceled"]},last_ip_address:{type:"string",nullable:!0},considered_risky:{type:"boolean"},confirmation_delivered:{type:"boolean"},store_owner_notification_delivered:{type:"boolean",nullable:!0},metadata:{type:"object"},cancel_note:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},approved_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},payment_total:{type:"string"},commission_amount_total:{type:"string"},commission_tax_total:{type:"string"},commission_total:{type:"string"},preferred_stock_location_id:{type:"string",nullable:!0},po_document_url:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},order_group_id:{type:"string",nullable:!0},tags:{type:"array",items:{type:"string"}},internal_note:{type:"string",nullable:!0},internal_note_html:{type:"string",nullable:!0},approver_id:{type:"string",nullable:!0},approver_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},approver:{$ref:"#/components/schemas/Actor"},canceler_id:{type:"string",nullable:!0},canceler_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},canceler:{$ref:"#/components/schemas/Actor"},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},cancel_reason_id:{type:"string",nullable:!0},cancel_reason_name:{type:"string",nullable:!0},customer_id:{type:"string",nullable:!0},applied_promotions:{type:"array",items:{$ref:"#/components/schemas/AppliedPromotion"}},payment_splits:{type:"array",items:{$ref:"#/components/schemas/PaymentSplit"}},cart:{$ref:"#/components/schemas/Cart"},channel:{$ref:"#/components/schemas/Channel"},preferred_stock_location:{$ref:"#/components/schemas/StockLocation"},payment_methods:{type:"array",items:{$ref:"#/components/schemas/PaymentMethod"}},customer:{$ref:"#/components/schemas/Customer"},cancel_reason:{$ref:"#/components/schemas/OrderCancellationReason"},returns:{type:"array",items:{$ref:"#/components/schemas/Return"}},exchanges:{type:"array",items:{$ref:"#/components/schemas/Exchange"}},claims:{type:"array",items:{$ref:"#/components/schemas/Claim"}},freight_summary:{allOf:[{$ref:"#/components/schemas/FreightSummary"}],nullable:!0}},required:["id","market_id","withdrawal_period_ends_at","within_withdrawal_period","shipping_eq_billing_address","cart_id","channel_id","company_id","company_name","po_document_filename","po_document_byte_size","number","email","customer_note","po_number","currency","locale","total_quantity","coupon_code","fulfillment_status","payment_status","completed_at","item_total","discount_total","tax_total","included_tax_total","additional_tax_total","delivery_total","fee_total","gift_card_total","store_credit_total","total","amount_due","covered_by_store_credit","adjustment_total","gift_card","market","external_references","status","last_ip_address","considered_risky","confirmation_delivered","store_owner_notification_delivered","metadata","cancel_note","canceled_at","approved_at","created_at","updated_at","payment_total","commission_amount_total","commission_tax_total","commission_total","preferred_stock_location_id","po_document_url","seller_id","order_group_id","tags","internal_note","internal_note_html","approver_id","approver_type","canceler_id","canceler_type","created_by_id","created_by_type","cancel_reason_id","cancel_reason_name","customer_id","freight_summary"],"x-typelizer":!0},PackageType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},kind:{type:"string",enum:["box","envelope","carton","pallet","container"]},length:{type:"string",nullable:!0},width:{type:"string",nullable:!0},height:{type:"string",nullable:!0},weight:{type:"string",nullable:!0},max_weight:{type:"string",nullable:!0},default:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},dimensions_unit:{type:"string",enum:["mm","cm","in","ft"]},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},volume:{type:"string",nullable:!0},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0}},required:["id","name","kind","length","width","height","weight","max_weight","default","metadata","created_at","updated_at","dimensions_unit","weight_unit","volume","seller_id","seller_name"],"x-typelizer":!0},PaymentCaptureEvent:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"}},required:["id","created_at","updated_at","amount"],"x-typelizer":!0},PaymentMethod:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},type:{type:"string",description:"Payment method type. Built-in: check, store_credit, custom_payment_source_method, bogus (test only); payment provider gems register their own, for example stripe."},session_required:{type:"boolean"},source_required:{type:"boolean"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},active:{type:"boolean"},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],nullable:!0},resolved_capture_method:{type:"string",enum:["checkout","on_dispatch","manual"]},storefront_visible:{type:"boolean"},position:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},preferences:{$ref:"#/components/schemas/PaymentMethodPreferences"},logo_url:{type:"string",nullable:!0},docs_url:{type:"string",nullable:!0},third_party:{type:"boolean"}},required:["id","name","description","type","session_required","source_required","metadata","active","capture_method","resolved_capture_method","storefront_visible","position","created_at","updated_at","preferences","logo_url","docs_url","third_party"],"x-typelizer":!0},Payment:{type:"object",properties:{id:{type:"string"},payment_method_id:{type:"string"},response_code:{type:"string",nullable:!0},number:{type:"string"},status:{anyOf:[{type:"string",enum:["checkout","processing","pending","completed","failed","void","invalid"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},amount:{type:"string"},source_type:{type:"string",nullable:!0,enum:["credit_card","store_credit","payment_source"]},source_id:{type:"string",nullable:!0},source:{anyOf:[{$ref:"#/components/schemas/CreditCard"},{$ref:"#/components/schemas/StoreCredit"},{$ref:"#/components/schemas/PaymentSource"}],nullable:!0},payment_method:{$ref:"#/components/schemas/PaymentMethod"},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},avs_response:{type:"string",nullable:!0},cvv_response_code:{type:"string",nullable:!0},cvv_response_message:{type:"string",nullable:!0},gateway_dashboard_payment_url:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},avs_risky:{type:"boolean",description:"Whether the card issuer reported that the billing address did not match."},cvv_risky:{type:"boolean",description:"Whether the card issuer reported that the security code did not match."},captured_amount:{type:"string"},order_id:{type:"string",nullable:!0},capture_events:{type:"array",items:{$ref:"#/components/schemas/PaymentCaptureEvent"}},order:{$ref:"#/components/schemas/Order"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}},payment_splits:{type:"array",items:{$ref:"#/components/schemas/PaymentSplit"}}},required:["id","payment_method_id","response_code","number","status","amount","source_type","source_id","source","metadata","avs_response","cvv_response_code","cvv_response_message","gateway_dashboard_payment_url","created_at","updated_at","avs_risky","cvv_risky","captured_amount","order_id"],"x-typelizer":!0},PaymentSource:{type:"object",properties:{id:{type:"string"},gateway_payment_profile_id:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","gateway_payment_profile_id","metadata","created_at","updated_at"],"x-typelizer":!0},PaymentSplit:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},authorized_amount:{type:"string"},captured_amount:{type:"string"},refunded_amount:{type:"string"},claimed_amount:{type:"string"},net_captured_amount:{type:"string"},refundable_amount:{type:"string"},payment_id:{type:"string"},payment_number:{type:"string",nullable:!0},order_id:{type:"string"},order_number:{type:"string",nullable:!0}},required:["id","currency","created_at","updated_at","authorized_amount","captured_amount","refunded_amount","claimed_amount","net_captured_amount","refundable_amount","payment_id","payment_number","order_id","order_number"],"x-typelizer":!0},Permission:{type:"object",properties:{key:{type:"string"},resource:{type:"string"},kind:{type:"string",enum:["read","write"]},group:{type:"string"},group_label:{type:"string"},label:{type:"string"},description:{type:"string"}},required:["key","resource","kind","group","group_label","label","description"],"x-typelizer":!0},Policy:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0},body_html:{type:"string",nullable:!0},updated_at:{type:"string"},created_at:{type:"string"}},required:["id","name","slug","body","body_html","updated_at","created_at"],"x-typelizer":!0},PriceAdjustmentTier:{type:"object",properties:{id:{type:"string"},min_quantity:{type:"number"},percentage:{type:"string"}},required:["id","min_quantity","percentage"],"x-typelizer":!0},PriceHistory:{type:"object",properties:{id:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string",nullable:!0},recorded_at:{type:"string"},variant_id:{type:"string"},price_id:{type:"string"},compare_at_amount:{type:"string",nullable:!0},created_at:{type:"string"}},required:["id","currency","amount","recorded_at","variant_id","price_id","compare_at_amount","created_at"],"x-typelizer":!0},PriceListProduct:{type:"object",properties:{id:{type:"string"},name:{type:"string"},thumbnail_url:{type:"string",nullable:!0},price_list_variants:{type:"array",items:{$ref:"#/components/schemas/CatalogPrice"}}},required:["id","name","thumbnail_url"],"x-typelizer":!0},PriceList:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},status:{anyOf:[{type:"string",enum:["draft","active","inactive","scheduled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},position:{type:"number"},match_policy:{type:"string",enum:["all","any"]},adjust_compare_at:{type:"boolean"},starts_at:{type:"string",nullable:!0},ends_at:{type:"string",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},price_adjustment_percentage:{type:"string",nullable:!0},automatic_pricing:{type:"boolean"},currently_active:{type:"boolean"},products_count:{type:"number"},prices_count:{type:"number"},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTier"}},price_rules:{type:"array",items:{$ref:"#/components/schemas/PriceRule"}}},required:["id","name","description","status","position","match_policy","adjust_compare_at","starts_at","ends_at","deleted_at","created_at","updated_at","price_adjustment_percentage","automatic_pricing","currently_active","products_count","prices_count","price_adjustment_tiers"],"x-typelizer":!0},PriceRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: channel_rule, customer_group_rule, market_rule, user_rule, volume_rule, zone_rule. Extensions may register more."},price_list_id:{type:"string"},preferences:{$ref:"#/components/schemas/PriceRulePreferences"},markets:{type:"array",items:{$ref:"#/components/schemas/Market"}},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}}},required:["id","created_at","updated_at","type","price_list_id","preferences"],"x-typelizer":!0},Price:{type:"object",properties:{id:{type:"string"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},amount:{type:"string",nullable:!0},compare_at_amount:{type:"string",nullable:!0},price_list_id:{type:"string",nullable:!0},min_quantity:{type:"number"},variant_id:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},variant:{$ref:"#/components/schemas/Variant"}},required:["id","currency","amount","compare_at_amount","price_list_id","min_quantity","variant_id","created_at","updated_at"],"x-typelizer":!0},ProductPublication:{type:"object",properties:{id:{type:"string"},published_at:{type:"string",nullable:!0},unpublished_at:{type:"string",nullable:!0},product_id:{type:"string"},channel_id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","published_at","unpublished_at","product_id","channel_id","created_at","updated_at"],"x-typelizer":!0},Product:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},meta_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},meta_keywords:{type:"string",nullable:!0},variant_count:{type:"number"},available_on:{type:"string",nullable:!0},preorder_ships_at:{type:"string",nullable:!0},purchasable:{type:"boolean"},preorder:{type:"boolean"},in_stock:{type:"boolean"},backorderable:{type:"boolean"},available:{type:"boolean"},description:{type:"string",nullable:!0},description_html:{type:"string",nullable:!0},default_variant_id:{type:"string"},buy_box_variant_id:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},tags:{type:"array",items:{type:"string"}},price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},original_price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},primary_media:{$ref:"#/components/schemas/Media"},media:{type:"array",items:{$ref:"#/components/schemas/Media"}},variants:{type:"array",items:{$ref:"#/components/schemas/Variant"}},default_variant:{$ref:"#/components/schemas/Variant"},option_types:{type:"array",items:{$ref:"#/components/schemas/OptionType"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},prior_price:{allOf:[{$ref:"#/components/schemas/PriceHistory"}],nullable:!0},external_references:{type:"object"},translations:{type:"object"},status:{anyOf:[{type:"string",enum:["draft","active","archived","proposed","rejected"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},metadata:{type:"object"},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},submission:{allOf:[{$ref:"#/components/schemas/ProductSubmission"}],nullable:!0},seller_name:{type:"string",nullable:!0},product_type_id:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},digital_assets:{type:"array",items:{$ref:"#/components/schemas/DigitalAsset"}},collections:{type:"array",items:{$ref:"#/components/schemas/Collection"}},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublication"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},product_type:{$ref:"#/components/schemas/ProductType"}},required:["id","name","slug","meta_title","meta_description","meta_keywords","variant_count","available_on","preorder_ships_at","purchasable","preorder","in_stock","backorderable","available","description","description_html","default_variant_id","buy_box_variant_id","thumbnail_url","tags","price","original_price","seller_id","external_references","status","metadata","deleted_at","created_at","updated_at","delivery_profile_id","seller_name","product_type_id","tax_category_id"],"x-typelizer":!0},ProductSubmission:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","approved","rejected","withdrawn"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},review_note:{type:"string",nullable:!0},reviewed_at:{type:"string",nullable:!0},created_at:{type:"string"},product_id:{type:"string"},metadata:{type:"object",nullable:!0},updated_at:{type:"string"},submitted_by_id:{type:"string",nullable:!0},reviewed_by_id:{type:"string",nullable:!0},reviewed_by_name:{type:"string",nullable:!0},auto_approved:{type:"boolean"}},required:["id","status","review_note","reviewed_at","created_at","product_id","metadata","updated_at","submitted_by_id","reviewed_by_id","reviewed_by_name","auto_approved"],"x-typelizer":!0},ProductTypeCustomFieldDefinition:{type:"object",properties:{id:{type:"string"},key:{type:"string"},namespace:{type:"string"},label:{type:"string"},field_type:{type:"string",enum:["short_text","long_text","rich_text","number","boolean","json"]},required:{type:"boolean"},sort_order:{type:"number"}},required:["id","key","namespace","label","field_type","required","sort_order"],"x-typelizer":!0},ProductType:{type:"object",properties:{id:{type:"string"},name:{type:"string"},translations:{type:"object"},products_count:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},option_type_ids:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinition"}}},required:["id","name","products_count","created_at","updated_at","delivery_profile_id","option_type_ids","category_ids","custom_field_definitions"],"x-typelizer":!0},PromotionAction:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Action type. Built-in: create_adjustment, create_item_adjustments, create_line_items, free_shipping. Extensions may register more."},promotion_id:{type:"string"},preferences:{type:"object"},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculator"}],nullable:!0},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItem"},nullable:!0}},required:["id","created_at","updated_at","type","promotion_id","preferences","calculator","line_items"],"x-typelizer":!0},PromotionRule:{type:"object",properties:{id:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},type:{type:"string",description:"Rule type. Built-in: currency, country, channel, market, item_total, product, customer, customer_group, first_order, customer_logged_in, one_use_per_user, category, option_value. Extensions may register more."},promotion_id:{type:"string"},preferences:{$ref:"#/components/schemas/PromotionRulePreferences"},product_ids:{type:"array",items:{type:"string"},nullable:!0},category_ids:{type:"array",items:{type:"string"},nullable:!0},customer_ids:{type:"array",items:{type:"string"},nullable:!0},option_value_ids:{type:"array",items:{type:"string"},nullable:!0},products:{type:"array",items:{$ref:"#/components/schemas/Product"}},categories:{type:"array",items:{$ref:"#/components/schemas/Category"}},customers:{type:"array",items:{$ref:"#/components/schemas/Customer"}},customer_groups:{type:"array",items:{$ref:"#/components/schemas/CustomerGroup"}},countries:{type:"array",items:{$ref:"#/components/schemas/Country"}},channels:{type:"array",items:{$ref:"#/components/schemas/Channel"}},markets:{type:"array",items:{$ref:"#/components/schemas/Market"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}}},required:["id","created_at","updated_at","type","promotion_id","preferences","product_ids","category_ids","customer_ids","option_value_ids"],"x-typelizer":!0},Promotion:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",nullable:!0},starts_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},usage_limit:{type:"number",nullable:!0},match_policy:{type:"string",enum:["all","any"]},path:{type:"string",nullable:!0},kind:{type:"string",enum:["coupon_code","automatic"]},multi_codes:{type:"boolean"},number_of_codes:{type:"number",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},action_ids:{type:"array",items:{type:"string"}},rule_ids:{type:"array",items:{type:"string"}}},required:["id","name","description","code","starts_at","expires_at","usage_limit","match_policy","path","kind","multi_codes","number_of_codes","code_prefix","promotion_category_id","metadata","created_at","updated_at","action_ids","rule_ids"],"x-typelizer":!0},PurchaseOrderItem:{type:"object",properties:{id:{type:"string"},quantity_ordered:{type:"number"},quantity_received:{type:"number"},quantity_rejected:{type:"number"},quantity_over:{type:"number"},outstanding:{type:"number"},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},created_at:{type:"string"},updated_at:{type:"string"},unit_cost:{type:"string"},total_cost:{type:"string"},purchase_order_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_ordered","quantity_received","quantity_rejected","quantity_over","outstanding","currency","created_at","updated_at","unit_cost","total_cost","purchase_order_id","variant_id","product_id","variant_name","variant_sku","options_text","thumbnail_url"],"x-typelizer":!0},PurchaseOrder:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","ordered","partially_received","received","over_received","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},metadata:{type:"object"},close_reason:{type:"string",nullable:!0},items_count:{type:"number"},quantity_received_total:{type:"number"},quantity_rejected_total:{type:"number"},ordered_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},closed_short_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},expected_at:{type:"string",nullable:!0},cancel_by:{type:"string",nullable:!0},closed_short:{type:"boolean"},quantity_ordered_total:{type:"number"},editable:{type:"boolean"},subtotal:{type:"string"},supplier_id:{type:"string",nullable:!0},destination_location_id:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItem"}},stock_receipts:{type:"array",items:{$ref:"#/components/schemas/StockReceipt"}},supplier:{$ref:"#/components/schemas/Supplier"},destination_location:{$ref:"#/components/schemas/StockLocation"}},required:["id","number","status","currency","reference","notes","metadata","close_reason","items_count","quantity_received_total","quantity_rejected_total","ordered_at","received_at","closed_short_at","created_at","updated_at","expected_at","cancel_by","closed_short","quantity_ordered_total","editable","subtotal","supplier_id","destination_location_id"],"x-typelizer":!0},RefundReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Refund:{type:"object",properties:{id:{type:"string"},transaction_id:{type:"string",nullable:!0},amount:{type:"string",nullable:!0},payment_id:{type:"string",nullable:!0},refund_reason_id:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0},originator_type:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},tax_amount:{type:"string"},refunder_id:{type:"string",nullable:!0},refunder_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},refunder:{$ref:"#/components/schemas/Actor"},payment:{$ref:"#/components/schemas/Payment"}},required:["id","transaction_id","amount","payment_id","refund_reason_id","originator_id","originator_type","metadata","created_at","updated_at","tax_amount","refunder_id","refunder_type"],"x-typelizer":!0},ReturnLineItem:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},received_quantity:{type:"number"},resellable:{type:"boolean"},pre_tax_amount:{type:"string"},included_tax_total:{type:"string"},additional_tax_total:{type:"string"},tax_total:{type:"string"},refund_amount:{type:"string"},variant_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_item_id:{type:"string",nullable:!0},variant:{$ref:"#/components/schemas/Variant"},created_at:{type:"string"},updated_at:{type:"string"},line_item:{$ref:"#/components/schemas/LineItem"},tax_lines:{type:"array",items:{$ref:"#/components/schemas/TaxLine"}}},required:["id","quantity","received_quantity","resellable","pre_tax_amount","included_tax_total","additional_tax_total","tax_total","refund_amount","variant_id","line_item_id","fulfillment_item_id","created_at","updated_at"],"x-typelizer":!0},ReturnReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","active","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},Return:{type:"object",properties:{id:{type:"string"},number:{type:"string"},status:{anyOf:[{type:"string",enum:["requested","approved","received","refunded","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},order_id:{type:"string",nullable:!0},reason_id:{type:"string",nullable:!0},refund_total:{type:"string"},refund_tax_total:{type:"string"},approved_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},refunded_at:{type:"string",nullable:!0},canceled_at:{type:"string",nullable:!0},reason:{$ref:"#/components/schemas/ReturnReason"},return_line_items:{type:"array",items:{$ref:"#/components/schemas/ReturnLineItem"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},stock_location_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},refunded_total:{type:"string"},refundable_total:{type:"string"},order:{$ref:"#/components/schemas/Order"},stock_location:{$ref:"#/components/schemas/StockLocation"},refunds:{type:"array",items:{$ref:"#/components/schemas/Refund"}},documents:{type:"array",items:{type:"object"}},labels:{type:"array",items:{$ref:"#/components/schemas/ShippingLabel"}},deliveries:{type:"array",items:{$ref:"#/components/schemas/Delivery"}}},required:["id","number","status","order_id","reason_id","refund_total","refund_tax_total","approved_at","received_at","refunded_at","canceled_at","external_references","memo","metadata","created_at","updated_at","stock_location_id","created_by_id","created_by_type","refunded_total","refundable_total","documents","labels","deliveries"],"x-typelizer":!0},Role:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},permissions:{type:"array",items:{type:"string"}},mutable:{type:"boolean"},users_count:{type:"number"}},required:["id","name","description","created_at","updated_at","permissions","mutable","users_count"],"x-typelizer":!0},SavedReport:{type:"object",properties:{id:{type:"string"},name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object"},seeded:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},user_id:{type:"string",nullable:!0},author_name:{type:"string",nullable:!0}},required:["id","name","description","query","seeded","created_at","updated_at","user_id","author_name"],"x-typelizer":!0},SellerBalance:{type:"object",properties:{currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},settlement_currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},converted:{type:"boolean"},seller_id:{type:"string"},earned:{type:"string"},pending:{type:"string"},payable:{type:"string"},paid:{type:"string"},balance:{type:"string"}},required:["currency","settlement_currency","converted","seller_id","earned","pending","payable","paid","balance"],"x-typelizer":!0},SellerPayout:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed","unresolved"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},metadata:{type:"object"},period_start:{type:"string",nullable:!0},period_end:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"},seller_id:{type:"string"},seller_name:{type:"string",nullable:!0},transfers_count:{type:"number"},provider:{type:"string",description:"Payout provider. Built-in: system. Provider gems register more (e.g. stripe)."}},required:["id","status","currency","reference","metadata","period_start","period_end","created_at","updated_at","amount","seller_id","seller_name","transfers_count","provider"],"x-typelizer":!0},SellerRequirement:{type:"object",properties:{id:{type:"string"},position:{type:"number"},active:{type:"boolean"},required:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},kind:{type:"string",description:"Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more."},name:{type:"string"},description:{type:"string",nullable:!0},preferences:{$ref:"#/components/schemas/SellerRequirementPreferences"},custom_field_definition_ids:{type:"array",items:{type:"string"}},allow_multiple:{type:"boolean"},accepts_submissions:{type:"boolean"},reviewed_by_operator:{type:"boolean"}},required:["id","position","active","required","metadata","created_at","updated_at","kind","name","description","preferences","custom_field_definition_ids","allow_multiple","accepts_submissions","reviewed_by_operator"],"x-typelizer":!0},SellerRequirementStatus:{type:"object",properties:{id:{type:"string"},kind:{type:"string",description:"Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more."},name:{type:"string"},description:{type:"string",nullable:!0},required:{type:"boolean"},position:{type:"number"},status:{type:"string",enum:["complete","incomplete","pending","rejected"]},action_url:{type:"string",nullable:!0},blocker:{type:"object",nullable:!0},blocking:{type:"boolean"},required_policy_name:{type:"string",nullable:!0},submission:{$ref:"#/components/schemas/SellerRequirementSubmission"},published_policy:{$ref:"#/components/schemas/Policy"}},required:["id","kind","name","description","required","position","status","action_url","blocker","blocking","required_policy_name"],"x-typelizer":!0},SellerRequirementSubmission:{type:"object",properties:{id:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","accepted","rejected","waived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},note:{type:"string",nullable:!0},review_note:{type:"string",nullable:!0},reference:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},reviewed_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},seller_id:{type:"string"},requirement_id:{type:"string"},requirement_name:{type:"string"},file_url:{type:"string",nullable:!0},file_name:{type:"string",nullable:!0}},required:["id","status","note","review_note","reference","metadata","reviewed_at","created_at","updated_at","seller_id","requirement_id","requirement_name","file_url","file_name"],"x-typelizer":!0},Seller:{type:"object",properties:{id:{type:"string"},name:{type:"string"},slug:{type:"string"},about:{type:"string"},about_html:{type:"string"},logo_url:{type:"string",nullable:!0},square_logo_url:{type:"string",nullable:!0},cover_photo_url:{type:"string",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},external_references:{type:"object"},status:{anyOf:[{type:"string",enum:["pending","invited","canceled","onboarding","ready_for_review","approved","rejected","suspended"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",nullable:!0,enum:["daily","weekly","biweekly","monthly","manual"]},metadata:{type:"object",nullable:!0},holiday_mode_until:{type:"string",nullable:!0},terms_accepted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},minimum_payout_amount:{type:"string",nullable:!0},on_holiday:{type:"boolean"},sellable:{type:"boolean"},products_count:{type:"number"},users_count:{type:"number"},onboarding_progress:{type:"object"},onboarding_complete:{type:"boolean"},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},billing_address:{$ref:"#/components/schemas/Address"},returns_address:{$ref:"#/components/schemas/Address"}},required:["id","name","slug","about","about_html","logo_url","square_logo_url","cover_photo_url","external_references","status","contact_email","billing_email","tax_remittance","payouts_schedule_interval","metadata","holiday_mode_until","terms_accepted_at","created_at","updated_at","deleted_at","minimum_payout_amount","on_holiday","sellable","products_count","users_count","onboarding_progress","onboarding_complete","legal_name","registration_number"],"x-typelizer":!0},SellerTeamMember:{type:"object",properties:{id:{type:"string"},email:{type:"string"},first_name:{type:"string",nullable:!0},last_name:{type:"string",nullable:!0},full_name:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},avatar_url:{type:"string",nullable:!0}},required:["id","email","first_name","last_name","full_name","created_at","updated_at","avatar_url"],"x-typelizer":!0},SellerTransfer:{type:"object",properties:{id:{type:"string"},kind:{type:"string",enum:["earning","refund_reversal"]},status:{anyOf:[{type:"string",enum:["pending","processing","completed","failed","unresolved"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},reference:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},amount:{type:"string"},settled_amount:{type:"string",nullable:!0},settled_currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},converted:{type:"boolean"},seller_id:{type:"string"},order_id:{type:"string",nullable:!0},payout_id:{type:"string",nullable:!0},reversed_from_id:{type:"string",nullable:!0},refund_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},order_number:{type:"string",nullable:!0},provider:{type:"string",description:"Payout provider. Built-in: system. Provider gems register more (e.g. stripe)."}},required:["id","kind","status","currency","reference","metadata","created_at","updated_at","amount","settled_amount","settled_currency","converted","seller_id","order_id","payout_id","reversed_from_id","refund_id","seller_name","order_number","provider"],"x-typelizer":!0},Session:{type:"object",properties:{id:{type:"string"},ip_address:{type:"string",nullable:!0},user_agent:{type:"string",nullable:!0},last_active_at:{type:"string"}},required:["id","ip_address","user_agent","last_active_at"],"x-typelizer":!0},SetupTask:{type:"object",properties:{name:{type:"string"},done:{type:"boolean"}},required:["name","done"],"x-typelizer":!0},ShippingLabel:{type:"object",properties:{id:{type:"string"},source:{type:"string",enum:["purchased","uploaded"]},status:{anyOf:[{type:"string",enum:["purchased","refund_requested","refunded"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},carrier:{type:"string",nullable:!0},carrier_name:{type:"string",nullable:!0},service:{type:"string",nullable:!0},tracking_number:{type:"string",nullable:!0},currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},format:{type:"string",nullable:!0,enum:["pdf","png","zpl"]},external_id:{type:"string",nullable:!0},metadata:{type:"object"},refunded_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},owner_id:{type:"string"},owner_type:{type:"string",enum:["fulfillment","return"]},cost:{type:"string"},integration_id:{type:"string",nullable:!0},file_pending:{type:"boolean"},download_url:{type:"string",nullable:!0}},required:["id","source","status","carrier","carrier_name","service","tracking_number","currency","format","external_id","metadata","refunded_at","created_at","updated_at","owner_id","owner_type","cost","integration_id","file_pending","download_url"],"x-typelizer":!0},State:{type:"object",properties:{abbr:{type:"string"},name:{type:"string"}},required:["abbr","name"],"x-typelizer":!0},StockLevel:{type:"object",properties:{id:{type:"string"},count_on_hand:{type:"number"},backorderable:{type:"boolean"},stock_location_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},external_references:{type:"object"},metadata:{type:"object"},reserved_count:{type:"number"},incoming_count:{type:"number"},purchasable_count:{type:"number"},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},stock_location_name:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},allocated_count:{type:"number"},available_count:{type:"number"},stock_location:{$ref:"#/components/schemas/StockLocation"},variant:{$ref:"#/components/schemas/Variant"}},required:["id","count_on_hand","backorderable","stock_location_id","variant_id","external_references","metadata","reserved_count","incoming_count","purchasable_count","variant_name","variant_sku","created_at","updated_at","stock_location_name","product_id","options_text","thumbnail_url","allocated_count","available_count"],"x-typelizer":!0},StockLocation:{type:"object",properties:{id:{type:"string"},name:{type:"string"},address1:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},country_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},state_text:{type:"string",nullable:!0},pickup_ready_in_minutes:{type:"number",nullable:!0},pickup_instructions:{type:"string",nullable:!0},external_references:{type:"object"},admin_name:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},active:{type:"boolean"},default:{type:"boolean"},backorderable_default:{type:"boolean"},propagate_all_variants:{type:"boolean"},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"]},returns_enabled:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"},seller_id:{type:"string",nullable:!0},seller_name:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"}},required:["id","name","address1","city","zipcode","country_code","country_name","state_code","state_text","pickup_ready_in_minutes","pickup_instructions","external_references","admin_name","address2","state_name","phone","company","active","default","backorderable_default","propagate_all_variants","kind","pickup_enabled","pickup_stock_policy","returns_enabled","created_at","updated_at","seller_id","seller_name"],"x-typelizer":!0},StockMovement:{type:"object",properties:{id:{type:"string"},quantity:{type:"number"},kind:{type:"string",nullable:!0,enum:["received","allocated","shipped","released","adjusted"]},reason:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},stock_level_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},stock_location_name:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},order_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},return_id:{type:"string",nullable:!0},exchange_id:{type:"string",nullable:!0},stock_transfer_id:{type:"string",nullable:!0},stock_receipt_id:{type:"string",nullable:!0},purchase_order_id:{type:"string",nullable:!0},order_number:{type:"string",nullable:!0},return_number:{type:"string",nullable:!0},exchange_number:{type:"string",nullable:!0},stock_transfer_number:{type:"string",nullable:!0},purchase_order_number:{type:"string",nullable:!0},unit_cost:{type:"string",nullable:!0}},required:["id","quantity","kind","reason","created_at","updated_at","stock_level_id","stock_location_id","stock_location_name","variant_id","variant_name","variant_sku","order_id","fulfillment_id","return_id","exchange_id","stock_transfer_id","stock_receipt_id","purchase_order_id","order_number","return_number","exchange_number","stock_transfer_number","purchase_order_number","unit_cost"],"x-typelizer":!0},StockReceiptItem:{type:"object",properties:{id:{type:"string"},quantity_accepted:{type:"number"},quantity_rejected:{type:"number"},rejection_reason:{type:"string",nullable:!0,enum:["damaged","wrong_item","expired","other"]},notes:{type:"string",nullable:!0},line_type:{type:"string",enum:["purchase_order_item","stock_transfer_item"]},line_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_accepted","quantity_rejected","rejection_reason","notes","line_type","line_id","variant_id","product_id","variant_name","variant_sku","thumbnail_url"],"x-typelizer":!0},StockReceipt:{type:"object",properties:{id:{type:"string"},number:{type:"string"},reference:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},metadata:{type:"object"},quantity_accepted_total:{type:"number"},quantity_rejected_total:{type:"number"},received_at:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},receivable_type:{type:"string",enum:["purchase_order","stock_transfer"]},receivable_id:{type:"string"},received_by_id:{type:"string",nullable:!0},received_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},received_by:{$ref:"#/components/schemas/Actor"},items_count:{type:"number"},items:{type:"array",items:{$ref:"#/components/schemas/StockReceiptItem"}}},required:["id","number","reference","notes","metadata","quantity_accepted_total","quantity_rejected_total","received_at","created_at","updated_at","receivable_type","receivable_id","received_by_id","received_by_type","items_count"],"x-typelizer":!0},StockReservation:{type:"object",properties:{id:{type:"string"},stock_level_id:{type:"string"},line_item_id:{type:"string"},order_id:{type:"string"},variant_id:{type:"string",nullable:!0},stock_location_id:{type:"string",nullable:!0},quantity:{type:"number"},expires_at:{type:"string"},active:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","stock_level_id","line_item_id","order_id","variant_id","stock_location_id","quantity","expires_at","active","created_at","updated_at"],"x-typelizer":!0},StockTransferItem:{type:"object",properties:{id:{type:"string"},quantity_shipped:{type:"number"},quantity_received:{type:"number"},quantity_rejected:{type:"number"},quantity_over:{type:"number"},outstanding:{type:"number"},created_at:{type:"string"},updated_at:{type:"string"},stock_transfer_id:{type:"string",nullable:!0},variant_id:{type:"string",nullable:!0},product_id:{type:"string",nullable:!0},variant_name:{type:"string",nullable:!0},variant_sku:{type:"string",nullable:!0},options_text:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0}},required:["id","quantity_shipped","quantity_received","quantity_rejected","quantity_over","outstanding","created_at","updated_at","stock_transfer_id","variant_id","product_id","variant_name","variant_sku","options_text","thumbnail_url"],"x-typelizer":!0},StockTransfer:{type:"object",properties:{id:{type:"string"},number:{type:"string"},reference:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},source_location_id:{type:"string"},destination_location_id:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","ready_to_ship","in_transit","partially_received","received","over_received","canceled"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},notes:{type:"string",nullable:!0},metadata:{type:"object"},close_reason:{type:"string",nullable:!0},items_count:{type:"number"},quantity_received_total:{type:"number"},quantity_rejected_total:{type:"number"},shipped_at:{type:"string",nullable:!0},received_at:{type:"string",nullable:!0},closed_short_at:{type:"string",nullable:!0},deleted_at:{type:"string",nullable:!0},closed_short:{type:"boolean"},quantity_shipped_total:{type:"number"},editable:{type:"boolean"},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItem"}},stock_receipts:{type:"array",items:{$ref:"#/components/schemas/StockReceipt"}},source_location:{$ref:"#/components/schemas/StockLocation"},destination_location:{$ref:"#/components/schemas/StockLocation"}},required:["id","number","reference","created_at","updated_at","source_location_id","destination_location_id","status","notes","metadata","close_reason","items_count","quantity_received_total","quantity_rejected_total","shipped_at","received_at","closed_short_at","deleted_at","closed_short","quantity_shipped_total","editable"],"x-typelizer":!0},StoreCreditEvent:{type:"object",properties:{id:{type:"string"},action:{type:"string"},authorization_code:{type:"string",nullable:!0},display_action:{type:"string",nullable:!0},amount:{type:"string"},created_at:{type:"string"},updated_at:{type:"string"},store_credit_id:{type:"string"},originator_type:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0}},required:["id","action","authorization_code","display_action","amount","created_at","updated_at","store_credit_id","originator_type","originator_id"],"x-typelizer":!0},StoreCredit:{type:"object",properties:{id:{type:"string"},amount:{type:"string"},amount_used:{type:"string"},amount_remaining:{type:"string"},currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},memo:{type:"string",nullable:!0},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},amount_authorized:{type:"string"},outstanding:{type:"boolean"},customer_id:{type:"string",nullable:!0},created_by_id:{type:"string",nullable:!0},created_by_type:{anyOf:[{type:"string",enum:["admin_user","api_key"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},created_by:{$ref:"#/components/schemas/Actor"},originator_type:{type:"string",nullable:!0},originator_id:{type:"string",nullable:!0},customer:{$ref:"#/components/schemas/Customer"}},required:["id","amount","amount_used","amount_remaining","currency","memo","metadata","created_at","updated_at","amount_authorized","outstanding","customer_id","created_by_id","created_by_type","originator_type","originator_id"],"x-typelizer":!0},Store:{type:"object",properties:{id:{type:"string"},name:{type:"string"},seo_title:{type:"string",nullable:!0},meta_description:{type:"string",nullable:!0},metadata:{type:"object"},code:{type:"string"},default_currency:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},default_locale:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},default_country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},mail_from_address:{type:"string",nullable:!0},customer_support_email:{type:"string",nullable:!0},new_order_notifications_email:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},order_routing_strategy:{type:"string",description:"Order routing strategy. Built-in: rules. Extensions may register more."},payout_provider:{type:"string",nullable:!0,description:"Payout provider; null uses the installation default. Built-in: system. Provider gems register more (e.g. stripe)."},admin_locale:{type:"string",nullable:!0,enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},timezone:{anyOf:[{type:"string",enum:["Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Asuncion","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Nuuk","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Canberra","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Etc/GMT+12","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu","UTC"]},{type:"string"}],description:"Common IANA time zones; any other IANA time zone identifier is accepted too."},storefront_url:{type:"string",nullable:!0},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},unit_system:{type:"string",enum:["metric","imperial"]},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"]},guest_checkout:{type:"boolean"},always_include_confirm_step:{type:"boolean"},company_field_enabled:{type:"boolean"},address_requires_company:{type:"boolean"},address_requires_phone:{type:"boolean"},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"]},track_inventory_levels:{type:"boolean"},stock_reservations_enabled:{type:"boolean"},low_stock_threshold:{type:"number"},tax_using_ship_address:{type:"boolean"},track_price_history:{type:"boolean"},show_products_without_price:{type:"boolean"},disable_sku_validation:{type:"boolean"},pricing_provider:{type:"string"},inventory_provider:{type:"string"},pricing_provider_failure_policy:{type:"string",enum:["fallback","strict"]},inventory_provider_failure_policy:{type:"string",enum:["fallback","strict"]},default_payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"]},auto_approve_sellers:{type:"boolean"},auto_approve_seller_products:{type:"boolean"},seller_digital_assets_enabled:{type:"boolean"},seller_digital_asset_content_types:{type:"array",items:{type:"string"}},review_seller_digital_asset_changes:{type:"boolean"},send_seller_transactional_emails:{type:"boolean"},document_number_format:{type:"string",enum:["sequential","random"]},order_number_prefix:{type:"string"},order_number_suffix:{type:"string"},order_number_sequence_start:{type:"number"},limit_digital_download_count:{type:"boolean"},digital_asset_authorized_clicks:{type:"number"},limit_digital_download_days:{type:"boolean"},digital_asset_authorized_days:{type:"number"},send_consumer_transactional_emails:{type:"boolean"},email_accent_color:{type:"string",nullable:!0},email_background_color:{type:"string",nullable:!0},email_card_color:{type:"string",nullable:!0},email_text_color:{type:"string",nullable:!0},email_heading_color:{type:"string",nullable:!0},email_font:{type:"string",nullable:!0,enum:["inter","system","helvetica","georgia","roboto","lato","merriweather"]},order_number_sequence_started:{type:"boolean"},default_minimum_payout_amount:{type:"string",nullable:!0},default_commission_tax_rate:{type:"string",nullable:!0},url:{type:"string"},api_url:{type:"string"},setup_tasks:{type:"array",items:{$ref:"#/components/schemas/SetupTask"}},supported_currencies:{type:"array",items:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]}},supported_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},available_locales:{type:"array",items:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]}},logo_url:{type:"string",nullable:!0},mailer_logo_url:{type:"string",nullable:!0}},required:["id","name","seo_title","meta_description","metadata","code","default_currency","default_locale","default_country_code","mail_from_address","customer_support_email","new_order_notifications_email","created_at","updated_at","order_routing_strategy","payout_provider","admin_locale","timezone","storefront_url","weight_unit","unit_system","storefront_access","guest_checkout","always_include_confirm_step","company_field_enabled","address_requires_company","address_requires_phone","capture_method","track_inventory_levels","stock_reservations_enabled","low_stock_threshold","tax_using_ship_address","track_price_history","show_products_without_price","disable_sku_validation","pricing_provider","inventory_provider","pricing_provider_failure_policy","inventory_provider_failure_policy","default_payouts_schedule_interval","auto_approve_sellers","auto_approve_seller_products","seller_digital_assets_enabled","seller_digital_asset_content_types","review_seller_digital_asset_changes","send_seller_transactional_emails","document_number_format","order_number_prefix","order_number_suffix","order_number_sequence_start","limit_digital_download_count","digital_asset_authorized_clicks","limit_digital_download_days","digital_asset_authorized_days","send_consumer_transactional_emails","email_accent_color","email_background_color","email_card_color","email_text_color","email_heading_color","email_font","order_number_sequence_started","default_minimum_payout_amount","default_commission_tax_rate","url","api_url","setup_tasks","supported_currencies","supported_locales","available_locales","logo_url","mailer_logo_url"],"x-typelizer":!0},Supplier:{type:"object",properties:{id:{type:"string"},name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},postal_code:{type:"string",nullable:!0},purchase_orders_count:{type:"number"},metadata:{type:"object"},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},can_be_deleted:{type:"boolean"}},required:["id","name","contact_name","email","phone","notes","address1","address2","city","state_name","state_code","country_code","postal_code","purchase_orders_count","metadata","created_at","updated_at","deleted_at","can_be_deleted"],"x-typelizer":!0},TaxCategory:{type:"object",properties:{id:{type:"string"},name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"},created_at:{type:"string"},updated_at:{type:"string"}},required:["id","name","tax_code","description","is_default","created_at","updated_at"],"x-typelizer":!0},TaxExemptionCertificate:{type:"object",properties:{id:{type:"string"},certificate_number:{type:"string"},status:{anyOf:[{type:"string",enum:["pending","verified","expired","revoked"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},issuing_authority:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},issued_at:{type:"string",nullable:!0},expires_at:{type:"string",nullable:!0},verified_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},company_id:{type:"string"},tax_exemption_reason_id:{type:"string"},tax_exemption_reason:{$ref:"#/components/schemas/TaxExemptionReason"},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},active:{type:"boolean"},lapsed:{type:"boolean"},can_be_deleted:{type:"boolean"},document_filename:{type:"string",nullable:!0},document_byte_size:{type:"number",nullable:!0},document_url:{type:"string",nullable:!0}},required:["id","certificate_number","status","issuing_authority","metadata","issued_at","expires_at","verified_at","created_at","updated_at","company_id","tax_exemption_reason_id","country_code","state_code","active","lapsed","can_be_deleted","document_filename","document_byte_size","document_url"],"x-typelizer":!0},TaxExemptionReason:{type:"object",properties:{id:{type:"string"},name:{type:"string"},code:{type:"string"},active:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},can_be_deleted:{type:"boolean"}},required:["id","name","code","active","metadata","created_at","updated_at","can_be_deleted"],"x-typelizer":!0},TaxIdentifier:{type:"object",properties:{id:{type:"string"},kind:{type:"string",description:"Tax identifier kind, keyed to a registered validator. Built-in: eu_vat. Extensions may register more."},value:{type:"string"},validation_status:{type:"string",nullable:!0,enum:["pending","verified","unverified","unavailable","unsupported"]},validation_evidence:{type:"object",nullable:!0},source:{type:"string",nullable:!0,enum:["override","company","customer"]},validated_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},validatable:{type:"boolean"},customer_id:{type:"string",nullable:!0},cart_id:{type:"string",nullable:!0},order_id:{type:"string",nullable:!0}},required:["id","kind","value","validation_status","validation_evidence","source","validated_at","created_at","updated_at","validatable","customer_id","cart_id","order_id"],"x-typelizer":!0},TaxLine:{type:"object",properties:{id:{type:"string"},label:{type:"string"},included:{type:"boolean"},credit:{type:"boolean"},rate:{type:"string",nullable:!0},tax_rate_id:{type:"string",nullable:!0},line_item_id:{type:"string",nullable:!0},fulfillment_id:{type:"string",nullable:!0},fee_id:{type:"string",nullable:!0},return_line_item_id:{type:"string",nullable:!0},claim_line_item_id:{type:"string",nullable:!0},exchange_line_item_id:{type:"string",nullable:!0},amount:{type:"string"},provider_id:{type:"string",nullable:!0},metadata:{type:"object",nullable:!0},taxability_reason:{anyOf:[{type:"string",enum:["standard_rated","reduced_rated","zero_rated","reverse_charge","intra_community_supply","export","customer_exempt","product_exempt","not_collecting","not_subject_to_tax"]},{type:"string",nullable:!0}],description:"The values listed are the built-in ones; extensions may add more."},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0},data:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},original_tax_line_id:{type:"string",nullable:!0}},required:["id","label","included","credit","rate","tax_rate_id","line_item_id","fulfillment_id","fee_id","return_line_item_id","claim_line_item_id","exchange_line_item_id","amount","provider_id","metadata","taxability_reason","country_code","state_code","data","created_at","updated_at","original_tax_line_id"],"x-typelizer":!0},TaxRate:{type:"object",properties:{id:{type:"string"},name:{type:"string"},show_rate_in_label:{type:"boolean"},metadata:{type:"object",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},deleted_at:{type:"string",nullable:!0},rate:{type:"string",nullable:!0},rate_percent:{type:"string",nullable:!0},tax_category_id:{type:"string",nullable:!0},store_id:{type:"string",nullable:!0},country_code:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},state_code:{type:"string",nullable:!0}},required:["id","name","show_rate_in_label","metadata","created_at","updated_at","deleted_at","rate","rate_percent","tax_category_id","store_id","country_code","state_code"],"x-typelizer":!0},UpdateStatus:{type:"object",properties:{current_version:{type:"string"},enabled:{type:"boolean"},checked_at:{type:"string",nullable:!0},update_available:{type:"boolean"},latest_version:{type:"string",nullable:!0},latest_release_url:{type:"string",nullable:!0},latest_release_published_at:{type:"string",nullable:!0}},required:["current_version","enabled","checked_at","update_available","latest_version","latest_release_url","latest_release_published_at"],"x-typelizer":!0},Variant:{type:"object",properties:{id:{type:"string"},product_id:{type:"string"},sku:{type:"string",nullable:!0},options_text:{type:"string"},track_inventory:{type:"boolean"},media_count:{type:"number"},preorder_ships_at:{type:"string",nullable:!0},thumbnail_url:{type:"string",nullable:!0},purchasable:{type:"boolean"},in_stock:{type:"boolean"},backorderable:{type:"boolean"},preorder:{type:"boolean"},weight:{type:"number",nullable:!0},height:{type:"number",nullable:!0},width:{type:"number",nullable:!0},depth:{type:"number",nullable:!0},weight_unit:{type:"string",enum:["g","kg","lb","oz"]},dimensions_unit:{type:"string",enum:["mm","cm","in","ft"]},minimum_order_quantity:{type:"number",nullable:!0},order_multiple:{type:"number",nullable:!0},purchase_unit:{type:"string",nullable:!0,enum:["unit","carton"]},units_per_carton:{type:"number",nullable:!0},price:{$ref:"#/components/schemas/Price"},original_price:{allOf:[{$ref:"#/components/schemas/Price"}],nullable:!0},seller_id:{type:"string",nullable:!0},seller:{$ref:"#/components/schemas/Seller"},primary_media:{$ref:"#/components/schemas/Media"},media:{type:"array",items:{$ref:"#/components/schemas/Media"}},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValue"}},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomField"}},prior_price:{allOf:[{$ref:"#/components/schemas/PriceHistory"}],nullable:!0},external_references:{type:"object"},metadata:{type:"object"},position:{type:"number"},cost_currency:{type:"string",nullable:!0,enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},barcode:{type:"string",nullable:!0},backorder_limit:{type:"number",nullable:!0},hs_code:{type:"string",nullable:!0},country_of_origin:{type:"string",nullable:!0,enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},customs_description:{type:"string",nullable:!0},carton_weight:{type:"string",nullable:!0},cartons_per_pallet:{type:"number",nullable:!0},deleted_at:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},cost_price:{type:"string",nullable:!0},preorderable:{type:"boolean"},tax_category_id:{type:"string",nullable:!0},carton_package_type_id:{type:"string",nullable:!0},units_per_pallet:{type:"number",nullable:!0},available_stock:{type:"number",nullable:!0},reserved_quantity:{type:"number"},total_on_hand:{type:"number",nullable:!0},product_name:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},prices:{type:"array",items:{$ref:"#/components/schemas/Price"}},stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevel"}}},required:["id","product_id","sku","options_text","track_inventory","media_count","preorder_ships_at","thumbnail_url","purchasable","in_stock","backorderable","preorder","weight","height","width","depth","weight_unit","dimensions_unit","minimum_order_quantity","order_multiple","purchase_unit","units_per_carton","price","original_price","seller_id","option_values","external_references","metadata","position","cost_currency","barcode","backorder_limit","hs_code","country_of_origin","customs_description","carton_weight","cartons_per_pallet","deleted_at","created_at","updated_at","cost_price","preorderable","tax_category_id","carton_package_type_id","units_per_pallet","available_stock","reserved_quantity","total_on_hand","product_name","delivery_profile_id"],"x-typelizer":!0},WebhookDelivery:{type:"object",properties:{id:{type:"string"},event_name:{type:"string"},event_id:{type:"string",nullable:!0},response_code:{type:"number",nullable:!0},execution_time:{type:"number",nullable:!0},error_type:{type:"string",nullable:!0},request_errors:{type:"string",nullable:!0},response_body:{type:"string",nullable:!0},success:{type:"boolean",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},delivered_at:{type:"string",nullable:!0},payload:{type:"object",nullable:!0},webhook_endpoint_id:{type:"string"},webhook_endpoint_url:{type:"string"}},required:["id","event_name","event_id","response_code","execution_time","error_type","request_errors","response_body","success","created_at","updated_at","delivered_at","payload","webhook_endpoint_id","webhook_endpoint_url"],"x-typelizer":!0},WebhookEndpoint:{type:"object",properties:{id:{type:"string"},name:{type:"string",nullable:!0},url:{type:"string"},active:{type:"boolean"},subscriptions:{type:"array",items:{type:"string"}},disabled_reason:{type:"string",nullable:!0},created_at:{type:"string"},updated_at:{type:"string"},disabled_at:{type:"string",nullable:!0},secret_key:{type:"string",nullable:!0},last_delivery_at:{type:"string",nullable:!0},recent_delivery_count:{type:"number"},recent_failure_count:{type:"number"},total_delivery_count:{type:"number"},successful_delivery_count:{type:"number"},failed_delivery_count:{type:"number"}},required:["id","name","url","active","subscriptions","disabled_reason","created_at","updated_at","disabled_at","secret_key","last_delivery_at","recent_delivery_count","recent_failure_count","total_delivery_count","successful_delivery_count","failed_delivery_count"],"x-typelizer":!0},WebhookEvent:{type:"object",properties:{name:{type:"string"},group:{type:"string"},credential_permission:{type:"string",nullable:!0},credential:{type:"boolean"},deprecated:{type:"boolean"},replaced_by:{type:"string",nullable:!0}},required:["name","group","credential_permission","credential","deprecated","replaced_by"],"x-typelizer":!0},CommissionRuleCategoryRulePreferences:{type:"object",properties:{category_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ctg_[A-Za-z0-9]+$","x-spree-prefix":"ctg"},default:[]}},additionalProperties:!1},CommissionRuleItemTotalRulePreferences:{type:"object",properties:{min_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},max_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},CommissionRuleProductRulePreferences:{type:"object",properties:{},additionalProperties:!1},CommissionRuleSellerRulePreferences:{type:"object",properties:{seller_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^sel_[A-Za-z0-9]+$","x-spree-prefix":"sel"},default:[]}},additionalProperties:!1},CommissionRulePreferences:{description:"Settings of a commission rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/CommissionRuleCategoryRulePreferences"},{$ref:"#/components/schemas/CommissionRuleItemTotalRulePreferences"},{$ref:"#/components/schemas/CommissionRuleProductRulePreferences"},{$ref:"#/components/schemas/CommissionRuleSellerRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{category_rule:"#/components/schemas/CommissionRuleCategoryRulePreferences",item_total_rule:"#/components/schemas/CommissionRuleItemTotalRulePreferences",product_rule:"#/components/schemas/CommissionRuleProductRulePreferences",seller_rule:"#/components/schemas/CommissionRuleSellerRulePreferences"}},DeliveryCalculatorDigitalDeliveryPreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorFlatPercentItemTotalPreferences:{type:"object",properties:{flat_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},DeliveryCalculatorFlatRatePreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorFlexiRatePreferences:{type:"object",properties:{first_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},additional_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},max_items:{type:"integer",default:0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPerItemPreferences:{type:"object",properties:{amounts:{type:"object",additionalProperties:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},default:{},"x-spree-property-names":{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0",nullable:!0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPriceSackPreferences:{type:"object",properties:{minimal_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},normal_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},discount_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},DeliveryCalculatorPreferences:{description:"Settings of a delivery calculator, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlatRatePreferences"},{$ref:"#/components/schemas/DeliveryCalculatorFlexiRatePreferences"},{$ref:"#/components/schemas/DeliveryCalculatorPerItemPreferences"},{$ref:"#/components/schemas/DeliveryCalculatorPriceSackPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{digital_delivery:"#/components/schemas/DeliveryCalculatorDigitalDeliveryPreferences",flat_percent_item_total:"#/components/schemas/DeliveryCalculatorFlatPercentItemTotalPreferences",flat_rate:"#/components/schemas/DeliveryCalculatorFlatRatePreferences",flexi_rate:"#/components/schemas/DeliveryCalculatorFlexiRatePreferences",per_item:"#/components/schemas/DeliveryCalculatorPerItemPreferences",price_sack:"#/components/schemas/DeliveryCalculatorPriceSackPreferences"}},DeliveryMethodRuleChannelRulePreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},DeliveryMethodRuleCompanyRulePreferences:{type:"object",properties:{company_orders_only:{type:"boolean",default:!0}},additionalProperties:!1},DeliveryMethodRuleExcludedProductsRulePreferences:{type:"object",properties:{},additionalProperties:!1},DeliveryMethodRuleItemTotalRulePreferences:{type:"object",properties:{minimum_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRuleVolumeRulePreferences:{type:"object",properties:{minimum_volume:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_volume:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRuleWeightRulePreferences:{type:"object",properties:{minimum_weight:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},maximum_weight:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},additionalProperties:!1},DeliveryMethodRulePreferences:{description:"Settings of a delivery method rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/DeliveryMethodRuleChannelRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleCompanyRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleVolumeRulePreferences"},{$ref:"#/components/schemas/DeliveryMethodRuleWeightRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{channel_rule:"#/components/schemas/DeliveryMethodRuleChannelRulePreferences",company_rule:"#/components/schemas/DeliveryMethodRuleCompanyRulePreferences",excluded_products_rule:"#/components/schemas/DeliveryMethodRuleExcludedProductsRulePreferences",item_total_rule:"#/components/schemas/DeliveryMethodRuleItemTotalRulePreferences",volume_rule:"#/components/schemas/DeliveryMethodRuleVolumeRulePreferences",weight_rule:"#/components/schemas/DeliveryMethodRuleWeightRulePreferences"}},IntegrationPreferences:{description:"Settings of a integration, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{}},OrderRoutingRuleDefaultLocationPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRuleMinimizeSplitsPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRulePreferredLocationPreferences:{type:"object",properties:{},additionalProperties:!1},OrderRoutingRulePreferences:{description:"Settings of a order routing rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/OrderRoutingRuleDefaultLocationPreferences"},{$ref:"#/components/schemas/OrderRoutingRuleMinimizeSplitsPreferences"},{$ref:"#/components/schemas/OrderRoutingRulePreferredLocationPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{default_location:"#/components/schemas/OrderRoutingRuleDefaultLocationPreferences",minimize_splits:"#/components/schemas/OrderRoutingRuleMinimizeSplitsPreferences",preferred_location:"#/components/schemas/OrderRoutingRulePreferredLocationPreferences"}},PaymentMethodBogusPreferences:{type:"object",properties:{dummy_key:{type:"string",default:"PUBLICKEY123"},dummy_secret_key:{type:"string","x-spree-secret":!0,nullable:!0}},additionalProperties:!1},PaymentMethodCheckPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodCustomPaymentSourceMethodPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodStoreCreditPreferences:{type:"object",properties:{},additionalProperties:!1},PaymentMethodPreferences:{description:"Settings of a payment method, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PaymentMethodBogusPreferences"},{$ref:"#/components/schemas/PaymentMethodCheckPreferences"},{$ref:"#/components/schemas/PaymentMethodCustomPaymentSourceMethodPreferences"},{$ref:"#/components/schemas/PaymentMethodStoreCreditPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{bogus:"#/components/schemas/PaymentMethodBogusPreferences",check:"#/components/schemas/PaymentMethodCheckPreferences",custom_payment_source_method:"#/components/schemas/PaymentMethodCustomPaymentSourceMethodPreferences",store_credit:"#/components/schemas/PaymentMethodStoreCreditPreferences"}},PriceRuleChannelRulePreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},PriceRuleCustomerGroupRulePreferences:{type:"object",properties:{customer_group_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cg_[A-Za-z0-9]+$","x-spree-prefix":"cg"},default:[]}},additionalProperties:!1},PriceRuleMarketRulePreferences:{type:"object",properties:{market_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^mkt_[A-Za-z0-9]+$","x-spree-prefix":"mkt"},default:[]}},additionalProperties:!1},PriceRuleUserRulePreferences:{type:"object",properties:{user_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cust_[A-Za-z0-9]+$","x-spree-prefix":"cust"},default:[]}},additionalProperties:!1},PriceRuleVolumeRulePreferences:{type:"object",properties:{min_quantity:{type:"integer",default:1},max_quantity:{type:"integer",nullable:!0}},additionalProperties:!1},PriceRulePreferences:{description:"Settings of a price rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PriceRuleChannelRulePreferences"},{$ref:"#/components/schemas/PriceRuleCustomerGroupRulePreferences"},{$ref:"#/components/schemas/PriceRuleMarketRulePreferences"},{$ref:"#/components/schemas/PriceRuleUserRulePreferences"},{$ref:"#/components/schemas/PriceRuleVolumeRulePreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{channel_rule:"#/components/schemas/PriceRuleChannelRulePreferences",customer_group_rule:"#/components/schemas/PriceRuleCustomerGroupRulePreferences",market_rule:"#/components/schemas/PriceRuleMarketRulePreferences",user_rule:"#/components/schemas/PriceRuleUserRulePreferences",volume_rule:"#/components/schemas/PriceRuleVolumeRulePreferences"}},PromotionCalculatorFlatPercentItemTotalPreferences:{type:"object",properties:{flat_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},PromotionCalculatorFlatRatePreferences:{type:"object",properties:{amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorFlexiRatePreferences:{type:"object",properties:{first_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},additional_item:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},max_items:{type:"integer",default:0},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorPercentOnLineItemPreferences:{type:"object",properties:{percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},apply_only_on_full_priced_items:{type:"boolean",default:!1}},additionalProperties:!1},PromotionCalculatorTieredFlatRatePreferences:{type:"object",properties:{tiers:{type:"array",items:{type:"object",properties:{threshold:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},value:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["threshold","value"],additionalProperties:!1},default:[]},base_amount:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"},currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$"}},additionalProperties:!1},PromotionCalculatorTieredPercentPreferences:{type:"object",properties:{tiers:{type:"array",items:{type:"object",properties:{threshold:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$"},value:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["threshold","value"],additionalProperties:!1},default:[]},base_percent:{type:"string",pattern:"^-?\\d+(\\.\\d+)?$",default:"0"}},additionalProperties:!1},PromotionCalculatorPreferences:{description:"Settings of a promotion calculator, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PromotionCalculatorFlatPercentItemTotalPreferences"},{$ref:"#/components/schemas/PromotionCalculatorFlatRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorFlexiRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorPercentOnLineItemPreferences"},{$ref:"#/components/schemas/PromotionCalculatorTieredFlatRatePreferences"},{$ref:"#/components/schemas/PromotionCalculatorTieredPercentPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{flat_percent_item_total:"#/components/schemas/PromotionCalculatorFlatPercentItemTotalPreferences",flat_rate:"#/components/schemas/PromotionCalculatorFlatRatePreferences",flexi_rate:"#/components/schemas/PromotionCalculatorFlexiRatePreferences",percent_on_line_item:"#/components/schemas/PromotionCalculatorPercentOnLineItemPreferences",tiered_flat_rate:"#/components/schemas/PromotionCalculatorTieredFlatRatePreferences",tiered_percent:"#/components/schemas/PromotionCalculatorTieredPercentPreferences"}},PromotionRuleCategoryPreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any","all"],default:"any"}},additionalProperties:!1},PromotionRuleChannelPreferences:{type:"object",properties:{channel_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^ch_[A-Za-z0-9]+$","x-spree-prefix":"ch"},default:[]}},additionalProperties:!1},PromotionRuleCountryPreferences:{type:"object",properties:{country_codes:{type:"array",items:{type:"string",format:"iso-country",pattern:"^[A-Z]{2}$"},default:[]},country_id:{type:"integer",nullable:!0},country_code:{type:"string",format:"iso-country",pattern:"^[A-Z]{2}$",nullable:!0}},additionalProperties:!1},PromotionRuleCurrencyPreferences:{type:"object",properties:{currency:{type:"string",format:"currency",pattern:"^[A-Z]{3}$",nullable:!0}},additionalProperties:!1},PromotionRuleCustomerPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleCustomerGroupPreferences:{type:"object",properties:{customer_group_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^cg_[A-Za-z0-9]+$","x-spree-prefix":"cg"},default:[]}},additionalProperties:!1},PromotionRuleCustomerLoggedInPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleFirstOrderPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleItemTotalPreferences:{type:"object",properties:{amount_min:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",default:"100"},operator_min:{type:"string",default:">"},amount_max:{type:"string",format:"money",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},operator_max:{type:"string",default:"<"}},additionalProperties:!1},PromotionRuleMarketPreferences:{type:"object",properties:{market_ids:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^mkt_[A-Za-z0-9]+$","x-spree-prefix":"mkt"},default:[]}},additionalProperties:!1},PromotionRuleOneUsePerUserPreferences:{type:"object",properties:{},additionalProperties:!1},PromotionRuleOptionValuePreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any"],default:"any"},eligible_values:{type:"array",items:{type:"string",format:"prefixed-id",pattern:"^optval_[A-Za-z0-9]+$","x-spree-prefix":"optval"},default:[]}},additionalProperties:!1},PromotionRuleProductPreferences:{type:"object",properties:{match_policy:{type:"string",enum:["any","all","none"],default:"any"}},additionalProperties:!1},PromotionRulePreferences:{description:"Settings of a promotion rule, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/PromotionRuleCategoryPreferences"},{$ref:"#/components/schemas/PromotionRuleChannelPreferences"},{$ref:"#/components/schemas/PromotionRuleCountryPreferences"},{$ref:"#/components/schemas/PromotionRuleCurrencyPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerGroupPreferences"},{$ref:"#/components/schemas/PromotionRuleCustomerLoggedInPreferences"},{$ref:"#/components/schemas/PromotionRuleFirstOrderPreferences"},{$ref:"#/components/schemas/PromotionRuleItemTotalPreferences"},{$ref:"#/components/schemas/PromotionRuleMarketPreferences"},{$ref:"#/components/schemas/PromotionRuleOneUsePerUserPreferences"},{$ref:"#/components/schemas/PromotionRuleOptionValuePreferences"},{$ref:"#/components/schemas/PromotionRuleProductPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{category:"#/components/schemas/PromotionRuleCategoryPreferences",channel:"#/components/schemas/PromotionRuleChannelPreferences",country:"#/components/schemas/PromotionRuleCountryPreferences",currency:"#/components/schemas/PromotionRuleCurrencyPreferences",customer:"#/components/schemas/PromotionRuleCustomerPreferences",customer_group:"#/components/schemas/PromotionRuleCustomerGroupPreferences",customer_logged_in:"#/components/schemas/PromotionRuleCustomerLoggedInPreferences",first_order:"#/components/schemas/PromotionRuleFirstOrderPreferences",item_total:"#/components/schemas/PromotionRuleItemTotalPreferences",market:"#/components/schemas/PromotionRuleMarketPreferences",one_use_per_user:"#/components/schemas/PromotionRuleOneUsePerUserPreferences",option_value:"#/components/schemas/PromotionRuleOptionValuePreferences",product:"#/components/schemas/PromotionRuleProductPreferences"}},SellerRequirementAcceptTermsPreferences:{type:"object",properties:{terms_body:{type:"string","x-spree-widget":"textarea",nullable:!0},terms_effective_from:{type:"string",format:"date",nullable:!0},terms_url:{type:"string",nullable:!0}},additionalProperties:!1},SellerRequirementAttestationPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementBillingAddressPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementCompleteProfilePreferences:{type:"object",properties:{require_about:{type:"boolean",default:!0},require_logo:{type:"boolean",default:!0},require_cover_photo:{type:"boolean",default:!1},require_contact_email:{type:"boolean",default:!0}},additionalProperties:!1},SellerRequirementDeliveryMethodPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementDocumentPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementMinimumProductsPreferences:{type:"object",properties:{minimum_count:{type:"integer",default:1}},additionalProperties:!1},SellerRequirementOperatorReviewPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPackageTypePreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPayoutAccountPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPolicyPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementRequiredCustomFieldsPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementReturnsAddressPreferences:{type:"object",properties:{},additionalProperties:!1},SellerRequirementPreferences:{description:"Settings of a seller requirement, shaped by its `type` (see `x-spree-preferences-by-type`). A type an extension registers is a plain object, described by the `schema` its `/types` entry carries.",anyOf:[{$ref:"#/components/schemas/SellerRequirementAcceptTermsPreferences"},{$ref:"#/components/schemas/SellerRequirementAttestationPreferences"},{$ref:"#/components/schemas/SellerRequirementBillingAddressPreferences"},{$ref:"#/components/schemas/SellerRequirementCompleteProfilePreferences"},{$ref:"#/components/schemas/SellerRequirementDeliveryMethodPreferences"},{$ref:"#/components/schemas/SellerRequirementDocumentPreferences"},{$ref:"#/components/schemas/SellerRequirementMinimumProductsPreferences"},{$ref:"#/components/schemas/SellerRequirementOperatorReviewPreferences"},{$ref:"#/components/schemas/SellerRequirementPackageTypePreferences"},{$ref:"#/components/schemas/SellerRequirementPayoutAccountPreferences"},{$ref:"#/components/schemas/SellerRequirementPolicyPreferences"},{$ref:"#/components/schemas/SellerRequirementRequiredCustomFieldsPreferences"},{$ref:"#/components/schemas/SellerRequirementReturnsAddressPreferences"},{type:"object",additionalProperties:!0}],"x-spree-preferences-by-type":{accept_terms:"#/components/schemas/SellerRequirementAcceptTermsPreferences",attestation:"#/components/schemas/SellerRequirementAttestationPreferences",billing_address:"#/components/schemas/SellerRequirementBillingAddressPreferences",complete_profile:"#/components/schemas/SellerRequirementCompleteProfilePreferences",delivery_method:"#/components/schemas/SellerRequirementDeliveryMethodPreferences",document:"#/components/schemas/SellerRequirementDocumentPreferences",minimum_products:"#/components/schemas/SellerRequirementMinimumProductsPreferences",operator_review:"#/components/schemas/SellerRequirementOperatorReviewPreferences",package_type:"#/components/schemas/SellerRequirementPackageTypePreferences",payout_account:"#/components/schemas/SellerRequirementPayoutAccountPreferences",policy:"#/components/schemas/SellerRequirementPolicyPreferences",required_custom_fields:"#/components/schemas/SellerRequirementRequiredCustomFieldsPreferences",returns_address:"#/components/schemas/SellerRequirementReturnsAddressPreferences"}},DeliveryMethodCalculator:{type:"object",description:"How the delivery method prices a shipment",properties:{type:{type:"string",description:"Wire shorthand for the calculator subclass"},preferences:{$ref:"#/components/schemas/DeliveryCalculatorPreferences"}},required:["type","preferences"]},PromotionActionCalculator:{type:"object",description:"The action's nested calculator (when the action carries one \u2014 null for actions like `free_shipping`)",properties:{type:{type:"string",description:"Wire shorthand for the calculator subclass"},preferences:{$ref:"#/components/schemas/PromotionCalculatorPreferences"}},required:["type","preferences"]},CurrencyCode:{type:"string",enum:["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SKK","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMM","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYI","UYU","UYW","UZS","VED","VEF","VES","VND","VUV","WST","XAF","XCD","XCG","XOF","XPF","YER","ZAR","ZMK","ZMW","ZWD","ZWG","ZWL","ZWN","ZWR"]},CountryCode:{type:"string",enum:["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},LocaleCode:{type:"string",enum:["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","de-AT","de-CH","dv","dz","ee","el","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","eo","es","es-419","es-CL","es-EC","es-MX","et","eu","fa","ff","fi","fj","fo","fr","fr-CA","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","pt-BR","pt-PT","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sl-SI","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh-CN","zh-HK","zh-TW","zu"]},TimeZone:{anyOf:[{type:"string",enum:["Africa/Algiers","Africa/Cairo","Africa/Casablanca","Africa/Harare","Africa/Johannesburg","Africa/Monrovia","Africa/Nairobi","America/Argentina/Buenos_Aires","America/Asuncion","America/Bogota","America/Caracas","America/Chicago","America/Chihuahua","America/Denver","America/Guatemala","America/Guyana","America/Halifax","America/Indiana/Indianapolis","America/Juneau","America/La_Paz","America/Lima","America/Los_Angeles","America/Mazatlan","America/Mexico_City","America/Monterrey","America/Montevideo","America/New_York","America/Nuuk","America/Phoenix","America/Puerto_Rico","America/Regina","America/Santiago","America/Sao_Paulo","America/St_Johns","America/Tijuana","Asia/Almaty","Asia/Baghdad","Asia/Baku","Asia/Bangkok","Asia/Chongqing","Asia/Colombo","Asia/Dhaka","Asia/Hong_Kong","Asia/Irkutsk","Asia/Jakarta","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuwait","Asia/Magadan","Asia/Muscat","Asia/Novosibirsk","Asia/Riyadh","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tokyo","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Cape_Verde","Atlantic/South_Georgia","Australia/Adelaide","Australia/Brisbane","Australia/Canberra","Australia/Darwin","Australia/Hobart","Australia/Melbourne","Australia/Perth","Australia/Sydney","Etc/GMT+12","Europe/Amsterdam","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Copenhagen","Europe/Dublin","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Madrid","Europe/Minsk","Europe/Moscow","Europe/Paris","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/Sarajevo","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Fakaofo","Pacific/Fiji","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Majuro","Pacific/Midway","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Port_Moresby","Pacific/Tongatapu","UTC"]},{type:"string"}],description:"Common IANA time zones; any other IANA time zone identifier is accepted too."},DimensionUnit:{type:"string",enum:["mm","cm","in","ft"]},WeightUnit:{type:"string",enum:["g","kg","lb","oz"]},AddressInputParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"}}},AdminUserUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},role_ids:{type:"array",items:{type:"string"},description:"Role IDs of the current store the user should hold. Replaces the user's roles on this store; an empty list removes them all."}}},AllowedOriginCreateParams:{type:"object",properties:{origin:{type:"string",description:"Origin to allow in admin CORS preflight checks: a bare `scheme://host[:port]` (no path, query or fragment) using `http` or `https`."}},required:["origin"]},AllowedOriginUpdateParams:{type:"object",properties:{origin:{type:"string",description:"Origin to allow in admin CORS preflight checks: a bare `scheme://host[:port]` (no path, query or fragment) using `http` or `https`."}}},ApiKeyCreateParams:{type:"object",properties:{name:{type:"string"},key_type:{type:"string",enum:["publishable","secret"]},scopes:{type:"array",items:{type:"string"},description:"Required for secret keys. You can only grant scopes you hold yourself. Fixed once created: to change them, create a new key and revoke the old one."},channel_id:{type:"string",description:"Binds a publishable key to one channel of the store (`ch_...`), so it rejects requests for other channels. Fixed once created; omit it for a store-wide key."}},required:["name","key_type"]},ApiKeyUpdateParams:{type:"object",properties:{name:{type:"string"}},required:["name"]},BulkTagsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"},description:"The records to change. Records the caller cannot update are skipped; an empty list changes nothing."},tags:{type:"array",items:{type:"string"}}},required:["ids","tags"]},CatalogAssignParams:{type:"object",properties:{assignable_type:{type:"string",enum:["customer_group","company"],description:"Buyer audiences only. A company assignment covers its subtree."},assignable_id:{type:"string"}},required:["assignable_type","assignable_id"]},CatalogAssignmentParams:{type:"object",properties:{assignable_type:{type:"string",enum:["customer_group","company"],description:"Buyer audiences only. A company assignment covers its subtree."},assignable_id:{type:"string"}},required:["assignable_type","assignable_id"]},CatalogCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Internal note on what the agreement is, never shown to shoppers.",nullable:!0},active:{type:"boolean"},position:{type:"integer"},minimum_order_quantity:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},order_multiple:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},metadata:{type:"object",additionalProperties:!0},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignmentParams"},description:"The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone."},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimumParams"},description:"The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone."},price_list:{allOf:[{$ref:"#/components/schemas/CatalogPriceListParams"}],description:"The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send `{}`, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive.",nullable:!0}},required:["name"]},CatalogOrderMinimumParams:{type:"object",properties:{currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 code. Required on create; one minimum per currency."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"}}},CatalogPriceListParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},status:{type:"string"},match_policy:{type:"string"},starts_at:{type:"string",format:"date-time",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"Contextual rules, in practice a `volume_rule`. Audience rules are left as they are, and an empty list clears the contextual rules."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Explicit per-variant amounts. An empty list clears them, which is what switching to a percentage sends."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the percentage. The payload is the whole ladder, so an empty list clears it."}}},CatalogProductTermsParams:{type:"object",properties:{terms:{type:"object",additionalProperties:!0,description:"Quantity terms keyed by product: `{ minimum_order_quantity, order_multiple }`, each a whole number or null. A product whose pair is both null has its terms cleared; a product not yet in the assortment is added."}},required:["terms"]},CatalogUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Internal note on what the agreement is, never shown to shoppers.",nullable:!0},active:{type:"boolean"},position:{type:"integer"},minimum_order_quantity:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},order_multiple:{type:"integer",description:"The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.",nullable:!0},metadata:{type:"object",additionalProperties:!0},assignments:{type:"array",items:{$ref:"#/components/schemas/CatalogAssignmentParams"},description:"The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone."},order_minimums:{type:"array",items:{$ref:"#/components/schemas/CatalogOrderMinimumParams"},description:"The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone."},price_list:{allOf:[{$ref:"#/components/schemas/CatalogPriceListParams"}],description:"The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send `{}`, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive.",nullable:!0}}},CategoryCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},parent_id:{type:"string",description:"The parent category. Omitted or null, a new category goes to the top level and an existing one keeps its parent: moving one to the top level is the reposition endpoint.",nullable:!0},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},CategoryRepositionParams:{type:"object",properties:{new_parent_id:{type:"string",description:"The new parent. Omit or null to move the category to the top level.",nullable:!0},new_position:{type:"integer",description:"0-based index among the new parent's children."}},required:["new_position"]},CategoryUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},parent_id:{type:"string",description:"The parent category. Omitted or null, a new category goes to the top level and an existing one keeps its parent: moving one to the top level is the reposition endpoint.",nullable:!0},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},ChannelAddProductsParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"}},published_at:{type:"string",format:"date-time",description:"When the publications go live. Null means immediately.",nullable:!0},unpublished_at:{type:"string",format:"date-time",description:"When the publications come down. Null means never.",nullable:!0}},required:["product_ids"]},ChannelCreateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"URL-safe slug, derived from `name` when blank (`Point of Sale` becomes `point-of-sale`)."},active:{type:"boolean"},default:{type:"boolean"},order_routing_strategy:{type:"string",description:"Order routing strategy shorthand (built-in: `rules`). Null inherits the store setting.",nullable:!0},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"What anonymous visitors can see. Null inherits the store setting.",nullable:!0},guest_checkout:{type:"boolean",description:"Whether guests can check out without an account. Null inherits the store setting.",nullable:!0},default_catalog_id:{type:"string",description:"Catalog (`cat_...`) shown to shoppers no company or customer group catalog covers. Null means every product published on the channel.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Stock locations (`sloc_...`) that fulfill this channel. Replaces the whole set; an empty list means every location of the store."}},required:["name"]},ChannelRemoveProductsParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"}}},required:["product_ids"]},ChannelUpdateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"URL-safe slug, derived from `name` when blank (`Point of Sale` becomes `point-of-sale`)."},active:{type:"boolean"},default:{type:"boolean"},order_routing_strategy:{type:"string",description:"Order routing strategy shorthand (built-in: `rules`). Null inherits the store setting.",nullable:!0},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"What anonymous visitors can see. Null inherits the store setting.",nullable:!0},guest_checkout:{type:"boolean",description:"Whether guests can check out without an account. Null inherits the store setting.",nullable:!0},default_catalog_id:{type:"string",description:"Catalog (`cat_...`) shown to shoppers no company or customer group catalog covers. Null means every product published on the channel.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Stock locations (`sloc_...`) that fulfill this channel. Replaces the whole set; an empty list means every location of the store."}}},ClaimCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the claim was canceled."}}},ClaimCreateParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{line_item_id:{type:"string"},quantity:{type:"integer"},description:{type:"string"},send_replacement:{type:"boolean"},replacement_variant_id:{type:"string",description:"Defaults to the variant that was bought."},refund_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"}},required:["line_item_id","quantity"]},description:"Affected items, and how each should be made right."},reason_id:{type:"string",description:"One of the store's claim reasons."},memo:{type:"string"}},required:["items"]},ClaimDenyParams:{type:"object",properties:{reason:{type:"string",description:"Recorded on the claim for the customer."}}},ClaimResolveParams:{type:"object",properties:{resolution:{type:"string",enum:["refund","replacement","refund_and_replacement"],description:"Money back, a replacement shipment, or both."},refund_method:{type:"string",enum:["original_payment","store_credit"],description:"Defaults to `store_credit`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the claim total."},replacement_line_item_ids:{type:"array",items:{type:"string"},description:"Which claim lines to send a replacement for. Omit to keep what the claim was opened with."}},required:["resolution"]},ClaimUpdateParams:{type:"object",properties:{reason_id:{type:"string",description:"One of the store's claim reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},CollectionCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},position:{type:"integer",description:"1-based position among the store's collections; the server shifts its siblings. The nested products reposition endpoints, unlike this, take 0-based indexes."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},automatic:{type:"boolean",description:"When true, membership is materialized from `rules` instead of curated by hand."},rules_match_policy:{type:"string",enum:["all","any"],description:"Whether a product must match all rules or any of them. Defaults to `all`."},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"],description:"Default product sort for the storefront listing; a shopper's own sort wins. Defaults to `manual`."},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRuleParams"},description:"The complete desired rule set. Entries with an `id` update, entries without one are created, and existing rules left out are removed."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},CollectionRuleParams:{type:"object",properties:{id:{type:"string",description:"Omit to create a new rule."},type:{type:"string",description:"Wire shorthand for the rule kind, from the collection rule types endpoint."},value:{type:"string"},match_policy:{type:"string",enum:["is_equal_to","is_not_equal_to","contains","does_not_contain"]}}},CollectionUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},permalink:{type:"string"},position:{type:"integer",description:"1-based position among the store's collections; the server shifts its siblings. The nested products reposition endpoints, unlike this, take 0-based indexes."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the landscape image, or null to remove it.",nullable:!0},square_image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the square image, or null to remove it.",nullable:!0},automatic:{type:"boolean",description:"When true, membership is materialized from `rules` instead of curated by hand."},rules_match_policy:{type:"string",enum:["all","any"],description:"Whether a product must match all rules or any of them. Defaults to `all`."},sort_order:{type:"string",enum:["manual","best_selling","price asc","price desc","available_on desc","available_on asc","name asc","name desc"],description:"Default product sort for the storefront listing; a shopper's own sort wins. Defaults to `manual`."},rules:{type:"array",items:{$ref:"#/components/schemas/CollectionRuleParams"},description:"The complete desired rule set. Entries with an `id` update, entries without one are created, and existing rules left out are removed."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},CommissionRateCreateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"Your own identifier for this rate; unique per store.",nullable:!0},enabled:{type:"boolean"},position:{type:"integer",description:"Place in the list. Rates resolve top-down and the first whose rules match wins, so 1 is tried first. New rates are created at the top; send this to move one. A rate with no rules matches every sale, so the marketplace default belongs at the bottom."},kind:{type:"string",enum:["percentage","fixed"],description:"`percentage` charges a share of the sale; `fixed` charges a flat fee."},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"A percentage (10 = 10%) or a flat amount, per `kind`."},tax_inclusive:{type:"boolean",description:"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},include_shipping:{type:"boolean",description:"Also charge commission on the seller's delivery revenue. Percentage rates only."},commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"VAT on the commission itself, as a fraction rather than a percentage. Null lets the store's tax engine answer for the seller's jurisdiction.",nullable:!0},metadata:{type:"object",additionalProperties:!0},amounts:{type:"object",additionalProperties:!0,description:"What a flat fee charges, keyed by currency, as decimal strings. A sale in a currency with no amount falls to the next matching rate. Replaces the whole set."},bounds:{type:"object",additionalProperties:!0,description:"The floor and cap a percentage charges within, keyed by currency: `{ min_amount, max_amount }` decimal strings. A sale in a currency with no bounds is charged unbounded. Replaces the whole set."},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRuleDraftParams"},description:"The full targeting; what you send replaces what the rate holds."}},required:["name","kind","value"]},CommissionRateUpdateParams:{type:"object",properties:{name:{type:"string"},code:{type:"string",description:"Your own identifier for this rate; unique per store.",nullable:!0},enabled:{type:"boolean"},position:{type:"integer",description:"Place in the list. Rates resolve top-down and the first whose rules match wins, so 1 is tried first. New rates are created at the top; send this to move one. A rate with no rules matches every sale, so the marketplace default belongs at the bottom."},kind:{type:"string",enum:["percentage","fixed"],description:"`percentage` charges a share of the sale; `fixed` charges a flat fee."},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"A percentage (10 = 10%) or a flat amount, per `kind`."},tax_inclusive:{type:"boolean",description:"Charge on the price including the customer's VAT. Left off, commission is charged on the seller's net revenue, which is the usual basis where the fee is taxed as its own supply."},include_shipping:{type:"boolean",description:"Also charge commission on the seller's delivery revenue. Percentage rates only."},commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"VAT on the commission itself, as a fraction rather than a percentage. Null lets the store's tax engine answer for the seller's jurisdiction.",nullable:!0},metadata:{type:"object",additionalProperties:!0},amounts:{type:"object",additionalProperties:!0,description:"What a flat fee charges, keyed by currency, as decimal strings. A sale in a currency with no amount falls to the next matching rate. Replaces the whole set."},bounds:{type:"object",additionalProperties:!0,description:"The floor and cap a percentage charges within, keyed by currency: `{ min_amount, max_amount }` decimal strings. A sale in a currency with no bounds is charged unbounded. Replaces the whole set."},rules:{type:"array",items:{$ref:"#/components/schemas/CommissionRuleDraftParams"},description:"The full targeting; what you send replaces what the rate holds."}}},CommissionRuleDraftParams:{type:"object",properties:{id:{type:"string",description:"Present for an existing rule; omit to create one.",nullable:!0},type:{type:"string",description:"A kind from `GET /commission_rates/rule_types`."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for the kind, per its type's `schema`."},product_ids:{type:"array",items:{type:"string"},description:"For kinds that name products, which are kept outside preferences."}},required:["type"]},CompanyAddressCreateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},default_billing:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."},default_shipping:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."}},required:["first_name","last_name","address1","city","country_code"]},CompanyAddressUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},default_billing:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."},default_shipping:{type:"boolean",description:"True makes this the default address of that kind, false gives the slot up, and leaving it out keeps the current default."}}},CompanyCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},kind:{type:"string",enum:["company","division"],description:"`company` is a legal entity (may hold tax registrations), `division` an organizational unit. Roots must be `company`."},parent_id:{type:"string",description:"The parent node. Omit or null for a root.",nullable:!0},po_number_required:{type:"boolean",description:"Whether this buyer's own procurement process demands a PO reference on every order: checkout asks for one and refuses to complete without it."},metadata:{type:"object",additionalProperties:!0}},required:["name"]},CompanyMembershipCreateParams:{type:"object",properties:{customer_email:{type:"string",description:"An existing customer becomes a member immediately; an unknown email becomes an invitation, and the response is an invitation instead of a membership."},metadata:{type:"object",additionalProperties:!0}},required:["customer_email"]},CompanyUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},kind:{type:"string",enum:["company","division"],description:"`company` is a legal entity (may hold tax registrations), `division` an organizational unit. Roots must be `company`."},parent_id:{type:"string",description:"The parent node. Omit or null for a root.",nullable:!0},po_number_required:{type:"boolean",description:"Whether this buyer's own procurement process demands a PO reference on every order: checkout asks for one and refuses to complete without it."},metadata:{type:"object",additionalProperties:!0}}},CustomFieldCreateParams:{type:"object",properties:{custom_field_definition_id:{type:"string"},value:{description:"A value matching the definition's `field_type`: a scalar for text, number and boolean fields; a list or a hash for JSON fields."}},required:["custom_field_definition_id","value"]},CustomFieldDefinitionCreateParams:{type:"object",properties:{namespace:{type:"string",description:"Defaults to `custom`."},key:{type:"string"},label:{type:"string",description:"Human-readable name; defaults to the titleized `key`."},field_type:{type:"string",description:"Custom field type token (`short_text`, `long_text`, `rich_text`, `number`, \u2026). An extension type that has no token is named by its registered class instead."},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, from the resource types endpoint."},storefront_visible:{type:"boolean",description:"When false, the definition is admin-only and never exposed in the Store API."},searchable:{type:"boolean",description:"Include values in storefront product text search. Supported for `short_text`, `long_text` and `number` fields; other types are refused."},sortable:{type:"boolean",description:"Allow storefront product listings to sort by this field (`sort=cf_{namespace}_{key}`). Supported for `short_text` and `number` fields; other types are refused."}},required:["key","field_type","resource_type"]},CustomFieldDefinitionUpdateParams:{type:"object",properties:{namespace:{type:"string",description:"Defaults to `custom`."},key:{type:"string"},label:{type:"string",description:"Human-readable name; defaults to the titleized `key`."},field_type:{type:"string",description:"Custom field type token (`short_text`, `long_text`, `rich_text`, `number`, \u2026). An extension type that has no token is named by its registered class instead."},resource_type:{type:"string",description:"Shorthand of the resource the field attaches to, from the resource types endpoint."},storefront_visible:{type:"boolean",description:"When false, the definition is admin-only and never exposed in the Store API."},searchable:{type:"boolean",description:"Include values in storefront product text search. Supported for `short_text`, `long_text` and `number` fields; other types are refused."},sortable:{type:"boolean",description:"Allow storefront product listings to sort by this field (`sort=cf_{namespace}_{key}`). Supported for `short_text` and `number` fields; other types are refused."}}},CustomFieldUpdateParams:{type:"object",properties:{value:{description:"A value matching the definition's `field_type`: a scalar for text, number and boolean fields; a list or a hash for JSON fields."}},required:["value"]},CustomFieldValueParams:{type:"object",properties:{id:{type:"string"},custom_field_definition_id:{type:"string"},value:{description:"A scalar for text, number and boolean fields; a list or a hash for JSON fields."}}},CustomerAddressCreateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean",description:"Makes this the customer's default address of that kind."},is_default_shipping:{type:"boolean",description:"Makes this the customer's default address of that kind."}},required:["first_name","last_name","address1","city","country_code"]},CustomerAddressUpdateParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."},alternative_phone:{type:"string"},quick_checkout:{type:"boolean"},is_default_billing:{type:"boolean",description:"Makes this the customer's default address of that kind."},is_default_shipping:{type:"boolean",description:"Makes this the customer's default address of that kind."}}},CustomerBulkGroupsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Groups from other stores are ignored."}},required:["ids","customer_group_ids"]},CustomerCreateParams:{type:"object",properties:{email:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},phone:{type:"string"},password:{type:"string",description:"Optional: a customer created without one claims the account through a password reset."},password_confirmation:{type:"string",description:"Optional: a customer created without one claims the account through a password reset."},selected_locale:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},accepts_email_marketing:{type:"boolean"},internal_note:{type:"string",description:"Rich text HTML. Reads come back as this plus `internal_note_html`."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Replaces the customer's group membership."}},required:["email"]},CustomerGroupCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},customer_ids:{type:"array",items:{type:"string"},description:"Replaces the group's members."}},required:["name"]},CustomerGroupUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},customer_ids:{type:"array",items:{type:"string"},description:"Replaces the group's members."}}},CustomerStoreCreditCreateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},memo:{type:"string"}},required:["amount","currency"]},CustomerStoreCreditUpdateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},memo:{type:"string"}}},CustomerUpdateParams:{type:"object",properties:{email:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},phone:{type:"string"},selected_locale:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},accepts_email_marketing:{type:"boolean"},internal_note:{type:"string",description:"Rich text HTML. Reads come back as this plus `internal_note_html`."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},customer_group_ids:{type:"array",items:{type:"string"},description:"Replaces the customer's group membership."}}},DataRequestCreateParams:{type:"object",properties:{customer_id:{type:"string"},kind:{type:"string",enum:["access","erasure"],description:"`access` asks for a copy of the customer's personal data; `erasure` asks for it to be erased."}},required:["customer_id","kind"]},DeliveryCreateParams:{type:"object",properties:{tracking_number:{type:"string",description:"A carrier tracking number, a freight PRO or container number, or a full tracking link. A corrected number resets the carrier status to `pending`."},carrier:{type:"string",description:"Free text; detected from the number's format when omitted."},service:{type:"string"},tracking_url:{type:"string"}},required:["tracking_number"]},DeliveryMarkDeliveredParams:{type:"object",properties:{delivered_at:{type:"string",format:"date-time",description:"When it arrived. Defaults to now."},notify_customer:{type:"boolean",description:"Whether the customer gets a delivery notification once the parcel completes. Defaults to true."}}},DeliveryMethodCreateParams:{type:"object",properties:{name:{type:"string"},admin_name:{type:"string",nullable:!0},code:{type:"string",nullable:!0},fulfillment_provider:{type:"string",description:"Fulfillment provider shorthand (see the fulfillment providers endpoint), e.g. `manual`."},pickup_point_provider:{type:"string",nullable:!0},rate_provider:{type:"string",description:"Rate provider shorthand (see the rate providers endpoint), e.g. `easy_post`. Omit or send null for the built-in provider, which prices through the method's calculator.",nullable:!0},storefront_visible:{type:"boolean"},available_to_sellers:{type:"boolean",description:"Marketplace only: whether a seller's packages may be quoted by this method. Off by default, and refused on a method that belongs to a seller."},tracking_url:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"integer",nullable:!0},estimated_transit_business_days_max:{type:"integer",nullable:!0},tax_category_id:{type:"string",description:"Prefixed tax category ID (`taxcat_...`), or null to clear.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level flat handling fee added on top of provider-quoted rates.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level percentage handling fee added on top of provider-quoted rates. Ignored for calculator-priced methods.",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this method belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group offering this method (`og_...`); defaults to the zone's group, else the profile's default group."},delivery_zone_id:{type:"string",description:"Delivery zone narrowing destinations (`dz_...`), or null for no restriction. Must belong to the method's profile.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Pickup locations (`sloc_...`); replaces the full set."},calculator:{type:"object",properties:{type:{type:"string"},preferences:{type:"object",additionalProperties:!0}},description:"How the method prices a shipment: a type from the calculators endpoint and its preferences, matching that type's `schema`."},rules:{type:"array",items:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean"},preferences:{type:"object",additionalProperties:!0},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to."}}},description:"Eligibility rules. Replaces the full set: omitted rules are removed."},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodServiceParams"},description:"Carrier service rows: which provider services this method offers. Replaces the full set: omitted rows are removed; no rows means every service the provider returns is offered."}},required:["name"]},DeliveryMethodRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean",description:"Defaults to true on create."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to. An empty list clears them."}},required:["type"]},DeliveryMethodRuleUpdateParams:{type:"object",properties:{active:{type:"boolean",description:"Defaults to true on create."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to. An empty list clears them."}}},DeliveryMethodServiceParams:{type:"object",properties:{id:{type:"string",description:"Prefixed row ID (`dms_...`) when updating an existing row."},carrier:{type:"string",description:"Carrier identifier as the provider's API knows it."},service:{type:"string",description:"Service identifier as the provider's API knows it."},label:{type:"string",description:"Display label shown to customers instead of the carrier-derived name.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Overrides the method-level flat markup for this service.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Overrides the method-level percentage markup for this service.",nullable:!0},position:{type:"integer"}},required:["carrier","service"]},DeliveryMethodUpdateParams:{type:"object",properties:{name:{type:"string"},admin_name:{type:"string",nullable:!0},code:{type:"string",nullable:!0},fulfillment_provider:{type:"string",description:"Fulfillment provider shorthand (see the fulfillment providers endpoint), e.g. `manual`."},pickup_point_provider:{type:"string",nullable:!0},rate_provider:{type:"string",description:"Rate provider shorthand (see the rate providers endpoint), e.g. `easy_post`. Omit or send null for the built-in provider, which prices through the method's calculator.",nullable:!0},storefront_visible:{type:"boolean"},available_to_sellers:{type:"boolean",description:"Marketplace only: whether a seller's packages may be quoted by this method. Off by default, and refused on a method that belongs to a seller."},tracking_url:{type:"string",nullable:!0},estimated_transit_business_days_min:{type:"integer",nullable:!0},estimated_transit_business_days_max:{type:"integer",nullable:!0},tax_category_id:{type:"string",description:"Prefixed tax category ID (`taxcat_...`), or null to clear.",nullable:!0},markup_flat:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level flat handling fee added on top of provider-quoted rates.",nullable:!0},markup_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Method-level percentage handling fee added on top of provider-quoted rates. Ignored for calculator-priced methods.",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this method belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group offering this method (`og_...`); defaults to the zone's group, else the profile's default group."},delivery_zone_id:{type:"string",description:"Delivery zone narrowing destinations (`dz_...`), or null for no restriction. Must belong to the method's profile.",nullable:!0},stock_location_ids:{type:"array",items:{type:"string"},description:"Pickup locations (`sloc_...`); replaces the full set."},calculator:{type:"object",properties:{type:{type:"string"},preferences:{type:"object",additionalProperties:!0}},description:"How the method prices a shipment: a type from the calculators endpoint and its preferences, matching that type's `schema`."},rules:{type:"array",items:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"A rule kind from the delivery method rule types endpoint."},active:{type:"boolean"},preferences:{type:"object",additionalProperties:!0},product_ids:{type:"array",items:{type:"string"},description:"Products an association-backed rule (`excluded_products_rule`) applies to."}}},description:"Eligibility rules. Replaces the full set: omitted rules are removed."},services:{type:"array",items:{$ref:"#/components/schemas/DeliveryMethodServiceParams"},description:"Carrier service rows: which provider services this method offers. Replaces the full set: omitted rows are removed; no rows means every service the provider returns is offered."}}},DeliveryOriginGroupParams:{type:"object",properties:{name:{type:"string",nullable:!0},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}}},DeliveryProfileCreateParams:{type:"object",properties:{name:{type:"string"},kind:{type:"string",description:"Registered profile kind (`shipping`, `digital`, extension kinds) from the kinds endpoint. Read on create only; defaults to shipping."},default:{type:"boolean",description:"Promotes this profile to the store default; the previous default is demoted."},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}},required:["name"]},DeliveryProfileUpdateParams:{type:"object",properties:{name:{type:"string"},kind:{type:"string",description:"Registered profile kind (`shipping`, `digital`, extension kinds) from the kinds endpoint. Read on create only; defaults to shipping."},default:{type:"boolean",description:"Promotes this profile to the store default; the previous default is demoted."},position:{type:"integer"},stock_location_ids:{type:"array",items:{type:"string"},description:"Prefixed stock location IDs (`sloc_...`); replaces the full set. Empty means every store location."}}},DeliveryUpdateParams:{type:"object",properties:{tracking_number:{type:"string",description:"A carrier tracking number, a freight PRO or container number, or a full tracking link. A corrected number resets the carrier status to `pending`."},carrier:{type:"string",description:"Free text; detected from the number's format when omitted."},service:{type:"string"},tracking_url:{type:"string"}}},DeliveryZoneCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this zone belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group this zone belongs to (`og_...`)."},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMemberParams"},description:"Replaces the zone's full member set atomically."}},required:["name"]},DeliveryZoneMemberParams:{type:"object",properties:{member_type:{type:"string",enum:["country","state","postal_code"]},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}]},state_code:{type:"string",description:"A subdivision code or name. Without `country_code` the country is inferred when only one country matches."},postal_code_prefix:{type:"string"},postal_code_from:{type:"string"},postal_code_to:{type:"string"}},required:["member_type"]},DeliveryZoneUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},delivery_profile_id:{type:"string",description:"Delivery profile this zone belongs to (`fp_...`); defaults to the store default profile."},delivery_origin_group_id:{type:"string",description:"Origin group this zone belongs to (`og_...`)."},members:{type:"array",items:{$ref:"#/components/schemas/DeliveryZoneMemberParams"},description:"Replaces the zone's full member set atomically."}}},DigitalAssetCreateParams:{type:"object",properties:{signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`. On update it replaces the file for everyone who already bought it. A seller's file must be of a content type the marketplace accepts, checked against the file's own signature where it has one."},variant_id:{type:"string",description:"On create, defaults to the product's default variant when omitted. On update, omitting it keeps the current variant."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},provider_type:{type:"string",description:"A provider shorthand from the providers endpoint. Omit for an uploaded file; a provider-backed asset sends no `signed_id`."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."}}},DigitalAssetUpdateParams:{type:"object",properties:{signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`. On update it replaces the file for everyone who already bought it. A seller's file must be of a content type the marketplace accepts, checked against the file's own signature where it has one."},variant_id:{type:"string",description:"On create, defaults to the product's default variant when omitted. On update, omitting it keeps the current variant."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},provider_type:{type:"string",description:"A provider shorthand from the providers endpoint. Omit for an uploaded file; a provider-backed asset sends no `signed_id`."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."}}},DiscountCodeApplyParams:{type:"object",properties:{code:{type:"string"}},required:["code"]},DiscountCreateParams:{type:"object",properties:{label:{type:"string"},value:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"An amount in the order currency for a `flat` discount, or a percentage for a `percent` one."},value_type:{type:"string",enum:["flat","percent"],description:"Defaults to `flat`."},line_item_id:{type:"string",description:"The line item the discount applies to. Omitted, the value is distributed across the line items.",nullable:!0}},required:["label","value"]},DiscountUpdateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The new amount of the row, in the order currency."}}},EmailTemplateDraftParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},subject:{type:"string",nullable:!0},body:{type:"string"},lock_version:{type:"integer",description:"The `lock_version` the draft was loaded with, or null when there was no draft; a save from an older copy is refused with 409. Omit it to save without checking.",nullable:!0},rebase:{type:"boolean",description:"Marks the draft as based on Spree's current default, after reviewing what changed in it."}}},EmailTemplatePreviewParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},subject:{type:"string",description:"An unsaved subject, in place of the current one.",nullable:!0},body:{type:"string",description:"An unsaved body, in place of the current one."},record_id:{type:"string",description:"The record to build sample data from; the store's latest matching record otherwise."},email_key:{type:"string",description:"For the layout or a partial, the email to show it in."},branding:{type:"object",properties:{accent_color:{type:"string",nullable:!0},background_color:{type:"string",nullable:!0},card_color:{type:"string",nullable:!0},text_color:{type:"string",nullable:!0},heading_color:{type:"string",nullable:!0},font:{type:"string",enum:["inter","system","helvetica","georgia","roboto","lato","merriweather"],nullable:!0}},description:"Unsaved colors and font to preview, named like the store's `email_*` settings."},mailer_logo_signed_id:{type:"string",description:"An unsaved email logo: the signed id of an uploaded image, or null to preview without one.",nullable:!0}}},EmailTemplateRestoreParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},lock_version:{type:"integer",description:"The open draft's `lock_version`, or null when there is none; checked as when saving.",nullable:!0}}},EmailTemplateVersionParams:{type:"object",properties:{language:{type:"string",description:"A language code, or `any` (the default) for the version every language uses."},lock_version:{type:"integer",description:"The draft's `lock_version` as reviewed. A draft saved since is refused with 409."}}},ExchangeCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the exchange was canceled."}}},ExchangeCreateParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{fulfillment_item_id:{type:"string"},new_variant_id:{type:"string"},quantity:{type:"integer"}},required:["fulfillment_item_id","new_variant_id","quantity"]},description:"Items coming back, and what goes out in their place."},stock_location_id:{type:"string",description:"Where the goods come back to."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"}},required:["items"]},ExchangeFulfillParams:{type:"object",properties:{refund_method:{type:"string",enum:["original_payment","store_credit"],description:"How a credit is returned when the replacements cost less than what came back. Defaults to `store_credit`. A balance the customer owes is left for the merchant to collect."}}},ExchangeReceiveParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{exchange_line_item_id:{type:"string"},quantity:{type:"integer"},resellable:{type:"boolean",description:"Goods that cannot be resold are received but never restocked. Defaults to true."}},required:["exchange_line_item_id","quantity"]},description:"What actually arrived. Omit to receive everything as requested and resellable."}}},ExchangeUpdateParams:{type:"object",properties:{stock_location_id:{type:"string",description:"Where the goods come back to."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},ExportCreateParams:{type:"object",properties:{type:{type:"string",description:"Which dataset to export, as its shorthand: `products`, `orders`, `customers`, `product_translations`, `gift_cards`, `coupon_codes`, `newsletter_subscribers`, `price_list_prices`, `purchase_orders`, or a type an extension registers."},record_selection:{type:"string",enum:["filtered","all"],description:"`filtered` (the default) keeps `search_params`; `all` ignores them and exports every record in scope."},results_url:{type:"string",description:"Absolute URL of your admin exports view; the export-done email uses it as the download button target. Only honored when it matches one of the store's allowed origins."},search_params:{type:"object",additionalProperties:!0,description:'A Ransack query, with the predicates the list endpoint accepts. A `price_list_prices` export requires `price_list_id_eq` naming a price list of the current store, and refuses `record_selection: "all"`.'}},required:["type"]},FeeCreateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"Defaults to `surcharge`. The values listed are the built-in ones; extensions may add more."},line_item_id:{type:"string",description:"The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.",nullable:!0},fulfillment_id:{type:"string",description:"The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.",nullable:!0}},required:["label","amount"]},FeeUpdateParams:{type:"object",properties:{label:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},kind:{anyOf:[{type:"string",enum:["surcharge","handling","gift_wrap","cod","payment","duty","exchange"]},{type:"string"}],description:"Defaults to `surcharge`. The values listed are the built-in ones; extensions may add more."}}},FileUploadCreateParams:{type:"object",properties:{filename:{type:"string"},content_type:{type:"string"},byte_size:{type:"integer"},checksum:{type:"string",description:"Base64-encoded MD5 digest of the file; the storage service checks the bytes against it."},visibility:{type:"string",enum:["public","private"],description:"`public` (the default) for images, videos and CSV files anyone may fetch, `private` for any type."},file:{type:"string",format:"binary",description:"The bytes, for a multipart upload."}},required:["filename","content_type"]},FulfillmentCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"The location the fulfillment ships from. On update, moving it re-prices the fulfillment against that location's rates."},source_fulfillment_id:{type:"string",description:"The only fulfillment of this order to move units from, its exchange and claim replacements included: how a canceled replacement is sent again. Omitted, the customer's bought units are taken from every unshipped fulfillment."},tracking:{type:"string",description:"Carrier tracking number, or a full `https://` tracking link, which is served back as `tracking_url` unchanged."},delivery_method_id:{type:"string",description:"Delivery method attached as the selected rate. Defaults to the delivery method of the fully drained source fulfillments."},cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Explicit shipping cost, such as the 3PL price. Defaults to the summed cost of the fully drained source fulfillments, which keeps the order total unchanged. Persists only with `status: shipped`; pending fulfillments are re-priced by the rate engine."},status:{type:"string",enum:["shipped"],description:"Pass `shipped` to register an already-shipped external fulfillment."},metadata:{type:"object",additionalProperties:!0},items:{type:"array",items:{type:"object",properties:{item_id:{type:"string"},quantity:{type:"integer"}},required:["item_id","quantity"]},description:"Line item quantities to fulfill. Omit to fulfill every unit not yet shipped."}},required:["stock_location_id"]},FulfillmentFulfillParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{item_id:{type:"string"},quantity:{type:"integer"}},required:["item_id","quantity"]},description:"Line item quantities to ship. Omit to ship everything the fulfillment holds; a subset is split onto a new fulfillment, which is the one that ships."},tracking:{type:"string",description:"Carrier tracking number or a full `https://` tracking link, stored on the fulfillment that ships."},tracking_carrier:{type:"string",description:"Which carrier the number belongs to; detected from the number when omitted."},notify_customer:{type:"boolean",description:"Whether the customer gets the shipment email. Defaults to true; pass false to suppress it for this dispatch only."},force:{type:"boolean",description:"Hand the goods over even though the order is unpaid or holds backordered units."}}},FulfillmentMarkDeliveredParams:{type:"object",properties:{delivered_at:{type:"string",format:"date-time",description:"When it arrived. Defaults to now; return windows run from this time."},notify_customer:{type:"boolean",description:"Whether the customer gets a delivery notification. Defaults to true."}}},FulfillmentSplitParams:{type:"object",properties:{variant_id:{type:"string",description:"The variant being moved out."},quantity:{type:"integer"},stock_location_id:{type:"string",description:"Origin of the new fulfillment. Defaults to the source fulfillment's location."}},required:["variant_id","quantity"]},FulfillmentUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"The location the fulfillment ships from. On update, moving it re-prices the fulfillment against that location's rates."},tracking:{type:"string",description:"Carrier tracking number, or a full `https://` tracking link, which is served back as `tracking_url` unchanged."},tracking_carrier:{type:"string",description:"Which carrier the tracking number belongs to: a slug from the tracking carriers endpoint. Left blank, it is detected from the number's format where possible."},selected_delivery_rate_id:{type:"string"}}},GiftCardApplyParams:{type:"object",properties:{code:{type:"string",description:"The gift card code; matched case-insensitively."}},required:["code"]},GiftCardBatchCreateParams:{type:"object",properties:{prefix:{type:"string",description:"Lowercased and prepended to every generated code."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The amount of each card, greater than zero."},codes_count:{type:"integer",description:"How many cards to generate. Capped at `gift_card_batch_limit`; batches over `gift_card_batch_web_limit` generate in the background."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},expires_at:{type:"string",format:"date",nullable:!0}},required:["prefix","amount","codes_count"]},GiftCardCreateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Greater than zero."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},code:{type:"string",description:"Generated when omitted."},expires_at:{type:"string",format:"date",nullable:!0},customer_id:{type:"string",description:"The customer the card belongs to. Needs the `read_customers` permission; null detaches it.",nullable:!0}},required:["amount"]},GiftCardUpdateParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Greater than zero."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code. Defaults to the store currency."},code:{type:"string",description:"Generated when omitted."},expires_at:{type:"string",format:"date",nullable:!0},customer_id:{type:"string",description:"The customer the card belongs to. Needs the `read_customers` permission; null detaches it.",nullable:!0}}},ImportCompleteMappingParams:{type:"object",properties:{mappings:{type:"array",items:{type:"object",properties:{schema_field:{type:"string",description:"A schema field name from the import's `schema_fields`."},file_column:{type:"string",description:"The CSV header to read the field from; null unmaps the field.",nullable:!0}},required:["schema_field"]},description:"Column assignments to apply before processing starts. Omit to accept the ones assigned on create."}}},ImportCreateParams:{type:"object",properties:{type:{type:"string",description:"Which dataset to import, as its shorthand: `products`, `customers`, `product_translations`, `price_list_prices`, `purchase_orders`, or a type an extension registers."},attachment_signed_id:{type:"string",description:'The `signed_id` of the uploaded CSV, from `files.upload()` with `visibility: "private"`.'},delimiter:{type:"string",enum:[",",";","|","	"],description:"CSV column separator. Defaults to a comma."},results_url:{type:"string",description:"Absolute URL of your admin imports view; the import-done email links back to it with `?import=<id>` appended. Only honored when it matches one of the store's allowed origins."},price_list_id:{type:"string",description:"For `price_list_prices` imports: the price list the rows are merged into. Must belong to the current store; other types ignore it."}},required:["type","attachment_signed_id"]},IntegrationCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand from the integration types endpoint."},active:{type:"boolean",description:"Activating runs the connection check, and a failed check is a 422."},preferences:{type:"object",additionalProperties:!0,description:"Credential values. Secret preferences come back masked, and sending a masked value back keeps the stored secret."}},required:["type"]},IntegrationUpdateParams:{type:"object",properties:{active:{type:"boolean",description:"Activating runs the connection check, and a failed check is a 422."},preferences:{type:"object",additionalProperties:!0,description:"Credential values. Secret preferences come back masked, and sending a masked value back keeps the stored secret."}}},InvitationAcceptParams:{type:"object",properties:{password:{type:"string",description:"Creates the account when the invitee has none yet. An existing account confirms it is theirs with it, unless the request is already signed in as that account."},password_confirmation:{type:"string"},first_name:{type:"string"},last_name:{type:"string"}}},InvitationCreateParams:{type:"object",properties:{email:{type:"string"},role_id:{type:"string",description:"The role (`role_...`) the invitee gets on accepting."}},required:["email","role_id"]},LineItemCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},variant_id:{type:"string"},quantity:{type:"integer",description:"Defaults to 1 when adding an item."},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price. Stamps the line `price_source: 'manual'`, so quantity changes and recalculation never re-price it; an explicit null reverts the line to catalog pricing. Omit to leave pricing alone. Draft (incomplete) orders only.",nullable:!0},options:{type:"object",additionalProperties:!0}},required:["variant_id"]},LineItemUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},quantity:{type:"integer",description:"Defaults to 1 when adding an item."},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price. Stamps the line `price_source: 'manual'`, so quantity changes and recalculation never re-price it; an explicit null reverts the line to catalog pricing. Omit to leave pricing alone. Draft (incomplete) orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}}},MaintenanceTaskRunCreateParams:{type:"object",properties:{task_name:{type:"string",description:"The task to run, as `task_name` from `GET /upgrade_steps`."},arguments:{type:"object",additionalProperties:!0,description:"Values for the task's declared parameters, keyed by parameter name. A key the task does not declare is rejected."},dry_run:{type:"boolean",description:"Report what would change without writing. Ignored by tasks that do not support a dry run, which run for real."}},required:["task_name"]},MarketCreateParams:{type:"object",properties:{name:{type:"string",description:"Display name, unique within the store."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code."},default_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Locale used as the market default. Always part of `supported_locales`."},tax_inclusive:{type:"boolean",description:"Whether the prices entered for this market include tax. True charges every customer the price as entered, with their tax inside it; false adds tax at checkout."},tax_provider:{type:"string",description:"Shorthand of the tax engine that prices this market, from the tax providers endpoint. Null uses the installation default.",nullable:!0},default:{type:"boolean",description:"Setting true demotes the previous default market of the store."},position:{type:"integer",description:"Sort order within the store; lower comes first."},supported_locales:{type:"array",items:{$ref:"#/components/schemas/LocaleCode"},description:"Locales available in this market. The default locale is always included."},country_codes:{type:"array",items:{$ref:"#/components/schemas/CountryCode"},description:"ISO 3166-1 alpha-2 codes of the countries in this market. At least one is required."}},required:["name","currency","default_locale","country_codes"]},MarketUpdateParams:{type:"object",properties:{name:{type:"string",description:"Display name, unique within the store."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency code."},default_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Locale used as the market default. Always part of `supported_locales`."},tax_inclusive:{type:"boolean",description:"Whether the prices entered for this market include tax. True charges every customer the price as entered, with their tax inside it; false adds tax at checkout."},tax_provider:{type:"string",description:"Shorthand of the tax engine that prices this market, from the tax providers endpoint. Null uses the installation default.",nullable:!0},default:{type:"boolean",description:"Setting true demotes the previous default market of the store."},position:{type:"integer",description:"Sort order within the store; lower comes first."},supported_locales:{type:"array",items:{$ref:"#/components/schemas/LocaleCode"},description:"Locales available in this market. The default locale is always included."},country_codes:{type:"array",items:{$ref:"#/components/schemas/CountryCode"},description:"ISO 3166-1 alpha-2 codes of the countries in this market. At least one is required."}}},MeUpdateParams:{type:"object",properties:{selected_locale:{type:"string",description:"The dashboard display language."},first_name:{type:"string"},last_name:{type:"string"},avatar_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` to set the avatar, or null to remove it. Omit it to keep the current photo.",nullable:!0}}},MediaCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},url:{type:"string",description:"Fetch an image from this URL, in the background. Images only: an external video uses `external_video_url`."},signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the media file itself."},source_media_id:{type:"string",description:"Place a file that is already in the library. The new row shares the source file rather than copying it, and takes its own alt, position and variant links from here."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaLibraryCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},url:{type:"string",description:"Fetch an image from this URL, in the background. Images only: an external video uses `external_video_url`."},signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the media file itself."},source_media_id:{type:"string",description:"Place a file that is already in the library. The new row shares the source file rather than copying it, and takes its own alt, position and variant links from here."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaLibraryUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},MediaUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},attachment:{type:"string",description:"The file itself, sent as multipart form data. JSON clients upload first and send `signed_id`."},variant_ids:{type:"array",items:{type:"string"},description:"Variants to link this product-level media to. Variants of other products are dropped."}}},OauthApplicationCreateParams:{type:"object",properties:{name:{type:"string"},redirect_uri:{type:"string",description:"Where the authorization server sends the browser back to."}},required:["name"]},OauthApplicationUpdateParams:{type:"object",properties:{name:{type:"string"},redirect_uri:{type:"string",description:"Where the authorization server sends the browser back to."}},required:["name"]},OptionTypeCreateParams:{type:"object",properties:{name:{type:"string"},label:{type:"string"},position:{type:"integer"},filterable:{type:"boolean"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValueParams"},description:"Inline option values. Values left out of the list on update are destroyed, so send the full set every time."}},required:["name","label"]},OptionTypeUpdateParams:{type:"object",properties:{name:{type:"string"},label:{type:"string"},position:{type:"integer"},filterable:{type:"boolean"},kind:{type:"string",enum:["dropdown","color_swatch","buttons"]},option_values:{type:"array",items:{$ref:"#/components/schemas/OptionValueParams"},description:"Inline option values. Values left out of the list on update are destroyed, so send the full set every time."}}},OptionValueParams:{type:"object",properties:{id:{type:"string",description:"Present for existing values. Omit to create a new one."},name:{type:"string"},label:{type:"string"},position:{type:"integer"},color_code:{type:"string",description:"Hex color. Only meaningful when the option type's `kind` is `color_swatch`.",nullable:!0},image_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`, or null to remove the image.",nullable:!0}}},OrderCancelParams:{type:"object",properties:{cancel_reason_id:{type:"string",description:"Why the order was canceled: the id of one of the store's cancellation reasons."},cancel_note:{type:"string",description:"Staff-facing note about the cancellation."},refund_payments:{type:"boolean",description:"Whether this order's share of a payment shared across a split checkout is handed back."},refund_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"How much of that share to return. Defaults to all of it; refused on an order whose payment is not shared."},notify_customer:{type:"boolean",description:"Send the order cancellation email after canceling."}}},OrderCompleteParams:{type:"object",properties:{payment_pending:{type:"boolean"},notify_customer:{type:"boolean",description:"Send the order confirmation email after completion."}}},OrderCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},email:{type:"string"},customer_id:{type:"string",description:"Null detaches the customer, leaving a guest order under its `email`.",nullable:!0},use_customer_default_address:{type:"boolean",description:"Copies the saved default billing and shipping addresses onto the order. Sent with `company_id`, it takes that company's defaults, inherited from its parent nodes when the company holds none of its own; otherwise it takes the customer's."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},market_id:{type:"string"},channel_id:{type:"string",description:"Defaults to the store primary channel when omitted."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}]},customer_note:{type:"string",description:"Public, customer-visible note."},internal_note:{type:"string",description:"Staff-only note. Rich text HTML; reads come back as this plus `internal_note_html`."},po_number:{type:"string",description:"The buyer's own purchase-order reference. Searchable alongside the order number, and rendered on every order-facing document."},po_document_signed_id:{type:"string",description:"The `signed_id` of the buyer's purchase order, from `files.upload()` with `visibility: 'private'`. Null removes the document the order carries.",nullable:!0},shipping_address_id:{type:"string",description:"An existing address from the customer's address book, or from the address book of the company the order is for."},billing_address_id:{type:"string",description:"An existing address from the customer's address book, or from the address book of the company the order is for."},preferred_stock_location_id:{type:"string",description:"Stock location to prefer for fulfillment. Order Routing's built-in preferred-location rule ranks it first; routing falls back to the next rule when the location can't cover the cart."},company_id:{type:"string",description:"Makes the order a company purchase, with that company's catalog prices and tax treatment. Null makes a draft a plain customer order again.",nullable:!0},coupon_code:{type:"string",description:"Applied non-fatally: an invalid code does not block creation."},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},shipping_address:{$ref:"#/components/schemas/AddressInputParams"},billing_address:{$ref:"#/components/schemas/AddressInputParams"},use_shipping:{type:"boolean",description:"When true, copies the shipping address to the billing address."},items:{type:"array",items:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price; stamps `price_source: 'manual'`. Null reverts the line to catalog pricing. Draft orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["variant_id"]},description:"Line items to upsert, keyed by variant. An entry sets that variant's quantity, creating the line item when the order has none; `quantity: 0` removes it. Variants you do not send are left alone."}}},OrderRoutingRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand for the rule kind, from the order routing rule types endpoint."},active:{type:"boolean"},position:{type:"integer",description:"1-based priority in the channel's rule list. Omitted on create, the rule goes last; a new position reorders the rest of the list around it."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."}},required:["type"]},OrderRoutingRuleUpdateParams:{type:"object",properties:{active:{type:"boolean"},position:{type:"integer",description:"1-based priority in the channel's rule list. Omitted on create, the rule goes last; a new position reorders the rest of the list around it."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's preference schema."}}},OrderUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},email:{type:"string"},customer_id:{type:"string",description:"Null detaches the customer, leaving a guest order under its `email`.",nullable:!0},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},market_id:{type:"string"},channel_id:{type:"string",description:"Defaults to the store primary channel when omitted."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}]},customer_note:{type:"string",description:"Public, customer-visible note."},internal_note:{type:"string",description:"Staff-only note. Rich text HTML; reads come back as this plus `internal_note_html`."},po_number:{type:"string",description:"The buyer's own purchase-order reference. Searchable alongside the order number, and rendered on every order-facing document."},po_document_signed_id:{type:"string",description:"The `signed_id` of the buyer's purchase order, from `files.upload()` with `visibility: 'private'`. Null removes the document the order carries.",nullable:!0},preferred_stock_location_id:{type:"string",description:"Stock location to prefer for fulfillment. Order Routing's built-in preferred-location rule ranks it first; routing falls back to the next rule when the location can't cover the cart."},company_id:{type:"string",description:"Makes the order a company purchase, with that company's catalog prices and tax treatment. Null makes a draft a plain customer order again.",nullable:!0},metadata:{type:"object",additionalProperties:!0},tags:{type:"array",items:{type:"string"}},shipping_address:{$ref:"#/components/schemas/AddressInputParams"},billing_address:{$ref:"#/components/schemas/AddressInputParams"},use_shipping:{type:"boolean",description:"When true, copies the shipping address to the billing address."},items:{type:"array",items:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"},price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Negotiated unit price; stamps `price_source: 'manual'`. Null reverts the line to catalog pricing. Draft orders only.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["variant_id"]},description:"Line items to upsert, keyed by variant. An entry sets that variant's quantity, creating the line item when the order has none; `quantity: 0` removes it. Variants you do not send are left alone."}}},PackageTypeCreateParams:{type:"object",properties:{name:{type:"string",description:"Unique within the store."},kind:{type:"string",enum:["box","envelope","carton","pallet","container"],description:"What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on."},length:{type:"number",nullable:!0},width:{type:"number",nullable:!0},height:{type:"number",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Unit the three dimensions are in; falls back to the store's unit system.",nullable:!0},weight:{type:"number",description:"The empty package's own weight, added to content weight on every quote.",nullable:!0},max_weight:{type:"number",description:"What the package can hold, not the same as its own weight.",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],nullable:!0},default:{type:"boolean",description:"The box every parcel quote is built on. Setting this demotes whichever row held it."},metadata:{type:"object",additionalProperties:!0}},required:["name","kind"]},PackageTypeUpdateParams:{type:"object",properties:{name:{type:"string",description:"Unique within the store."},kind:{type:"string",enum:["box","envelope","carton","pallet","container"],description:"What this packaging is: the box parcels ship in, or the carton, pallet or container a wholesale order leaves on."},length:{type:"number",nullable:!0},width:{type:"number",nullable:!0},height:{type:"number",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Unit the three dimensions are in; falls back to the store's unit system.",nullable:!0},weight:{type:"number",description:"The empty package's own weight, added to content weight on every quote.",nullable:!0},max_weight:{type:"number",description:"What the package can hold, not the same as its own weight.",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],nullable:!0},default:{type:"boolean",description:"The box every parcel quote is built on. Setting this demotes whichever row held it."},metadata:{type:"object",additionalProperties:!0}}},PasswordResetParams:{type:"object",properties:{password:{type:"string"},password_confirmation:{type:"string"}},required:["password","password_confirmation"]},PasswordResetRequestParams:{type:"object",properties:{email:{type:"string",format:"email"},redirect_url:{type:"string",description:"The page the emailed reset link points at, with the reset token appended. Honored only on the dashboard origin, for an account that is staff of the store; ignored otherwise."}},required:["email"]},PaymentCaptureParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Captures part of the authorized amount. Defaults to all of it."}}},PaymentCreateParams:{type:"object",properties:{payment_method_id:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the order total left after store credit."},source_id:{type:"string",description:"A saved payment source of the order's customer (a credit card), for an off-session charge. Used only by payment methods that require a source."}},required:["payment_method_id"]},PaymentMethodCreateParams:{type:"object",properties:{type:{type:"string",description:"Wire shorthand from the payment method types endpoint."},name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},storefront_visible:{type:"boolean",description:"False keeps the method to the dashboard; true also offers it on the storefront."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"When customers are charged for this method. Null inherits the store setting.",nullable:!0},position:{type:"integer"},metadata:{type:"object",additionalProperties:!0},preferences:{type:"object",additionalProperties:!0,description:"Values for the provider's preference schema, from the payment method types endpoint."}},required:["type","name"]},PaymentMethodUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},active:{type:"boolean"},storefront_visible:{type:"boolean",description:"False keeps the method to the dashboard; true also offers it on the storefront."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"When customers are charged for this method. Null inherits the store setting.",nullable:!0},position:{type:"integer"},metadata:{type:"object",additionalProperties:!0},preferences:{type:"object",additionalProperties:!0,description:"Values for the provider's preference schema, from the payment method types endpoint."}}},PolicyCreateParams:{type:"object",properties:{name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0}},required:["name"]},PolicyUpdateParams:{type:"object",properties:{name:{type:"string"},slug:{type:"string"},body:{type:"string",nullable:!0}}},PriceAdjustmentTierParams:{type:"object",properties:{min_quantity:{type:"integer",description:"Above 1; quantity 1 is the list's own `price_adjustment_percentage`."},percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts, positive marks up."}},required:["min_quantity","percentage"]},PriceBulkDestroyParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}}},required:["ids"]},PriceBulkUpsertParams:{type:"object",properties:{prices:{type:"array",items:{$ref:"#/components/schemas/PriceBulkUpsertRowParams"},description:"Send an empty list to change nothing."}},required:["prices"]},PriceBulkUpsertRowParams:{type:"object",properties:{id:{type:"string",description:"Present: updates that row. Absent: upserts on `(variant_id, currency, price_list_id, min_quantity)`.",nullable:!0},variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},price_list_id:{type:"string",description:"Omit or null for a base price.",nullable:!0},min_quantity:{type:"integer",description:"The rung of the variant's ladder. Omit for the bottom rung; anything above 1 requires a `price_list_id`. A variant carries at most ten rungs on one list per currency."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},required:["variant_id","currency"]},PriceCreateParams:{type:"object",properties:{variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The quantity a line must reach for this price to apply. Omit for the bottom rung of the ladder. Anything above 1 requires a `price_list_id`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},price_list_id:{type:"string",description:"Omit or null for a base price; a price list for a list override.",nullable:!0}},required:["variant_id","currency"]},PriceListCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},position:{type:"integer"},starts_at:{type:"string",format:"date-time",description:"Pair with `ends_at` to schedule the list: activating a list whose start is in the future marks it `scheduled`.",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},match_policy:{type:"string",enum:["all","any"],description:"`all`: every rule must match. `any`: one matching rule is enough."},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"The complete rule set: rules are matched by `id` and updated, new ones are built, and rules left out are removed."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the list's percentage. The payload is the whole ladder: a band left out is removed."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Per-variant price overrides. Each row upserts, so the variants it names become part of the list. Curating whole products goes through the nested products endpoint instead."}},required:["name"]},PriceListPriceOverrideParams:{type:"object",properties:{id:{type:"string",description:"Updates this price row. Without it, the row upserts on `(variant_id, currency, min_quantity)`."},variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The rung of the variant's ladder. Omit for the bottom rung."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}}},PriceListRuleParams:{type:"object",properties:{id:{type:"string",description:"Present for existing rules. Omit to create a new one.",nullable:!0},type:{type:"string",description:"Wire shorthand for the rule kind, from the price rule types endpoint."},preferences:{type:"object",additionalProperties:!0,description:"The rule kind's settings, keyed by preference name."}},required:["type"]},PriceListUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},position:{type:"integer"},starts_at:{type:"string",format:"date-time",description:"Pair with `ends_at` to schedule the list: activating a list whose start is in the future marks it `scheduled`.",nullable:!0},ends_at:{type:"string",format:"date-time",nullable:!0},match_policy:{type:"string",enum:["all","any"],description:"`all`: every rule must match. `any`: one matching rule is enough."},price_adjustment_percentage:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Signed: negative discounts off base prices, positive marks up.",nullable:!0},adjust_compare_at:{type:"boolean"},rules:{type:"array",items:{$ref:"#/components/schemas/PriceListRuleParams"},description:"The complete rule set: rules are matched by `id` and updated, new ones are built, and rules left out are removed."},price_adjustment_tiers:{type:"array",items:{$ref:"#/components/schemas/PriceAdjustmentTierParams"},description:"Quantity bands on the list's percentage. The payload is the whole ladder: a band left out is removed."},prices:{type:"array",items:{$ref:"#/components/schemas/PriceListPriceOverrideParams"},description:"Per-variant price overrides. Each row upserts, so the variants it names become part of the list. Curating whole products goes through the nested products endpoint instead."}}},PriceParams:{type:"object",properties:{currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:'A canonical decimal string (`"1234.56"`: period decimal, no grouping). The API does not parse localized input.'},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0}},required:["currency","amount"]},PriceUpdateParams:{type:"object",properties:{variant_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}]},min_quantity:{type:"integer",description:"The quantity a line must reach for this price to apply. Omit for the bottom rung of the ladder. Anything above 1 requires a `price_list_id`."},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},compare_at_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},price_list_id:{type:"string",description:"Omit or null for a base price; a price list for a list override.",nullable:!0}}},ProductBulkCategoriesParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}}},required:["ids","category_ids"]},ProductBulkChannelsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},channel_ids:{type:"array",items:{type:"string"}}},required:["ids","channel_ids"]},ProductBulkCollectionsParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"}}},required:["ids","collection_ids"]},ProductBulkDestroyParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"},description:"Products the caller cannot delete are skipped."}},required:["ids"]},ProductBulkStatusParams:{type:"object",properties:{ids:{type:"array",items:{type:"string"}},status:{type:"string",enum:["draft","active","archived"],description:"Products in review are skipped and counted in `skipped_in_review_count`."}},required:["ids","status"]},ProductCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},slug:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","active","archived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},tax_category_id:{type:"string"},product_type_id:{type:"string",description:"The product type this product is created from (`pt_...`). Its option types and categories seed onto the product and its custom field definitions drive the product form. Editing the type later never rewrites existing products.",nullable:!0},delivery_profile_id:{type:"string",description:"The delivery profile deciding how this product ships (`fp_...`); null falls back to the store default.",nullable:!0},promotionable:{type:"boolean"},tags:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"},description:"Manual collections this product belongs to. Automatic collections are kept as they are, since their rules decide membership."},metadata:{type:"object",additionalProperties:!0},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants` instead. Don't pass both."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."},media:{type:"array",items:{$ref:"#/components/schemas/ProductMediaParams"},description:"Media written with the product. Entries with `id` update an existing asset; entries with `signed_id` attach a fresh upload; an external video needs only its URL."},digital_assets:{type:"array",items:{$ref:"#/components/schemas/ProductDigitalAssetParams"},description:"Downloadable files written with the product. Each entry carries a `signed_id` (an upload to private storage) or a `provider_type` (a provider-backed asset), and attaches to the default variant unless `variant_id` is given. An `id` updates that asset in place, so replaying the list does not duplicate it; removal uses the nested digital assets endpoint."},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublicationParams"}},variants:{type:"array",items:{$ref:"#/components/schemas/ProductVariantParams"},description:"Every purchasable attribute (sku, prices, stock, weight, dimensions) lives on variants. An entry without `options` upserts onto the default variant of a simple product; pass `id` to update an existing variant."}},required:["name"]},ProductDigitalAssetParams:{type:"object",properties:{id:{type:"string"},signed_id:{type:"string"},variant_id:{type:"string"},provider_type:{type:"string",description:"A provider shorthand from the digital asset providers endpoint."},provider_settings:{type:"object",additionalProperties:!0,description:"Values for the provider's settings schema, keyed by field name."},authorized_clicks:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0},authorized_days:{type:"integer",description:"Null means the store's download settings apply.",nullable:!0}}},ProductMediaParams:{type:"object",properties:{id:{type:"string"},signed_id:{type:"string",description:"A `signed_id` from `files.upload()`."},source_media_id:{type:"string",description:"Copies an asset from the media library."},alt:{type:"string",nullable:!0},position:{type:"integer"},media_type:{type:"string",enum:["image","video","external_video"],description:"Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`."},external_video_url:{type:"string",description:"YouTube or Vimeo link. Required when `media_type` is `external_video`.",nullable:!0},poster_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for a video's poster frame."},focal_point_x:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},focal_point_y:{type:"number",description:"Where the image is anchored when cropped, from 0 to 1.",nullable:!0},variant_ids:{type:"array",items:{type:"string"},description:"Replaces the variants this media is linked to. An empty list clears them."}}},ProductMembershipParams:{type:"object",properties:{product_ids:{type:"array",items:{type:"string"},description:"Products from other stores, or ones the caller cannot see, are ignored."}},required:["product_ids"]},ProductMembershipRepositionParams:{type:"object",properties:{new_position:{type:"integer",description:"0-based index among the parent's products."}},required:["new_position"]},ProductPublicationParams:{type:"object",properties:{id:{type:"string"},channel_id:{type:"string"},published_at:{type:"string",format:"date-time",nullable:!0},unpublished_at:{type:"string",format:"date-time",nullable:!0}}},ProductRejectParams:{type:"object",properties:{reason:{type:"string",description:"Why the submission was turned down. Sent back to the seller."}}},ProductTypeCreateParams:{type:"object",properties:{name:{type:"string"},delivery_profile_id:{type:"string",description:"Delivery profile stamped onto products created with this type. Null leaves new products on the store default profile.",nullable:!0},option_type_ids:{type:"array",items:{type:"string"},description:"Option types seeded onto products that get this type. Use apply to products to backfill existing ones."},category_ids:{type:"array",items:{type:"string"},description:"Categories seeded onto products that get this type. Categories from other stores are ignored."},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinitionParams"},description:"The custom field definitions the product form shows. Definitions not listed are removed from the type."}},required:["name"]},ProductTypeCustomFieldDefinitionParams:{type:"object",properties:{id:{type:"string",description:"The custom field definition."},required:{type:"boolean"},sort_order:{type:"integer"}},required:["id"]},ProductTypeUpdateParams:{type:"object",properties:{name:{type:"string"},delivery_profile_id:{type:"string",description:"Delivery profile stamped onto products created with this type. Null leaves new products on the store default profile.",nullable:!0},option_type_ids:{type:"array",items:{type:"string"},description:"Option types seeded onto products that get this type. Use apply to products to backfill existing ones."},category_ids:{type:"array",items:{type:"string"},description:"Categories seeded onto products that get this type. Categories from other stores are ignored."},custom_field_definitions:{type:"array",items:{$ref:"#/components/schemas/ProductTypeCustomFieldDefinitionParams"},description:"The custom field definitions the product form shows. Definitions not listed are removed from the type."}}},ProductUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},description:{type:"string",description:"Rich text HTML. Reads come back as this (plain text) plus `description_html`."},slug:{type:"string"},status:{anyOf:[{type:"string",enum:["draft","active","archived"]},{type:"string"}],description:"The values listed are the built-in ones; extensions may add more."},meta_title:{type:"string"},meta_description:{type:"string"},meta_keywords:{type:"string"},tax_category_id:{type:"string"},product_type_id:{type:"string",description:"The product type this product is created from (`pt_...`). Its option types and categories seed onto the product and its custom field definitions drive the product form. Editing the type later never rewrites existing products.",nullable:!0},delivery_profile_id:{type:"string",description:"The delivery profile deciding how this product ships (`fp_...`); null falls back to the store default.",nullable:!0},promotionable:{type:"boolean"},tags:{type:"array",items:{type:"string"}},category_ids:{type:"array",items:{type:"string"}},collection_ids:{type:"array",items:{type:"string"},description:"Manual collections this product belongs to. Automatic collections are kept as they are, since their rules decide membership."},metadata:{type:"object",additionalProperties:!0},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under `variants` instead. Don't pass both."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."},media:{type:"array",items:{$ref:"#/components/schemas/ProductMediaParams"},description:"Media written with the product. Entries with `id` update an existing asset; entries with `signed_id` attach a fresh upload; an external video needs only its URL."},digital_assets:{type:"array",items:{$ref:"#/components/schemas/ProductDigitalAssetParams"},description:"Downloadable files written with the product. Each entry carries a `signed_id` (an upload to private storage) or a `provider_type` (a provider-backed asset), and attaches to the default variant unless `variant_id` is given. An `id` updates that asset in place, so replaying the list does not duplicate it; removal uses the nested digital assets endpoint."},product_publications:{type:"array",items:{$ref:"#/components/schemas/ProductPublicationParams"}},variants:{type:"array",items:{$ref:"#/components/schemas/ProductVariantParams"},description:"Every purchasable attribute (sku, prices, stock, weight, dimensions) lives on variants. An entry without `options` upserts onto the default variant of a simple product; pass `id` to update an existing variant."}}},ProductVariantParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{id:{type:"string"}}}]},PromotionActionCalculatorParams:{type:"object",properties:{type:{type:"string",description:"The calculator kind, from `GET /promotion_actions/calculators`. Changing it swaps the calculator."},preferences:{type:"object",additionalProperties:!0,description:"Values for the calculator's settings, such as `amount` or `flat_percent`."}}},PromotionActionCreateParams:{type:"object",properties:{type:{type:"string",description:"The action kind, from `GET /promotion_actions/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}},required:["type"]},PromotionActionDraftParams:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"The action kind, from `GET /promotion_actions/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}},required:["type"]},PromotionActionLineItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity:{type:"integer"}},required:["variant_id","quantity"]},PromotionActionUpdateParams:{type:"object",properties:{preferences:{type:"object",additionalProperties:!0,description:"Values for the action kind's settings schema, from `GET /promotion_actions/types`."},calculator:{allOf:[{$ref:"#/components/schemas/PromotionActionCalculatorParams"}],description:"For adjustment actions."},line_items:{type:"array",items:{$ref:"#/components/schemas/PromotionActionLineItemParams"},description:"For `create_line_items`: the variants to add and their quantities. Variants left out are removed."}}},PromotionCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",description:"Required for single-code coupon promotions. Ignored when `multi_codes` is true.",nullable:!0},path:{type:"string",nullable:!0},starts_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},usage_limit:{type:"integer",nullable:!0},match_policy:{type:"string",enum:["all","any"]},kind:{type:"string",enum:["coupon_code","automatic"],description:"`coupon_code` needs a code (or `multi_codes`); `automatic` applies without one."},multi_codes:{type:"boolean",description:"Generates `number_of_codes` codes starting with `code_prefix`."},number_of_codes:{type:"integer",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},rules:{type:"array",items:{$ref:"#/components/schemas/PromotionRuleDraftParams"},description:"The rules the promotion should have: entries with `id` update, entries without are created, and rules left out are removed."},actions:{type:"array",items:{$ref:"#/components/schemas/PromotionActionDraftParams"},description:"The actions the promotion should have, matched the same way as `rules`."}},required:["name"]},PromotionRuleCreateParams:{type:"object",properties:{type:{type:"string",description:"The rule kind, from `GET /promotion_rules/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}},required:["type"]},PromotionRuleDraftParams:{type:"object",properties:{id:{type:"string"},type:{type:"string",description:"The rule kind, from `GET /promotion_rules/types`."},preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}},required:["type"]},PromotionRuleUpdateParams:{type:"object",properties:{preferences:{type:"object",additionalProperties:!0,description:"Values for the rule kind's settings schema, from `GET /promotion_rules/types`."},product_ids:{type:"array",items:{type:"string"},description:"For the `product` rule."},category_ids:{type:"array",items:{type:"string"},description:"For the `category` rule."},customer_ids:{type:"array",items:{type:"string"},description:"For the `user` rule: the customers who qualify."}}},PromotionUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},code:{type:"string",description:"Required for single-code coupon promotions. Ignored when `multi_codes` is true.",nullable:!0},path:{type:"string",nullable:!0},starts_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},usage_limit:{type:"integer",nullable:!0},match_policy:{type:"string",enum:["all","any"]},kind:{type:"string",enum:["coupon_code","automatic"],description:"`coupon_code` needs a code (or `multi_codes`); `automatic` applies without one."},multi_codes:{type:"boolean",description:"Generates `number_of_codes` codes starting with `code_prefix`."},number_of_codes:{type:"integer",nullable:!0},code_prefix:{type:"string",nullable:!0},promotion_category_id:{type:"string",nullable:!0},rules:{type:"array",items:{$ref:"#/components/schemas/PromotionRuleDraftParams"},description:"The rules the promotion should have: entries with `id` update, entries without are created, and rules left out are removed."},actions:{type:"array",items:{$ref:"#/components/schemas/PromotionActionDraftParams"},description:"The actions the promotion should have, matched the same way as `rules`."}}},PurchaseOrderCancelParams:{type:"object",properties:{reason:{type:"string",description:"Appended to the order's notes."}}},PurchaseOrderCreateParams:{type:"object",properties:{supplier_id:{type:"string"},destination_location_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Defaults to the store's currency; set it for a foreign-currency order.",nullable:!0},expected_at:{type:"string",format:"date",description:"The day the supplier promised. `null` clears it.",nullable:!0},cancel_by:{type:"string",format:"date",description:"The day after which the goods are no longer wanted. `null` clears it.",nullable:!0},reference:{type:"string",description:"The supplier's own order number. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItemParams"},description:"Sending the list replaces whatever the order currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["supplier_id","destination_location_id"]},PurchaseOrderItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity_ordered:{type:"integer"},unit_cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"What the merchant agreed to pay per unit."}},required:["variant_id","quantity_ordered","unit_cost"]},PurchaseOrderUpdateParams:{type:"object",properties:{supplier_id:{type:"string"},destination_location_id:{type:"string"},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Defaults to the store's currency; set it for a foreign-currency order.",nullable:!0},expected_at:{type:"string",format:"date",description:"The day the supplier promised. `null` clears it.",nullable:!0},cancel_by:{type:"string",format:"date",description:"The day after which the goods are no longer wanted. `null` clears it.",nullable:!0},reference:{type:"string",description:"The supplier's own order number. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/PurchaseOrderItemParams"},description:"Sending the list replaces whatever the order currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},ReasonCreateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."}},required:["name"]},ReasonUpdateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."}}},ReceivableCloseParams:{type:"object",properties:{reason:{type:"string",description:"Why the balance is not coming.",nullable:!0}}},RefundCreateParams:{type:"object",properties:{payment_id:{type:"string"},amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$"},refund_reason_id:{type:"string",description:"Defaults to the store's first refund reason."}},required:["payment_id","amount"]},ReportingQueryParams:{type:"object",properties:{metrics:{type:"array",items:{type:"string"},description:"Registered metric names, from the reporting schema endpoint."},dimensions:{type:"array",items:{},description:"Up to 2 dimensions to break the metrics down by. Each is a dimension name, or `{ name, grain, include_empty }`: `grain` (`hour`, `day`, `week`, `month`) buckets a time dimension, and `include_empty` lists members with no matching rows where the schema entry supports it."},filters:{type:"array",items:{type:"object",properties:{dimension:{type:"string"},op:{type:"string",enum:["eq","in"]},value:{description:"One value for `eq`, a list for `in`."}},required:["dimension","op","value"]},description:"Narrows the rows by dimension value."},metric_filters:{type:"array",items:{type:"object",properties:{metric:{type:"string"},op:{type:"string",enum:["eq","gt","gte","lt","lte"]},value:{type:"number"}},required:["metric","op","value"]},description:"Filters on an aggregate, such as `units_sold = 0`. Narrows the rows only; the totals stay the period's real figure. The metric must also appear in `metrics`, and cannot be a derived one."},time_range:{type:"object",properties:{preset:{type:"string"},since:{type:"string"},until:{type:"string"}},description:"A named preset (`last_month`, `week_to_date`, any `last_<n>_<days|weeks|months>`), or ISO 8601 dates or times in `since` and `until` (a bare date covers the store's whole day). Defaults to the last 30 days, in the store's time zone."},compare:{type:"string",enum:["previous_period","previous_year"]},sort:{type:"string",description:"A metric name; prefix it with `-` to sort descending."},limit:{type:"integer",description:"At most 1000."},currency:{$ref:"#/components/schemas/CurrencyCode"}},required:["metrics"]},ReturnCancelParams:{type:"object",properties:{reason:{type:"string",description:"A note on why the return was canceled."}}},ReturnCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},items:{type:"array",items:{type:"object",properties:{fulfillment_item_id:{type:"string"},quantity:{type:"integer"}},required:["fulfillment_item_id","quantity"]},description:"Fulfilled units coming back, and how many of each."},stock_location_id:{type:"string",description:"Where the goods come back to. Defaults to the location that shipped them."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"}},required:["items"]},ReturnReceiveParams:{type:"object",properties:{items:{type:"array",items:{type:"object",properties:{return_line_item_id:{type:"string"},quantity:{type:"integer"},resellable:{type:"boolean",description:"Goods that cannot be resold are received but never restocked. Defaults to true."}},required:["return_line_item_id","quantity"]},description:"What actually arrived. Omit to receive everything as requested and resellable; send rows for a partial or damaged receipt."}}},ReturnRefundParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the value of what was actually received."},refund_method:{type:"string",enum:["original_payment","store_credit"],description:"`store_credit` issues credit immediately; `original_payment` (the default) refunds through the gateway that took the money."}}},ReturnUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},stock_location_id:{type:"string",description:"Where the goods come back to. Defaults to the location that shipped them."},reason_id:{type:"string",description:"One of the store's return reasons."},memo:{type:"string"},metadata:{type:"object",additionalProperties:!0}}},RoleCreateParams:{type:"object",properties:{name:{type:"string",description:"Unique role name, the machine identifier shown capitalized in the dashboard."},description:{type:"string",nullable:!0},permissions:{type:"array",items:{type:"string"},description:"Permission keys (`read_orders`, `write_products`, ...) from the permissions endpoint. You can only grant keys you hold yourself."}},required:["name"]},RoleUpdateParams:{type:"object",properties:{name:{type:"string",description:"Unique role name, the machine identifier shown capitalized in the dashboard."},description:{type:"string",nullable:!0},permissions:{type:"array",items:{type:"string"},description:"Permission keys (`read_orders`, `write_products`, ...) from the permissions endpoint. You can only grant keys you hold yourself."}}},SavedReportCreateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object",additionalProperties:!0,description:"A reporting query, validated against the reporting registry on save."}},required:["name","query"]},SavedReportUpdateParams:{type:"object",properties:{name:{type:"string"},description:{type:"string",nullable:!0},query:{type:"object",additionalProperties:!0,description:"A reporting query, validated against the reporting registry on save."}}},SellerAddressParams:{type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},company:{type:"string"},address1:{type:"string"},address2:{type:"string"},city:{type:"string"},postal_code:{type:"string"},phone:{type:"string"},label:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 code, such as `US`."},state_code:{type:"string",description:"The state or province abbreviation, such as `NY`."},state_name:{type:"string",description:"For countries without states in the database."}}},SellerApproveParams:{type:"object",properties:{override_requirements:{type:"boolean",description:"Admits a seller whose onboarding checklist is unfinished: the operator's deliberate exception, which the `seller.approved` event records along with what was outstanding."}}},SellerCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},slug:{type:"string",description:"URL-safe slug, derived from the name when omitted."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},about:{type:"string",description:"Sanitized HTML: the seller's public description.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from the files upload endpoint to set the image, `null` to remove it, or omit the key to leave it untouched. The same applies to `square_logo_signed_id` and `cover_photo_signed_id`.",nullable:!0},square_logo_signed_id:{type:"string",nullable:!0},cover_photo_signed_id:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"],nullable:!0},minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},holiday_mode_until:{type:"string",format:"date-time",description:"Set while the seller is away: the catalog stays but stops selling.",nullable:!0},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0},billing_address:{allOf:[{$ref:"#/components/schemas/SellerAddressParams"}],description:"The seller's own billing address, written inline. There is no `billing_address_id`: an address belongs to whoever it was created for, so it is never referenced by id."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}},required:["name"]},SellerInviteParams:{type:"object",properties:{email:{type:"string"},role_id:{type:"string",description:"A role this seller owns; defaults to the seller's own admin role.",nullable:!0}},required:["email"]},SellerPayoutCompleteParams:{type:"object",properties:{reference:{type:"string",description:"The provider's own id for the settlement, when one made it."}}},SellerRejectParams:{type:"object",properties:{reason:{type:"string"}}},SellerReopenOnboardingParams:{type:"object",properties:{note:{type:"string",description:"What the seller has to fix."}}},SellerRequirementCreateParams:{type:"object",properties:{type:{type:"string",description:"The kind, from the seller requirement types endpoint."},name:{type:"string",description:"What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself."},description:{type:"string",description:"Instructions shown to the seller."},position:{type:"integer",description:"Place in the checklist."},active:{type:"boolean"},required:{type:"boolean",description:"Whether this blocks approval. Off means recommended."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for this kind, per its type's `schema`."},metadata:{type:"object",additionalProperties:!0},custom_field_definition_ids:{type:"array",items:{type:"string"},description:"Custom field definitions this requirement asks the seller to fill in (`required_custom_fields` kind)."}},required:["type"]},SellerRequirementReviewParams:{type:"object",properties:{review_note:{type:"string",description:"Kept with the decision. On a rejection it is the reason sent back to the seller."}}},SellerRequirementUpdateParams:{type:"object",properties:{name:{type:"string",description:"What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself."},description:{type:"string",description:"Instructions shown to the seller."},position:{type:"integer",description:"Place in the checklist."},active:{type:"boolean"},required:{type:"boolean",description:"Whether this blocks approval. Off means recommended."},preferences:{type:"object",additionalProperties:!0,description:"Configuration for this kind, per its type's `schema`."},metadata:{type:"object",additionalProperties:!0},custom_field_definition_ids:{type:"array",items:{type:"string"},description:"Custom field definitions this requirement asks the seller to fill in (`required_custom_fields` kind)."}}},SellerRequirementWaiveParams:{type:"object",properties:{requirement_id:{type:"string",description:"The requirement the seller is excused from."},review_note:{type:"string",description:"Why the seller is excused. Kept with the decision."}},required:["requirement_id"]},SellerSuspendParams:{type:"object",properties:{reason:{type:"string"}}},SellerUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},slug:{type:"string",description:"URL-safe slug, derived from the name when omitted."},contact_email:{type:"string",nullable:!0},billing_email:{type:"string",nullable:!0},about:{type:"string",description:"Sanitized HTML: the seller's public description.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from the files upload endpoint to set the image, `null` to remove it, or omit the key to leave it untouched. The same applies to `square_logo_signed_id` and `cover_photo_signed_id`.",nullable:!0},square_logo_signed_id:{type:"string",nullable:!0},cover_photo_signed_id:{type:"string",nullable:!0},tax_remittance:{type:"string",enum:["seller","platform"]},payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"],nullable:!0},minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},holiday_mode_until:{type:"string",format:"date-time",description:"Set while the seller is away: the catalog stays but stops selling.",nullable:!0},legal_name:{type:"string",nullable:!0},registration_number:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0},billing_address:{allOf:[{$ref:"#/components/schemas/SellerAddressParams"}],description:"The seller's own billing address, written inline. There is no `billing_address_id`: an address belongs to whoever it was created for, so it is never referenced by id."},custom_fields:{type:"array",items:{$ref:"#/components/schemas/CustomFieldValueParams"},description:"Custom field values, each validated against its definition."}}},SetupParams:{type:"object",properties:{setup_token:{type:"string",description:"The one-time token from the install output."},email:{type:"string",format:"email"},password:{type:"string"},password_confirmation:{type:"string"},first_name:{type:"string"},last_name:{type:"string"},store_name:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO 3166-1 alpha-2 country the store sells from. It determines the default market, the warehouse, the delivery zones and the currency."},locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"Storefront locale. Defaults to the country's own language."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"ISO 4217 currency. Defaults to the country's own currency: pass one only when the store prices in something else."},sample_data:{type:"boolean",description:"Load the demo catalog, customers and orders in the background once the admin account exists. The load takes minutes, so the response does not wait for it."}},required:["setup_token","email","password","country_code"]},ShippingLabelCreateParams:{type:"object",properties:{file_signed_id:{type:"string",description:"A `signed_id` from `files.upload()`. Its presence records a label bought elsewhere instead of buying one; without it the body is ignored and the label is bought through the carrier."},tracking_number:{type:"string",description:"The number printed on an uploaded label. Required with `file_signed_id`."},carrier:{type:"string",description:"Free text; a forwarder's name is as valid as a carrier slug. Detected from the number when omitted."},service:{type:"string",description:"Carrier service the label was bought at."},cost:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"What the merchant paid the carrier. Accounting data only; it never touches the order's shipping charge."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Currency of the cost."},file_format:{type:"string",enum:["pdf","png","zpl"],description:"Taken from the file when omitted."},tracking_url:{type:"string",description:"Tracking page for the consignment the label mints."}}},StockLevelBulkUpsertParams:{type:"object",properties:{stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevelBulkUpsertRowParams"},description:"Send an empty list to change nothing."}},required:["stock_levels"]},StockLevelBulkUpsertRowParams:{type:"object",properties:{variant_id:{type:"string"},stock_location_id:{type:"string"},count_on_hand:{type:"integer",description:"The absolute level the external system reports.",nullable:!0},adjustment:{type:"integer",description:"A relative change, for feeds that report movements rather than levels. Each row needs `count_on_hand` or `adjustment`.",nullable:!0},backorderable:{type:"boolean",nullable:!0}},required:["variant_id","stock_location_id"]},StockLevelParams:{type:"object",properties:{stock_location_id:{type:"string",description:"The location holding the stock (`sloc_...`)."},count_on_hand:{type:"integer",description:"Units physically at the location, not units available to sell: stock promised to placed orders counts until it ships. Sent as the count the shelf should end at; the API records the difference as an adjustment in the stock history."},backorderable:{type:"boolean",description:"Whether this location sells the variant beyond what it holds."}},required:["stock_location_id","count_on_hand"]},StockLevelUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},count_on_hand:{type:"integer",description:"The count the shelf should end at: a whole number of zero or more. The API records the difference as an `adjusted` movement, so the correction appears in the stock history."},adjustment:{type:"integer",description:"A signed change to the shelf instead of a target count, applied to the count the API holds at that moment and recorded the same way. Cannot be sent together with `count_on_hand`."},backorderable:{type:"boolean",description:"Whether this location sells the variant beyond what it holds."},reason:{type:"string",description:'Labels the correction in the stock history. Defaults to "Manual adjustment".'},metadata:{type:"object",additionalProperties:!0}}},StockLocationCreateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},admin_name:{type:"string",description:"Internal name shown only in the admin.",nullable:!0},active:{type:"boolean"},default:{type:"boolean",description:"Setting to true demotes the previous default."},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"Categorizes the location. The values listed are the built-in ones; extensions may add more."},propagate_all_variants:{type:"boolean"},backorderable_default:{type:"boolean"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO-3166 alpha-2 country code.",nullable:!0},state_code:{type:"string",description:"State or province abbreviation, resolved against the selected country's states.",nullable:!0},state_name:{type:"string",description:"Free-text state for countries that don't have a states list.",nullable:!0},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"],description:"`local` collects only items at this location; `any` lets items transfer in from other locations (ship-to-store)."},pickup_ready_in_minutes:{type:"integer",nullable:!0},returns_enabled:{type:"boolean",description:"Whether customers may send returns to this location."},pickup_instructions:{type:"string",nullable:!0}},required:["name"]},StockLocationUpdateParams:{type:"object",properties:{external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."},name:{type:"string"},admin_name:{type:"string",description:"Internal name shown only in the admin.",nullable:!0},active:{type:"boolean"},default:{type:"boolean",description:"Setting to true demotes the previous default."},kind:{anyOf:[{type:"string",enum:["warehouse","store","fulfillment_center"]},{type:"string"}],description:"Categorizes the location. The values listed are the built-in ones; extensions may add more."},propagate_all_variants:{type:"boolean"},backorderable_default:{type:"boolean"},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},zipcode:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},company:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO-3166 alpha-2 country code.",nullable:!0},state_code:{type:"string",description:"State or province abbreviation, resolved against the selected country's states.",nullable:!0},state_name:{type:"string",description:"Free-text state for countries that don't have a states list.",nullable:!0},pickup_enabled:{type:"boolean"},pickup_stock_policy:{type:"string",enum:["local","any"],description:"`local` collects only items at this location; `any` lets items transfer in from other locations (ship-to-store)."},pickup_ready_in_minutes:{type:"integer",nullable:!0},returns_enabled:{type:"boolean",description:"Whether customers may send returns to this location."},pickup_instructions:{type:"string",nullable:!0}}},StockReceiptCreateParams:{type:"object",properties:{reference:{type:"string",description:"The supplier's delivery note, or the carrier's reference.",nullable:!0},received_at:{type:"string",format:"date-time",description:"When the goods were counted in. Defaults to now.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockReceiptItemParams"},description:"Omit to book in everything still outstanding, intact. Naming lines, even none, records exactly what the dock counted: `quantity_accepted` reaches the shelf; `quantity_rejected` is refused, recorded with a `rejection_reason` and never stocked."}}},StockReceiptItemParams:{type:"object",properties:{id:{type:"string",description:"The purchase order or transfer line."},quantity_accepted:{type:"integer"},quantity_rejected:{type:"integer"},rejection_reason:{type:"string",enum:["damaged","wrong_item","expired","other"],nullable:!0},notes:{type:"string",nullable:!0}},required:["id"]},StockTransferCancelParams:{type:"object",properties:{on_in_transit:{type:"string",enum:["restock","write_off"],description:"Required once the units have left the source: either they come back (`restock`) or they are written off as lost (`write_off`)."},reason:{type:"string",description:"Recorded against the written-off lines.",nullable:!0}}},StockTransferCreateParams:{type:"object",properties:{source_location_id:{type:"string"},destination_location_id:{type:"string"},reference:{type:"string",description:"The merchant's own label for the trip. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItemParams"},description:"A draft may open empty and gain lines as the merchant packs. Sending the list replaces whatever the draft currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["source_location_id","destination_location_id"]},StockTransferItemParams:{type:"object",properties:{variant_id:{type:"string"},quantity_shipped:{type:"integer"}},required:["variant_id","quantity_shipped"]},StockTransferMarkInTransitParams:{type:"object",properties:{force:{type:"boolean",description:"Ship even if it drives the source below zero."}}},StockTransferUpdateParams:{type:"object",properties:{source_location_id:{type:"string"},destination_location_id:{type:"string"},reference:{type:"string",description:"The merchant's own label for the trip. `null` clears it.",nullable:!0},notes:{type:"string",nullable:!0},items:{type:"array",items:{$ref:"#/components/schemas/StockTransferItemParams"},description:"A draft may open empty and gain lines as the merchant packs. Sending the list replaces whatever the draft currently holds."},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},StoreCreditApplyParams:{type:"object",properties:{amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"Defaults to the customer's available store credit, up to the order total."}}},StoreUpdateParams:{type:"object",properties:{name:{type:"string"},seo_title:{type:"string",description:"The storefront's default page title, in the store's default language. Translate it through the translations endpoints.",nullable:!0},meta_description:{type:"string",description:"The storefront's default meta description, in the store's default language.",nullable:!0},admin_locale:{allOf:[{$ref:"#/components/schemas/LocaleCode"}],description:"The language the dashboard opens in for every staff member; null lets each use their own.",nullable:!0},timezone:{allOf:[{$ref:"#/components/schemas/TimeZone"}]},weight_unit:{$ref:"#/components/schemas/WeightUnit"},unit_system:{type:"string",enum:["metric","imperial"]},storefront_access:{type:"string",enum:["public","prices_hidden","login_required"],description:"The store-wide default for what anonymous visitors can see. Channels fall back to it when they don't set their own."},storefront_url:{type:"string",description:"The storefront's public URL, the base for links in customer emails. Saving it also completes the storefront setup task.",nullable:!0},guest_checkout:{type:"boolean",description:"The store-wide default for guest checkout. Channels fall back to it."},always_include_confirm_step:{type:"boolean",description:"Always show a confirmation step in checkout, even when no payment method requires one."},company_field_enabled:{type:"boolean",description:"Shows a company field on address forms."},address_requires_company:{type:"boolean",description:"Makes a company name mandatory on addresses."},address_requires_phone:{type:"boolean",description:"Makes a phone number mandatory on customer addresses."},capture_method:{type:"string",enum:["checkout","on_dispatch","manual"],description:"The store-wide default for when a customer is charged rather than only authorized. A payment method's own setting wins when set."},track_inventory_levels:{type:"boolean",description:"Counts on-hand quantities. Off means everything is treated as always available."},stock_reservations_enabled:{type:"boolean",description:"Holds stock for shoppers while they check out, so the same item can't be sold twice."},low_stock_threshold:{type:"integer",description:"On-hand units at or below which a tracked variant counts as low stock on the home screen; 0 turns the warning off."},tax_using_ship_address:{type:"boolean",description:"Calculates tax from the shipping address. When false, tax is calculated from the billing address."},track_price_history:{type:"boolean",description:"Records price changes for the EU Omnibus lowest-price-in-30-days display."},show_products_without_price:{type:"boolean",description:"Whether products with no price in the shopper's currency still appear in listings."},disable_sku_validation:{type:"boolean",description:"Lets more than one variant share the same SKU."},order_routing_strategy:{type:"string",description:"The store-wide order routing strategy shorthand. Channels fall back to it."},pricing_provider:{type:"string",description:"Where prices come from: a registered provider key, or `internal`."},inventory_provider:{type:"string",description:"Where stock levels come from: a registered provider key, or `internal`."},pricing_provider_failure_policy:{type:"string",enum:["fallback","strict"],description:"`strict` refuses to price when the provider cannot answer; `fallback` uses the catalog."},inventory_provider_failure_policy:{type:"string",enum:["fallback","strict"],description:"`fallback` sells on the local stock snapshot when the provider cannot answer; `strict` refuses."},payout_provider:{type:"string",description:"Blank means the built-in provider: the marketplace settles by hand."},default_payouts_schedule_interval:{type:"string",enum:["daily","weekly","biweekly","monthly","manual"]},default_minimum_payout_amount:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"In the store's currency."},auto_approve_sellers:{type:"boolean",description:"Admits a seller as soon as they finish onboarding, with no operator review."},auto_approve_seller_products:{type:"boolean",description:"Puts a seller product on sale the moment it is submitted, with no review."},seller_digital_assets_enabled:{type:"boolean",description:"Lets sellers attach downloadable files to their own products."},seller_digital_asset_content_types:{type:"array",items:{type:"string"},description:"The content types a seller's file may have, checked against the file's own signature where it has one. An entry names one type or, with `*` as the subtype, a whole family. The operator's own uploads are not restricted."},review_seller_digital_asset_changes:{type:"boolean",description:"Sends a seller product already on sale back to review when the seller adds or replaces a file on it."},send_seller_transactional_emails:{type:"boolean",description:"When false, transactional seller emails (approval, payouts and so on) are not sent."},default_commission_tax_rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:'Tax charged on commission as a fraction (`"0.23"` is 23%), when neither the commission rate nor the tax provider names one.'},document_number_format:{type:"string",description:"How document numbers are produced: `sequential` or `random`. Applies to every numbered document."},order_number_prefix:{type:"string",description:"Leads every order number. Uppercase letters, digits, dashes and # only."},order_number_suffix:{type:"string",description:"Ends every order number. Uppercase letters, digits, dashes and # only."},order_number_sequence_start:{type:"integer",description:"The first sequential order number. Only applies before the store's first order."},limit_digital_download_count:{type:"boolean",description:"Whether a digital download link stops working after a number of clicks."},digital_asset_authorized_clicks:{type:"integer",description:"How many clicks a download link allows, unless the file sets its own."},limit_digital_download_days:{type:"boolean",description:"Whether a digital download link expires after a number of days."},digital_asset_authorized_days:{type:"integer",description:"How many days a download link stays valid, unless the file sets its own."},mail_from_address:{type:"string",description:"Sender address of every transactional email."},customer_support_email:{type:"string",description:"Customer-facing reply-to address shown in the storefront and email footers.",nullable:!0},new_order_notifications_email:{type:"string",description:'Recipient of "new order placed" staff notifications.',nullable:!0},send_consumer_transactional_emails:{type:"boolean",description:"When false, transactional customer emails (order confirmation and so on) are not sent."},email_accent_color:{type:"string",description:"Customer email buttons and links, as `#RRGGBB`. Blank keeps the outlined buttons emails ship with.",nullable:!0},email_background_color:{type:"string",description:"Customer email page background, as `#RRGGBB`.",nullable:!0},email_card_color:{type:"string",description:"Customer email card behind the content, as `#RRGGBB`.",nullable:!0},email_text_color:{type:"string",description:"Customer email body text, as `#RRGGBB`.",nullable:!0},email_heading_color:{type:"string",description:"Customer email headings and emphasized text, as `#RRGGBB`.",nullable:!0},email_font:{type:"string",description:"Customer email font: `inter`, `system`, `helvetica`, `georgia`, `roboto`, `lato` or `merriweather`.",nullable:!0},logo_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the store logo, or null to remove it.",nullable:!0},mailer_logo_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` for the logo in transactional emails, or null to remove it.",nullable:!0}}},SupplierCreateParams:{type:"object",properties:{name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],nullable:!0},postal_code:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0,nullable:!0}},required:["name"]},SupplierUpdateParams:{type:"object",properties:{name:{type:"string"},contact_name:{type:"string",nullable:!0},email:{type:"string",nullable:!0},phone:{type:"string",nullable:!0},notes:{type:"string",nullable:!0},address1:{type:"string",nullable:!0},address2:{type:"string",nullable:!0},city:{type:"string",nullable:!0},state_name:{type:"string",nullable:!0},state_code:{type:"string",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],nullable:!0},postal_code:{type:"string",nullable:!0},metadata:{type:"object",additionalProperties:!0,nullable:!0}}},TaxCategoryCreateParams:{type:"object",properties:{name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"}},required:["name"]},TaxCategoryUpdateParams:{type:"object",properties:{name:{type:"string"},tax_code:{type:"string",nullable:!0},description:{type:"string",nullable:!0},is_default:{type:"boolean"}}},TaxExemptionCertificateCreateParams:{type:"object",properties:{certificate_number:{type:"string"},tax_exemption_reason_id:{type:"string",description:"One of the store's active tax exemption reasons. The tax provider receives its `code`."},issuing_authority:{type:"string",nullable:!0},issued_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"Where the certificate holds. Omit it and `state_code` for one valid everywhere.",nullable:!0},state_code:{type:"string",nullable:!0},document_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`."},metadata:{type:"object",additionalProperties:!0}},required:["certificate_number","tax_exemption_reason_id"]},TaxExemptionCertificateUpdateParams:{type:"object",properties:{certificate_number:{type:"string"},tax_exemption_reason_id:{type:"string",description:"One of the store's active tax exemption reasons. The tax provider receives its `code`."},issuing_authority:{type:"string",nullable:!0},issued_at:{type:"string",format:"date-time",nullable:!0},expires_at:{type:"string",format:"date-time",nullable:!0},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"Where the certificate holds. Omit it and `state_code` for one valid everywhere.",nullable:!0},state_code:{type:"string",nullable:!0},document_signed_id:{type:"string",description:"A `signed_id` from `files.upload()` with `visibility: 'private'`."},metadata:{type:"object",additionalProperties:!0}}},TaxExemptionReasonCreateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."},code:{type:"string",description:"What the tax provider receives for every certificate holding this reason \u2014 for Avalara, an entity use code such as `G`. Saved in capitals. Changing it changes what those certificates send from then on."},metadata:{type:"object",additionalProperties:!0}},required:["name","code"]},TaxExemptionReasonUpdateParams:{type:"object",properties:{name:{type:"string"},active:{type:"boolean",description:"Whether the reason is offered on new records."},code:{type:"string",description:"What the tax provider receives for every certificate holding this reason \u2014 for Avalara, an entity use code such as `G`. Saved in capitals. Changing it changes what those certificates send from then on."},metadata:{type:"object",additionalProperties:!0}}},TaxIdentifierCreateParams:{type:"object",properties:{kind:{type:"string",description:"The registration the number belongs to, such as `eu_vat` or `gb_vat`. Any kind is accepted; one with a registered validator is checked by it. Built-in: `eu_vat`. Extensions may register more."},value:{type:"string"}},required:["kind","value"]},TaxIdentifierUpdateParams:{type:"object",properties:{kind:{type:"string",description:"The registration the number belongs to, such as `eu_vat` or `gb_vat`. Any kind is accepted; one with a registered validator is checked by it. Built-in: `eu_vat`. Extensions may register more."},value:{type:"string"}}},TaxRateCreateParams:{type:"object",properties:{name:{type:"string",description:"Customer-facing rate name."},rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a fraction. Send this or `rate_percent`."},rate_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a percentage."},show_rate_in_label:{type:"boolean"},tax_category_id:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO country code. A rate naming no country taxes everywhere.",nullable:!0},state_code:{type:"string",description:"State abbreviation within that country.",nullable:!0},metadata:{type:"object",additionalProperties:!0}},required:["name","tax_category_id"]},TaxRateUpdateParams:{type:"object",properties:{name:{type:"string",description:"Customer-facing rate name."},rate:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a fraction. Send this or `rate_percent`."},rate_percent:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",description:"The rate as a percentage."},show_rate_in_label:{type:"boolean"},tax_category_id:{type:"string"},country_code:{allOf:[{$ref:"#/components/schemas/CountryCode"}],description:"ISO country code. A rate naming no country taxes everywhere.",nullable:!0},state_code:{type:"string",description:"State abbreviation within that country.",nullable:!0},metadata:{type:"object",additionalProperties:!0}}},TranslationBatchEntryParams:{type:"object",properties:{resource_type:{type:"string",description:"Translatable resource type token, e.g. `option_type`."},resource_id:{type:"string"},values:{type:"object",additionalProperties:!0,description:"Translated fields keyed by locale code, then by field name."}},required:["resource_type","resource_id","values"]},TranslationBatchParams:{type:"object",properties:{translations:{type:"array",items:{$ref:"#/components/schemas/TranslationBatchEntryParams"},description:"At least one entry. All entries are saved, or none are."}},required:["translations"]},VariantCreateParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing. On update, omit to leave the option values untouched."},external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."}},required:["options"]}]},VariantOptionParams:{type:"object",properties:{name:{type:"string"},value:{type:"string"}},required:["name","value"]},VariantParams:{type:"object",properties:{sku:{type:"string"},barcode:{type:"string"},cost_price:{type:"string",format:"decimal",pattern:"^-?\\d+(\\.\\d+)?$",nullable:!0},cost_currency:{$ref:"#/components/schemas/CurrencyCode"},weight:{type:"number",nullable:!0},height:{type:"number",nullable:!0},width:{type:"number",nullable:!0},depth:{type:"number",nullable:!0},weight_unit:{allOf:[{$ref:"#/components/schemas/WeightUnit"}],description:"Null falls back to the store's weight unit.",nullable:!0},dimensions_unit:{allOf:[{$ref:"#/components/schemas/DimensionUnit"}],description:"Null falls back to the store's unit system.",nullable:!0},hs_code:{type:"string"},customs_description:{type:"string"},country_of_origin:{$ref:"#/components/schemas/CountryCode"},minimum_order_quantity:{type:"integer",nullable:!0},order_multiple:{type:"integer",nullable:!0},purchase_unit:{type:"string",enum:["unit","carton"],nullable:!0},units_per_carton:{type:"integer",description:"How many units fill one carton.",nullable:!0},carton_package_type_id:{type:"string",description:"The carton this variant is packed into: a package type of kind `carton`. Its dimensions are shared by every product packed the same way, so a corrected carton size fixes all of them at once.",nullable:!0},carton_weight:{type:"number",description:"What one packed carton weighs, in the variant's weight unit.",nullable:!0},cartons_per_pallet:{type:"integer",description:"How many cartons stack on one pallet.",nullable:!0},track_inventory:{type:"boolean"},preorderable:{type:"boolean",description:"Sell this variant before it's in stock. Adds the pre-order label and ships-by promise; the cap comes from `backorder_limit`, an incoming stock count, or backorder."},preorder_ships_at:{type:"string",format:"date-time",description:'The "ships by" date shown to customers while the variant is a pre-order. Once it passes, the variant is no longer a pre-order. Null clears it.',nullable:!0},backorder_limit:{type:"integer",description:"Maximum units sellable beyond available stock, capping backorders and pre-orders. Null is unlimited.",nullable:!0},position:{type:"integer"},options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing."},seller_id:{type:"string"},delivery_profile_id:{type:"string",nullable:!0},tax_category_id:{type:"string"},prices:{type:"array",items:{$ref:"#/components/schemas/PriceParams"},description:"Per-currency prices. Upserted by currency."},stock_levels:{type:"array",items:{$ref:"#/components/schemas/StockLevelParams"},description:"Stock per location. Upserted by location; omitted locations are removed."}}},VariantSalesContextParams:{type:"object",properties:{order_id:{type:"string",description:"A draft order to sell to: lists only what its buyer can be sold on its channel, priced in its market. Needs `read_orders`, and cannot be combined with the fields below."},market_id:{type:"string",description:"Prices in this market and lists only variants with a price in its currency."},channel_id:{type:"string",description:"Lists only variants published on this channel. When a market, customer, company or currency is given without it, the store default channel applies; an order uses its own."},customer_id:{type:"string",description:"Narrows to the customer's catalogs and prices as they would pay. Needs `read_customers`."},company_id:{type:"string",description:"Narrows to the company's catalogs and prices under its agreement. Needs `read_customers`."},currency:{allOf:[{$ref:"#/components/schemas/CurrencyCode"}],description:"Lists only variants with a price in this currency. With `market_id` it must be the market's currency."}}},VariantUpdateParams:{allOf:[{$ref:"#/components/schemas/VariantParams"},{type:"object",properties:{options:{type:"array",items:{$ref:"#/components/schemas/VariantOptionParams"},description:"One pair per option type the variant takes part in (size, color). Option types and values are created when missing. On update, omit to leave the option values untouched."},external_references:{type:"object",additionalProperties:!0,description:"Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too."}}}]},WebhookEndpointCreateParams:{type:"object",properties:{name:{type:"string",description:"A label shown in the dashboard list.",nullable:!0},url:{type:"string",description:"HTTPS destination URL. It cannot resolve to a private IP address outside development."},active:{type:"boolean",description:"Defaults to true on create. Prefer the disable and enable endpoints to pause one."},subscriptions:{type:"array",items:{type:"string"},description:'Event names this endpoint receives. An empty list or `["*"]` subscribes to every event; otherwise list exact names (`order.completed`) or patterns with `*` in place of a segment (`order.*`, `*.created`). At most 200 entries of up to 100 characters.'}},required:["url"]},WebhookEndpointDisableParams:{type:"object",properties:{reason:{type:"string",description:'Shown next to the disabled indicator. Defaults to "Manually disabled".'}}},WebhookEndpointUpdateParams:{type:"object",properties:{name:{type:"string",description:"A label shown in the dashboard list.",nullable:!0},url:{type:"string",description:"HTTPS destination URL. It cannot resolve to a private IP address outside development."},active:{type:"boolean",description:"Defaults to true on create. Prefer the disable and enable endpoints to pause one."},subscriptions:{type:"array",items:{type:"string"},description:'Event names this endpoint receives. An empty list or `["*"]` subscribes to every event; otherwise list exact names (`order.completed`) or patterns with `*` in place of a segment (`order.*`, `*.created`). At most 200 entries of up to 100 characters.'}}}}}};var Zy=new Set(["get","post","put","patch","delete"]);function Ga(){return zy}function fT(e){let t=e.description?.match(/\*\*Required scope:\*\* (.+?) \(for API-key authentication\)\./);return t?t[1].replaceAll("`",""):"\u2014"}function Yy(e,t={}){let r=[];for(let[n,i]of Object.entries(e.paths)){let a=n.replace("/api/v3/admin","")||"/";for(let[s,o]of Object.entries(i)){if(!Zy.has(s))continue;if(t.resource){let l=a.split("/")[1]??"";if(l!==t.resource&&!l.startsWith(t.resource))continue}let d=o.summary??"";t.search&&!`${s} ${a} ${d}`.toLowerCase().includes(t.search.toLowerCase())||r.push({method:s.toUpperCase(),path:a,scope:fT(o),summary:d})}}return r}function Jy(e,t){let r=t.trim().split(/\s+/),n=r.length>1?r[0].toLowerCase():void 0,i=r.length>1?r[1]:r[0],a=In(i),s=Vy(e,n,o=>o===a);return s.length>0?s:Vy(e,n,o=>gT(o,a))}function Vy(e,t,r){let n=[];for(let[i,a]of Object.entries(e.paths)){let s=i.replace("/api/v3/admin","")||"/";if(r(s))for(let[o,d]of Object.entries(a))Zy.has(o)&&(t&&o!==t||n.push({method:o.toUpperCase(),path:s,summary:d.summary,description:d.description,parameters:Or(d.parameters,e),requestBody:Or(d.requestBody,e),responses:Or(d.responses,e)}))}return n}function gT(e,t){if(e===t)return!0;let r=e.split("/"),n=t.split("/");return r.length!==n.length?!1:r.every((i,a)=>i.startsWith("{")&&i.endsWith("}")?n[a].length>0:i===n[a])}var bT=8;function Or(e,t,r=[]){if(Array.isArray(e))return e.map(s=>Or(s,t,r));if(!e||typeof e!="object")return e;let n=e,i=n.$ref;if(typeof i=="string"){let s=i.replace("#/components/schemas/","");return r.includes(s)||r.length>=bT||!(s in t.components.schemas)?{$ref:i}:Or(t.components.schemas[s],t,[...r,s])}let a={};for(let[s,o]of Object.entries(n))a[s]=Or(o,t,r);return a}function kT(e,t){return[...t,e]}function Qy(e){return e.option("--profile <name>","use a saved profile (see `spree auth`)").option("--base-url <url>","store URL (overrides profile/env/project)").option("--api-key <key>","secret API key (prefer SPREE_API_KEY \u2014 flags leak into shell history)").option("--store-id <id>","X-Spree-Store-Id for hosts serving multiple stores")}function e_(){return new Ae("--format <format>","output format").choices(["json","table"]).default("json")}function jd(e){return Qy(e).addOption(e_())}async function Od(e){let t=await xn({baseUrl:e.baseUrl,apiKey:e.apiKey,profile:e.profile});return{client:An({baseUrl:t.baseUrl,secretKey:t.apiKey,...e.storeId?{storeId:e.storeId}:{}}),credentials:t}}function t_(e){let t=e.command("api").description("Call the Admin API directly (generic get/post/patch/delete)");t.addHelpText("after",["","Examples:","  spree api get /products -q status_eq=active --limit 10",`  spree api post /products -d '{"name":"Classic Tee","prices":[{"currency":"USD","amount":"29.99"}]}'`,"  spree api get /orders/ord_x8k2J9aQ --expand items,payments","  spree api upload ./products.csv --private   # prints a signed_id to pass to another endpoint","","Discover the surface (offline, no server needed):","  spree api endpoints --search <term>   # find endpoints + required scopes",'  spree api schema "POST /orders"       # request/response schema for one operation',"  spree completion zsh                  # tab-completion for paths, filters, scopes"].join(`
 `)),jd(t.command("get <path>").description("GET an Admin API path, e.g. `spree api get /products -q status_eq=active`").option("-q, --query <expr>","Ransack predicate key=value (repeatable)",kT,[]).option("--sort <fields>","sort, e.g. -created_at").option("--page <n>","page number").option("--limit <n>","page size (max 100)").option("--expand <relations>","expand relations, e.g. variants,variants.prices").option("--fields <fields>","sparse fields, e.g. id,name")).action(async(r,n)=>{let i;try{let a=Wy(n),{client:s,credentials:o}=await Od(n);i=o.baseUrl;let d=await s.request("GET",In(r),{params:a});Ir(d,n.format)}catch(a){It(a,{baseUrl:i})}});for(let r of["post","patch","delete"])jd(t.command(`${r} <path>`).description(`${r.toUpperCase()} an Admin API path`).option("-d, --data <json>","request body: inline JSON, @file, or '-' for stdin")).action(async(n,i)=>{let a;try{let s=await Gy(i.data),{client:o,credentials:d}=await Od(i);a=d.baseUrl;let l=await o.request(r.toUpperCase(),In(n),{...s===$d?{}:{body:s}});Ir(l,i.format)}catch(s){It(s,{baseUrl:a})}});jd(t.command("upload <file>").description("Upload a file (10 MB by default) and print its signed_id, e.g. `spree api upload ./logo.png`").option("--private","store on private storage (documents, imports, digital products)").option("--content-type <type>","content type, when it cannot be read from the file")).action(async(r,n)=>{let i;try{let a=await qT(r),{client:s,credentials:o}=await Od(n);i=o.baseUrl;let d=await s.files.upload(a,{method:"multipart",filename:vT(r),contentType:n.contentType,visibility:n.private?"private":"public"});Ir(d,n.format)}catch(a){It(a,{baseUrl:i})}}),t.command("endpoints").description("List Admin API endpoints with their required scopes").option("--resource <name>","filter by first path segment, e.g. orders").option("--search <term>","filter by method, path, or summary").addOption(e_()).action(r=>{let n=Yy(Ga(),{resource:r.resource,search:r.search});if(n.length===0){process.stderr.write(`No endpoints match.
 `),process.exitCode=1;return}if(r.format==="table"){(0,Xy.printTable)(n.map(i=>({Method:i.method,Path:i.path,Scope:i.scope,Summary:i.summary})));return}Ir(n,"json")}),t.command("schema <operation>").description('Show the request/response schema for an operation, e.g. `spree api schema "POST /products"`').action(r=>{let n=Jy(Ga(),r);if(n.length===0){process.stderr.write(`No operation matches "${r}". Try \`spree api endpoints --search ${r.split(/\s+/).pop()}\`.
 `),process.exitCode=1;return}let i=/\s/.test(r.trim());Ir(i&&n.length===1?n[0]:n,"json")}),Qy(t.command("status").description("Show resolved credentials, server reachability, and the bundled spec version")).action(async r=>{try{let n=await xn({baseUrl:r.baseUrl,apiKey:r.apiKey,profile:r.profile},{allowMint:!1}),i=await jn(n.baseUrl,n.apiKey),a=Ga(),s=Fa(i),o=[`${Ze.default.bold("Base URL:")}     ${n.baseUrl}`,`${Ze.default.bold("Credentials:")}  ${n.source}${n.profileName?` (${n.profileName})`:""}, key ${n.tokenPrefix}${Ze.default.dim("\u2026")}`],d=i.status==="unreachable"||i.status==="unauthorized"?null:await Hy(n.baseUrl,n.apiKey);d!==null?o.push(`${Ze.default.bold("Scopes:")}       ${d.length?d.join(", "):Ze.default.dim("(none)")}`):n.scopes?.length&&o.push(`${Ze.default.bold("Scopes:")}       ${n.scopes.join(", ")} ${Ze.default.dim("(local snapshot from mint time \u2014 may be stale)")}`),o.push(`${Ze.default.bold("Server:")}       ${s}`),o.push(`${Ze.default.bold("Bundled spec:")} ${a.info?.version??"unknown"} ${Ze.default.dim("(spree api endpoints/schema reflect this snapshot, not the live server)")}`),process.stdout.write(`${o.join(`