generated-types.ts 208 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765
  1. /* eslint-disable */
  2. export type Maybe<T> = T;
  3. export type InputMaybe<T> = T;
  4. export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
  5. export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
  6. export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
  7. export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
  8. export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
  9. /** All built-in and custom scalars, mapped to their actual values */
  10. export type Scalars = {
  11. ID: { input: string | number; output: string | number; }
  12. String: { input: string; output: string; }
  13. Boolean: { input: boolean; output: boolean; }
  14. Int: { input: number; output: number; }
  15. Float: { input: number; output: number; }
  16. DateTime: { input: any; output: any; }
  17. JSON: { input: any; output: any; }
  18. Money: { input: number; output: number; }
  19. Upload: { input: any; output: any; }
  20. };
  21. export type AddFulfillmentToOrderResult = CreateFulfillmentError | EmptyOrderLineSelectionError | Fulfillment | FulfillmentStateTransitionError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | ItemsAlreadyFulfilledError;
  22. export type AddItemInput = {
  23. productVariantId: Scalars['ID']['input'];
  24. quantity: Scalars['Int']['input'];
  25. };
  26. export type AddItemToDraftOrderInput = {
  27. productVariantId: Scalars['ID']['input'];
  28. quantity: Scalars['Int']['input'];
  29. };
  30. export type AddManualPaymentToOrderResult = ManualPaymentStateError | Order;
  31. export type AddNoteToCustomerInput = {
  32. id: Scalars['ID']['input'];
  33. isPublic: Scalars['Boolean']['input'];
  34. note: Scalars['String']['input'];
  35. };
  36. export type AddNoteToOrderInput = {
  37. id: Scalars['ID']['input'];
  38. isPublic: Scalars['Boolean']['input'];
  39. note: Scalars['String']['input'];
  40. };
  41. export type Address = Node & {
  42. __typename?: 'Address';
  43. city?: Maybe<Scalars['String']['output']>;
  44. company?: Maybe<Scalars['String']['output']>;
  45. country: Country;
  46. createdAt: Scalars['DateTime']['output'];
  47. customFields?: Maybe<Scalars['JSON']['output']>;
  48. defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
  49. defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
  50. fullName?: Maybe<Scalars['String']['output']>;
  51. id: Scalars['ID']['output'];
  52. phoneNumber?: Maybe<Scalars['String']['output']>;
  53. postalCode?: Maybe<Scalars['String']['output']>;
  54. province?: Maybe<Scalars['String']['output']>;
  55. streetLine1: Scalars['String']['output'];
  56. streetLine2?: Maybe<Scalars['String']['output']>;
  57. updatedAt: Scalars['DateTime']['output'];
  58. };
  59. export type AdjustDraftOrderLineInput = {
  60. orderLineId: Scalars['ID']['input'];
  61. quantity: Scalars['Int']['input'];
  62. };
  63. export type Adjustment = {
  64. __typename?: 'Adjustment';
  65. adjustmentSource: Scalars['String']['output'];
  66. amount: Scalars['Money']['output'];
  67. data?: Maybe<Scalars['JSON']['output']>;
  68. description: Scalars['String']['output'];
  69. type: AdjustmentType;
  70. };
  71. export enum AdjustmentType {
  72. DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
  73. OTHER = 'OTHER',
  74. PROMOTION = 'PROMOTION'
  75. }
  76. export type Administrator = Node & {
  77. __typename?: 'Administrator';
  78. createdAt: Scalars['DateTime']['output'];
  79. customFields?: Maybe<Scalars['JSON']['output']>;
  80. emailAddress: Scalars['String']['output'];
  81. firstName: Scalars['String']['output'];
  82. id: Scalars['ID']['output'];
  83. lastName: Scalars['String']['output'];
  84. updatedAt: Scalars['DateTime']['output'];
  85. user: User;
  86. };
  87. export type AdministratorFilterParameter = {
  88. _and?: InputMaybe<Array<AdministratorFilterParameter>>;
  89. _or?: InputMaybe<Array<AdministratorFilterParameter>>;
  90. createdAt?: InputMaybe<DateOperators>;
  91. emailAddress?: InputMaybe<StringOperators>;
  92. firstName?: InputMaybe<StringOperators>;
  93. id?: InputMaybe<IdOperators>;
  94. lastName?: InputMaybe<StringOperators>;
  95. updatedAt?: InputMaybe<DateOperators>;
  96. };
  97. export type AdministratorList = PaginatedList & {
  98. __typename?: 'AdministratorList';
  99. items: Array<Administrator>;
  100. totalItems: Scalars['Int']['output'];
  101. };
  102. export type AdministratorListOptions = {
  103. /** Allows the results to be filtered */
  104. filter?: InputMaybe<AdministratorFilterParameter>;
  105. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  106. filterOperator?: InputMaybe<LogicalOperator>;
  107. /** Skips the first n results, for use in pagination */
  108. skip?: InputMaybe<Scalars['Int']['input']>;
  109. /** Specifies which properties to sort the results by */
  110. sort?: InputMaybe<AdministratorSortParameter>;
  111. /** Takes n results, for use in pagination */
  112. take?: InputMaybe<Scalars['Int']['input']>;
  113. };
  114. export type AdministratorPaymentInput = {
  115. metadata?: InputMaybe<Scalars['JSON']['input']>;
  116. paymentMethod?: InputMaybe<Scalars['String']['input']>;
  117. };
  118. export type AdministratorRefundInput = {
  119. /**
  120. * The amount to be refunded to this particular Payment. This was introduced in
  121. * v2.2.0 as the preferred way to specify the refund amount. The `lines`, `shipping` and `adjustment`
  122. * fields will be removed in a future version.
  123. */
  124. amount?: InputMaybe<Scalars['Money']['input']>;
  125. paymentId: Scalars['ID']['input'];
  126. reason?: InputMaybe<Scalars['String']['input']>;
  127. };
  128. export type AdministratorSortParameter = {
  129. createdAt?: InputMaybe<SortOrder>;
  130. emailAddress?: InputMaybe<SortOrder>;
  131. firstName?: InputMaybe<SortOrder>;
  132. id?: InputMaybe<SortOrder>;
  133. lastName?: InputMaybe<SortOrder>;
  134. updatedAt?: InputMaybe<SortOrder>;
  135. };
  136. export type Allocation = Node & StockMovement & {
  137. __typename?: 'Allocation';
  138. createdAt: Scalars['DateTime']['output'];
  139. customFields?: Maybe<Scalars['JSON']['output']>;
  140. id: Scalars['ID']['output'];
  141. orderLine: OrderLine;
  142. productVariant: ProductVariant;
  143. quantity: Scalars['Int']['output'];
  144. type: StockMovementType;
  145. updatedAt: Scalars['DateTime']['output'];
  146. };
  147. /** Returned if an attempting to refund an OrderItem which has already been refunded */
  148. export type AlreadyRefundedError = ErrorResult & {
  149. __typename?: 'AlreadyRefundedError';
  150. errorCode: ErrorCode;
  151. message: Scalars['String']['output'];
  152. refundId: Scalars['ID']['output'];
  153. };
  154. export type ApplyCouponCodeResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | Order;
  155. export type Asset = Node & {
  156. __typename?: 'Asset';
  157. createdAt: Scalars['DateTime']['output'];
  158. customFields?: Maybe<Scalars['JSON']['output']>;
  159. fileSize: Scalars['Int']['output'];
  160. focalPoint?: Maybe<Coordinate>;
  161. height: Scalars['Int']['output'];
  162. id: Scalars['ID']['output'];
  163. mimeType: Scalars['String']['output'];
  164. name: Scalars['String']['output'];
  165. preview: Scalars['String']['output'];
  166. source: Scalars['String']['output'];
  167. tags: Array<Tag>;
  168. type: AssetType;
  169. updatedAt: Scalars['DateTime']['output'];
  170. width: Scalars['Int']['output'];
  171. };
  172. export type AssetFilterParameter = {
  173. _and?: InputMaybe<Array<AssetFilterParameter>>;
  174. _or?: InputMaybe<Array<AssetFilterParameter>>;
  175. createdAt?: InputMaybe<DateOperators>;
  176. fileSize?: InputMaybe<NumberOperators>;
  177. height?: InputMaybe<NumberOperators>;
  178. id?: InputMaybe<IdOperators>;
  179. mimeType?: InputMaybe<StringOperators>;
  180. name?: InputMaybe<StringOperators>;
  181. preview?: InputMaybe<StringOperators>;
  182. source?: InputMaybe<StringOperators>;
  183. type?: InputMaybe<StringOperators>;
  184. updatedAt?: InputMaybe<DateOperators>;
  185. width?: InputMaybe<NumberOperators>;
  186. };
  187. export type AssetList = PaginatedList & {
  188. __typename?: 'AssetList';
  189. items: Array<Asset>;
  190. totalItems: Scalars['Int']['output'];
  191. };
  192. export type AssetListOptions = {
  193. /** Allows the results to be filtered */
  194. filter?: InputMaybe<AssetFilterParameter>;
  195. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  196. filterOperator?: InputMaybe<LogicalOperator>;
  197. /** Skips the first n results, for use in pagination */
  198. skip?: InputMaybe<Scalars['Int']['input']>;
  199. /** Specifies which properties to sort the results by */
  200. sort?: InputMaybe<AssetSortParameter>;
  201. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  202. tagsOperator?: InputMaybe<LogicalOperator>;
  203. /** Takes n results, for use in pagination */
  204. take?: InputMaybe<Scalars['Int']['input']>;
  205. };
  206. export type AssetSortParameter = {
  207. createdAt?: InputMaybe<SortOrder>;
  208. fileSize?: InputMaybe<SortOrder>;
  209. height?: InputMaybe<SortOrder>;
  210. id?: InputMaybe<SortOrder>;
  211. mimeType?: InputMaybe<SortOrder>;
  212. name?: InputMaybe<SortOrder>;
  213. preview?: InputMaybe<SortOrder>;
  214. source?: InputMaybe<SortOrder>;
  215. updatedAt?: InputMaybe<SortOrder>;
  216. width?: InputMaybe<SortOrder>;
  217. };
  218. export enum AssetType {
  219. BINARY = 'BINARY',
  220. IMAGE = 'IMAGE',
  221. VIDEO = 'VIDEO'
  222. }
  223. export type AssignAssetsToChannelInput = {
  224. assetIds: Array<Scalars['ID']['input']>;
  225. channelId: Scalars['ID']['input'];
  226. };
  227. export type AssignCollectionsToChannelInput = {
  228. channelId: Scalars['ID']['input'];
  229. collectionIds: Array<Scalars['ID']['input']>;
  230. };
  231. export type AssignFacetsToChannelInput = {
  232. channelId: Scalars['ID']['input'];
  233. facetIds: Array<Scalars['ID']['input']>;
  234. };
  235. export type AssignPaymentMethodsToChannelInput = {
  236. channelId: Scalars['ID']['input'];
  237. paymentMethodIds: Array<Scalars['ID']['input']>;
  238. };
  239. export type AssignProductVariantsToChannelInput = {
  240. channelId: Scalars['ID']['input'];
  241. priceFactor?: InputMaybe<Scalars['Float']['input']>;
  242. productVariantIds: Array<Scalars['ID']['input']>;
  243. };
  244. export type AssignProductsToChannelInput = {
  245. channelId: Scalars['ID']['input'];
  246. priceFactor?: InputMaybe<Scalars['Float']['input']>;
  247. productIds: Array<Scalars['ID']['input']>;
  248. };
  249. export type AssignPromotionsToChannelInput = {
  250. channelId: Scalars['ID']['input'];
  251. promotionIds: Array<Scalars['ID']['input']>;
  252. };
  253. export type AssignShippingMethodsToChannelInput = {
  254. channelId: Scalars['ID']['input'];
  255. shippingMethodIds: Array<Scalars['ID']['input']>;
  256. };
  257. export type AssignStockLocationsToChannelInput = {
  258. channelId: Scalars['ID']['input'];
  259. stockLocationIds: Array<Scalars['ID']['input']>;
  260. };
  261. export type AuthenticationInput = {
  262. native?: InputMaybe<NativeAuthInput>;
  263. };
  264. export type AuthenticationMethod = Node & {
  265. __typename?: 'AuthenticationMethod';
  266. createdAt: Scalars['DateTime']['output'];
  267. id: Scalars['ID']['output'];
  268. strategy: Scalars['String']['output'];
  269. updatedAt: Scalars['DateTime']['output'];
  270. };
  271. export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
  272. export type BooleanCustomFieldConfig = CustomField & {
  273. __typename?: 'BooleanCustomFieldConfig';
  274. description?: Maybe<Array<LocalizedString>>;
  275. internal?: Maybe<Scalars['Boolean']['output']>;
  276. label?: Maybe<Array<LocalizedString>>;
  277. list: Scalars['Boolean']['output'];
  278. name: Scalars['String']['output'];
  279. nullable?: Maybe<Scalars['Boolean']['output']>;
  280. readonly?: Maybe<Scalars['Boolean']['output']>;
  281. requiresPermission?: Maybe<Array<Permission>>;
  282. type: Scalars['String']['output'];
  283. ui?: Maybe<Scalars['JSON']['output']>;
  284. };
  285. /** Operators for filtering on a list of Boolean fields */
  286. export type BooleanListOperators = {
  287. inList: Scalars['Boolean']['input'];
  288. };
  289. /** Operators for filtering on a Boolean field */
  290. export type BooleanOperators = {
  291. eq?: InputMaybe<Scalars['Boolean']['input']>;
  292. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  293. };
  294. export type BooleanStructFieldConfig = StructField & {
  295. __typename?: 'BooleanStructFieldConfig';
  296. description?: Maybe<Array<LocalizedString>>;
  297. label?: Maybe<Array<LocalizedString>>;
  298. list: Scalars['Boolean']['output'];
  299. name: Scalars['String']['output'];
  300. type: Scalars['String']['output'];
  301. ui?: Maybe<Scalars['JSON']['output']>;
  302. };
  303. /** Returned if an attempting to cancel lines from an Order which is still active */
  304. export type CancelActiveOrderError = ErrorResult & {
  305. __typename?: 'CancelActiveOrderError';
  306. errorCode: ErrorCode;
  307. message: Scalars['String']['output'];
  308. orderState: Scalars['String']['output'];
  309. };
  310. export type CancelOrderInput = {
  311. /** Specify whether the shipping charges should also be cancelled. Defaults to false */
  312. cancelShipping?: InputMaybe<Scalars['Boolean']['input']>;
  313. /** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
  314. lines?: InputMaybe<Array<OrderLineInput>>;
  315. /** The id of the order to be cancelled */
  316. orderId: Scalars['ID']['input'];
  317. reason?: InputMaybe<Scalars['String']['input']>;
  318. };
  319. export type CancelOrderResult = CancelActiveOrderError | EmptyOrderLineSelectionError | MultipleOrderError | Order | OrderStateTransitionError | QuantityTooGreatError;
  320. /** Returned if the Payment cancellation fails */
  321. export type CancelPaymentError = ErrorResult & {
  322. __typename?: 'CancelPaymentError';
  323. errorCode: ErrorCode;
  324. message: Scalars['String']['output'];
  325. paymentErrorMessage: Scalars['String']['output'];
  326. };
  327. export type CancelPaymentResult = CancelPaymentError | Payment | PaymentStateTransitionError;
  328. export type Cancellation = Node & StockMovement & {
  329. __typename?: 'Cancellation';
  330. createdAt: Scalars['DateTime']['output'];
  331. customFields?: Maybe<Scalars['JSON']['output']>;
  332. id: Scalars['ID']['output'];
  333. orderLine: OrderLine;
  334. productVariant: ProductVariant;
  335. quantity: Scalars['Int']['output'];
  336. type: StockMovementType;
  337. updatedAt: Scalars['DateTime']['output'];
  338. };
  339. export type Channel = Node & {
  340. __typename?: 'Channel';
  341. availableCurrencyCodes: Array<CurrencyCode>;
  342. availableLanguageCodes?: Maybe<Array<LanguageCode>>;
  343. code: Scalars['String']['output'];
  344. createdAt: Scalars['DateTime']['output'];
  345. /** @deprecated Use defaultCurrencyCode instead */
  346. currencyCode: CurrencyCode;
  347. customFields?: Maybe<Scalars['JSON']['output']>;
  348. defaultCurrencyCode: CurrencyCode;
  349. defaultLanguageCode: LanguageCode;
  350. defaultShippingZone?: Maybe<Zone>;
  351. defaultTaxZone?: Maybe<Zone>;
  352. id: Scalars['ID']['output'];
  353. /** Not yet used - will be implemented in a future release. */
  354. outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
  355. pricesIncludeTax: Scalars['Boolean']['output'];
  356. seller?: Maybe<Seller>;
  357. token: Scalars['String']['output'];
  358. /** Not yet used - will be implemented in a future release. */
  359. trackInventory?: Maybe<Scalars['Boolean']['output']>;
  360. updatedAt: Scalars['DateTime']['output'];
  361. };
  362. /**
  363. * Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
  364. * of the GlobalSettings
  365. */
  366. export type ChannelDefaultLanguageError = ErrorResult & {
  367. __typename?: 'ChannelDefaultLanguageError';
  368. channelCode: Scalars['String']['output'];
  369. errorCode: ErrorCode;
  370. language: Scalars['String']['output'];
  371. message: Scalars['String']['output'];
  372. };
  373. export type ChannelFilterParameter = {
  374. _and?: InputMaybe<Array<ChannelFilterParameter>>;
  375. _or?: InputMaybe<Array<ChannelFilterParameter>>;
  376. code?: InputMaybe<StringOperators>;
  377. createdAt?: InputMaybe<DateOperators>;
  378. currencyCode?: InputMaybe<StringOperators>;
  379. defaultCurrencyCode?: InputMaybe<StringOperators>;
  380. defaultLanguageCode?: InputMaybe<StringOperators>;
  381. id?: InputMaybe<IdOperators>;
  382. outOfStockThreshold?: InputMaybe<NumberOperators>;
  383. pricesIncludeTax?: InputMaybe<BooleanOperators>;
  384. token?: InputMaybe<StringOperators>;
  385. trackInventory?: InputMaybe<BooleanOperators>;
  386. updatedAt?: InputMaybe<DateOperators>;
  387. };
  388. export type ChannelList = PaginatedList & {
  389. __typename?: 'ChannelList';
  390. items: Array<Channel>;
  391. totalItems: Scalars['Int']['output'];
  392. };
  393. export type ChannelListOptions = {
  394. /** Allows the results to be filtered */
  395. filter?: InputMaybe<ChannelFilterParameter>;
  396. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  397. filterOperator?: InputMaybe<LogicalOperator>;
  398. /** Skips the first n results, for use in pagination */
  399. skip?: InputMaybe<Scalars['Int']['input']>;
  400. /** Specifies which properties to sort the results by */
  401. sort?: InputMaybe<ChannelSortParameter>;
  402. /** Takes n results, for use in pagination */
  403. take?: InputMaybe<Scalars['Int']['input']>;
  404. };
  405. export type ChannelSortParameter = {
  406. code?: InputMaybe<SortOrder>;
  407. createdAt?: InputMaybe<SortOrder>;
  408. id?: InputMaybe<SortOrder>;
  409. outOfStockThreshold?: InputMaybe<SortOrder>;
  410. token?: InputMaybe<SortOrder>;
  411. updatedAt?: InputMaybe<SortOrder>;
  412. };
  413. export type Collection = Node & {
  414. __typename?: 'Collection';
  415. assets: Array<Asset>;
  416. breadcrumbs: Array<CollectionBreadcrumb>;
  417. children?: Maybe<Array<Collection>>;
  418. createdAt: Scalars['DateTime']['output'];
  419. customFields?: Maybe<Scalars['JSON']['output']>;
  420. description: Scalars['String']['output'];
  421. featuredAsset?: Maybe<Asset>;
  422. filters: Array<ConfigurableOperation>;
  423. id: Scalars['ID']['output'];
  424. inheritFilters: Scalars['Boolean']['output'];
  425. isPrivate: Scalars['Boolean']['output'];
  426. languageCode?: Maybe<LanguageCode>;
  427. name: Scalars['String']['output'];
  428. parent?: Maybe<Collection>;
  429. parentId: Scalars['ID']['output'];
  430. position: Scalars['Int']['output'];
  431. productVariants: ProductVariantList;
  432. slug: Scalars['String']['output'];
  433. translations: Array<CollectionTranslation>;
  434. updatedAt: Scalars['DateTime']['output'];
  435. };
  436. export type CollectionProductVariantsArgs = {
  437. options?: InputMaybe<ProductVariantListOptions>;
  438. };
  439. export type CollectionBreadcrumb = {
  440. __typename?: 'CollectionBreadcrumb';
  441. id: Scalars['ID']['output'];
  442. name: Scalars['String']['output'];
  443. slug: Scalars['String']['output'];
  444. };
  445. export type CollectionFilterParameter = {
  446. _and?: InputMaybe<Array<CollectionFilterParameter>>;
  447. _or?: InputMaybe<Array<CollectionFilterParameter>>;
  448. createdAt?: InputMaybe<DateOperators>;
  449. description?: InputMaybe<StringOperators>;
  450. id?: InputMaybe<IdOperators>;
  451. inheritFilters?: InputMaybe<BooleanOperators>;
  452. isPrivate?: InputMaybe<BooleanOperators>;
  453. languageCode?: InputMaybe<StringOperators>;
  454. name?: InputMaybe<StringOperators>;
  455. parentId?: InputMaybe<IdOperators>;
  456. position?: InputMaybe<NumberOperators>;
  457. slug?: InputMaybe<StringOperators>;
  458. updatedAt?: InputMaybe<DateOperators>;
  459. };
  460. export type CollectionList = PaginatedList & {
  461. __typename?: 'CollectionList';
  462. items: Array<Collection>;
  463. totalItems: Scalars['Int']['output'];
  464. };
  465. export type CollectionListOptions = {
  466. /** Allows the results to be filtered */
  467. filter?: InputMaybe<CollectionFilterParameter>;
  468. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  469. filterOperator?: InputMaybe<LogicalOperator>;
  470. /** Skips the first n results, for use in pagination */
  471. skip?: InputMaybe<Scalars['Int']['input']>;
  472. /** Specifies which properties to sort the results by */
  473. sort?: InputMaybe<CollectionSortParameter>;
  474. /** Takes n results, for use in pagination */
  475. take?: InputMaybe<Scalars['Int']['input']>;
  476. topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
  477. };
  478. /**
  479. * Which Collections are present in the products returned
  480. * by the search, and in what quantity.
  481. */
  482. export type CollectionResult = {
  483. __typename?: 'CollectionResult';
  484. collection: Collection;
  485. count: Scalars['Int']['output'];
  486. };
  487. export type CollectionSortParameter = {
  488. createdAt?: InputMaybe<SortOrder>;
  489. description?: InputMaybe<SortOrder>;
  490. id?: InputMaybe<SortOrder>;
  491. name?: InputMaybe<SortOrder>;
  492. parentId?: InputMaybe<SortOrder>;
  493. position?: InputMaybe<SortOrder>;
  494. slug?: InputMaybe<SortOrder>;
  495. updatedAt?: InputMaybe<SortOrder>;
  496. };
  497. export type CollectionTranslation = {
  498. __typename?: 'CollectionTranslation';
  499. createdAt: Scalars['DateTime']['output'];
  500. description: Scalars['String']['output'];
  501. id: Scalars['ID']['output'];
  502. languageCode: LanguageCode;
  503. name: Scalars['String']['output'];
  504. slug: Scalars['String']['output'];
  505. updatedAt: Scalars['DateTime']['output'];
  506. };
  507. export type ConfigArg = {
  508. __typename?: 'ConfigArg';
  509. name: Scalars['String']['output'];
  510. value: Scalars['String']['output'];
  511. };
  512. export type ConfigArgDefinition = {
  513. __typename?: 'ConfigArgDefinition';
  514. defaultValue?: Maybe<Scalars['JSON']['output']>;
  515. description?: Maybe<Scalars['String']['output']>;
  516. label?: Maybe<Scalars['String']['output']>;
  517. list: Scalars['Boolean']['output'];
  518. name: Scalars['String']['output'];
  519. required: Scalars['Boolean']['output'];
  520. type: Scalars['String']['output'];
  521. ui?: Maybe<Scalars['JSON']['output']>;
  522. };
  523. export type ConfigArgInput = {
  524. name: Scalars['String']['input'];
  525. /** A JSON stringified representation of the actual value */
  526. value: Scalars['String']['input'];
  527. };
  528. export type ConfigurableOperation = {
  529. __typename?: 'ConfigurableOperation';
  530. args: Array<ConfigArg>;
  531. code: Scalars['String']['output'];
  532. };
  533. export type ConfigurableOperationDefinition = {
  534. __typename?: 'ConfigurableOperationDefinition';
  535. args: Array<ConfigArgDefinition>;
  536. code: Scalars['String']['output'];
  537. description: Scalars['String']['output'];
  538. };
  539. export type ConfigurableOperationInput = {
  540. arguments: Array<ConfigArgInput>;
  541. code: Scalars['String']['input'];
  542. };
  543. export type Coordinate = {
  544. __typename?: 'Coordinate';
  545. x: Scalars['Float']['output'];
  546. y: Scalars['Float']['output'];
  547. };
  548. export type CoordinateInput = {
  549. x: Scalars['Float']['input'];
  550. y: Scalars['Float']['input'];
  551. };
  552. /**
  553. * A Country of the world which your shop operates in.
  554. *
  555. * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
  556. * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
  557. */
  558. export type Country = Node & Region & {
  559. __typename?: 'Country';
  560. code: Scalars['String']['output'];
  561. createdAt: Scalars['DateTime']['output'];
  562. customFields?: Maybe<Scalars['JSON']['output']>;
  563. enabled: Scalars['Boolean']['output'];
  564. id: Scalars['ID']['output'];
  565. languageCode: LanguageCode;
  566. name: Scalars['String']['output'];
  567. parent?: Maybe<Region>;
  568. parentId?: Maybe<Scalars['ID']['output']>;
  569. translations: Array<RegionTranslation>;
  570. type: Scalars['String']['output'];
  571. updatedAt: Scalars['DateTime']['output'];
  572. };
  573. export type CountryFilterParameter = {
  574. _and?: InputMaybe<Array<CountryFilterParameter>>;
  575. _or?: InputMaybe<Array<CountryFilterParameter>>;
  576. code?: InputMaybe<StringOperators>;
  577. createdAt?: InputMaybe<DateOperators>;
  578. enabled?: InputMaybe<BooleanOperators>;
  579. id?: InputMaybe<IdOperators>;
  580. languageCode?: InputMaybe<StringOperators>;
  581. name?: InputMaybe<StringOperators>;
  582. parentId?: InputMaybe<IdOperators>;
  583. type?: InputMaybe<StringOperators>;
  584. updatedAt?: InputMaybe<DateOperators>;
  585. };
  586. export type CountryList = PaginatedList & {
  587. __typename?: 'CountryList';
  588. items: Array<Country>;
  589. totalItems: Scalars['Int']['output'];
  590. };
  591. export type CountryListOptions = {
  592. /** Allows the results to be filtered */
  593. filter?: InputMaybe<CountryFilterParameter>;
  594. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  595. filterOperator?: InputMaybe<LogicalOperator>;
  596. /** Skips the first n results, for use in pagination */
  597. skip?: InputMaybe<Scalars['Int']['input']>;
  598. /** Specifies which properties to sort the results by */
  599. sort?: InputMaybe<CountrySortParameter>;
  600. /** Takes n results, for use in pagination */
  601. take?: InputMaybe<Scalars['Int']['input']>;
  602. };
  603. export type CountrySortParameter = {
  604. code?: InputMaybe<SortOrder>;
  605. createdAt?: InputMaybe<SortOrder>;
  606. id?: InputMaybe<SortOrder>;
  607. name?: InputMaybe<SortOrder>;
  608. parentId?: InputMaybe<SortOrder>;
  609. type?: InputMaybe<SortOrder>;
  610. updatedAt?: InputMaybe<SortOrder>;
  611. };
  612. export type CountryTranslationInput = {
  613. customFields?: InputMaybe<Scalars['JSON']['input']>;
  614. id?: InputMaybe<Scalars['ID']['input']>;
  615. languageCode: LanguageCode;
  616. name?: InputMaybe<Scalars['String']['input']>;
  617. };
  618. /** Returned if the provided coupon code is invalid */
  619. export type CouponCodeExpiredError = ErrorResult & {
  620. __typename?: 'CouponCodeExpiredError';
  621. couponCode: Scalars['String']['output'];
  622. errorCode: ErrorCode;
  623. message: Scalars['String']['output'];
  624. };
  625. /** Returned if the provided coupon code is invalid */
  626. export type CouponCodeInvalidError = ErrorResult & {
  627. __typename?: 'CouponCodeInvalidError';
  628. couponCode: Scalars['String']['output'];
  629. errorCode: ErrorCode;
  630. message: Scalars['String']['output'];
  631. };
  632. /** Returned if the provided coupon code is invalid */
  633. export type CouponCodeLimitError = ErrorResult & {
  634. __typename?: 'CouponCodeLimitError';
  635. couponCode: Scalars['String']['output'];
  636. errorCode: ErrorCode;
  637. limit: Scalars['Int']['output'];
  638. message: Scalars['String']['output'];
  639. };
  640. /**
  641. * Input used to create an Address.
  642. *
  643. * The countryCode must correspond to a `code` property of a Country that has been defined in the
  644. * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
  645. * If an invalid code is passed, the mutation will fail.
  646. */
  647. export type CreateAddressInput = {
  648. city?: InputMaybe<Scalars['String']['input']>;
  649. company?: InputMaybe<Scalars['String']['input']>;
  650. countryCode: Scalars['String']['input'];
  651. customFields?: InputMaybe<Scalars['JSON']['input']>;
  652. defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  653. defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  654. fullName?: InputMaybe<Scalars['String']['input']>;
  655. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  656. postalCode?: InputMaybe<Scalars['String']['input']>;
  657. province?: InputMaybe<Scalars['String']['input']>;
  658. streetLine1: Scalars['String']['input'];
  659. streetLine2?: InputMaybe<Scalars['String']['input']>;
  660. };
  661. export type CreateAdministratorInput = {
  662. customFields?: InputMaybe<Scalars['JSON']['input']>;
  663. emailAddress: Scalars['String']['input'];
  664. firstName: Scalars['String']['input'];
  665. lastName: Scalars['String']['input'];
  666. password: Scalars['String']['input'];
  667. roleIds: Array<Scalars['ID']['input']>;
  668. };
  669. export type CreateAssetInput = {
  670. customFields?: InputMaybe<Scalars['JSON']['input']>;
  671. file: Scalars['Upload']['input'];
  672. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  673. };
  674. export type CreateAssetResult = Asset | MimeTypeError;
  675. export type CreateChannelInput = {
  676. availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
  677. availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
  678. code: Scalars['String']['input'];
  679. /** @deprecated Use defaultCurrencyCode instead */
  680. currencyCode?: InputMaybe<CurrencyCode>;
  681. customFields?: InputMaybe<Scalars['JSON']['input']>;
  682. defaultCurrencyCode?: InputMaybe<CurrencyCode>;
  683. defaultLanguageCode: LanguageCode;
  684. defaultShippingZoneId: Scalars['ID']['input'];
  685. defaultTaxZoneId: Scalars['ID']['input'];
  686. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  687. pricesIncludeTax: Scalars['Boolean']['input'];
  688. sellerId?: InputMaybe<Scalars['ID']['input']>;
  689. token: Scalars['String']['input'];
  690. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  691. };
  692. export type CreateChannelResult = Channel | LanguageNotAvailableError;
  693. export type CreateCollectionInput = {
  694. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  695. customFields?: InputMaybe<Scalars['JSON']['input']>;
  696. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  697. filters: Array<ConfigurableOperationInput>;
  698. inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
  699. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  700. parentId?: InputMaybe<Scalars['ID']['input']>;
  701. translations: Array<CreateCollectionTranslationInput>;
  702. };
  703. export type CreateCollectionTranslationInput = {
  704. customFields?: InputMaybe<Scalars['JSON']['input']>;
  705. description: Scalars['String']['input'];
  706. languageCode: LanguageCode;
  707. name: Scalars['String']['input'];
  708. slug: Scalars['String']['input'];
  709. };
  710. export type CreateCountryInput = {
  711. code: Scalars['String']['input'];
  712. customFields?: InputMaybe<Scalars['JSON']['input']>;
  713. enabled: Scalars['Boolean']['input'];
  714. translations: Array<CountryTranslationInput>;
  715. };
  716. export type CreateCustomerGroupInput = {
  717. customFields?: InputMaybe<Scalars['JSON']['input']>;
  718. customerIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  719. name: Scalars['String']['input'];
  720. };
  721. export type CreateCustomerInput = {
  722. customFields?: InputMaybe<Scalars['JSON']['input']>;
  723. emailAddress: Scalars['String']['input'];
  724. firstName: Scalars['String']['input'];
  725. lastName: Scalars['String']['input'];
  726. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  727. title?: InputMaybe<Scalars['String']['input']>;
  728. };
  729. export type CreateCustomerResult = Customer | EmailAddressConflictError;
  730. export type CreateFacetInput = {
  731. code: Scalars['String']['input'];
  732. customFields?: InputMaybe<Scalars['JSON']['input']>;
  733. isPrivate: Scalars['Boolean']['input'];
  734. translations: Array<FacetTranslationInput>;
  735. values?: InputMaybe<Array<CreateFacetValueWithFacetInput>>;
  736. };
  737. export type CreateFacetValueInput = {
  738. code: Scalars['String']['input'];
  739. customFields?: InputMaybe<Scalars['JSON']['input']>;
  740. facetId: Scalars['ID']['input'];
  741. translations: Array<FacetValueTranslationInput>;
  742. };
  743. export type CreateFacetValueWithFacetInput = {
  744. code: Scalars['String']['input'];
  745. translations: Array<FacetValueTranslationInput>;
  746. };
  747. /** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
  748. export type CreateFulfillmentError = ErrorResult & {
  749. __typename?: 'CreateFulfillmentError';
  750. errorCode: ErrorCode;
  751. fulfillmentHandlerError: Scalars['String']['output'];
  752. message: Scalars['String']['output'];
  753. };
  754. export type CreateGroupOptionInput = {
  755. code: Scalars['String']['input'];
  756. translations: Array<ProductOptionGroupTranslationInput>;
  757. };
  758. export type CreatePaymentMethodInput = {
  759. checker?: InputMaybe<ConfigurableOperationInput>;
  760. code: Scalars['String']['input'];
  761. customFields?: InputMaybe<Scalars['JSON']['input']>;
  762. enabled: Scalars['Boolean']['input'];
  763. handler: ConfigurableOperationInput;
  764. translations: Array<PaymentMethodTranslationInput>;
  765. };
  766. export type CreateProductInput = {
  767. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  768. customFields?: InputMaybe<Scalars['JSON']['input']>;
  769. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  770. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  771. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  772. translations: Array<ProductTranslationInput>;
  773. };
  774. export type CreateProductOptionGroupInput = {
  775. code: Scalars['String']['input'];
  776. customFields?: InputMaybe<Scalars['JSON']['input']>;
  777. options: Array<CreateGroupOptionInput>;
  778. translations: Array<ProductOptionGroupTranslationInput>;
  779. };
  780. export type CreateProductOptionInput = {
  781. code: Scalars['String']['input'];
  782. customFields?: InputMaybe<Scalars['JSON']['input']>;
  783. productOptionGroupId: Scalars['ID']['input'];
  784. translations: Array<ProductOptionGroupTranslationInput>;
  785. };
  786. export type CreateProductVariantInput = {
  787. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  788. customFields?: InputMaybe<Scalars['JSON']['input']>;
  789. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  790. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  791. optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  792. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  793. price?: InputMaybe<Scalars['Money']['input']>;
  794. prices?: InputMaybe<Array<InputMaybe<CreateProductVariantPriceInput>>>;
  795. productId: Scalars['ID']['input'];
  796. sku: Scalars['String']['input'];
  797. stockLevels?: InputMaybe<Array<StockLevelInput>>;
  798. stockOnHand?: InputMaybe<Scalars['Int']['input']>;
  799. taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
  800. trackInventory?: InputMaybe<GlobalFlag>;
  801. translations: Array<ProductVariantTranslationInput>;
  802. useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
  803. };
  804. export type CreateProductVariantOptionInput = {
  805. code: Scalars['String']['input'];
  806. optionGroupId: Scalars['ID']['input'];
  807. translations: Array<ProductOptionTranslationInput>;
  808. };
  809. export type CreateProductVariantPriceInput = {
  810. currencyCode: CurrencyCode;
  811. customFields?: InputMaybe<Scalars['JSON']['input']>;
  812. price: Scalars['Money']['input'];
  813. };
  814. export type CreatePromotionInput = {
  815. actions: Array<ConfigurableOperationInput>;
  816. conditions: Array<ConfigurableOperationInput>;
  817. couponCode?: InputMaybe<Scalars['String']['input']>;
  818. customFields?: InputMaybe<Scalars['JSON']['input']>;
  819. enabled: Scalars['Boolean']['input'];
  820. endsAt?: InputMaybe<Scalars['DateTime']['input']>;
  821. perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
  822. startsAt?: InputMaybe<Scalars['DateTime']['input']>;
  823. translations: Array<PromotionTranslationInput>;
  824. usageLimit?: InputMaybe<Scalars['Int']['input']>;
  825. };
  826. export type CreatePromotionResult = MissingConditionsError | Promotion;
  827. export type CreateProvinceInput = {
  828. code: Scalars['String']['input'];
  829. customFields?: InputMaybe<Scalars['JSON']['input']>;
  830. enabled: Scalars['Boolean']['input'];
  831. translations: Array<ProvinceTranslationInput>;
  832. };
  833. export type CreateRoleInput = {
  834. channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  835. code: Scalars['String']['input'];
  836. description: Scalars['String']['input'];
  837. permissions: Array<Permission>;
  838. };
  839. export type CreateSellerInput = {
  840. customFields?: InputMaybe<Scalars['JSON']['input']>;
  841. name: Scalars['String']['input'];
  842. };
  843. export type CreateShippingMethodInput = {
  844. calculator: ConfigurableOperationInput;
  845. checker: ConfigurableOperationInput;
  846. code: Scalars['String']['input'];
  847. customFields?: InputMaybe<Scalars['JSON']['input']>;
  848. fulfillmentHandler: Scalars['String']['input'];
  849. translations: Array<ShippingMethodTranslationInput>;
  850. };
  851. export type CreateStockLocationInput = {
  852. customFields?: InputMaybe<Scalars['JSON']['input']>;
  853. description?: InputMaybe<Scalars['String']['input']>;
  854. name: Scalars['String']['input'];
  855. };
  856. export type CreateTagInput = {
  857. value: Scalars['String']['input'];
  858. };
  859. export type CreateTaxCategoryInput = {
  860. customFields?: InputMaybe<Scalars['JSON']['input']>;
  861. isDefault?: InputMaybe<Scalars['Boolean']['input']>;
  862. name: Scalars['String']['input'];
  863. };
  864. export type CreateTaxRateInput = {
  865. categoryId: Scalars['ID']['input'];
  866. customFields?: InputMaybe<Scalars['JSON']['input']>;
  867. customerGroupId?: InputMaybe<Scalars['ID']['input']>;
  868. enabled: Scalars['Boolean']['input'];
  869. name: Scalars['String']['input'];
  870. value: Scalars['Float']['input'];
  871. zoneId: Scalars['ID']['input'];
  872. };
  873. export type CreateZoneInput = {
  874. customFields?: InputMaybe<Scalars['JSON']['input']>;
  875. memberIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  876. name: Scalars['String']['input'];
  877. };
  878. /**
  879. * @description
  880. * ISO 4217 currency code
  881. *
  882. * @docsCategory common
  883. */
  884. export enum CurrencyCode {
  885. /** United Arab Emirates dirham */
  886. AED = 'AED',
  887. /** Afghan afghani */
  888. AFN = 'AFN',
  889. /** Albanian lek */
  890. ALL = 'ALL',
  891. /** Armenian dram */
  892. AMD = 'AMD',
  893. /** Netherlands Antillean guilder */
  894. ANG = 'ANG',
  895. /** Angolan kwanza */
  896. AOA = 'AOA',
  897. /** Argentine peso */
  898. ARS = 'ARS',
  899. /** Australian dollar */
  900. AUD = 'AUD',
  901. /** Aruban florin */
  902. AWG = 'AWG',
  903. /** Azerbaijani manat */
  904. AZN = 'AZN',
  905. /** Bosnia and Herzegovina convertible mark */
  906. BAM = 'BAM',
  907. /** Barbados dollar */
  908. BBD = 'BBD',
  909. /** Bangladeshi taka */
  910. BDT = 'BDT',
  911. /** Bulgarian lev */
  912. BGN = 'BGN',
  913. /** Bahraini dinar */
  914. BHD = 'BHD',
  915. /** Burundian franc */
  916. BIF = 'BIF',
  917. /** Bermudian dollar */
  918. BMD = 'BMD',
  919. /** Brunei dollar */
  920. BND = 'BND',
  921. /** Boliviano */
  922. BOB = 'BOB',
  923. /** Brazilian real */
  924. BRL = 'BRL',
  925. /** Bahamian dollar */
  926. BSD = 'BSD',
  927. /** Bhutanese ngultrum */
  928. BTN = 'BTN',
  929. /** Botswana pula */
  930. BWP = 'BWP',
  931. /** Belarusian ruble */
  932. BYN = 'BYN',
  933. /** Belize dollar */
  934. BZD = 'BZD',
  935. /** Canadian dollar */
  936. CAD = 'CAD',
  937. /** Congolese franc */
  938. CDF = 'CDF',
  939. /** Swiss franc */
  940. CHF = 'CHF',
  941. /** Chilean peso */
  942. CLP = 'CLP',
  943. /** Renminbi (Chinese) yuan */
  944. CNY = 'CNY',
  945. /** Colombian peso */
  946. COP = 'COP',
  947. /** Costa Rican colon */
  948. CRC = 'CRC',
  949. /** Cuban convertible peso */
  950. CUC = 'CUC',
  951. /** Cuban peso */
  952. CUP = 'CUP',
  953. /** Cape Verde escudo */
  954. CVE = 'CVE',
  955. /** Czech koruna */
  956. CZK = 'CZK',
  957. /** Djiboutian franc */
  958. DJF = 'DJF',
  959. /** Danish krone */
  960. DKK = 'DKK',
  961. /** Dominican peso */
  962. DOP = 'DOP',
  963. /** Algerian dinar */
  964. DZD = 'DZD',
  965. /** Egyptian pound */
  966. EGP = 'EGP',
  967. /** Eritrean nakfa */
  968. ERN = 'ERN',
  969. /** Ethiopian birr */
  970. ETB = 'ETB',
  971. /** Euro */
  972. EUR = 'EUR',
  973. /** Fiji dollar */
  974. FJD = 'FJD',
  975. /** Falkland Islands pound */
  976. FKP = 'FKP',
  977. /** Pound sterling */
  978. GBP = 'GBP',
  979. /** Georgian lari */
  980. GEL = 'GEL',
  981. /** Ghanaian cedi */
  982. GHS = 'GHS',
  983. /** Gibraltar pound */
  984. GIP = 'GIP',
  985. /** Gambian dalasi */
  986. GMD = 'GMD',
  987. /** Guinean franc */
  988. GNF = 'GNF',
  989. /** Guatemalan quetzal */
  990. GTQ = 'GTQ',
  991. /** Guyanese dollar */
  992. GYD = 'GYD',
  993. /** Hong Kong dollar */
  994. HKD = 'HKD',
  995. /** Honduran lempira */
  996. HNL = 'HNL',
  997. /** Croatian kuna */
  998. HRK = 'HRK',
  999. /** Haitian gourde */
  1000. HTG = 'HTG',
  1001. /** Hungarian forint */
  1002. HUF = 'HUF',
  1003. /** Indonesian rupiah */
  1004. IDR = 'IDR',
  1005. /** Israeli new shekel */
  1006. ILS = 'ILS',
  1007. /** Indian rupee */
  1008. INR = 'INR',
  1009. /** Iraqi dinar */
  1010. IQD = 'IQD',
  1011. /** Iranian rial */
  1012. IRR = 'IRR',
  1013. /** Icelandic króna */
  1014. ISK = 'ISK',
  1015. /** Jamaican dollar */
  1016. JMD = 'JMD',
  1017. /** Jordanian dinar */
  1018. JOD = 'JOD',
  1019. /** Japanese yen */
  1020. JPY = 'JPY',
  1021. /** Kenyan shilling */
  1022. KES = 'KES',
  1023. /** Kyrgyzstani som */
  1024. KGS = 'KGS',
  1025. /** Cambodian riel */
  1026. KHR = 'KHR',
  1027. /** Comoro franc */
  1028. KMF = 'KMF',
  1029. /** North Korean won */
  1030. KPW = 'KPW',
  1031. /** South Korean won */
  1032. KRW = 'KRW',
  1033. /** Kuwaiti dinar */
  1034. KWD = 'KWD',
  1035. /** Cayman Islands dollar */
  1036. KYD = 'KYD',
  1037. /** Kazakhstani tenge */
  1038. KZT = 'KZT',
  1039. /** Lao kip */
  1040. LAK = 'LAK',
  1041. /** Lebanese pound */
  1042. LBP = 'LBP',
  1043. /** Sri Lankan rupee */
  1044. LKR = 'LKR',
  1045. /** Liberian dollar */
  1046. LRD = 'LRD',
  1047. /** Lesotho loti */
  1048. LSL = 'LSL',
  1049. /** Libyan dinar */
  1050. LYD = 'LYD',
  1051. /** Moroccan dirham */
  1052. MAD = 'MAD',
  1053. /** Moldovan leu */
  1054. MDL = 'MDL',
  1055. /** Malagasy ariary */
  1056. MGA = 'MGA',
  1057. /** Macedonian denar */
  1058. MKD = 'MKD',
  1059. /** Myanmar kyat */
  1060. MMK = 'MMK',
  1061. /** Mongolian tögrög */
  1062. MNT = 'MNT',
  1063. /** Macanese pataca */
  1064. MOP = 'MOP',
  1065. /** Mauritanian ouguiya */
  1066. MRU = 'MRU',
  1067. /** Mauritian rupee */
  1068. MUR = 'MUR',
  1069. /** Maldivian rufiyaa */
  1070. MVR = 'MVR',
  1071. /** Malawian kwacha */
  1072. MWK = 'MWK',
  1073. /** Mexican peso */
  1074. MXN = 'MXN',
  1075. /** Malaysian ringgit */
  1076. MYR = 'MYR',
  1077. /** Mozambican metical */
  1078. MZN = 'MZN',
  1079. /** Namibian dollar */
  1080. NAD = 'NAD',
  1081. /** Nigerian naira */
  1082. NGN = 'NGN',
  1083. /** Nicaraguan córdoba */
  1084. NIO = 'NIO',
  1085. /** Norwegian krone */
  1086. NOK = 'NOK',
  1087. /** Nepalese rupee */
  1088. NPR = 'NPR',
  1089. /** New Zealand dollar */
  1090. NZD = 'NZD',
  1091. /** Omani rial */
  1092. OMR = 'OMR',
  1093. /** Panamanian balboa */
  1094. PAB = 'PAB',
  1095. /** Peruvian sol */
  1096. PEN = 'PEN',
  1097. /** Papua New Guinean kina */
  1098. PGK = 'PGK',
  1099. /** Philippine peso */
  1100. PHP = 'PHP',
  1101. /** Pakistani rupee */
  1102. PKR = 'PKR',
  1103. /** Polish złoty */
  1104. PLN = 'PLN',
  1105. /** Paraguayan guaraní */
  1106. PYG = 'PYG',
  1107. /** Qatari riyal */
  1108. QAR = 'QAR',
  1109. /** Romanian leu */
  1110. RON = 'RON',
  1111. /** Serbian dinar */
  1112. RSD = 'RSD',
  1113. /** Russian ruble */
  1114. RUB = 'RUB',
  1115. /** Rwandan franc */
  1116. RWF = 'RWF',
  1117. /** Saudi riyal */
  1118. SAR = 'SAR',
  1119. /** Solomon Islands dollar */
  1120. SBD = 'SBD',
  1121. /** Seychelles rupee */
  1122. SCR = 'SCR',
  1123. /** Sudanese pound */
  1124. SDG = 'SDG',
  1125. /** Swedish krona/kronor */
  1126. SEK = 'SEK',
  1127. /** Singapore dollar */
  1128. SGD = 'SGD',
  1129. /** Saint Helena pound */
  1130. SHP = 'SHP',
  1131. /** Sierra Leonean leone */
  1132. SLL = 'SLL',
  1133. /** Somali shilling */
  1134. SOS = 'SOS',
  1135. /** Surinamese dollar */
  1136. SRD = 'SRD',
  1137. /** South Sudanese pound */
  1138. SSP = 'SSP',
  1139. /** São Tomé and Príncipe dobra */
  1140. STN = 'STN',
  1141. /** Salvadoran colón */
  1142. SVC = 'SVC',
  1143. /** Syrian pound */
  1144. SYP = 'SYP',
  1145. /** Swazi lilangeni */
  1146. SZL = 'SZL',
  1147. /** Thai baht */
  1148. THB = 'THB',
  1149. /** Tajikistani somoni */
  1150. TJS = 'TJS',
  1151. /** Turkmenistan manat */
  1152. TMT = 'TMT',
  1153. /** Tunisian dinar */
  1154. TND = 'TND',
  1155. /** Tongan paʻanga */
  1156. TOP = 'TOP',
  1157. /** Turkish lira */
  1158. TRY = 'TRY',
  1159. /** Trinidad and Tobago dollar */
  1160. TTD = 'TTD',
  1161. /** New Taiwan dollar */
  1162. TWD = 'TWD',
  1163. /** Tanzanian shilling */
  1164. TZS = 'TZS',
  1165. /** Ukrainian hryvnia */
  1166. UAH = 'UAH',
  1167. /** Ugandan shilling */
  1168. UGX = 'UGX',
  1169. /** United States dollar */
  1170. USD = 'USD',
  1171. /** Uruguayan peso */
  1172. UYU = 'UYU',
  1173. /** Uzbekistan som */
  1174. UZS = 'UZS',
  1175. /** Venezuelan bolívar soberano */
  1176. VES = 'VES',
  1177. /** Vietnamese đồng */
  1178. VND = 'VND',
  1179. /** Vanuatu vatu */
  1180. VUV = 'VUV',
  1181. /** Samoan tala */
  1182. WST = 'WST',
  1183. /** CFA franc BEAC */
  1184. XAF = 'XAF',
  1185. /** East Caribbean dollar */
  1186. XCD = 'XCD',
  1187. /** CFA franc BCEAO */
  1188. XOF = 'XOF',
  1189. /** CFP franc (franc Pacifique) */
  1190. XPF = 'XPF',
  1191. /** Yemeni rial */
  1192. YER = 'YER',
  1193. /** South African rand */
  1194. ZAR = 'ZAR',
  1195. /** Zambian kwacha */
  1196. ZMW = 'ZMW',
  1197. /** Zimbabwean dollar */
  1198. ZWL = 'ZWL'
  1199. }
  1200. export type CurrentUser = {
  1201. __typename?: 'CurrentUser';
  1202. channels: Array<CurrentUserChannel>;
  1203. id: Scalars['ID']['output'];
  1204. identifier: Scalars['String']['output'];
  1205. };
  1206. export type CurrentUserChannel = {
  1207. __typename?: 'CurrentUserChannel';
  1208. code: Scalars['String']['output'];
  1209. id: Scalars['ID']['output'];
  1210. permissions: Array<Permission>;
  1211. token: Scalars['String']['output'];
  1212. };
  1213. export type CustomField = {
  1214. description?: Maybe<Array<LocalizedString>>;
  1215. internal?: Maybe<Scalars['Boolean']['output']>;
  1216. label?: Maybe<Array<LocalizedString>>;
  1217. list: Scalars['Boolean']['output'];
  1218. name: Scalars['String']['output'];
  1219. nullable?: Maybe<Scalars['Boolean']['output']>;
  1220. readonly?: Maybe<Scalars['Boolean']['output']>;
  1221. requiresPermission?: Maybe<Array<Permission>>;
  1222. type: Scalars['String']['output'];
  1223. ui?: Maybe<Scalars['JSON']['output']>;
  1224. };
  1225. export type CustomFieldConfig = BooleanCustomFieldConfig | DateTimeCustomFieldConfig | FloatCustomFieldConfig | IntCustomFieldConfig | LocaleStringCustomFieldConfig | LocaleTextCustomFieldConfig | RelationCustomFieldConfig | StringCustomFieldConfig | StructCustomFieldConfig | TextCustomFieldConfig;
  1226. /**
  1227. * This type is deprecated in v2.2 in favor of the EntityCustomFields type,
  1228. * which allows custom fields to be defined on user-supplied entities.
  1229. */
  1230. export type CustomFields = {
  1231. __typename?: 'CustomFields';
  1232. Address: Array<CustomFieldConfig>;
  1233. Administrator: Array<CustomFieldConfig>;
  1234. Asset: Array<CustomFieldConfig>;
  1235. Channel: Array<CustomFieldConfig>;
  1236. Collection: Array<CustomFieldConfig>;
  1237. Customer: Array<CustomFieldConfig>;
  1238. CustomerGroup: Array<CustomFieldConfig>;
  1239. Facet: Array<CustomFieldConfig>;
  1240. FacetValue: Array<CustomFieldConfig>;
  1241. Fulfillment: Array<CustomFieldConfig>;
  1242. GlobalSettings: Array<CustomFieldConfig>;
  1243. HistoryEntry: Array<CustomFieldConfig>;
  1244. Order: Array<CustomFieldConfig>;
  1245. OrderLine: Array<CustomFieldConfig>;
  1246. Payment: Array<CustomFieldConfig>;
  1247. PaymentMethod: Array<CustomFieldConfig>;
  1248. Product: Array<CustomFieldConfig>;
  1249. ProductOption: Array<CustomFieldConfig>;
  1250. ProductOptionGroup: Array<CustomFieldConfig>;
  1251. ProductVariant: Array<CustomFieldConfig>;
  1252. ProductVariantPrice: Array<CustomFieldConfig>;
  1253. Promotion: Array<CustomFieldConfig>;
  1254. Refund: Array<CustomFieldConfig>;
  1255. Region: Array<CustomFieldConfig>;
  1256. Seller: Array<CustomFieldConfig>;
  1257. Session: Array<CustomFieldConfig>;
  1258. ShippingLine: Array<CustomFieldConfig>;
  1259. ShippingMethod: Array<CustomFieldConfig>;
  1260. StockLevel: Array<CustomFieldConfig>;
  1261. StockLocation: Array<CustomFieldConfig>;
  1262. StockMovement: Array<CustomFieldConfig>;
  1263. TaxCategory: Array<CustomFieldConfig>;
  1264. TaxRate: Array<CustomFieldConfig>;
  1265. User: Array<CustomFieldConfig>;
  1266. Zone: Array<CustomFieldConfig>;
  1267. };
  1268. export type Customer = Node & {
  1269. __typename?: 'Customer';
  1270. addresses?: Maybe<Array<Address>>;
  1271. createdAt: Scalars['DateTime']['output'];
  1272. customFields?: Maybe<Scalars['JSON']['output']>;
  1273. emailAddress: Scalars['String']['output'];
  1274. firstName: Scalars['String']['output'];
  1275. groups: Array<CustomerGroup>;
  1276. history: HistoryEntryList;
  1277. id: Scalars['ID']['output'];
  1278. lastName: Scalars['String']['output'];
  1279. orders: OrderList;
  1280. phoneNumber?: Maybe<Scalars['String']['output']>;
  1281. title?: Maybe<Scalars['String']['output']>;
  1282. updatedAt: Scalars['DateTime']['output'];
  1283. user?: Maybe<User>;
  1284. };
  1285. export type CustomerHistoryArgs = {
  1286. options?: InputMaybe<HistoryEntryListOptions>;
  1287. };
  1288. export type CustomerOrdersArgs = {
  1289. options?: InputMaybe<OrderListOptions>;
  1290. };
  1291. export type CustomerFilterParameter = {
  1292. _and?: InputMaybe<Array<CustomerFilterParameter>>;
  1293. _or?: InputMaybe<Array<CustomerFilterParameter>>;
  1294. createdAt?: InputMaybe<DateOperators>;
  1295. emailAddress?: InputMaybe<StringOperators>;
  1296. firstName?: InputMaybe<StringOperators>;
  1297. id?: InputMaybe<IdOperators>;
  1298. lastName?: InputMaybe<StringOperators>;
  1299. phoneNumber?: InputMaybe<StringOperators>;
  1300. postalCode?: InputMaybe<StringOperators>;
  1301. title?: InputMaybe<StringOperators>;
  1302. updatedAt?: InputMaybe<DateOperators>;
  1303. };
  1304. export type CustomerGroup = Node & {
  1305. __typename?: 'CustomerGroup';
  1306. createdAt: Scalars['DateTime']['output'];
  1307. customFields?: Maybe<Scalars['JSON']['output']>;
  1308. customers: CustomerList;
  1309. id: Scalars['ID']['output'];
  1310. name: Scalars['String']['output'];
  1311. updatedAt: Scalars['DateTime']['output'];
  1312. };
  1313. export type CustomerGroupCustomersArgs = {
  1314. options?: InputMaybe<CustomerListOptions>;
  1315. };
  1316. export type CustomerGroupFilterParameter = {
  1317. _and?: InputMaybe<Array<CustomerGroupFilterParameter>>;
  1318. _or?: InputMaybe<Array<CustomerGroupFilterParameter>>;
  1319. createdAt?: InputMaybe<DateOperators>;
  1320. id?: InputMaybe<IdOperators>;
  1321. name?: InputMaybe<StringOperators>;
  1322. updatedAt?: InputMaybe<DateOperators>;
  1323. };
  1324. export type CustomerGroupList = PaginatedList & {
  1325. __typename?: 'CustomerGroupList';
  1326. items: Array<CustomerGroup>;
  1327. totalItems: Scalars['Int']['output'];
  1328. };
  1329. export type CustomerGroupListOptions = {
  1330. /** Allows the results to be filtered */
  1331. filter?: InputMaybe<CustomerGroupFilterParameter>;
  1332. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1333. filterOperator?: InputMaybe<LogicalOperator>;
  1334. /** Skips the first n results, for use in pagination */
  1335. skip?: InputMaybe<Scalars['Int']['input']>;
  1336. /** Specifies which properties to sort the results by */
  1337. sort?: InputMaybe<CustomerGroupSortParameter>;
  1338. /** Takes n results, for use in pagination */
  1339. take?: InputMaybe<Scalars['Int']['input']>;
  1340. };
  1341. export type CustomerGroupSortParameter = {
  1342. createdAt?: InputMaybe<SortOrder>;
  1343. id?: InputMaybe<SortOrder>;
  1344. name?: InputMaybe<SortOrder>;
  1345. updatedAt?: InputMaybe<SortOrder>;
  1346. };
  1347. export type CustomerList = PaginatedList & {
  1348. __typename?: 'CustomerList';
  1349. items: Array<Customer>;
  1350. totalItems: Scalars['Int']['output'];
  1351. };
  1352. export type CustomerListOptions = {
  1353. /** Allows the results to be filtered */
  1354. filter?: InputMaybe<CustomerFilterParameter>;
  1355. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1356. filterOperator?: InputMaybe<LogicalOperator>;
  1357. /** Skips the first n results, for use in pagination */
  1358. skip?: InputMaybe<Scalars['Int']['input']>;
  1359. /** Specifies which properties to sort the results by */
  1360. sort?: InputMaybe<CustomerSortParameter>;
  1361. /** Takes n results, for use in pagination */
  1362. take?: InputMaybe<Scalars['Int']['input']>;
  1363. };
  1364. export type CustomerSortParameter = {
  1365. createdAt?: InputMaybe<SortOrder>;
  1366. emailAddress?: InputMaybe<SortOrder>;
  1367. firstName?: InputMaybe<SortOrder>;
  1368. id?: InputMaybe<SortOrder>;
  1369. lastName?: InputMaybe<SortOrder>;
  1370. phoneNumber?: InputMaybe<SortOrder>;
  1371. title?: InputMaybe<SortOrder>;
  1372. updatedAt?: InputMaybe<SortOrder>;
  1373. };
  1374. /** Operators for filtering on a list of Date fields */
  1375. export type DateListOperators = {
  1376. inList: Scalars['DateTime']['input'];
  1377. };
  1378. /** Operators for filtering on a DateTime field */
  1379. export type DateOperators = {
  1380. after?: InputMaybe<Scalars['DateTime']['input']>;
  1381. before?: InputMaybe<Scalars['DateTime']['input']>;
  1382. between?: InputMaybe<DateRange>;
  1383. eq?: InputMaybe<Scalars['DateTime']['input']>;
  1384. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  1385. };
  1386. export type DateRange = {
  1387. end: Scalars['DateTime']['input'];
  1388. start: Scalars['DateTime']['input'];
  1389. };
  1390. /**
  1391. * Expects the same validation formats as the `<input type="datetime-local">` HTML element.
  1392. * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
  1393. */
  1394. export type DateTimeCustomFieldConfig = CustomField & {
  1395. __typename?: 'DateTimeCustomFieldConfig';
  1396. description?: Maybe<Array<LocalizedString>>;
  1397. internal?: Maybe<Scalars['Boolean']['output']>;
  1398. label?: Maybe<Array<LocalizedString>>;
  1399. list: Scalars['Boolean']['output'];
  1400. max?: Maybe<Scalars['String']['output']>;
  1401. min?: Maybe<Scalars['String']['output']>;
  1402. name: Scalars['String']['output'];
  1403. nullable?: Maybe<Scalars['Boolean']['output']>;
  1404. readonly?: Maybe<Scalars['Boolean']['output']>;
  1405. requiresPermission?: Maybe<Array<Permission>>;
  1406. step?: Maybe<Scalars['Int']['output']>;
  1407. type: Scalars['String']['output'];
  1408. ui?: Maybe<Scalars['JSON']['output']>;
  1409. };
  1410. /**
  1411. * Expects the same validation formats as the `<input type="datetime-local">` HTML element.
  1412. * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
  1413. */
  1414. export type DateTimeStructFieldConfig = StructField & {
  1415. __typename?: 'DateTimeStructFieldConfig';
  1416. description?: Maybe<Array<LocalizedString>>;
  1417. label?: Maybe<Array<LocalizedString>>;
  1418. list: Scalars['Boolean']['output'];
  1419. max?: Maybe<Scalars['String']['output']>;
  1420. min?: Maybe<Scalars['String']['output']>;
  1421. name: Scalars['String']['output'];
  1422. step?: Maybe<Scalars['Int']['output']>;
  1423. type: Scalars['String']['output'];
  1424. ui?: Maybe<Scalars['JSON']['output']>;
  1425. };
  1426. export type DeleteAssetInput = {
  1427. assetId: Scalars['ID']['input'];
  1428. deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
  1429. force?: InputMaybe<Scalars['Boolean']['input']>;
  1430. };
  1431. export type DeleteAssetsInput = {
  1432. assetIds: Array<Scalars['ID']['input']>;
  1433. deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
  1434. force?: InputMaybe<Scalars['Boolean']['input']>;
  1435. };
  1436. export type DeleteStockLocationInput = {
  1437. id: Scalars['ID']['input'];
  1438. transferToLocationId?: InputMaybe<Scalars['ID']['input']>;
  1439. };
  1440. export type DeletionResponse = {
  1441. __typename?: 'DeletionResponse';
  1442. message?: Maybe<Scalars['String']['output']>;
  1443. result: DeletionResult;
  1444. };
  1445. export enum DeletionResult {
  1446. /** The entity was successfully deleted */
  1447. DELETED = 'DELETED',
  1448. /** Deletion did not take place, reason given in message */
  1449. NOT_DELETED = 'NOT_DELETED'
  1450. }
  1451. export type Discount = {
  1452. __typename?: 'Discount';
  1453. adjustmentSource: Scalars['String']['output'];
  1454. amount: Scalars['Money']['output'];
  1455. amountWithTax: Scalars['Money']['output'];
  1456. description: Scalars['String']['output'];
  1457. type: AdjustmentType;
  1458. };
  1459. export type DuplicateEntityError = ErrorResult & {
  1460. __typename?: 'DuplicateEntityError';
  1461. duplicationError: Scalars['String']['output'];
  1462. errorCode: ErrorCode;
  1463. message: Scalars['String']['output'];
  1464. };
  1465. export type DuplicateEntityInput = {
  1466. duplicatorInput: ConfigurableOperationInput;
  1467. entityId: Scalars['ID']['input'];
  1468. entityName: Scalars['String']['input'];
  1469. };
  1470. export type DuplicateEntityResult = DuplicateEntityError | DuplicateEntitySuccess;
  1471. export type DuplicateEntitySuccess = {
  1472. __typename?: 'DuplicateEntitySuccess';
  1473. newEntityId: Scalars['ID']['output'];
  1474. };
  1475. /** Returned when attempting to create a Customer with an email address already registered to an existing User. */
  1476. export type EmailAddressConflictError = ErrorResult & {
  1477. __typename?: 'EmailAddressConflictError';
  1478. errorCode: ErrorCode;
  1479. message: Scalars['String']['output'];
  1480. };
  1481. /** Returned if no OrderLines have been specified for the operation */
  1482. export type EmptyOrderLineSelectionError = ErrorResult & {
  1483. __typename?: 'EmptyOrderLineSelectionError';
  1484. errorCode: ErrorCode;
  1485. message: Scalars['String']['output'];
  1486. };
  1487. export type EntityCustomFields = {
  1488. __typename?: 'EntityCustomFields';
  1489. customFields: Array<CustomFieldConfig>;
  1490. entityName: Scalars['String']['output'];
  1491. };
  1492. export type EntityDuplicatorDefinition = {
  1493. __typename?: 'EntityDuplicatorDefinition';
  1494. args: Array<ConfigArgDefinition>;
  1495. code: Scalars['String']['output'];
  1496. description: Scalars['String']['output'];
  1497. forEntities: Array<Scalars['String']['output']>;
  1498. requiresPermission: Array<Permission>;
  1499. };
  1500. export enum ErrorCode {
  1501. ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
  1502. CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
  1503. CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
  1504. CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
  1505. COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
  1506. COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
  1507. COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
  1508. CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
  1509. DUPLICATE_ENTITY_ERROR = 'DUPLICATE_ENTITY_ERROR',
  1510. EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
  1511. EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
  1512. FACET_IN_USE_ERROR = 'FACET_IN_USE_ERROR',
  1513. FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
  1514. GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
  1515. INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
  1516. INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
  1517. INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
  1518. INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
  1519. INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
  1520. ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
  1521. LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
  1522. MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
  1523. MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
  1524. MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
  1525. MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
  1526. NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
  1527. NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
  1528. NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
  1529. NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
  1530. NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
  1531. ORDER_INTERCEPTOR_ERROR = 'ORDER_INTERCEPTOR_ERROR',
  1532. ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
  1533. ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
  1534. ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
  1535. ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
  1536. PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
  1537. PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
  1538. PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
  1539. PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
  1540. QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
  1541. REFUND_AMOUNT_ERROR = 'REFUND_AMOUNT_ERROR',
  1542. REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
  1543. REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
  1544. REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
  1545. SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
  1546. UNKNOWN_ERROR = 'UNKNOWN_ERROR'
  1547. }
  1548. export type ErrorResult = {
  1549. errorCode: ErrorCode;
  1550. message: Scalars['String']['output'];
  1551. };
  1552. export type Facet = Node & {
  1553. __typename?: 'Facet';
  1554. code: Scalars['String']['output'];
  1555. createdAt: Scalars['DateTime']['output'];
  1556. customFields?: Maybe<Scalars['JSON']['output']>;
  1557. id: Scalars['ID']['output'];
  1558. isPrivate: Scalars['Boolean']['output'];
  1559. languageCode: LanguageCode;
  1560. name: Scalars['String']['output'];
  1561. translations: Array<FacetTranslation>;
  1562. updatedAt: Scalars['DateTime']['output'];
  1563. /** Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0. */
  1564. valueList: FacetValueList;
  1565. values: Array<FacetValue>;
  1566. };
  1567. export type FacetValueListArgs = {
  1568. options?: InputMaybe<FacetValueListOptions>;
  1569. };
  1570. export type FacetFilterParameter = {
  1571. _and?: InputMaybe<Array<FacetFilterParameter>>;
  1572. _or?: InputMaybe<Array<FacetFilterParameter>>;
  1573. code?: InputMaybe<StringOperators>;
  1574. createdAt?: InputMaybe<DateOperators>;
  1575. id?: InputMaybe<IdOperators>;
  1576. isPrivate?: InputMaybe<BooleanOperators>;
  1577. languageCode?: InputMaybe<StringOperators>;
  1578. name?: InputMaybe<StringOperators>;
  1579. updatedAt?: InputMaybe<DateOperators>;
  1580. };
  1581. export type FacetInUseError = ErrorResult & {
  1582. __typename?: 'FacetInUseError';
  1583. errorCode: ErrorCode;
  1584. facetCode: Scalars['String']['output'];
  1585. message: Scalars['String']['output'];
  1586. productCount: Scalars['Int']['output'];
  1587. variantCount: Scalars['Int']['output'];
  1588. };
  1589. export type FacetList = PaginatedList & {
  1590. __typename?: 'FacetList';
  1591. items: Array<Facet>;
  1592. totalItems: Scalars['Int']['output'];
  1593. };
  1594. export type FacetListOptions = {
  1595. /** Allows the results to be filtered */
  1596. filter?: InputMaybe<FacetFilterParameter>;
  1597. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1598. filterOperator?: InputMaybe<LogicalOperator>;
  1599. /** Skips the first n results, for use in pagination */
  1600. skip?: InputMaybe<Scalars['Int']['input']>;
  1601. /** Specifies which properties to sort the results by */
  1602. sort?: InputMaybe<FacetSortParameter>;
  1603. /** Takes n results, for use in pagination */
  1604. take?: InputMaybe<Scalars['Int']['input']>;
  1605. };
  1606. export type FacetSortParameter = {
  1607. code?: InputMaybe<SortOrder>;
  1608. createdAt?: InputMaybe<SortOrder>;
  1609. id?: InputMaybe<SortOrder>;
  1610. name?: InputMaybe<SortOrder>;
  1611. updatedAt?: InputMaybe<SortOrder>;
  1612. };
  1613. export type FacetTranslation = {
  1614. __typename?: 'FacetTranslation';
  1615. createdAt: Scalars['DateTime']['output'];
  1616. id: Scalars['ID']['output'];
  1617. languageCode: LanguageCode;
  1618. name: Scalars['String']['output'];
  1619. updatedAt: Scalars['DateTime']['output'];
  1620. };
  1621. export type FacetTranslationInput = {
  1622. customFields?: InputMaybe<Scalars['JSON']['input']>;
  1623. id?: InputMaybe<Scalars['ID']['input']>;
  1624. languageCode: LanguageCode;
  1625. name?: InputMaybe<Scalars['String']['input']>;
  1626. };
  1627. export type FacetValue = Node & {
  1628. __typename?: 'FacetValue';
  1629. code: Scalars['String']['output'];
  1630. createdAt: Scalars['DateTime']['output'];
  1631. customFields?: Maybe<Scalars['JSON']['output']>;
  1632. facet: Facet;
  1633. facetId: Scalars['ID']['output'];
  1634. id: Scalars['ID']['output'];
  1635. languageCode: LanguageCode;
  1636. name: Scalars['String']['output'];
  1637. translations: Array<FacetValueTranslation>;
  1638. updatedAt: Scalars['DateTime']['output'];
  1639. };
  1640. /**
  1641. * Used to construct boolean expressions for filtering search results
  1642. * by FacetValue ID. Examples:
  1643. *
  1644. * * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
  1645. * * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
  1646. * * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
  1647. */
  1648. export type FacetValueFilterInput = {
  1649. and?: InputMaybe<Scalars['ID']['input']>;
  1650. or?: InputMaybe<Array<Scalars['ID']['input']>>;
  1651. };
  1652. export type FacetValueFilterParameter = {
  1653. _and?: InputMaybe<Array<FacetValueFilterParameter>>;
  1654. _or?: InputMaybe<Array<FacetValueFilterParameter>>;
  1655. code?: InputMaybe<StringOperators>;
  1656. createdAt?: InputMaybe<DateOperators>;
  1657. facetId?: InputMaybe<IdOperators>;
  1658. id?: InputMaybe<IdOperators>;
  1659. languageCode?: InputMaybe<StringOperators>;
  1660. name?: InputMaybe<StringOperators>;
  1661. updatedAt?: InputMaybe<DateOperators>;
  1662. };
  1663. export type FacetValueList = PaginatedList & {
  1664. __typename?: 'FacetValueList';
  1665. items: Array<FacetValue>;
  1666. totalItems: Scalars['Int']['output'];
  1667. };
  1668. export type FacetValueListOptions = {
  1669. /** Allows the results to be filtered */
  1670. filter?: InputMaybe<FacetValueFilterParameter>;
  1671. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1672. filterOperator?: InputMaybe<LogicalOperator>;
  1673. /** Skips the first n results, for use in pagination */
  1674. skip?: InputMaybe<Scalars['Int']['input']>;
  1675. /** Specifies which properties to sort the results by */
  1676. sort?: InputMaybe<FacetValueSortParameter>;
  1677. /** Takes n results, for use in pagination */
  1678. take?: InputMaybe<Scalars['Int']['input']>;
  1679. };
  1680. /**
  1681. * Which FacetValues are present in the products returned
  1682. * by the search, and in what quantity.
  1683. */
  1684. export type FacetValueResult = {
  1685. __typename?: 'FacetValueResult';
  1686. count: Scalars['Int']['output'];
  1687. facetValue: FacetValue;
  1688. };
  1689. export type FacetValueSortParameter = {
  1690. code?: InputMaybe<SortOrder>;
  1691. createdAt?: InputMaybe<SortOrder>;
  1692. facetId?: InputMaybe<SortOrder>;
  1693. id?: InputMaybe<SortOrder>;
  1694. name?: InputMaybe<SortOrder>;
  1695. updatedAt?: InputMaybe<SortOrder>;
  1696. };
  1697. export type FacetValueTranslation = {
  1698. __typename?: 'FacetValueTranslation';
  1699. createdAt: Scalars['DateTime']['output'];
  1700. id: Scalars['ID']['output'];
  1701. languageCode: LanguageCode;
  1702. name: Scalars['String']['output'];
  1703. updatedAt: Scalars['DateTime']['output'];
  1704. };
  1705. export type FacetValueTranslationInput = {
  1706. customFields?: InputMaybe<Scalars['JSON']['input']>;
  1707. id?: InputMaybe<Scalars['ID']['input']>;
  1708. languageCode: LanguageCode;
  1709. name?: InputMaybe<Scalars['String']['input']>;
  1710. };
  1711. export type FloatCustomFieldConfig = CustomField & {
  1712. __typename?: 'FloatCustomFieldConfig';
  1713. description?: Maybe<Array<LocalizedString>>;
  1714. internal?: Maybe<Scalars['Boolean']['output']>;
  1715. label?: Maybe<Array<LocalizedString>>;
  1716. list: Scalars['Boolean']['output'];
  1717. max?: Maybe<Scalars['Float']['output']>;
  1718. min?: Maybe<Scalars['Float']['output']>;
  1719. name: Scalars['String']['output'];
  1720. nullable?: Maybe<Scalars['Boolean']['output']>;
  1721. readonly?: Maybe<Scalars['Boolean']['output']>;
  1722. requiresPermission?: Maybe<Array<Permission>>;
  1723. step?: Maybe<Scalars['Float']['output']>;
  1724. type: Scalars['String']['output'];
  1725. ui?: Maybe<Scalars['JSON']['output']>;
  1726. };
  1727. export type FloatStructFieldConfig = StructField & {
  1728. __typename?: 'FloatStructFieldConfig';
  1729. description?: Maybe<Array<LocalizedString>>;
  1730. label?: Maybe<Array<LocalizedString>>;
  1731. list: Scalars['Boolean']['output'];
  1732. max?: Maybe<Scalars['Float']['output']>;
  1733. min?: Maybe<Scalars['Float']['output']>;
  1734. name: Scalars['String']['output'];
  1735. step?: Maybe<Scalars['Float']['output']>;
  1736. type: Scalars['String']['output'];
  1737. ui?: Maybe<Scalars['JSON']['output']>;
  1738. };
  1739. export type FulfillOrderInput = {
  1740. handler: ConfigurableOperationInput;
  1741. lines: Array<OrderLineInput>;
  1742. };
  1743. export type Fulfillment = Node & {
  1744. __typename?: 'Fulfillment';
  1745. createdAt: Scalars['DateTime']['output'];
  1746. customFields?: Maybe<Scalars['JSON']['output']>;
  1747. id: Scalars['ID']['output'];
  1748. lines: Array<FulfillmentLine>;
  1749. method: Scalars['String']['output'];
  1750. nextStates: Array<Scalars['String']['output']>;
  1751. state: Scalars['String']['output'];
  1752. /** @deprecated Use the `lines` field instead */
  1753. summary: Array<FulfillmentLine>;
  1754. trackingCode?: Maybe<Scalars['String']['output']>;
  1755. updatedAt: Scalars['DateTime']['output'];
  1756. };
  1757. export type FulfillmentLine = {
  1758. __typename?: 'FulfillmentLine';
  1759. fulfillment: Fulfillment;
  1760. fulfillmentId: Scalars['ID']['output'];
  1761. orderLine: OrderLine;
  1762. orderLineId: Scalars['ID']['output'];
  1763. quantity: Scalars['Int']['output'];
  1764. };
  1765. /** Returned when there is an error in transitioning the Fulfillment state */
  1766. export type FulfillmentStateTransitionError = ErrorResult & {
  1767. __typename?: 'FulfillmentStateTransitionError';
  1768. errorCode: ErrorCode;
  1769. fromState: Scalars['String']['output'];
  1770. message: Scalars['String']['output'];
  1771. toState: Scalars['String']['output'];
  1772. transitionError: Scalars['String']['output'];
  1773. };
  1774. export enum GlobalFlag {
  1775. FALSE = 'FALSE',
  1776. INHERIT = 'INHERIT',
  1777. TRUE = 'TRUE'
  1778. }
  1779. export type GlobalSettings = {
  1780. __typename?: 'GlobalSettings';
  1781. availableLanguages: Array<LanguageCode>;
  1782. createdAt: Scalars['DateTime']['output'];
  1783. customFields?: Maybe<Scalars['JSON']['output']>;
  1784. id: Scalars['ID']['output'];
  1785. outOfStockThreshold: Scalars['Int']['output'];
  1786. serverConfig: ServerConfig;
  1787. trackInventory: Scalars['Boolean']['output'];
  1788. updatedAt: Scalars['DateTime']['output'];
  1789. };
  1790. /** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
  1791. export type GuestCheckoutError = ErrorResult & {
  1792. __typename?: 'GuestCheckoutError';
  1793. errorCode: ErrorCode;
  1794. errorDetail: Scalars['String']['output'];
  1795. message: Scalars['String']['output'];
  1796. };
  1797. export type HistoryEntry = Node & {
  1798. __typename?: 'HistoryEntry';
  1799. administrator?: Maybe<Administrator>;
  1800. createdAt: Scalars['DateTime']['output'];
  1801. customFields?: Maybe<Scalars['JSON']['output']>;
  1802. data: Scalars['JSON']['output'];
  1803. id: Scalars['ID']['output'];
  1804. isPublic: Scalars['Boolean']['output'];
  1805. type: HistoryEntryType;
  1806. updatedAt: Scalars['DateTime']['output'];
  1807. };
  1808. export type HistoryEntryFilterParameter = {
  1809. _and?: InputMaybe<Array<HistoryEntryFilterParameter>>;
  1810. _or?: InputMaybe<Array<HistoryEntryFilterParameter>>;
  1811. createdAt?: InputMaybe<DateOperators>;
  1812. id?: InputMaybe<IdOperators>;
  1813. isPublic?: InputMaybe<BooleanOperators>;
  1814. type?: InputMaybe<StringOperators>;
  1815. updatedAt?: InputMaybe<DateOperators>;
  1816. };
  1817. export type HistoryEntryList = PaginatedList & {
  1818. __typename?: 'HistoryEntryList';
  1819. items: Array<HistoryEntry>;
  1820. totalItems: Scalars['Int']['output'];
  1821. };
  1822. export type HistoryEntryListOptions = {
  1823. /** Allows the results to be filtered */
  1824. filter?: InputMaybe<HistoryEntryFilterParameter>;
  1825. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1826. filterOperator?: InputMaybe<LogicalOperator>;
  1827. /** Skips the first n results, for use in pagination */
  1828. skip?: InputMaybe<Scalars['Int']['input']>;
  1829. /** Specifies which properties to sort the results by */
  1830. sort?: InputMaybe<HistoryEntrySortParameter>;
  1831. /** Takes n results, for use in pagination */
  1832. take?: InputMaybe<Scalars['Int']['input']>;
  1833. };
  1834. export type HistoryEntrySortParameter = {
  1835. createdAt?: InputMaybe<SortOrder>;
  1836. id?: InputMaybe<SortOrder>;
  1837. updatedAt?: InputMaybe<SortOrder>;
  1838. };
  1839. export enum HistoryEntryType {
  1840. CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
  1841. CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
  1842. CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
  1843. CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
  1844. CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
  1845. CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
  1846. CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
  1847. CUSTOMER_NOTE = 'CUSTOMER_NOTE',
  1848. CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
  1849. CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
  1850. CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
  1851. CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
  1852. CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
  1853. CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
  1854. ORDER_CANCELLATION = 'ORDER_CANCELLATION',
  1855. ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
  1856. ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
  1857. ORDER_CUSTOMER_UPDATED = 'ORDER_CUSTOMER_UPDATED',
  1858. ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
  1859. ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
  1860. ORDER_MODIFIED = 'ORDER_MODIFIED',
  1861. ORDER_NOTE = 'ORDER_NOTE',
  1862. ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
  1863. ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
  1864. ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION'
  1865. }
  1866. /** Operators for filtering on a list of ID fields */
  1867. export type IdListOperators = {
  1868. inList: Scalars['ID']['input'];
  1869. };
  1870. /** Operators for filtering on an ID field */
  1871. export type IdOperators = {
  1872. eq?: InputMaybe<Scalars['String']['input']>;
  1873. in?: InputMaybe<Array<Scalars['String']['input']>>;
  1874. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  1875. notEq?: InputMaybe<Scalars['String']['input']>;
  1876. notIn?: InputMaybe<Array<Scalars['String']['input']>>;
  1877. };
  1878. export type ImportInfo = {
  1879. __typename?: 'ImportInfo';
  1880. errors?: Maybe<Array<Scalars['String']['output']>>;
  1881. imported: Scalars['Int']['output'];
  1882. processed: Scalars['Int']['output'];
  1883. };
  1884. /** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
  1885. export type IneligibleShippingMethodError = ErrorResult & {
  1886. __typename?: 'IneligibleShippingMethodError';
  1887. errorCode: ErrorCode;
  1888. message: Scalars['String']['output'];
  1889. };
  1890. /** Returned when attempting to add more items to the Order than are available */
  1891. export type InsufficientStockError = ErrorResult & {
  1892. __typename?: 'InsufficientStockError';
  1893. errorCode: ErrorCode;
  1894. message: Scalars['String']['output'];
  1895. order: Order;
  1896. quantityAvailable: Scalars['Int']['output'];
  1897. };
  1898. /**
  1899. * Returned if attempting to create a Fulfillment when there is insufficient
  1900. * stockOnHand of a ProductVariant to satisfy the requested quantity.
  1901. */
  1902. export type InsufficientStockOnHandError = ErrorResult & {
  1903. __typename?: 'InsufficientStockOnHandError';
  1904. errorCode: ErrorCode;
  1905. message: Scalars['String']['output'];
  1906. productVariantId: Scalars['ID']['output'];
  1907. productVariantName: Scalars['String']['output'];
  1908. stockOnHand: Scalars['Int']['output'];
  1909. };
  1910. export type IntCustomFieldConfig = CustomField & {
  1911. __typename?: 'IntCustomFieldConfig';
  1912. description?: Maybe<Array<LocalizedString>>;
  1913. internal?: Maybe<Scalars['Boolean']['output']>;
  1914. label?: Maybe<Array<LocalizedString>>;
  1915. list: Scalars['Boolean']['output'];
  1916. max?: Maybe<Scalars['Int']['output']>;
  1917. min?: Maybe<Scalars['Int']['output']>;
  1918. name: Scalars['String']['output'];
  1919. nullable?: Maybe<Scalars['Boolean']['output']>;
  1920. readonly?: Maybe<Scalars['Boolean']['output']>;
  1921. requiresPermission?: Maybe<Array<Permission>>;
  1922. step?: Maybe<Scalars['Int']['output']>;
  1923. type: Scalars['String']['output'];
  1924. ui?: Maybe<Scalars['JSON']['output']>;
  1925. };
  1926. export type IntStructFieldConfig = StructField & {
  1927. __typename?: 'IntStructFieldConfig';
  1928. description?: Maybe<Array<LocalizedString>>;
  1929. label?: Maybe<Array<LocalizedString>>;
  1930. list: Scalars['Boolean']['output'];
  1931. max?: Maybe<Scalars['Int']['output']>;
  1932. min?: Maybe<Scalars['Int']['output']>;
  1933. name: Scalars['String']['output'];
  1934. step?: Maybe<Scalars['Int']['output']>;
  1935. type: Scalars['String']['output'];
  1936. ui?: Maybe<Scalars['JSON']['output']>;
  1937. };
  1938. /** Returned if the user authentication credentials are not valid */
  1939. export type InvalidCredentialsError = ErrorResult & {
  1940. __typename?: 'InvalidCredentialsError';
  1941. authenticationError: Scalars['String']['output'];
  1942. errorCode: ErrorCode;
  1943. message: Scalars['String']['output'];
  1944. };
  1945. /** Returned if the specified FulfillmentHandler code is not valid */
  1946. export type InvalidFulfillmentHandlerError = ErrorResult & {
  1947. __typename?: 'InvalidFulfillmentHandlerError';
  1948. errorCode: ErrorCode;
  1949. message: Scalars['String']['output'];
  1950. };
  1951. /** Returned if the specified items are already part of a Fulfillment */
  1952. export type ItemsAlreadyFulfilledError = ErrorResult & {
  1953. __typename?: 'ItemsAlreadyFulfilledError';
  1954. errorCode: ErrorCode;
  1955. message: Scalars['String']['output'];
  1956. };
  1957. export type Job = Node & {
  1958. __typename?: 'Job';
  1959. attempts: Scalars['Int']['output'];
  1960. createdAt: Scalars['DateTime']['output'];
  1961. data?: Maybe<Scalars['JSON']['output']>;
  1962. duration: Scalars['Int']['output'];
  1963. error?: Maybe<Scalars['JSON']['output']>;
  1964. id: Scalars['ID']['output'];
  1965. isSettled: Scalars['Boolean']['output'];
  1966. progress: Scalars['Float']['output'];
  1967. queueName: Scalars['String']['output'];
  1968. result?: Maybe<Scalars['JSON']['output']>;
  1969. retries: Scalars['Int']['output'];
  1970. settledAt?: Maybe<Scalars['DateTime']['output']>;
  1971. startedAt?: Maybe<Scalars['DateTime']['output']>;
  1972. state: JobState;
  1973. };
  1974. export type JobBufferSize = {
  1975. __typename?: 'JobBufferSize';
  1976. bufferId: Scalars['String']['output'];
  1977. size: Scalars['Int']['output'];
  1978. };
  1979. export type JobFilterParameter = {
  1980. _and?: InputMaybe<Array<JobFilterParameter>>;
  1981. _or?: InputMaybe<Array<JobFilterParameter>>;
  1982. attempts?: InputMaybe<NumberOperators>;
  1983. createdAt?: InputMaybe<DateOperators>;
  1984. duration?: InputMaybe<NumberOperators>;
  1985. id?: InputMaybe<IdOperators>;
  1986. isSettled?: InputMaybe<BooleanOperators>;
  1987. progress?: InputMaybe<NumberOperators>;
  1988. queueName?: InputMaybe<StringOperators>;
  1989. retries?: InputMaybe<NumberOperators>;
  1990. settledAt?: InputMaybe<DateOperators>;
  1991. startedAt?: InputMaybe<DateOperators>;
  1992. state?: InputMaybe<StringOperators>;
  1993. };
  1994. export type JobList = PaginatedList & {
  1995. __typename?: 'JobList';
  1996. items: Array<Job>;
  1997. totalItems: Scalars['Int']['output'];
  1998. };
  1999. export type JobListOptions = {
  2000. /** Allows the results to be filtered */
  2001. filter?: InputMaybe<JobFilterParameter>;
  2002. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  2003. filterOperator?: InputMaybe<LogicalOperator>;
  2004. /** Skips the first n results, for use in pagination */
  2005. skip?: InputMaybe<Scalars['Int']['input']>;
  2006. /** Specifies which properties to sort the results by */
  2007. sort?: InputMaybe<JobSortParameter>;
  2008. /** Takes n results, for use in pagination */
  2009. take?: InputMaybe<Scalars['Int']['input']>;
  2010. };
  2011. export type JobQueue = {
  2012. __typename?: 'JobQueue';
  2013. name: Scalars['String']['output'];
  2014. running: Scalars['Boolean']['output'];
  2015. };
  2016. export type JobSortParameter = {
  2017. attempts?: InputMaybe<SortOrder>;
  2018. createdAt?: InputMaybe<SortOrder>;
  2019. duration?: InputMaybe<SortOrder>;
  2020. id?: InputMaybe<SortOrder>;
  2021. progress?: InputMaybe<SortOrder>;
  2022. queueName?: InputMaybe<SortOrder>;
  2023. retries?: InputMaybe<SortOrder>;
  2024. settledAt?: InputMaybe<SortOrder>;
  2025. startedAt?: InputMaybe<SortOrder>;
  2026. };
  2027. /**
  2028. * @description
  2029. * The state of a Job in the JobQueue
  2030. *
  2031. * @docsCategory common
  2032. */
  2033. export enum JobState {
  2034. CANCELLED = 'CANCELLED',
  2035. COMPLETED = 'COMPLETED',
  2036. FAILED = 'FAILED',
  2037. PENDING = 'PENDING',
  2038. RETRYING = 'RETRYING',
  2039. RUNNING = 'RUNNING'
  2040. }
  2041. /**
  2042. * @description
  2043. * Languages in the form of a ISO 639-1 language code with optional
  2044. * region or script modifier (e.g. de_AT). The selection available is based
  2045. * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  2046. * and includes the major spoken languages of the world and any widely-used variants.
  2047. *
  2048. * @docsCategory common
  2049. */
  2050. export enum LanguageCode {
  2051. /** Afrikaans */
  2052. af = 'af',
  2053. /** Akan */
  2054. ak = 'ak',
  2055. /** Amharic */
  2056. am = 'am',
  2057. /** Arabic */
  2058. ar = 'ar',
  2059. /** Assamese */
  2060. as = 'as',
  2061. /** Azerbaijani */
  2062. az = 'az',
  2063. /** Belarusian */
  2064. be = 'be',
  2065. /** Bulgarian */
  2066. bg = 'bg',
  2067. /** Bambara */
  2068. bm = 'bm',
  2069. /** Bangla */
  2070. bn = 'bn',
  2071. /** Tibetan */
  2072. bo = 'bo',
  2073. /** Breton */
  2074. br = 'br',
  2075. /** Bosnian */
  2076. bs = 'bs',
  2077. /** Catalan */
  2078. ca = 'ca',
  2079. /** Chechen */
  2080. ce = 'ce',
  2081. /** Corsican */
  2082. co = 'co',
  2083. /** Czech */
  2084. cs = 'cs',
  2085. /** Church Slavic */
  2086. cu = 'cu',
  2087. /** Welsh */
  2088. cy = 'cy',
  2089. /** Danish */
  2090. da = 'da',
  2091. /** German */
  2092. de = 'de',
  2093. /** Austrian German */
  2094. de_AT = 'de_AT',
  2095. /** Swiss High German */
  2096. de_CH = 'de_CH',
  2097. /** Dzongkha */
  2098. dz = 'dz',
  2099. /** Ewe */
  2100. ee = 'ee',
  2101. /** Greek */
  2102. el = 'el',
  2103. /** English */
  2104. en = 'en',
  2105. /** Australian English */
  2106. en_AU = 'en_AU',
  2107. /** Canadian English */
  2108. en_CA = 'en_CA',
  2109. /** British English */
  2110. en_GB = 'en_GB',
  2111. /** American English */
  2112. en_US = 'en_US',
  2113. /** Esperanto */
  2114. eo = 'eo',
  2115. /** Spanish */
  2116. es = 'es',
  2117. /** European Spanish */
  2118. es_ES = 'es_ES',
  2119. /** Mexican Spanish */
  2120. es_MX = 'es_MX',
  2121. /** Estonian */
  2122. et = 'et',
  2123. /** Basque */
  2124. eu = 'eu',
  2125. /** Persian */
  2126. fa = 'fa',
  2127. /** Dari */
  2128. fa_AF = 'fa_AF',
  2129. /** Fulah */
  2130. ff = 'ff',
  2131. /** Finnish */
  2132. fi = 'fi',
  2133. /** Faroese */
  2134. fo = 'fo',
  2135. /** French */
  2136. fr = 'fr',
  2137. /** Canadian French */
  2138. fr_CA = 'fr_CA',
  2139. /** Swiss French */
  2140. fr_CH = 'fr_CH',
  2141. /** Western Frisian */
  2142. fy = 'fy',
  2143. /** Irish */
  2144. ga = 'ga',
  2145. /** Scottish Gaelic */
  2146. gd = 'gd',
  2147. /** Galician */
  2148. gl = 'gl',
  2149. /** Gujarati */
  2150. gu = 'gu',
  2151. /** Manx */
  2152. gv = 'gv',
  2153. /** Hausa */
  2154. ha = 'ha',
  2155. /** Hebrew */
  2156. he = 'he',
  2157. /** Hindi */
  2158. hi = 'hi',
  2159. /** Croatian */
  2160. hr = 'hr',
  2161. /** Haitian Creole */
  2162. ht = 'ht',
  2163. /** Hungarian */
  2164. hu = 'hu',
  2165. /** Armenian */
  2166. hy = 'hy',
  2167. /** Interlingua */
  2168. ia = 'ia',
  2169. /** Indonesian */
  2170. id = 'id',
  2171. /** Igbo */
  2172. ig = 'ig',
  2173. /** Sichuan Yi */
  2174. ii = 'ii',
  2175. /** Icelandic */
  2176. is = 'is',
  2177. /** Italian */
  2178. it = 'it',
  2179. /** Japanese */
  2180. ja = 'ja',
  2181. /** Javanese */
  2182. jv = 'jv',
  2183. /** Georgian */
  2184. ka = 'ka',
  2185. /** Kikuyu */
  2186. ki = 'ki',
  2187. /** Kazakh */
  2188. kk = 'kk',
  2189. /** Kalaallisut */
  2190. kl = 'kl',
  2191. /** Khmer */
  2192. km = 'km',
  2193. /** Kannada */
  2194. kn = 'kn',
  2195. /** Korean */
  2196. ko = 'ko',
  2197. /** Kashmiri */
  2198. ks = 'ks',
  2199. /** Kurdish */
  2200. ku = 'ku',
  2201. /** Cornish */
  2202. kw = 'kw',
  2203. /** Kyrgyz */
  2204. ky = 'ky',
  2205. /** Latin */
  2206. la = 'la',
  2207. /** Luxembourgish */
  2208. lb = 'lb',
  2209. /** Ganda */
  2210. lg = 'lg',
  2211. /** Lingala */
  2212. ln = 'ln',
  2213. /** Lao */
  2214. lo = 'lo',
  2215. /** Lithuanian */
  2216. lt = 'lt',
  2217. /** Luba-Katanga */
  2218. lu = 'lu',
  2219. /** Latvian */
  2220. lv = 'lv',
  2221. /** Malagasy */
  2222. mg = 'mg',
  2223. /** Maori */
  2224. mi = 'mi',
  2225. /** Macedonian */
  2226. mk = 'mk',
  2227. /** Malayalam */
  2228. ml = 'ml',
  2229. /** Mongolian */
  2230. mn = 'mn',
  2231. /** Marathi */
  2232. mr = 'mr',
  2233. /** Malay */
  2234. ms = 'ms',
  2235. /** Maltese */
  2236. mt = 'mt',
  2237. /** Burmese */
  2238. my = 'my',
  2239. /** Norwegian Bokmål */
  2240. nb = 'nb',
  2241. /** North Ndebele */
  2242. nd = 'nd',
  2243. /** Nepali */
  2244. ne = 'ne',
  2245. /** Dutch */
  2246. nl = 'nl',
  2247. /** Flemish */
  2248. nl_BE = 'nl_BE',
  2249. /** Norwegian Nynorsk */
  2250. nn = 'nn',
  2251. /** Nyanja */
  2252. ny = 'ny',
  2253. /** Oromo */
  2254. om = 'om',
  2255. /** Odia */
  2256. or = 'or',
  2257. /** Ossetic */
  2258. os = 'os',
  2259. /** Punjabi */
  2260. pa = 'pa',
  2261. /** Polish */
  2262. pl = 'pl',
  2263. /** Pashto */
  2264. ps = 'ps',
  2265. /** Portuguese */
  2266. pt = 'pt',
  2267. /** Brazilian Portuguese */
  2268. pt_BR = 'pt_BR',
  2269. /** European Portuguese */
  2270. pt_PT = 'pt_PT',
  2271. /** Quechua */
  2272. qu = 'qu',
  2273. /** Romansh */
  2274. rm = 'rm',
  2275. /** Rundi */
  2276. rn = 'rn',
  2277. /** Romanian */
  2278. ro = 'ro',
  2279. /** Moldavian */
  2280. ro_MD = 'ro_MD',
  2281. /** Russian */
  2282. ru = 'ru',
  2283. /** Kinyarwanda */
  2284. rw = 'rw',
  2285. /** Sanskrit */
  2286. sa = 'sa',
  2287. /** Sindhi */
  2288. sd = 'sd',
  2289. /** Northern Sami */
  2290. se = 'se',
  2291. /** Sango */
  2292. sg = 'sg',
  2293. /** Sinhala */
  2294. si = 'si',
  2295. /** Slovak */
  2296. sk = 'sk',
  2297. /** Slovenian */
  2298. sl = 'sl',
  2299. /** Samoan */
  2300. sm = 'sm',
  2301. /** Shona */
  2302. sn = 'sn',
  2303. /** Somali */
  2304. so = 'so',
  2305. /** Albanian */
  2306. sq = 'sq',
  2307. /** Serbian */
  2308. sr = 'sr',
  2309. /** Southern Sotho */
  2310. st = 'st',
  2311. /** Sundanese */
  2312. su = 'su',
  2313. /** Swedish */
  2314. sv = 'sv',
  2315. /** Swahili */
  2316. sw = 'sw',
  2317. /** Congo Swahili */
  2318. sw_CD = 'sw_CD',
  2319. /** Tamil */
  2320. ta = 'ta',
  2321. /** Telugu */
  2322. te = 'te',
  2323. /** Tajik */
  2324. tg = 'tg',
  2325. /** Thai */
  2326. th = 'th',
  2327. /** Tigrinya */
  2328. ti = 'ti',
  2329. /** Turkmen */
  2330. tk = 'tk',
  2331. /** Tongan */
  2332. to = 'to',
  2333. /** Turkish */
  2334. tr = 'tr',
  2335. /** Tatar */
  2336. tt = 'tt',
  2337. /** Uyghur */
  2338. ug = 'ug',
  2339. /** Ukrainian */
  2340. uk = 'uk',
  2341. /** Urdu */
  2342. ur = 'ur',
  2343. /** Uzbek */
  2344. uz = 'uz',
  2345. /** Vietnamese */
  2346. vi = 'vi',
  2347. /** Volapük */
  2348. vo = 'vo',
  2349. /** Wolof */
  2350. wo = 'wo',
  2351. /** Xhosa */
  2352. xh = 'xh',
  2353. /** Yiddish */
  2354. yi = 'yi',
  2355. /** Yoruba */
  2356. yo = 'yo',
  2357. /** Chinese */
  2358. zh = 'zh',
  2359. /** Simplified Chinese */
  2360. zh_Hans = 'zh_Hans',
  2361. /** Traditional Chinese */
  2362. zh_Hant = 'zh_Hant',
  2363. /** Zulu */
  2364. zu = 'zu'
  2365. }
  2366. /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
  2367. export type LanguageNotAvailableError = ErrorResult & {
  2368. __typename?: 'LanguageNotAvailableError';
  2369. errorCode: ErrorCode;
  2370. languageCode: Scalars['String']['output'];
  2371. message: Scalars['String']['output'];
  2372. };
  2373. export type LocaleStringCustomFieldConfig = CustomField & {
  2374. __typename?: 'LocaleStringCustomFieldConfig';
  2375. description?: Maybe<Array<LocalizedString>>;
  2376. internal?: Maybe<Scalars['Boolean']['output']>;
  2377. label?: Maybe<Array<LocalizedString>>;
  2378. length?: Maybe<Scalars['Int']['output']>;
  2379. list: Scalars['Boolean']['output'];
  2380. name: Scalars['String']['output'];
  2381. nullable?: Maybe<Scalars['Boolean']['output']>;
  2382. pattern?: Maybe<Scalars['String']['output']>;
  2383. readonly?: Maybe<Scalars['Boolean']['output']>;
  2384. requiresPermission?: Maybe<Array<Permission>>;
  2385. type: Scalars['String']['output'];
  2386. ui?: Maybe<Scalars['JSON']['output']>;
  2387. };
  2388. export type LocaleTextCustomFieldConfig = CustomField & {
  2389. __typename?: 'LocaleTextCustomFieldConfig';
  2390. description?: Maybe<Array<LocalizedString>>;
  2391. internal?: Maybe<Scalars['Boolean']['output']>;
  2392. label?: Maybe<Array<LocalizedString>>;
  2393. list: Scalars['Boolean']['output'];
  2394. name: Scalars['String']['output'];
  2395. nullable?: Maybe<Scalars['Boolean']['output']>;
  2396. readonly?: Maybe<Scalars['Boolean']['output']>;
  2397. requiresPermission?: Maybe<Array<Permission>>;
  2398. type: Scalars['String']['output'];
  2399. ui?: Maybe<Scalars['JSON']['output']>;
  2400. };
  2401. export type LocalizedString = {
  2402. __typename?: 'LocalizedString';
  2403. languageCode: LanguageCode;
  2404. value: Scalars['String']['output'];
  2405. };
  2406. export enum LogicalOperator {
  2407. AND = 'AND',
  2408. OR = 'OR'
  2409. }
  2410. export type ManualPaymentInput = {
  2411. metadata?: InputMaybe<Scalars['JSON']['input']>;
  2412. method: Scalars['String']['input'];
  2413. orderId: Scalars['ID']['input'];
  2414. transactionId?: InputMaybe<Scalars['String']['input']>;
  2415. };
  2416. /**
  2417. * Returned when a call to addManualPaymentToOrder is made but the Order
  2418. * is not in the required state.
  2419. */
  2420. export type ManualPaymentStateError = ErrorResult & {
  2421. __typename?: 'ManualPaymentStateError';
  2422. errorCode: ErrorCode;
  2423. message: Scalars['String']['output'];
  2424. };
  2425. export enum MetricInterval {
  2426. Daily = 'Daily'
  2427. }
  2428. export type MetricSummary = {
  2429. __typename?: 'MetricSummary';
  2430. entries: Array<MetricSummaryEntry>;
  2431. interval: MetricInterval;
  2432. title: Scalars['String']['output'];
  2433. type: MetricType;
  2434. };
  2435. export type MetricSummaryEntry = {
  2436. __typename?: 'MetricSummaryEntry';
  2437. label: Scalars['String']['output'];
  2438. value: Scalars['Float']['output'];
  2439. };
  2440. export type MetricSummaryInput = {
  2441. interval: MetricInterval;
  2442. refresh?: InputMaybe<Scalars['Boolean']['input']>;
  2443. types: Array<MetricType>;
  2444. };
  2445. export enum MetricType {
  2446. AverageOrderValue = 'AverageOrderValue',
  2447. OrderCount = 'OrderCount',
  2448. OrderTotal = 'OrderTotal'
  2449. }
  2450. export type MimeTypeError = ErrorResult & {
  2451. __typename?: 'MimeTypeError';
  2452. errorCode: ErrorCode;
  2453. fileName: Scalars['String']['output'];
  2454. message: Scalars['String']['output'];
  2455. mimeType: Scalars['String']['output'];
  2456. };
  2457. /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
  2458. export type MissingConditionsError = ErrorResult & {
  2459. __typename?: 'MissingConditionsError';
  2460. errorCode: ErrorCode;
  2461. message: Scalars['String']['output'];
  2462. };
  2463. export type ModifyOrderInput = {
  2464. addItems?: InputMaybe<Array<AddItemInput>>;
  2465. adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
  2466. couponCodes?: InputMaybe<Array<Scalars['String']['input']>>;
  2467. dryRun: Scalars['Boolean']['input'];
  2468. note?: InputMaybe<Scalars['String']['input']>;
  2469. options?: InputMaybe<ModifyOrderOptions>;
  2470. orderId: Scalars['ID']['input'];
  2471. /**
  2472. * Deprecated in v2.2.0. Use `refunds` instead to allow multiple refunds to be
  2473. * applied in the case that multiple payment methods have been used on the order.
  2474. */
  2475. refund?: InputMaybe<AdministratorRefundInput>;
  2476. refunds?: InputMaybe<Array<AdministratorRefundInput>>;
  2477. /** Added in v2.2 */
  2478. shippingMethodIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  2479. surcharges?: InputMaybe<Array<SurchargeInput>>;
  2480. updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2481. updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2482. };
  2483. export type ModifyOrderOptions = {
  2484. freezePromotions?: InputMaybe<Scalars['Boolean']['input']>;
  2485. recalculateShipping?: InputMaybe<Scalars['Boolean']['input']>;
  2486. };
  2487. export type ModifyOrderResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | IneligibleShippingMethodError | InsufficientStockError | NegativeQuantityError | NoChangesSpecifiedError | Order | OrderLimitError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError;
  2488. export type MoveCollectionInput = {
  2489. collectionId: Scalars['ID']['input'];
  2490. index: Scalars['Int']['input'];
  2491. parentId: Scalars['ID']['input'];
  2492. };
  2493. /** Returned if an operation has specified OrderLines from multiple Orders */
  2494. export type MultipleOrderError = ErrorResult & {
  2495. __typename?: 'MultipleOrderError';
  2496. errorCode: ErrorCode;
  2497. message: Scalars['String']['output'];
  2498. };
  2499. export type Mutation = {
  2500. __typename?: 'Mutation';
  2501. /** Add Customers to a CustomerGroup */
  2502. addCustomersToGroup: CustomerGroup;
  2503. addFulfillmentToOrder: AddFulfillmentToOrderResult;
  2504. /** Adds an item to the draft Order. */
  2505. addItemToDraftOrder: UpdateOrderItemsResult;
  2506. /**
  2507. * Used to manually create a new Payment against an Order.
  2508. * This can be used by an Administrator when an Order is in the ArrangingPayment state.
  2509. *
  2510. * It is also used when a completed Order
  2511. * has been modified (using `modifyOrder`) and the price has increased. The extra payment
  2512. * can then be manually arranged by the administrator, and the details used to create a new
  2513. * Payment.
  2514. */
  2515. addManualPaymentToOrder: AddManualPaymentToOrderResult;
  2516. /** Add members to a Zone */
  2517. addMembersToZone: Zone;
  2518. addNoteToCustomer: Customer;
  2519. addNoteToOrder: Order;
  2520. /** Add an OptionGroup to a Product */
  2521. addOptionGroupToProduct: Product;
  2522. /** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
  2523. adjustDraftOrderLine: UpdateOrderItemsResult;
  2524. /** Applies the given coupon code to the draft Order */
  2525. applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
  2526. /** Assign assets to channel */
  2527. assignAssetsToChannel: Array<Asset>;
  2528. /** Assigns Collections to the specified Channel */
  2529. assignCollectionsToChannel: Array<Collection>;
  2530. /** Assigns Facets to the specified Channel */
  2531. assignFacetsToChannel: Array<Facet>;
  2532. /** Assigns PaymentMethods to the specified Channel */
  2533. assignPaymentMethodsToChannel: Array<PaymentMethod>;
  2534. /** Assigns ProductVariants to the specified Channel */
  2535. assignProductVariantsToChannel: Array<ProductVariant>;
  2536. /** Assigns all ProductVariants of Product to the specified Channel */
  2537. assignProductsToChannel: Array<Product>;
  2538. /** Assigns Promotions to the specified Channel */
  2539. assignPromotionsToChannel: Array<Promotion>;
  2540. /** Assign a Role to an Administrator */
  2541. assignRoleToAdministrator: Administrator;
  2542. /** Assigns ShippingMethods to the specified Channel */
  2543. assignShippingMethodsToChannel: Array<ShippingMethod>;
  2544. /** Assigns StockLocations to the specified Channel */
  2545. assignStockLocationsToChannel: Array<StockLocation>;
  2546. /** Authenticates the user using a named authentication strategy */
  2547. authenticate: AuthenticationResult;
  2548. cancelJob: Job;
  2549. cancelOrder: CancelOrderResult;
  2550. cancelPayment: CancelPaymentResult;
  2551. /** Create a new Administrator */
  2552. createAdministrator: Administrator;
  2553. /** Create a new Asset */
  2554. createAssets: Array<CreateAssetResult>;
  2555. /** Create a new Channel */
  2556. createChannel: CreateChannelResult;
  2557. /** Create a new Collection */
  2558. createCollection: Collection;
  2559. /** Create a new Country */
  2560. createCountry: Country;
  2561. /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
  2562. createCustomer: CreateCustomerResult;
  2563. /** Create a new Address and associate it with the Customer specified by customerId */
  2564. createCustomerAddress: Address;
  2565. /** Create a new CustomerGroup */
  2566. createCustomerGroup: CustomerGroup;
  2567. /** Creates a draft Order */
  2568. createDraftOrder: Order;
  2569. /** Create a new Facet */
  2570. createFacet: Facet;
  2571. /** Create one or more FacetValues */
  2572. createFacetValues: Array<FacetValue>;
  2573. /** Create existing PaymentMethod */
  2574. createPaymentMethod: PaymentMethod;
  2575. /** Create a new Product */
  2576. createProduct: Product;
  2577. /** Create a new ProductOption within a ProductOptionGroup */
  2578. createProductOption: ProductOption;
  2579. /** Create a new ProductOptionGroup */
  2580. createProductOptionGroup: ProductOptionGroup;
  2581. /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
  2582. createProductVariants: Array<Maybe<ProductVariant>>;
  2583. createPromotion: CreatePromotionResult;
  2584. /** Create a new Province */
  2585. createProvince: Province;
  2586. /** Create a new Role */
  2587. createRole: Role;
  2588. /** Create a new Seller */
  2589. createSeller: Seller;
  2590. /** Create a new ShippingMethod */
  2591. createShippingMethod: ShippingMethod;
  2592. createStockLocation: StockLocation;
  2593. /** Create a new Tag */
  2594. createTag: Tag;
  2595. /** Create a new TaxCategory */
  2596. createTaxCategory: TaxCategory;
  2597. /** Create a new TaxRate */
  2598. createTaxRate: TaxRate;
  2599. /** Create a new Zone */
  2600. createZone: Zone;
  2601. /** Delete an Administrator */
  2602. deleteAdministrator: DeletionResponse;
  2603. /** Delete multiple Administrators */
  2604. deleteAdministrators: Array<DeletionResponse>;
  2605. /** Delete an Asset */
  2606. deleteAsset: DeletionResponse;
  2607. /** Delete multiple Assets */
  2608. deleteAssets: DeletionResponse;
  2609. /** Delete a Channel */
  2610. deleteChannel: DeletionResponse;
  2611. /** Delete multiple Channels */
  2612. deleteChannels: Array<DeletionResponse>;
  2613. /** Delete a Collection and all of its descendants */
  2614. deleteCollection: DeletionResponse;
  2615. /** Delete multiple Collections and all of their descendants */
  2616. deleteCollections: Array<DeletionResponse>;
  2617. /** Delete multiple Countries */
  2618. deleteCountries: Array<DeletionResponse>;
  2619. /** Delete a Country */
  2620. deleteCountry: DeletionResponse;
  2621. /** Delete a Customer */
  2622. deleteCustomer: DeletionResponse;
  2623. /** Update an existing Address */
  2624. deleteCustomerAddress: Success;
  2625. /** Delete a CustomerGroup */
  2626. deleteCustomerGroup: DeletionResponse;
  2627. /** Delete multiple CustomerGroups */
  2628. deleteCustomerGroups: Array<DeletionResponse>;
  2629. deleteCustomerNote: DeletionResponse;
  2630. /** Deletes Customers */
  2631. deleteCustomers: Array<DeletionResponse>;
  2632. /** Deletes a draft Order */
  2633. deleteDraftOrder: DeletionResponse;
  2634. /** Delete an existing Facet */
  2635. deleteFacet: DeletionResponse;
  2636. /** Delete one or more FacetValues */
  2637. deleteFacetValues: Array<DeletionResponse>;
  2638. /** Delete multiple existing Facets */
  2639. deleteFacets: Array<DeletionResponse>;
  2640. deleteOrderNote: DeletionResponse;
  2641. /** Delete a PaymentMethod */
  2642. deletePaymentMethod: DeletionResponse;
  2643. /** Delete multiple PaymentMethods */
  2644. deletePaymentMethods: Array<DeletionResponse>;
  2645. /** Delete a Product */
  2646. deleteProduct: DeletionResponse;
  2647. /** Delete a ProductOption */
  2648. deleteProductOption: DeletionResponse;
  2649. /** Delete a ProductVariant */
  2650. deleteProductVariant: DeletionResponse;
  2651. /** Delete multiple ProductVariants */
  2652. deleteProductVariants: Array<DeletionResponse>;
  2653. /** Delete multiple Products */
  2654. deleteProducts: Array<DeletionResponse>;
  2655. deletePromotion: DeletionResponse;
  2656. deletePromotions: Array<DeletionResponse>;
  2657. /** Delete a Province */
  2658. deleteProvince: DeletionResponse;
  2659. /** Delete an existing Role */
  2660. deleteRole: DeletionResponse;
  2661. /** Delete multiple Roles */
  2662. deleteRoles: Array<DeletionResponse>;
  2663. /** Delete a Seller */
  2664. deleteSeller: DeletionResponse;
  2665. /** Delete multiple Sellers */
  2666. deleteSellers: Array<DeletionResponse>;
  2667. /** Delete a ShippingMethod */
  2668. deleteShippingMethod: DeletionResponse;
  2669. /** Delete multiple ShippingMethods */
  2670. deleteShippingMethods: Array<DeletionResponse>;
  2671. deleteStockLocation: DeletionResponse;
  2672. deleteStockLocations: Array<DeletionResponse>;
  2673. /** Delete an existing Tag */
  2674. deleteTag: DeletionResponse;
  2675. /** Deletes multiple TaxCategories */
  2676. deleteTaxCategories: Array<DeletionResponse>;
  2677. /** Deletes a TaxCategory */
  2678. deleteTaxCategory: DeletionResponse;
  2679. /** Delete a TaxRate */
  2680. deleteTaxRate: DeletionResponse;
  2681. /** Delete multiple TaxRates */
  2682. deleteTaxRates: Array<DeletionResponse>;
  2683. /** Delete a Zone */
  2684. deleteZone: DeletionResponse;
  2685. /** Delete a Zone */
  2686. deleteZones: Array<DeletionResponse>;
  2687. /**
  2688. * Duplicate an existing entity using a specific EntityDuplicator.
  2689. * Since v2.2.0.
  2690. */
  2691. duplicateEntity: DuplicateEntityResult;
  2692. flushBufferedJobs: Success;
  2693. importProducts?: Maybe<ImportInfo>;
  2694. /**
  2695. * Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})
  2696. *
  2697. * The `rememberMe` option applies when using cookie-based sessions, and if `true` it will set the maxAge of the session cookie
  2698. * to 1 year.
  2699. */
  2700. login: NativeAuthenticationResult;
  2701. logout: Success;
  2702. /**
  2703. * Allows an Order to be modified after it has been completed by the Customer. The Order must first
  2704. * be in the `Modifying` state.
  2705. */
  2706. modifyOrder: ModifyOrderResult;
  2707. /** Move a Collection to a different parent or index */
  2708. moveCollection: Collection;
  2709. refundOrder: RefundOrderResult;
  2710. reindex: Job;
  2711. /** Removes Collections from the specified Channel */
  2712. removeCollectionsFromChannel: Array<Collection>;
  2713. /** Removes the given coupon code from the draft Order */
  2714. removeCouponCodeFromDraftOrder?: Maybe<Order>;
  2715. /** Remove Customers from a CustomerGroup */
  2716. removeCustomersFromGroup: CustomerGroup;
  2717. /** Remove an OrderLine from the draft Order */
  2718. removeDraftOrderLine: RemoveOrderItemsResult;
  2719. /** Removes Facets from the specified Channel */
  2720. removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
  2721. /** Remove members from a Zone */
  2722. removeMembersFromZone: Zone;
  2723. /**
  2724. * Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
  2725. * the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
  2726. * Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
  2727. * as well as removing any of the group's options from the Product's ProductVariants.
  2728. */
  2729. removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
  2730. /** Removes PaymentMethods from the specified Channel */
  2731. removePaymentMethodsFromChannel: Array<PaymentMethod>;
  2732. /** Removes ProductVariants from the specified Channel */
  2733. removeProductVariantsFromChannel: Array<ProductVariant>;
  2734. /** Removes all ProductVariants of Product from the specified Channel */
  2735. removeProductsFromChannel: Array<Product>;
  2736. /** Removes Promotions from the specified Channel */
  2737. removePromotionsFromChannel: Array<Promotion>;
  2738. /** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
  2739. removeSettledJobs: Scalars['Int']['output'];
  2740. /** Removes ShippingMethods from the specified Channel */
  2741. removeShippingMethodsFromChannel: Array<ShippingMethod>;
  2742. /** Removes StockLocations from the specified Channel */
  2743. removeStockLocationsFromChannel: Array<StockLocation>;
  2744. runPendingSearchIndexUpdates: Success;
  2745. setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
  2746. /** Sets the billing address for a draft Order */
  2747. setDraftOrderBillingAddress: Order;
  2748. /** Allows any custom fields to be set for the active order */
  2749. setDraftOrderCustomFields: Order;
  2750. /** Sets the shipping address for a draft Order */
  2751. setDraftOrderShippingAddress: Order;
  2752. /** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
  2753. setDraftOrderShippingMethod: SetOrderShippingMethodResult;
  2754. setOrderCustomFields?: Maybe<Order>;
  2755. /** Allows a different Customer to be assigned to an Order. Added in v2.2.0. */
  2756. setOrderCustomer?: Maybe<Order>;
  2757. settlePayment: SettlePaymentResult;
  2758. settleRefund: SettleRefundResult;
  2759. transitionFulfillmentToState: TransitionFulfillmentToStateResult;
  2760. transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
  2761. transitionPaymentToState: TransitionPaymentToStateResult;
  2762. /** Unsets the billing address for a draft Order */
  2763. unsetDraftOrderBillingAddress: Order;
  2764. /** Unsets the shipping address for a draft Order */
  2765. unsetDraftOrderShippingAddress: Order;
  2766. /** Update the active (currently logged-in) Administrator */
  2767. updateActiveAdministrator: Administrator;
  2768. /** Update an existing Administrator */
  2769. updateAdministrator: Administrator;
  2770. /** Update an existing Asset */
  2771. updateAsset: Asset;
  2772. /** Update an existing Channel */
  2773. updateChannel: UpdateChannelResult;
  2774. /** Update an existing Collection */
  2775. updateCollection: Collection;
  2776. /** Update an existing Country */
  2777. updateCountry: Country;
  2778. /** Update an existing Customer */
  2779. updateCustomer: UpdateCustomerResult;
  2780. /** Update an existing Address */
  2781. updateCustomerAddress: Address;
  2782. /** Update an existing CustomerGroup */
  2783. updateCustomerGroup: CustomerGroup;
  2784. updateCustomerNote: HistoryEntry;
  2785. /** Update an existing Facet */
  2786. updateFacet: Facet;
  2787. /** Update one or more FacetValues */
  2788. updateFacetValues: Array<FacetValue>;
  2789. updateGlobalSettings: UpdateGlobalSettingsResult;
  2790. updateOrderNote: HistoryEntry;
  2791. /** Update an existing PaymentMethod */
  2792. updatePaymentMethod: PaymentMethod;
  2793. /** Update an existing Product */
  2794. updateProduct: Product;
  2795. /** Create a new ProductOption within a ProductOptionGroup */
  2796. updateProductOption: ProductOption;
  2797. /** Update an existing ProductOptionGroup */
  2798. updateProductOptionGroup: ProductOptionGroup;
  2799. /** Update existing ProductVariants */
  2800. updateProductVariants: Array<Maybe<ProductVariant>>;
  2801. /** Update multiple existing Products */
  2802. updateProducts: Array<Product>;
  2803. updatePromotion: UpdatePromotionResult;
  2804. /** Update an existing Province */
  2805. updateProvince: Province;
  2806. /** Update an existing Role */
  2807. updateRole: Role;
  2808. /** Update an existing Seller */
  2809. updateSeller: Seller;
  2810. /** Update an existing ShippingMethod */
  2811. updateShippingMethod: ShippingMethod;
  2812. updateStockLocation: StockLocation;
  2813. /** Update an existing Tag */
  2814. updateTag: Tag;
  2815. /** Update an existing TaxCategory */
  2816. updateTaxCategory: TaxCategory;
  2817. /** Update an existing TaxRate */
  2818. updateTaxRate: TaxRate;
  2819. /** Update an existing Zone */
  2820. updateZone: Zone;
  2821. };
  2822. export type MutationAddCustomersToGroupArgs = {
  2823. customerGroupId: Scalars['ID']['input'];
  2824. customerIds: Array<Scalars['ID']['input']>;
  2825. };
  2826. export type MutationAddFulfillmentToOrderArgs = {
  2827. input: FulfillOrderInput;
  2828. };
  2829. export type MutationAddItemToDraftOrderArgs = {
  2830. input: AddItemToDraftOrderInput;
  2831. orderId: Scalars['ID']['input'];
  2832. };
  2833. export type MutationAddManualPaymentToOrderArgs = {
  2834. input: ManualPaymentInput;
  2835. };
  2836. export type MutationAddMembersToZoneArgs = {
  2837. memberIds: Array<Scalars['ID']['input']>;
  2838. zoneId: Scalars['ID']['input'];
  2839. };
  2840. export type MutationAddNoteToCustomerArgs = {
  2841. input: AddNoteToCustomerInput;
  2842. };
  2843. export type MutationAddNoteToOrderArgs = {
  2844. input: AddNoteToOrderInput;
  2845. };
  2846. export type MutationAddOptionGroupToProductArgs = {
  2847. optionGroupId: Scalars['ID']['input'];
  2848. productId: Scalars['ID']['input'];
  2849. };
  2850. export type MutationAdjustDraftOrderLineArgs = {
  2851. input: AdjustDraftOrderLineInput;
  2852. orderId: Scalars['ID']['input'];
  2853. };
  2854. export type MutationApplyCouponCodeToDraftOrderArgs = {
  2855. couponCode: Scalars['String']['input'];
  2856. orderId: Scalars['ID']['input'];
  2857. };
  2858. export type MutationAssignAssetsToChannelArgs = {
  2859. input: AssignAssetsToChannelInput;
  2860. };
  2861. export type MutationAssignCollectionsToChannelArgs = {
  2862. input: AssignCollectionsToChannelInput;
  2863. };
  2864. export type MutationAssignFacetsToChannelArgs = {
  2865. input: AssignFacetsToChannelInput;
  2866. };
  2867. export type MutationAssignPaymentMethodsToChannelArgs = {
  2868. input: AssignPaymentMethodsToChannelInput;
  2869. };
  2870. export type MutationAssignProductVariantsToChannelArgs = {
  2871. input: AssignProductVariantsToChannelInput;
  2872. };
  2873. export type MutationAssignProductsToChannelArgs = {
  2874. input: AssignProductsToChannelInput;
  2875. };
  2876. export type MutationAssignPromotionsToChannelArgs = {
  2877. input: AssignPromotionsToChannelInput;
  2878. };
  2879. export type MutationAssignRoleToAdministratorArgs = {
  2880. administratorId: Scalars['ID']['input'];
  2881. roleId: Scalars['ID']['input'];
  2882. };
  2883. export type MutationAssignShippingMethodsToChannelArgs = {
  2884. input: AssignShippingMethodsToChannelInput;
  2885. };
  2886. export type MutationAssignStockLocationsToChannelArgs = {
  2887. input: AssignStockLocationsToChannelInput;
  2888. };
  2889. export type MutationAuthenticateArgs = {
  2890. input: AuthenticationInput;
  2891. rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
  2892. };
  2893. export type MutationCancelJobArgs = {
  2894. jobId: Scalars['ID']['input'];
  2895. };
  2896. export type MutationCancelOrderArgs = {
  2897. input: CancelOrderInput;
  2898. };
  2899. export type MutationCancelPaymentArgs = {
  2900. id: Scalars['ID']['input'];
  2901. };
  2902. export type MutationCreateAdministratorArgs = {
  2903. input: CreateAdministratorInput;
  2904. };
  2905. export type MutationCreateAssetsArgs = {
  2906. input: Array<CreateAssetInput>;
  2907. };
  2908. export type MutationCreateChannelArgs = {
  2909. input: CreateChannelInput;
  2910. };
  2911. export type MutationCreateCollectionArgs = {
  2912. input: CreateCollectionInput;
  2913. };
  2914. export type MutationCreateCountryArgs = {
  2915. input: CreateCountryInput;
  2916. };
  2917. export type MutationCreateCustomerArgs = {
  2918. input: CreateCustomerInput;
  2919. password?: InputMaybe<Scalars['String']['input']>;
  2920. };
  2921. export type MutationCreateCustomerAddressArgs = {
  2922. customerId: Scalars['ID']['input'];
  2923. input: CreateAddressInput;
  2924. };
  2925. export type MutationCreateCustomerGroupArgs = {
  2926. input: CreateCustomerGroupInput;
  2927. };
  2928. export type MutationCreateFacetArgs = {
  2929. input: CreateFacetInput;
  2930. };
  2931. export type MutationCreateFacetValuesArgs = {
  2932. input: Array<CreateFacetValueInput>;
  2933. };
  2934. export type MutationCreatePaymentMethodArgs = {
  2935. input: CreatePaymentMethodInput;
  2936. };
  2937. export type MutationCreateProductArgs = {
  2938. input: CreateProductInput;
  2939. };
  2940. export type MutationCreateProductOptionArgs = {
  2941. input: CreateProductOptionInput;
  2942. };
  2943. export type MutationCreateProductOptionGroupArgs = {
  2944. input: CreateProductOptionGroupInput;
  2945. };
  2946. export type MutationCreateProductVariantsArgs = {
  2947. input: Array<CreateProductVariantInput>;
  2948. };
  2949. export type MutationCreatePromotionArgs = {
  2950. input: CreatePromotionInput;
  2951. };
  2952. export type MutationCreateProvinceArgs = {
  2953. input: CreateProvinceInput;
  2954. };
  2955. export type MutationCreateRoleArgs = {
  2956. input: CreateRoleInput;
  2957. };
  2958. export type MutationCreateSellerArgs = {
  2959. input: CreateSellerInput;
  2960. };
  2961. export type MutationCreateShippingMethodArgs = {
  2962. input: CreateShippingMethodInput;
  2963. };
  2964. export type MutationCreateStockLocationArgs = {
  2965. input: CreateStockLocationInput;
  2966. };
  2967. export type MutationCreateTagArgs = {
  2968. input: CreateTagInput;
  2969. };
  2970. export type MutationCreateTaxCategoryArgs = {
  2971. input: CreateTaxCategoryInput;
  2972. };
  2973. export type MutationCreateTaxRateArgs = {
  2974. input: CreateTaxRateInput;
  2975. };
  2976. export type MutationCreateZoneArgs = {
  2977. input: CreateZoneInput;
  2978. };
  2979. export type MutationDeleteAdministratorArgs = {
  2980. id: Scalars['ID']['input'];
  2981. };
  2982. export type MutationDeleteAdministratorsArgs = {
  2983. ids: Array<Scalars['ID']['input']>;
  2984. };
  2985. export type MutationDeleteAssetArgs = {
  2986. input: DeleteAssetInput;
  2987. };
  2988. export type MutationDeleteAssetsArgs = {
  2989. input: DeleteAssetsInput;
  2990. };
  2991. export type MutationDeleteChannelArgs = {
  2992. id: Scalars['ID']['input'];
  2993. };
  2994. export type MutationDeleteChannelsArgs = {
  2995. ids: Array<Scalars['ID']['input']>;
  2996. };
  2997. export type MutationDeleteCollectionArgs = {
  2998. id: Scalars['ID']['input'];
  2999. };
  3000. export type MutationDeleteCollectionsArgs = {
  3001. ids: Array<Scalars['ID']['input']>;
  3002. };
  3003. export type MutationDeleteCountriesArgs = {
  3004. ids: Array<Scalars['ID']['input']>;
  3005. };
  3006. export type MutationDeleteCountryArgs = {
  3007. id: Scalars['ID']['input'];
  3008. };
  3009. export type MutationDeleteCustomerArgs = {
  3010. id: Scalars['ID']['input'];
  3011. };
  3012. export type MutationDeleteCustomerAddressArgs = {
  3013. id: Scalars['ID']['input'];
  3014. };
  3015. export type MutationDeleteCustomerGroupArgs = {
  3016. id: Scalars['ID']['input'];
  3017. };
  3018. export type MutationDeleteCustomerGroupsArgs = {
  3019. ids: Array<Scalars['ID']['input']>;
  3020. };
  3021. export type MutationDeleteCustomerNoteArgs = {
  3022. id: Scalars['ID']['input'];
  3023. };
  3024. export type MutationDeleteCustomersArgs = {
  3025. ids: Array<Scalars['ID']['input']>;
  3026. };
  3027. export type MutationDeleteDraftOrderArgs = {
  3028. orderId: Scalars['ID']['input'];
  3029. };
  3030. export type MutationDeleteFacetArgs = {
  3031. force?: InputMaybe<Scalars['Boolean']['input']>;
  3032. id: Scalars['ID']['input'];
  3033. };
  3034. export type MutationDeleteFacetValuesArgs = {
  3035. force?: InputMaybe<Scalars['Boolean']['input']>;
  3036. ids: Array<Scalars['ID']['input']>;
  3037. };
  3038. export type MutationDeleteFacetsArgs = {
  3039. force?: InputMaybe<Scalars['Boolean']['input']>;
  3040. ids: Array<Scalars['ID']['input']>;
  3041. };
  3042. export type MutationDeleteOrderNoteArgs = {
  3043. id: Scalars['ID']['input'];
  3044. };
  3045. export type MutationDeletePaymentMethodArgs = {
  3046. force?: InputMaybe<Scalars['Boolean']['input']>;
  3047. id: Scalars['ID']['input'];
  3048. };
  3049. export type MutationDeletePaymentMethodsArgs = {
  3050. force?: InputMaybe<Scalars['Boolean']['input']>;
  3051. ids: Array<Scalars['ID']['input']>;
  3052. };
  3053. export type MutationDeleteProductArgs = {
  3054. id: Scalars['ID']['input'];
  3055. };
  3056. export type MutationDeleteProductOptionArgs = {
  3057. id: Scalars['ID']['input'];
  3058. };
  3059. export type MutationDeleteProductVariantArgs = {
  3060. id: Scalars['ID']['input'];
  3061. };
  3062. export type MutationDeleteProductVariantsArgs = {
  3063. ids: Array<Scalars['ID']['input']>;
  3064. };
  3065. export type MutationDeleteProductsArgs = {
  3066. ids: Array<Scalars['ID']['input']>;
  3067. };
  3068. export type MutationDeletePromotionArgs = {
  3069. id: Scalars['ID']['input'];
  3070. };
  3071. export type MutationDeletePromotionsArgs = {
  3072. ids: Array<Scalars['ID']['input']>;
  3073. };
  3074. export type MutationDeleteProvinceArgs = {
  3075. id: Scalars['ID']['input'];
  3076. };
  3077. export type MutationDeleteRoleArgs = {
  3078. id: Scalars['ID']['input'];
  3079. };
  3080. export type MutationDeleteRolesArgs = {
  3081. ids: Array<Scalars['ID']['input']>;
  3082. };
  3083. export type MutationDeleteSellerArgs = {
  3084. id: Scalars['ID']['input'];
  3085. };
  3086. export type MutationDeleteSellersArgs = {
  3087. ids: Array<Scalars['ID']['input']>;
  3088. };
  3089. export type MutationDeleteShippingMethodArgs = {
  3090. id: Scalars['ID']['input'];
  3091. };
  3092. export type MutationDeleteShippingMethodsArgs = {
  3093. ids: Array<Scalars['ID']['input']>;
  3094. };
  3095. export type MutationDeleteStockLocationArgs = {
  3096. input: DeleteStockLocationInput;
  3097. };
  3098. export type MutationDeleteStockLocationsArgs = {
  3099. input: Array<DeleteStockLocationInput>;
  3100. };
  3101. export type MutationDeleteTagArgs = {
  3102. id: Scalars['ID']['input'];
  3103. };
  3104. export type MutationDeleteTaxCategoriesArgs = {
  3105. ids: Array<Scalars['ID']['input']>;
  3106. };
  3107. export type MutationDeleteTaxCategoryArgs = {
  3108. id: Scalars['ID']['input'];
  3109. };
  3110. export type MutationDeleteTaxRateArgs = {
  3111. id: Scalars['ID']['input'];
  3112. };
  3113. export type MutationDeleteTaxRatesArgs = {
  3114. ids: Array<Scalars['ID']['input']>;
  3115. };
  3116. export type MutationDeleteZoneArgs = {
  3117. id: Scalars['ID']['input'];
  3118. };
  3119. export type MutationDeleteZonesArgs = {
  3120. ids: Array<Scalars['ID']['input']>;
  3121. };
  3122. export type MutationDuplicateEntityArgs = {
  3123. input: DuplicateEntityInput;
  3124. };
  3125. export type MutationFlushBufferedJobsArgs = {
  3126. bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
  3127. };
  3128. export type MutationImportProductsArgs = {
  3129. csvFile: Scalars['Upload']['input'];
  3130. };
  3131. export type MutationLoginArgs = {
  3132. password: Scalars['String']['input'];
  3133. rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
  3134. username: Scalars['String']['input'];
  3135. };
  3136. export type MutationModifyOrderArgs = {
  3137. input: ModifyOrderInput;
  3138. };
  3139. export type MutationMoveCollectionArgs = {
  3140. input: MoveCollectionInput;
  3141. };
  3142. export type MutationRefundOrderArgs = {
  3143. input: RefundOrderInput;
  3144. };
  3145. export type MutationRemoveCollectionsFromChannelArgs = {
  3146. input: RemoveCollectionsFromChannelInput;
  3147. };
  3148. export type MutationRemoveCouponCodeFromDraftOrderArgs = {
  3149. couponCode: Scalars['String']['input'];
  3150. orderId: Scalars['ID']['input'];
  3151. };
  3152. export type MutationRemoveCustomersFromGroupArgs = {
  3153. customerGroupId: Scalars['ID']['input'];
  3154. customerIds: Array<Scalars['ID']['input']>;
  3155. };
  3156. export type MutationRemoveDraftOrderLineArgs = {
  3157. orderId: Scalars['ID']['input'];
  3158. orderLineId: Scalars['ID']['input'];
  3159. };
  3160. export type MutationRemoveFacetsFromChannelArgs = {
  3161. input: RemoveFacetsFromChannelInput;
  3162. };
  3163. export type MutationRemoveMembersFromZoneArgs = {
  3164. memberIds: Array<Scalars['ID']['input']>;
  3165. zoneId: Scalars['ID']['input'];
  3166. };
  3167. export type MutationRemoveOptionGroupFromProductArgs = {
  3168. force?: InputMaybe<Scalars['Boolean']['input']>;
  3169. optionGroupId: Scalars['ID']['input'];
  3170. productId: Scalars['ID']['input'];
  3171. };
  3172. export type MutationRemovePaymentMethodsFromChannelArgs = {
  3173. input: RemovePaymentMethodsFromChannelInput;
  3174. };
  3175. export type MutationRemoveProductVariantsFromChannelArgs = {
  3176. input: RemoveProductVariantsFromChannelInput;
  3177. };
  3178. export type MutationRemoveProductsFromChannelArgs = {
  3179. input: RemoveProductsFromChannelInput;
  3180. };
  3181. export type MutationRemovePromotionsFromChannelArgs = {
  3182. input: RemovePromotionsFromChannelInput;
  3183. };
  3184. export type MutationRemoveSettledJobsArgs = {
  3185. olderThan?: InputMaybe<Scalars['DateTime']['input']>;
  3186. queueNames?: InputMaybe<Array<Scalars['String']['input']>>;
  3187. };
  3188. export type MutationRemoveShippingMethodsFromChannelArgs = {
  3189. input: RemoveShippingMethodsFromChannelInput;
  3190. };
  3191. export type MutationRemoveStockLocationsFromChannelArgs = {
  3192. input: RemoveStockLocationsFromChannelInput;
  3193. };
  3194. export type MutationSetCustomerForDraftOrderArgs = {
  3195. customerId?: InputMaybe<Scalars['ID']['input']>;
  3196. input?: InputMaybe<CreateCustomerInput>;
  3197. orderId: Scalars['ID']['input'];
  3198. };
  3199. export type MutationSetDraftOrderBillingAddressArgs = {
  3200. input: CreateAddressInput;
  3201. orderId: Scalars['ID']['input'];
  3202. };
  3203. export type MutationSetDraftOrderCustomFieldsArgs = {
  3204. input: UpdateOrderInput;
  3205. orderId: Scalars['ID']['input'];
  3206. };
  3207. export type MutationSetDraftOrderShippingAddressArgs = {
  3208. input: CreateAddressInput;
  3209. orderId: Scalars['ID']['input'];
  3210. };
  3211. export type MutationSetDraftOrderShippingMethodArgs = {
  3212. orderId: Scalars['ID']['input'];
  3213. shippingMethodId: Scalars['ID']['input'];
  3214. };
  3215. export type MutationSetOrderCustomFieldsArgs = {
  3216. input: UpdateOrderInput;
  3217. };
  3218. export type MutationSetOrderCustomerArgs = {
  3219. input: SetOrderCustomerInput;
  3220. };
  3221. export type MutationSettlePaymentArgs = {
  3222. id: Scalars['ID']['input'];
  3223. };
  3224. export type MutationSettleRefundArgs = {
  3225. input: SettleRefundInput;
  3226. };
  3227. export type MutationTransitionFulfillmentToStateArgs = {
  3228. id: Scalars['ID']['input'];
  3229. state: Scalars['String']['input'];
  3230. };
  3231. export type MutationTransitionOrderToStateArgs = {
  3232. id: Scalars['ID']['input'];
  3233. state: Scalars['String']['input'];
  3234. };
  3235. export type MutationTransitionPaymentToStateArgs = {
  3236. id: Scalars['ID']['input'];
  3237. state: Scalars['String']['input'];
  3238. };
  3239. export type MutationUnsetDraftOrderBillingAddressArgs = {
  3240. orderId: Scalars['ID']['input'];
  3241. };
  3242. export type MutationUnsetDraftOrderShippingAddressArgs = {
  3243. orderId: Scalars['ID']['input'];
  3244. };
  3245. export type MutationUpdateActiveAdministratorArgs = {
  3246. input: UpdateActiveAdministratorInput;
  3247. };
  3248. export type MutationUpdateAdministratorArgs = {
  3249. input: UpdateAdministratorInput;
  3250. };
  3251. export type MutationUpdateAssetArgs = {
  3252. input: UpdateAssetInput;
  3253. };
  3254. export type MutationUpdateChannelArgs = {
  3255. input: UpdateChannelInput;
  3256. };
  3257. export type MutationUpdateCollectionArgs = {
  3258. input: UpdateCollectionInput;
  3259. };
  3260. export type MutationUpdateCountryArgs = {
  3261. input: UpdateCountryInput;
  3262. };
  3263. export type MutationUpdateCustomerArgs = {
  3264. input: UpdateCustomerInput;
  3265. };
  3266. export type MutationUpdateCustomerAddressArgs = {
  3267. input: UpdateAddressInput;
  3268. };
  3269. export type MutationUpdateCustomerGroupArgs = {
  3270. input: UpdateCustomerGroupInput;
  3271. };
  3272. export type MutationUpdateCustomerNoteArgs = {
  3273. input: UpdateCustomerNoteInput;
  3274. };
  3275. export type MutationUpdateFacetArgs = {
  3276. input: UpdateFacetInput;
  3277. };
  3278. export type MutationUpdateFacetValuesArgs = {
  3279. input: Array<UpdateFacetValueInput>;
  3280. };
  3281. export type MutationUpdateGlobalSettingsArgs = {
  3282. input: UpdateGlobalSettingsInput;
  3283. };
  3284. export type MutationUpdateOrderNoteArgs = {
  3285. input: UpdateOrderNoteInput;
  3286. };
  3287. export type MutationUpdatePaymentMethodArgs = {
  3288. input: UpdatePaymentMethodInput;
  3289. };
  3290. export type MutationUpdateProductArgs = {
  3291. input: UpdateProductInput;
  3292. };
  3293. export type MutationUpdateProductOptionArgs = {
  3294. input: UpdateProductOptionInput;
  3295. };
  3296. export type MutationUpdateProductOptionGroupArgs = {
  3297. input: UpdateProductOptionGroupInput;
  3298. };
  3299. export type MutationUpdateProductVariantsArgs = {
  3300. input: Array<UpdateProductVariantInput>;
  3301. };
  3302. export type MutationUpdateProductsArgs = {
  3303. input: Array<UpdateProductInput>;
  3304. };
  3305. export type MutationUpdatePromotionArgs = {
  3306. input: UpdatePromotionInput;
  3307. };
  3308. export type MutationUpdateProvinceArgs = {
  3309. input: UpdateProvinceInput;
  3310. };
  3311. export type MutationUpdateRoleArgs = {
  3312. input: UpdateRoleInput;
  3313. };
  3314. export type MutationUpdateSellerArgs = {
  3315. input: UpdateSellerInput;
  3316. };
  3317. export type MutationUpdateShippingMethodArgs = {
  3318. input: UpdateShippingMethodInput;
  3319. };
  3320. export type MutationUpdateStockLocationArgs = {
  3321. input: UpdateStockLocationInput;
  3322. };
  3323. export type MutationUpdateTagArgs = {
  3324. input: UpdateTagInput;
  3325. };
  3326. export type MutationUpdateTaxCategoryArgs = {
  3327. input: UpdateTaxCategoryInput;
  3328. };
  3329. export type MutationUpdateTaxRateArgs = {
  3330. input: UpdateTaxRateInput;
  3331. };
  3332. export type MutationUpdateZoneArgs = {
  3333. input: UpdateZoneInput;
  3334. };
  3335. export type NativeAuthInput = {
  3336. password: Scalars['String']['input'];
  3337. username: Scalars['String']['input'];
  3338. };
  3339. /** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
  3340. export type NativeAuthStrategyError = ErrorResult & {
  3341. __typename?: 'NativeAuthStrategyError';
  3342. errorCode: ErrorCode;
  3343. message: Scalars['String']['output'];
  3344. };
  3345. export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
  3346. /** Returned when attempting to set a negative OrderLine quantity. */
  3347. export type NegativeQuantityError = ErrorResult & {
  3348. __typename?: 'NegativeQuantityError';
  3349. errorCode: ErrorCode;
  3350. message: Scalars['String']['output'];
  3351. };
  3352. /**
  3353. * Returned when invoking a mutation which depends on there being an active Order on the
  3354. * current session.
  3355. */
  3356. export type NoActiveOrderError = ErrorResult & {
  3357. __typename?: 'NoActiveOrderError';
  3358. errorCode: ErrorCode;
  3359. message: Scalars['String']['output'];
  3360. };
  3361. /** Returned when a call to modifyOrder fails to specify any changes */
  3362. export type NoChangesSpecifiedError = ErrorResult & {
  3363. __typename?: 'NoChangesSpecifiedError';
  3364. errorCode: ErrorCode;
  3365. message: Scalars['String']['output'];
  3366. };
  3367. export type Node = {
  3368. id: Scalars['ID']['output'];
  3369. };
  3370. /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
  3371. export type NothingToRefundError = ErrorResult & {
  3372. __typename?: 'NothingToRefundError';
  3373. errorCode: ErrorCode;
  3374. message: Scalars['String']['output'];
  3375. };
  3376. /** Operators for filtering on a list of Number fields */
  3377. export type NumberListOperators = {
  3378. inList: Scalars['Float']['input'];
  3379. };
  3380. /** Operators for filtering on a Int or Float field */
  3381. export type NumberOperators = {
  3382. between?: InputMaybe<NumberRange>;
  3383. eq?: InputMaybe<Scalars['Float']['input']>;
  3384. gt?: InputMaybe<Scalars['Float']['input']>;
  3385. gte?: InputMaybe<Scalars['Float']['input']>;
  3386. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  3387. lt?: InputMaybe<Scalars['Float']['input']>;
  3388. lte?: InputMaybe<Scalars['Float']['input']>;
  3389. };
  3390. export type NumberRange = {
  3391. end: Scalars['Float']['input'];
  3392. start: Scalars['Float']['input'];
  3393. };
  3394. export type Order = Node & {
  3395. __typename?: 'Order';
  3396. /** An order is active as long as the payment process has not been completed */
  3397. active: Scalars['Boolean']['output'];
  3398. aggregateOrder?: Maybe<Order>;
  3399. aggregateOrderId?: Maybe<Scalars['ID']['output']>;
  3400. billingAddress?: Maybe<OrderAddress>;
  3401. channels: Array<Channel>;
  3402. /** A unique code for the Order */
  3403. code: Scalars['String']['output'];
  3404. /** An array of all coupon codes applied to the Order */
  3405. couponCodes: Array<Scalars['String']['output']>;
  3406. createdAt: Scalars['DateTime']['output'];
  3407. currencyCode: CurrencyCode;
  3408. customFields?: Maybe<Scalars['JSON']['output']>;
  3409. customer?: Maybe<Customer>;
  3410. discounts: Array<Discount>;
  3411. fulfillments?: Maybe<Array<Fulfillment>>;
  3412. history: HistoryEntryList;
  3413. id: Scalars['ID']['output'];
  3414. lines: Array<OrderLine>;
  3415. modifications: Array<OrderModification>;
  3416. nextStates: Array<Scalars['String']['output']>;
  3417. /**
  3418. * The date & time that the Order was placed, i.e. the Customer
  3419. * completed the checkout and the Order is no longer "active"
  3420. */
  3421. orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
  3422. payments?: Maybe<Array<Payment>>;
  3423. /** Promotions applied to the order. Only gets populated after the payment process has completed. */
  3424. promotions: Array<Promotion>;
  3425. sellerOrders?: Maybe<Array<Order>>;
  3426. shipping: Scalars['Money']['output'];
  3427. shippingAddress?: Maybe<OrderAddress>;
  3428. shippingLines: Array<ShippingLine>;
  3429. shippingWithTax: Scalars['Money']['output'];
  3430. state: Scalars['String']['output'];
  3431. /**
  3432. * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  3433. * discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
  3434. * To get a total of all OrderLines which does not account for prorated discounts, use the
  3435. * sum of `OrderLine.discountedLinePrice` values.
  3436. */
  3437. subTotal: Scalars['Money']['output'];
  3438. /** Same as subTotal, but inclusive of tax */
  3439. subTotalWithTax: Scalars['Money']['output'];
  3440. /**
  3441. * Surcharges are arbitrary modifications to the Order total which are neither
  3442. * ProductVariants nor discounts resulting from applied Promotions. For example,
  3443. * one-off discounts based on customer interaction, or surcharges based on payment
  3444. * methods.
  3445. */
  3446. surcharges: Array<Surcharge>;
  3447. /** A summary of the taxes being applied to this Order */
  3448. taxSummary: Array<OrderTaxSummary>;
  3449. /** Equal to subTotal plus shipping */
  3450. total: Scalars['Money']['output'];
  3451. totalQuantity: Scalars['Int']['output'];
  3452. /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
  3453. totalWithTax: Scalars['Money']['output'];
  3454. type: OrderType;
  3455. updatedAt: Scalars['DateTime']['output'];
  3456. };
  3457. export type OrderHistoryArgs = {
  3458. options?: InputMaybe<HistoryEntryListOptions>;
  3459. };
  3460. export type OrderAddress = {
  3461. __typename?: 'OrderAddress';
  3462. city?: Maybe<Scalars['String']['output']>;
  3463. company?: Maybe<Scalars['String']['output']>;
  3464. country?: Maybe<Scalars['String']['output']>;
  3465. countryCode?: Maybe<Scalars['String']['output']>;
  3466. customFields?: Maybe<Scalars['JSON']['output']>;
  3467. fullName?: Maybe<Scalars['String']['output']>;
  3468. phoneNumber?: Maybe<Scalars['String']['output']>;
  3469. postalCode?: Maybe<Scalars['String']['output']>;
  3470. province?: Maybe<Scalars['String']['output']>;
  3471. streetLine1?: Maybe<Scalars['String']['output']>;
  3472. streetLine2?: Maybe<Scalars['String']['output']>;
  3473. };
  3474. export type OrderFilterParameter = {
  3475. _and?: InputMaybe<Array<OrderFilterParameter>>;
  3476. _or?: InputMaybe<Array<OrderFilterParameter>>;
  3477. active?: InputMaybe<BooleanOperators>;
  3478. aggregateOrderId?: InputMaybe<IdOperators>;
  3479. code?: InputMaybe<StringOperators>;
  3480. createdAt?: InputMaybe<DateOperators>;
  3481. currencyCode?: InputMaybe<StringOperators>;
  3482. customerLastName?: InputMaybe<StringOperators>;
  3483. id?: InputMaybe<IdOperators>;
  3484. orderPlacedAt?: InputMaybe<DateOperators>;
  3485. shipping?: InputMaybe<NumberOperators>;
  3486. shippingWithTax?: InputMaybe<NumberOperators>;
  3487. state?: InputMaybe<StringOperators>;
  3488. subTotal?: InputMaybe<NumberOperators>;
  3489. subTotalWithTax?: InputMaybe<NumberOperators>;
  3490. total?: InputMaybe<NumberOperators>;
  3491. totalQuantity?: InputMaybe<NumberOperators>;
  3492. totalWithTax?: InputMaybe<NumberOperators>;
  3493. transactionId?: InputMaybe<StringOperators>;
  3494. type?: InputMaybe<StringOperators>;
  3495. updatedAt?: InputMaybe<DateOperators>;
  3496. };
  3497. /** Returned when an order operation is rejected by an OrderInterceptor method. */
  3498. export type OrderInterceptorError = ErrorResult & {
  3499. __typename?: 'OrderInterceptorError';
  3500. errorCode: ErrorCode;
  3501. interceptorError: Scalars['String']['output'];
  3502. message: Scalars['String']['output'];
  3503. };
  3504. /** Returned when the maximum order size limit has been reached. */
  3505. export type OrderLimitError = ErrorResult & {
  3506. __typename?: 'OrderLimitError';
  3507. errorCode: ErrorCode;
  3508. maxItems: Scalars['Int']['output'];
  3509. message: Scalars['String']['output'];
  3510. };
  3511. export type OrderLine = Node & {
  3512. __typename?: 'OrderLine';
  3513. createdAt: Scalars['DateTime']['output'];
  3514. customFields?: Maybe<Scalars['JSON']['output']>;
  3515. /** The price of the line including discounts, excluding tax */
  3516. discountedLinePrice: Scalars['Money']['output'];
  3517. /** The price of the line including discounts and tax */
  3518. discountedLinePriceWithTax: Scalars['Money']['output'];
  3519. /**
  3520. * The price of a single unit including discounts, excluding tax.
  3521. *
  3522. * If Order-level discounts have been applied, this will not be the
  3523. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  3524. * correct price to display to customers to avoid confusion
  3525. * about the internal handling of distributed Order-level discounts.
  3526. */
  3527. discountedUnitPrice: Scalars['Money']['output'];
  3528. /** The price of a single unit including discounts and tax */
  3529. discountedUnitPriceWithTax: Scalars['Money']['output'];
  3530. discounts: Array<Discount>;
  3531. featuredAsset?: Maybe<Asset>;
  3532. fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
  3533. id: Scalars['ID']['output'];
  3534. /** The total price of the line excluding tax and discounts. */
  3535. linePrice: Scalars['Money']['output'];
  3536. /** The total price of the line including tax but excluding discounts. */
  3537. linePriceWithTax: Scalars['Money']['output'];
  3538. /** The total tax on this line */
  3539. lineTax: Scalars['Money']['output'];
  3540. order: Order;
  3541. /** The quantity at the time the Order was placed */
  3542. orderPlacedQuantity: Scalars['Int']['output'];
  3543. productVariant: ProductVariant;
  3544. /**
  3545. * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3546. * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
  3547. * and refund calculations.
  3548. */
  3549. proratedLinePrice: Scalars['Money']['output'];
  3550. /** The proratedLinePrice including tax */
  3551. proratedLinePriceWithTax: Scalars['Money']['output'];
  3552. /**
  3553. * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3554. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  3555. * and refund calculations.
  3556. */
  3557. proratedUnitPrice: Scalars['Money']['output'];
  3558. /** The proratedUnitPrice including tax */
  3559. proratedUnitPriceWithTax: Scalars['Money']['output'];
  3560. /** The quantity of items purchased */
  3561. quantity: Scalars['Int']['output'];
  3562. taxLines: Array<TaxLine>;
  3563. taxRate: Scalars['Float']['output'];
  3564. /** The price of a single unit, excluding tax and discounts */
  3565. unitPrice: Scalars['Money']['output'];
  3566. /** Non-zero if the unitPrice has changed since it was initially added to Order */
  3567. unitPriceChangeSinceAdded: Scalars['Money']['output'];
  3568. /** The price of a single unit, including tax but excluding discounts */
  3569. unitPriceWithTax: Scalars['Money']['output'];
  3570. /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
  3571. unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
  3572. updatedAt: Scalars['DateTime']['output'];
  3573. };
  3574. export type OrderLineInput = {
  3575. orderLineId: Scalars['ID']['input'];
  3576. quantity: Scalars['Int']['input'];
  3577. };
  3578. export type OrderList = PaginatedList & {
  3579. __typename?: 'OrderList';
  3580. items: Array<Order>;
  3581. totalItems: Scalars['Int']['output'];
  3582. };
  3583. export type OrderListOptions = {
  3584. /** Allows the results to be filtered */
  3585. filter?: InputMaybe<OrderFilterParameter>;
  3586. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  3587. filterOperator?: InputMaybe<LogicalOperator>;
  3588. /** Skips the first n results, for use in pagination */
  3589. skip?: InputMaybe<Scalars['Int']['input']>;
  3590. /** Specifies which properties to sort the results by */
  3591. sort?: InputMaybe<OrderSortParameter>;
  3592. /** Takes n results, for use in pagination */
  3593. take?: InputMaybe<Scalars['Int']['input']>;
  3594. };
  3595. export type OrderModification = Node & {
  3596. __typename?: 'OrderModification';
  3597. createdAt: Scalars['DateTime']['output'];
  3598. id: Scalars['ID']['output'];
  3599. isSettled: Scalars['Boolean']['output'];
  3600. lines: Array<OrderModificationLine>;
  3601. note: Scalars['String']['output'];
  3602. payment?: Maybe<Payment>;
  3603. priceChange: Scalars['Money']['output'];
  3604. refund?: Maybe<Refund>;
  3605. surcharges?: Maybe<Array<Surcharge>>;
  3606. updatedAt: Scalars['DateTime']['output'];
  3607. };
  3608. /** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
  3609. export type OrderModificationError = ErrorResult & {
  3610. __typename?: 'OrderModificationError';
  3611. errorCode: ErrorCode;
  3612. message: Scalars['String']['output'];
  3613. };
  3614. export type OrderModificationLine = {
  3615. __typename?: 'OrderModificationLine';
  3616. modification: OrderModification;
  3617. modificationId: Scalars['ID']['output'];
  3618. orderLine: OrderLine;
  3619. orderLineId: Scalars['ID']['output'];
  3620. quantity: Scalars['Int']['output'];
  3621. };
  3622. /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
  3623. export type OrderModificationStateError = ErrorResult & {
  3624. __typename?: 'OrderModificationStateError';
  3625. errorCode: ErrorCode;
  3626. message: Scalars['String']['output'];
  3627. };
  3628. export type OrderProcessState = {
  3629. __typename?: 'OrderProcessState';
  3630. name: Scalars['String']['output'];
  3631. to: Array<Scalars['String']['output']>;
  3632. };
  3633. export type OrderSortParameter = {
  3634. aggregateOrderId?: InputMaybe<SortOrder>;
  3635. code?: InputMaybe<SortOrder>;
  3636. createdAt?: InputMaybe<SortOrder>;
  3637. customerLastName?: InputMaybe<SortOrder>;
  3638. id?: InputMaybe<SortOrder>;
  3639. orderPlacedAt?: InputMaybe<SortOrder>;
  3640. shipping?: InputMaybe<SortOrder>;
  3641. shippingWithTax?: InputMaybe<SortOrder>;
  3642. state?: InputMaybe<SortOrder>;
  3643. subTotal?: InputMaybe<SortOrder>;
  3644. subTotalWithTax?: InputMaybe<SortOrder>;
  3645. total?: InputMaybe<SortOrder>;
  3646. totalQuantity?: InputMaybe<SortOrder>;
  3647. totalWithTax?: InputMaybe<SortOrder>;
  3648. transactionId?: InputMaybe<SortOrder>;
  3649. updatedAt?: InputMaybe<SortOrder>;
  3650. };
  3651. /** Returned if there is an error in transitioning the Order state */
  3652. export type OrderStateTransitionError = ErrorResult & {
  3653. __typename?: 'OrderStateTransitionError';
  3654. errorCode: ErrorCode;
  3655. fromState: Scalars['String']['output'];
  3656. message: Scalars['String']['output'];
  3657. toState: Scalars['String']['output'];
  3658. transitionError: Scalars['String']['output'];
  3659. };
  3660. /**
  3661. * A summary of the taxes being applied to this order, grouped
  3662. * by taxRate.
  3663. */
  3664. export type OrderTaxSummary = {
  3665. __typename?: 'OrderTaxSummary';
  3666. /** A description of this tax */
  3667. description: Scalars['String']['output'];
  3668. /** The total net price of OrderLines to which this taxRate applies */
  3669. taxBase: Scalars['Money']['output'];
  3670. /** The taxRate as a percentage */
  3671. taxRate: Scalars['Float']['output'];
  3672. /** The total tax being applied to the Order at this taxRate */
  3673. taxTotal: Scalars['Money']['output'];
  3674. };
  3675. export enum OrderType {
  3676. Aggregate = 'Aggregate',
  3677. Regular = 'Regular',
  3678. Seller = 'Seller'
  3679. }
  3680. export type PaginatedList = {
  3681. items: Array<Node>;
  3682. totalItems: Scalars['Int']['output'];
  3683. };
  3684. export type Payment = Node & {
  3685. __typename?: 'Payment';
  3686. amount: Scalars['Money']['output'];
  3687. createdAt: Scalars['DateTime']['output'];
  3688. customFields?: Maybe<Scalars['JSON']['output']>;
  3689. errorMessage?: Maybe<Scalars['String']['output']>;
  3690. id: Scalars['ID']['output'];
  3691. metadata?: Maybe<Scalars['JSON']['output']>;
  3692. method: Scalars['String']['output'];
  3693. nextStates: Array<Scalars['String']['output']>;
  3694. refunds: Array<Refund>;
  3695. state: Scalars['String']['output'];
  3696. transactionId?: Maybe<Scalars['String']['output']>;
  3697. updatedAt: Scalars['DateTime']['output'];
  3698. };
  3699. export type PaymentMethod = Node & {
  3700. __typename?: 'PaymentMethod';
  3701. checker?: Maybe<ConfigurableOperation>;
  3702. code: Scalars['String']['output'];
  3703. createdAt: Scalars['DateTime']['output'];
  3704. customFields?: Maybe<Scalars['JSON']['output']>;
  3705. description: Scalars['String']['output'];
  3706. enabled: Scalars['Boolean']['output'];
  3707. handler: ConfigurableOperation;
  3708. id: Scalars['ID']['output'];
  3709. name: Scalars['String']['output'];
  3710. translations: Array<PaymentMethodTranslation>;
  3711. updatedAt: Scalars['DateTime']['output'];
  3712. };
  3713. export type PaymentMethodFilterParameter = {
  3714. _and?: InputMaybe<Array<PaymentMethodFilterParameter>>;
  3715. _or?: InputMaybe<Array<PaymentMethodFilterParameter>>;
  3716. code?: InputMaybe<StringOperators>;
  3717. createdAt?: InputMaybe<DateOperators>;
  3718. description?: InputMaybe<StringOperators>;
  3719. enabled?: InputMaybe<BooleanOperators>;
  3720. id?: InputMaybe<IdOperators>;
  3721. name?: InputMaybe<StringOperators>;
  3722. updatedAt?: InputMaybe<DateOperators>;
  3723. };
  3724. export type PaymentMethodList = PaginatedList & {
  3725. __typename?: 'PaymentMethodList';
  3726. items: Array<PaymentMethod>;
  3727. totalItems: Scalars['Int']['output'];
  3728. };
  3729. export type PaymentMethodListOptions = {
  3730. /** Allows the results to be filtered */
  3731. filter?: InputMaybe<PaymentMethodFilterParameter>;
  3732. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  3733. filterOperator?: InputMaybe<LogicalOperator>;
  3734. /** Skips the first n results, for use in pagination */
  3735. skip?: InputMaybe<Scalars['Int']['input']>;
  3736. /** Specifies which properties to sort the results by */
  3737. sort?: InputMaybe<PaymentMethodSortParameter>;
  3738. /** Takes n results, for use in pagination */
  3739. take?: InputMaybe<Scalars['Int']['input']>;
  3740. };
  3741. /**
  3742. * Returned when a call to modifyOrder fails to include a paymentMethod even
  3743. * though the price has increased as a result of the changes.
  3744. */
  3745. export type PaymentMethodMissingError = ErrorResult & {
  3746. __typename?: 'PaymentMethodMissingError';
  3747. errorCode: ErrorCode;
  3748. message: Scalars['String']['output'];
  3749. };
  3750. export type PaymentMethodQuote = {
  3751. __typename?: 'PaymentMethodQuote';
  3752. code: Scalars['String']['output'];
  3753. customFields?: Maybe<Scalars['JSON']['output']>;
  3754. description: Scalars['String']['output'];
  3755. eligibilityMessage?: Maybe<Scalars['String']['output']>;
  3756. id: Scalars['ID']['output'];
  3757. isEligible: Scalars['Boolean']['output'];
  3758. name: Scalars['String']['output'];
  3759. };
  3760. export type PaymentMethodSortParameter = {
  3761. code?: InputMaybe<SortOrder>;
  3762. createdAt?: InputMaybe<SortOrder>;
  3763. description?: InputMaybe<SortOrder>;
  3764. id?: InputMaybe<SortOrder>;
  3765. name?: InputMaybe<SortOrder>;
  3766. updatedAt?: InputMaybe<SortOrder>;
  3767. };
  3768. export type PaymentMethodTranslation = {
  3769. __typename?: 'PaymentMethodTranslation';
  3770. createdAt: Scalars['DateTime']['output'];
  3771. description: Scalars['String']['output'];
  3772. id: Scalars['ID']['output'];
  3773. languageCode: LanguageCode;
  3774. name: Scalars['String']['output'];
  3775. updatedAt: Scalars['DateTime']['output'];
  3776. };
  3777. export type PaymentMethodTranslationInput = {
  3778. customFields?: InputMaybe<Scalars['JSON']['input']>;
  3779. description?: InputMaybe<Scalars['String']['input']>;
  3780. id?: InputMaybe<Scalars['ID']['input']>;
  3781. languageCode: LanguageCode;
  3782. name?: InputMaybe<Scalars['String']['input']>;
  3783. };
  3784. /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
  3785. export type PaymentOrderMismatchError = ErrorResult & {
  3786. __typename?: 'PaymentOrderMismatchError';
  3787. errorCode: ErrorCode;
  3788. message: Scalars['String']['output'];
  3789. };
  3790. /** Returned when there is an error in transitioning the Payment state */
  3791. export type PaymentStateTransitionError = ErrorResult & {
  3792. __typename?: 'PaymentStateTransitionError';
  3793. errorCode: ErrorCode;
  3794. fromState: Scalars['String']['output'];
  3795. message: Scalars['String']['output'];
  3796. toState: Scalars['String']['output'];
  3797. transitionError: Scalars['String']['output'];
  3798. };
  3799. /**
  3800. * @description
  3801. * Permissions for administrators and customers. Used to control access to
  3802. * GraphQL resolvers via the {@link Allow} decorator.
  3803. *
  3804. * ## Understanding Permission.Owner
  3805. *
  3806. * `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
  3807. * be accessible to the "owner" of that resource.
  3808. *
  3809. * For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
  3810. * based on the activeUserId of the current session. As a result, the resolver code looks like this:
  3811. *
  3812. * @example
  3813. * ```TypeScript
  3814. * \@Query()
  3815. * \@Allow(Permission.Owner)
  3816. * async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
  3817. * const userId = ctx.activeUserId;
  3818. * if (userId) {
  3819. * return this.customerService.findOneByUserId(ctx, userId);
  3820. * }
  3821. * }
  3822. * ```
  3823. *
  3824. * Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
  3825. * nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
  3826. * of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
  3827. *
  3828. *
  3829. * @docsCategory common
  3830. */
  3831. export enum Permission {
  3832. /** Authenticated means simply that the user is logged in */
  3833. Authenticated = 'Authenticated',
  3834. /** Grants permission to create Administrator */
  3835. CreateAdministrator = 'CreateAdministrator',
  3836. /** Grants permission to create Asset */
  3837. CreateAsset = 'CreateAsset',
  3838. /** Grants permission to create Products, Facets, Assets, Collections */
  3839. CreateCatalog = 'CreateCatalog',
  3840. /** Grants permission to create Channel */
  3841. CreateChannel = 'CreateChannel',
  3842. /** Grants permission to create Collection */
  3843. CreateCollection = 'CreateCollection',
  3844. /** Grants permission to create Country */
  3845. CreateCountry = 'CreateCountry',
  3846. /** Grants permission to create Customer */
  3847. CreateCustomer = 'CreateCustomer',
  3848. /** Grants permission to create CustomerGroup */
  3849. CreateCustomerGroup = 'CreateCustomerGroup',
  3850. /** Grants permission to create Facet */
  3851. CreateFacet = 'CreateFacet',
  3852. /** Grants permission to create Order */
  3853. CreateOrder = 'CreateOrder',
  3854. /** Grants permission to create PaymentMethod */
  3855. CreatePaymentMethod = 'CreatePaymentMethod',
  3856. /** Grants permission to create Product */
  3857. CreateProduct = 'CreateProduct',
  3858. /** Grants permission to create Promotion */
  3859. CreatePromotion = 'CreatePromotion',
  3860. /** Grants permission to create Seller */
  3861. CreateSeller = 'CreateSeller',
  3862. /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3863. CreateSettings = 'CreateSettings',
  3864. /** Grants permission to create ShippingMethod */
  3865. CreateShippingMethod = 'CreateShippingMethod',
  3866. /** Grants permission to create StockLocation */
  3867. CreateStockLocation = 'CreateStockLocation',
  3868. /** Grants permission to create System */
  3869. CreateSystem = 'CreateSystem',
  3870. /** Grants permission to create Tag */
  3871. CreateTag = 'CreateTag',
  3872. /** Grants permission to create TaxCategory */
  3873. CreateTaxCategory = 'CreateTaxCategory',
  3874. /** Grants permission to create TaxRate */
  3875. CreateTaxRate = 'CreateTaxRate',
  3876. /** Grants permission to create Zone */
  3877. CreateZone = 'CreateZone',
  3878. /** Grants permission to delete Administrator */
  3879. DeleteAdministrator = 'DeleteAdministrator',
  3880. /** Grants permission to delete Asset */
  3881. DeleteAsset = 'DeleteAsset',
  3882. /** Grants permission to delete Products, Facets, Assets, Collections */
  3883. DeleteCatalog = 'DeleteCatalog',
  3884. /** Grants permission to delete Channel */
  3885. DeleteChannel = 'DeleteChannel',
  3886. /** Grants permission to delete Collection */
  3887. DeleteCollection = 'DeleteCollection',
  3888. /** Grants permission to delete Country */
  3889. DeleteCountry = 'DeleteCountry',
  3890. /** Grants permission to delete Customer */
  3891. DeleteCustomer = 'DeleteCustomer',
  3892. /** Grants permission to delete CustomerGroup */
  3893. DeleteCustomerGroup = 'DeleteCustomerGroup',
  3894. /** Grants permission to delete Facet */
  3895. DeleteFacet = 'DeleteFacet',
  3896. /** Grants permission to delete Order */
  3897. DeleteOrder = 'DeleteOrder',
  3898. /** Grants permission to delete PaymentMethod */
  3899. DeletePaymentMethod = 'DeletePaymentMethod',
  3900. /** Grants permission to delete Product */
  3901. DeleteProduct = 'DeleteProduct',
  3902. /** Grants permission to delete Promotion */
  3903. DeletePromotion = 'DeletePromotion',
  3904. /** Grants permission to delete Seller */
  3905. DeleteSeller = 'DeleteSeller',
  3906. /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3907. DeleteSettings = 'DeleteSettings',
  3908. /** Grants permission to delete ShippingMethod */
  3909. DeleteShippingMethod = 'DeleteShippingMethod',
  3910. /** Grants permission to delete StockLocation */
  3911. DeleteStockLocation = 'DeleteStockLocation',
  3912. /** Grants permission to delete System */
  3913. DeleteSystem = 'DeleteSystem',
  3914. /** Grants permission to delete Tag */
  3915. DeleteTag = 'DeleteTag',
  3916. /** Grants permission to delete TaxCategory */
  3917. DeleteTaxCategory = 'DeleteTaxCategory',
  3918. /** Grants permission to delete TaxRate */
  3919. DeleteTaxRate = 'DeleteTaxRate',
  3920. /** Grants permission to delete Zone */
  3921. DeleteZone = 'DeleteZone',
  3922. /** Owner means the user owns this entity, e.g. a Customer's own Order */
  3923. Owner = 'Owner',
  3924. /** Public means any unauthenticated user may perform the operation */
  3925. Public = 'Public',
  3926. /** Grants permission to read Administrator */
  3927. ReadAdministrator = 'ReadAdministrator',
  3928. /** Grants permission to read Asset */
  3929. ReadAsset = 'ReadAsset',
  3930. /** Grants permission to read Products, Facets, Assets, Collections */
  3931. ReadCatalog = 'ReadCatalog',
  3932. /** Grants permission to read Channel */
  3933. ReadChannel = 'ReadChannel',
  3934. /** Grants permission to read Collection */
  3935. ReadCollection = 'ReadCollection',
  3936. /** Grants permission to read Country */
  3937. ReadCountry = 'ReadCountry',
  3938. /** Grants permission to read Customer */
  3939. ReadCustomer = 'ReadCustomer',
  3940. /** Grants permission to read CustomerGroup */
  3941. ReadCustomerGroup = 'ReadCustomerGroup',
  3942. /** Grants permission to read Facet */
  3943. ReadFacet = 'ReadFacet',
  3944. /** Grants permission to read Order */
  3945. ReadOrder = 'ReadOrder',
  3946. /** Grants permission to read PaymentMethod */
  3947. ReadPaymentMethod = 'ReadPaymentMethod',
  3948. /** Grants permission to read Product */
  3949. ReadProduct = 'ReadProduct',
  3950. /** Grants permission to read Promotion */
  3951. ReadPromotion = 'ReadPromotion',
  3952. /** Grants permission to read Seller */
  3953. ReadSeller = 'ReadSeller',
  3954. /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3955. ReadSettings = 'ReadSettings',
  3956. /** Grants permission to read ShippingMethod */
  3957. ReadShippingMethod = 'ReadShippingMethod',
  3958. /** Grants permission to read StockLocation */
  3959. ReadStockLocation = 'ReadStockLocation',
  3960. /** Grants permission to read System */
  3961. ReadSystem = 'ReadSystem',
  3962. /** Grants permission to read Tag */
  3963. ReadTag = 'ReadTag',
  3964. /** Grants permission to read TaxCategory */
  3965. ReadTaxCategory = 'ReadTaxCategory',
  3966. /** Grants permission to read TaxRate */
  3967. ReadTaxRate = 'ReadTaxRate',
  3968. /** Grants permission to read Zone */
  3969. ReadZone = 'ReadZone',
  3970. /** SuperAdmin has unrestricted access to all operations */
  3971. SuperAdmin = 'SuperAdmin',
  3972. /** Grants permission to update Administrator */
  3973. UpdateAdministrator = 'UpdateAdministrator',
  3974. /** Grants permission to update Asset */
  3975. UpdateAsset = 'UpdateAsset',
  3976. /** Grants permission to update Products, Facets, Assets, Collections */
  3977. UpdateCatalog = 'UpdateCatalog',
  3978. /** Grants permission to update Channel */
  3979. UpdateChannel = 'UpdateChannel',
  3980. /** Grants permission to update Collection */
  3981. UpdateCollection = 'UpdateCollection',
  3982. /** Grants permission to update Country */
  3983. UpdateCountry = 'UpdateCountry',
  3984. /** Grants permission to update Customer */
  3985. UpdateCustomer = 'UpdateCustomer',
  3986. /** Grants permission to update CustomerGroup */
  3987. UpdateCustomerGroup = 'UpdateCustomerGroup',
  3988. /** Grants permission to update Facet */
  3989. UpdateFacet = 'UpdateFacet',
  3990. /** Grants permission to update GlobalSettings */
  3991. UpdateGlobalSettings = 'UpdateGlobalSettings',
  3992. /** Grants permission to update Order */
  3993. UpdateOrder = 'UpdateOrder',
  3994. /** Grants permission to update PaymentMethod */
  3995. UpdatePaymentMethod = 'UpdatePaymentMethod',
  3996. /** Grants permission to update Product */
  3997. UpdateProduct = 'UpdateProduct',
  3998. /** Grants permission to update Promotion */
  3999. UpdatePromotion = 'UpdatePromotion',
  4000. /** Grants permission to update Seller */
  4001. UpdateSeller = 'UpdateSeller',
  4002. /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  4003. UpdateSettings = 'UpdateSettings',
  4004. /** Grants permission to update ShippingMethod */
  4005. UpdateShippingMethod = 'UpdateShippingMethod',
  4006. /** Grants permission to update StockLocation */
  4007. UpdateStockLocation = 'UpdateStockLocation',
  4008. /** Grants permission to update System */
  4009. UpdateSystem = 'UpdateSystem',
  4010. /** Grants permission to update Tag */
  4011. UpdateTag = 'UpdateTag',
  4012. /** Grants permission to update TaxCategory */
  4013. UpdateTaxCategory = 'UpdateTaxCategory',
  4014. /** Grants permission to update TaxRate */
  4015. UpdateTaxRate = 'UpdateTaxRate',
  4016. /** Grants permission to update Zone */
  4017. UpdateZone = 'UpdateZone'
  4018. }
  4019. export type PermissionDefinition = {
  4020. __typename?: 'PermissionDefinition';
  4021. assignable: Scalars['Boolean']['output'];
  4022. description: Scalars['String']['output'];
  4023. name: Scalars['String']['output'];
  4024. };
  4025. export type PreviewCollectionVariantsInput = {
  4026. filters: Array<ConfigurableOperationInput>;
  4027. inheritFilters: Scalars['Boolean']['input'];
  4028. parentId?: InputMaybe<Scalars['ID']['input']>;
  4029. };
  4030. /** The price range where the result has more than one price */
  4031. export type PriceRange = {
  4032. __typename?: 'PriceRange';
  4033. max: Scalars['Money']['output'];
  4034. min: Scalars['Money']['output'];
  4035. };
  4036. export type Product = Node & {
  4037. __typename?: 'Product';
  4038. assets: Array<Asset>;
  4039. channels: Array<Channel>;
  4040. collections: Array<Collection>;
  4041. createdAt: Scalars['DateTime']['output'];
  4042. customFields?: Maybe<Scalars['JSON']['output']>;
  4043. description: Scalars['String']['output'];
  4044. enabled: Scalars['Boolean']['output'];
  4045. facetValues: Array<FacetValue>;
  4046. featuredAsset?: Maybe<Asset>;
  4047. id: Scalars['ID']['output'];
  4048. languageCode: LanguageCode;
  4049. name: Scalars['String']['output'];
  4050. optionGroups: Array<ProductOptionGroup>;
  4051. slug: Scalars['String']['output'];
  4052. translations: Array<ProductTranslation>;
  4053. updatedAt: Scalars['DateTime']['output'];
  4054. /** Returns a paginated, sortable, filterable list of ProductVariants */
  4055. variantList: ProductVariantList;
  4056. /** Returns all ProductVariants */
  4057. variants: Array<ProductVariant>;
  4058. };
  4059. export type ProductVariantListArgs = {
  4060. options?: InputMaybe<ProductVariantListOptions>;
  4061. };
  4062. export type ProductFilterParameter = {
  4063. _and?: InputMaybe<Array<ProductFilterParameter>>;
  4064. _or?: InputMaybe<Array<ProductFilterParameter>>;
  4065. createdAt?: InputMaybe<DateOperators>;
  4066. description?: InputMaybe<StringOperators>;
  4067. enabled?: InputMaybe<BooleanOperators>;
  4068. facetValueId?: InputMaybe<IdOperators>;
  4069. id?: InputMaybe<IdOperators>;
  4070. languageCode?: InputMaybe<StringOperators>;
  4071. name?: InputMaybe<StringOperators>;
  4072. sku?: InputMaybe<StringOperators>;
  4073. slug?: InputMaybe<StringOperators>;
  4074. updatedAt?: InputMaybe<DateOperators>;
  4075. };
  4076. export type ProductList = PaginatedList & {
  4077. __typename?: 'ProductList';
  4078. items: Array<Product>;
  4079. totalItems: Scalars['Int']['output'];
  4080. };
  4081. export type ProductListOptions = {
  4082. /** Allows the results to be filtered */
  4083. filter?: InputMaybe<ProductFilterParameter>;
  4084. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4085. filterOperator?: InputMaybe<LogicalOperator>;
  4086. /** Skips the first n results, for use in pagination */
  4087. skip?: InputMaybe<Scalars['Int']['input']>;
  4088. /** Specifies which properties to sort the results by */
  4089. sort?: InputMaybe<ProductSortParameter>;
  4090. /** Takes n results, for use in pagination */
  4091. take?: InputMaybe<Scalars['Int']['input']>;
  4092. };
  4093. export type ProductOption = Node & {
  4094. __typename?: 'ProductOption';
  4095. code: Scalars['String']['output'];
  4096. createdAt: Scalars['DateTime']['output'];
  4097. customFields?: Maybe<Scalars['JSON']['output']>;
  4098. group: ProductOptionGroup;
  4099. groupId: Scalars['ID']['output'];
  4100. id: Scalars['ID']['output'];
  4101. languageCode: LanguageCode;
  4102. name: Scalars['String']['output'];
  4103. translations: Array<ProductOptionTranslation>;
  4104. updatedAt: Scalars['DateTime']['output'];
  4105. };
  4106. export type ProductOptionGroup = Node & {
  4107. __typename?: 'ProductOptionGroup';
  4108. code: Scalars['String']['output'];
  4109. createdAt: Scalars['DateTime']['output'];
  4110. customFields?: Maybe<Scalars['JSON']['output']>;
  4111. id: Scalars['ID']['output'];
  4112. languageCode: LanguageCode;
  4113. name: Scalars['String']['output'];
  4114. options: Array<ProductOption>;
  4115. translations: Array<ProductOptionGroupTranslation>;
  4116. updatedAt: Scalars['DateTime']['output'];
  4117. };
  4118. export type ProductOptionGroupTranslation = {
  4119. __typename?: 'ProductOptionGroupTranslation';
  4120. createdAt: Scalars['DateTime']['output'];
  4121. id: Scalars['ID']['output'];
  4122. languageCode: LanguageCode;
  4123. name: Scalars['String']['output'];
  4124. updatedAt: Scalars['DateTime']['output'];
  4125. };
  4126. export type ProductOptionGroupTranslationInput = {
  4127. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4128. id?: InputMaybe<Scalars['ID']['input']>;
  4129. languageCode: LanguageCode;
  4130. name?: InputMaybe<Scalars['String']['input']>;
  4131. };
  4132. export type ProductOptionInUseError = ErrorResult & {
  4133. __typename?: 'ProductOptionInUseError';
  4134. errorCode: ErrorCode;
  4135. message: Scalars['String']['output'];
  4136. optionGroupCode: Scalars['String']['output'];
  4137. productVariantCount: Scalars['Int']['output'];
  4138. };
  4139. export type ProductOptionTranslation = {
  4140. __typename?: 'ProductOptionTranslation';
  4141. createdAt: Scalars['DateTime']['output'];
  4142. id: Scalars['ID']['output'];
  4143. languageCode: LanguageCode;
  4144. name: Scalars['String']['output'];
  4145. updatedAt: Scalars['DateTime']['output'];
  4146. };
  4147. export type ProductOptionTranslationInput = {
  4148. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4149. id?: InputMaybe<Scalars['ID']['input']>;
  4150. languageCode: LanguageCode;
  4151. name?: InputMaybe<Scalars['String']['input']>;
  4152. };
  4153. export type ProductSortParameter = {
  4154. createdAt?: InputMaybe<SortOrder>;
  4155. description?: InputMaybe<SortOrder>;
  4156. id?: InputMaybe<SortOrder>;
  4157. name?: InputMaybe<SortOrder>;
  4158. slug?: InputMaybe<SortOrder>;
  4159. updatedAt?: InputMaybe<SortOrder>;
  4160. };
  4161. export type ProductTranslation = {
  4162. __typename?: 'ProductTranslation';
  4163. createdAt: Scalars['DateTime']['output'];
  4164. description: Scalars['String']['output'];
  4165. id: Scalars['ID']['output'];
  4166. languageCode: LanguageCode;
  4167. name: Scalars['String']['output'];
  4168. slug: Scalars['String']['output'];
  4169. updatedAt: Scalars['DateTime']['output'];
  4170. };
  4171. export type ProductTranslationInput = {
  4172. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4173. description?: InputMaybe<Scalars['String']['input']>;
  4174. id?: InputMaybe<Scalars['ID']['input']>;
  4175. languageCode: LanguageCode;
  4176. name?: InputMaybe<Scalars['String']['input']>;
  4177. slug?: InputMaybe<Scalars['String']['input']>;
  4178. };
  4179. export type ProductVariant = Node & {
  4180. __typename?: 'ProductVariant';
  4181. assets: Array<Asset>;
  4182. channels: Array<Channel>;
  4183. createdAt: Scalars['DateTime']['output'];
  4184. currencyCode: CurrencyCode;
  4185. customFields?: Maybe<Scalars['JSON']['output']>;
  4186. enabled: Scalars['Boolean']['output'];
  4187. facetValues: Array<FacetValue>;
  4188. featuredAsset?: Maybe<Asset>;
  4189. id: Scalars['ID']['output'];
  4190. languageCode: LanguageCode;
  4191. name: Scalars['String']['output'];
  4192. options: Array<ProductOption>;
  4193. outOfStockThreshold: Scalars['Int']['output'];
  4194. price: Scalars['Money']['output'];
  4195. priceWithTax: Scalars['Money']['output'];
  4196. prices: Array<ProductVariantPrice>;
  4197. product: Product;
  4198. productId: Scalars['ID']['output'];
  4199. sku: Scalars['String']['output'];
  4200. /** @deprecated use stockLevels */
  4201. stockAllocated: Scalars['Int']['output'];
  4202. stockLevel: Scalars['String']['output'];
  4203. stockLevels: Array<StockLevel>;
  4204. stockMovements: StockMovementList;
  4205. /** @deprecated use stockLevels */
  4206. stockOnHand: Scalars['Int']['output'];
  4207. taxCategory: TaxCategory;
  4208. taxRateApplied: TaxRate;
  4209. trackInventory: GlobalFlag;
  4210. translations: Array<ProductVariantTranslation>;
  4211. updatedAt: Scalars['DateTime']['output'];
  4212. useGlobalOutOfStockThreshold: Scalars['Boolean']['output'];
  4213. };
  4214. export type ProductVariantStockMovementsArgs = {
  4215. options?: InputMaybe<StockMovementListOptions>;
  4216. };
  4217. export type ProductVariantFilterParameter = {
  4218. _and?: InputMaybe<Array<ProductVariantFilterParameter>>;
  4219. _or?: InputMaybe<Array<ProductVariantFilterParameter>>;
  4220. createdAt?: InputMaybe<DateOperators>;
  4221. currencyCode?: InputMaybe<StringOperators>;
  4222. enabled?: InputMaybe<BooleanOperators>;
  4223. facetValueId?: InputMaybe<IdOperators>;
  4224. id?: InputMaybe<IdOperators>;
  4225. languageCode?: InputMaybe<StringOperators>;
  4226. name?: InputMaybe<StringOperators>;
  4227. outOfStockThreshold?: InputMaybe<NumberOperators>;
  4228. price?: InputMaybe<NumberOperators>;
  4229. priceWithTax?: InputMaybe<NumberOperators>;
  4230. productId?: InputMaybe<IdOperators>;
  4231. sku?: InputMaybe<StringOperators>;
  4232. stockAllocated?: InputMaybe<NumberOperators>;
  4233. stockLevel?: InputMaybe<StringOperators>;
  4234. stockOnHand?: InputMaybe<NumberOperators>;
  4235. trackInventory?: InputMaybe<StringOperators>;
  4236. updatedAt?: InputMaybe<DateOperators>;
  4237. useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
  4238. };
  4239. export type ProductVariantList = PaginatedList & {
  4240. __typename?: 'ProductVariantList';
  4241. items: Array<ProductVariant>;
  4242. totalItems: Scalars['Int']['output'];
  4243. };
  4244. export type ProductVariantListOptions = {
  4245. /** Allows the results to be filtered */
  4246. filter?: InputMaybe<ProductVariantFilterParameter>;
  4247. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4248. filterOperator?: InputMaybe<LogicalOperator>;
  4249. /** Skips the first n results, for use in pagination */
  4250. skip?: InputMaybe<Scalars['Int']['input']>;
  4251. /** Specifies which properties to sort the results by */
  4252. sort?: InputMaybe<ProductVariantSortParameter>;
  4253. /** Takes n results, for use in pagination */
  4254. take?: InputMaybe<Scalars['Int']['input']>;
  4255. };
  4256. export type ProductVariantPrice = {
  4257. __typename?: 'ProductVariantPrice';
  4258. currencyCode: CurrencyCode;
  4259. customFields?: Maybe<Scalars['JSON']['output']>;
  4260. price: Scalars['Money']['output'];
  4261. };
  4262. export type ProductVariantSortParameter = {
  4263. createdAt?: InputMaybe<SortOrder>;
  4264. id?: InputMaybe<SortOrder>;
  4265. name?: InputMaybe<SortOrder>;
  4266. outOfStockThreshold?: InputMaybe<SortOrder>;
  4267. price?: InputMaybe<SortOrder>;
  4268. priceWithTax?: InputMaybe<SortOrder>;
  4269. productId?: InputMaybe<SortOrder>;
  4270. sku?: InputMaybe<SortOrder>;
  4271. stockAllocated?: InputMaybe<SortOrder>;
  4272. stockLevel?: InputMaybe<SortOrder>;
  4273. stockOnHand?: InputMaybe<SortOrder>;
  4274. updatedAt?: InputMaybe<SortOrder>;
  4275. };
  4276. export type ProductVariantTranslation = {
  4277. __typename?: 'ProductVariantTranslation';
  4278. createdAt: Scalars['DateTime']['output'];
  4279. id: Scalars['ID']['output'];
  4280. languageCode: LanguageCode;
  4281. name: Scalars['String']['output'];
  4282. updatedAt: Scalars['DateTime']['output'];
  4283. };
  4284. export type ProductVariantTranslationInput = {
  4285. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4286. id?: InputMaybe<Scalars['ID']['input']>;
  4287. languageCode: LanguageCode;
  4288. name?: InputMaybe<Scalars['String']['input']>;
  4289. };
  4290. export type Promotion = Node & {
  4291. __typename?: 'Promotion';
  4292. actions: Array<ConfigurableOperation>;
  4293. conditions: Array<ConfigurableOperation>;
  4294. couponCode?: Maybe<Scalars['String']['output']>;
  4295. createdAt: Scalars['DateTime']['output'];
  4296. customFields?: Maybe<Scalars['JSON']['output']>;
  4297. description: Scalars['String']['output'];
  4298. enabled: Scalars['Boolean']['output'];
  4299. endsAt?: Maybe<Scalars['DateTime']['output']>;
  4300. id: Scalars['ID']['output'];
  4301. name: Scalars['String']['output'];
  4302. perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
  4303. startsAt?: Maybe<Scalars['DateTime']['output']>;
  4304. translations: Array<PromotionTranslation>;
  4305. updatedAt: Scalars['DateTime']['output'];
  4306. usageLimit?: Maybe<Scalars['Int']['output']>;
  4307. };
  4308. export type PromotionFilterParameter = {
  4309. _and?: InputMaybe<Array<PromotionFilterParameter>>;
  4310. _or?: InputMaybe<Array<PromotionFilterParameter>>;
  4311. couponCode?: InputMaybe<StringOperators>;
  4312. createdAt?: InputMaybe<DateOperators>;
  4313. description?: InputMaybe<StringOperators>;
  4314. enabled?: InputMaybe<BooleanOperators>;
  4315. endsAt?: InputMaybe<DateOperators>;
  4316. id?: InputMaybe<IdOperators>;
  4317. name?: InputMaybe<StringOperators>;
  4318. perCustomerUsageLimit?: InputMaybe<NumberOperators>;
  4319. startsAt?: InputMaybe<DateOperators>;
  4320. updatedAt?: InputMaybe<DateOperators>;
  4321. usageLimit?: InputMaybe<NumberOperators>;
  4322. };
  4323. export type PromotionList = PaginatedList & {
  4324. __typename?: 'PromotionList';
  4325. items: Array<Promotion>;
  4326. totalItems: Scalars['Int']['output'];
  4327. };
  4328. export type PromotionListOptions = {
  4329. /** Allows the results to be filtered */
  4330. filter?: InputMaybe<PromotionFilterParameter>;
  4331. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4332. filterOperator?: InputMaybe<LogicalOperator>;
  4333. /** Skips the first n results, for use in pagination */
  4334. skip?: InputMaybe<Scalars['Int']['input']>;
  4335. /** Specifies which properties to sort the results by */
  4336. sort?: InputMaybe<PromotionSortParameter>;
  4337. /** Takes n results, for use in pagination */
  4338. take?: InputMaybe<Scalars['Int']['input']>;
  4339. };
  4340. export type PromotionSortParameter = {
  4341. couponCode?: InputMaybe<SortOrder>;
  4342. createdAt?: InputMaybe<SortOrder>;
  4343. description?: InputMaybe<SortOrder>;
  4344. endsAt?: InputMaybe<SortOrder>;
  4345. id?: InputMaybe<SortOrder>;
  4346. name?: InputMaybe<SortOrder>;
  4347. perCustomerUsageLimit?: InputMaybe<SortOrder>;
  4348. startsAt?: InputMaybe<SortOrder>;
  4349. updatedAt?: InputMaybe<SortOrder>;
  4350. usageLimit?: InputMaybe<SortOrder>;
  4351. };
  4352. export type PromotionTranslation = {
  4353. __typename?: 'PromotionTranslation';
  4354. createdAt: Scalars['DateTime']['output'];
  4355. description: Scalars['String']['output'];
  4356. id: Scalars['ID']['output'];
  4357. languageCode: LanguageCode;
  4358. name: Scalars['String']['output'];
  4359. updatedAt: Scalars['DateTime']['output'];
  4360. };
  4361. export type PromotionTranslationInput = {
  4362. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4363. description?: InputMaybe<Scalars['String']['input']>;
  4364. id?: InputMaybe<Scalars['ID']['input']>;
  4365. languageCode: LanguageCode;
  4366. name?: InputMaybe<Scalars['String']['input']>;
  4367. };
  4368. export type Province = Node & Region & {
  4369. __typename?: 'Province';
  4370. code: Scalars['String']['output'];
  4371. createdAt: Scalars['DateTime']['output'];
  4372. customFields?: Maybe<Scalars['JSON']['output']>;
  4373. enabled: Scalars['Boolean']['output'];
  4374. id: Scalars['ID']['output'];
  4375. languageCode: LanguageCode;
  4376. name: Scalars['String']['output'];
  4377. parent?: Maybe<Region>;
  4378. parentId?: Maybe<Scalars['ID']['output']>;
  4379. translations: Array<RegionTranslation>;
  4380. type: Scalars['String']['output'];
  4381. updatedAt: Scalars['DateTime']['output'];
  4382. };
  4383. export type ProvinceFilterParameter = {
  4384. _and?: InputMaybe<Array<ProvinceFilterParameter>>;
  4385. _or?: InputMaybe<Array<ProvinceFilterParameter>>;
  4386. code?: InputMaybe<StringOperators>;
  4387. createdAt?: InputMaybe<DateOperators>;
  4388. enabled?: InputMaybe<BooleanOperators>;
  4389. id?: InputMaybe<IdOperators>;
  4390. languageCode?: InputMaybe<StringOperators>;
  4391. name?: InputMaybe<StringOperators>;
  4392. parentId?: InputMaybe<IdOperators>;
  4393. type?: InputMaybe<StringOperators>;
  4394. updatedAt?: InputMaybe<DateOperators>;
  4395. };
  4396. export type ProvinceList = PaginatedList & {
  4397. __typename?: 'ProvinceList';
  4398. items: Array<Province>;
  4399. totalItems: Scalars['Int']['output'];
  4400. };
  4401. export type ProvinceListOptions = {
  4402. /** Allows the results to be filtered */
  4403. filter?: InputMaybe<ProvinceFilterParameter>;
  4404. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4405. filterOperator?: InputMaybe<LogicalOperator>;
  4406. /** Skips the first n results, for use in pagination */
  4407. skip?: InputMaybe<Scalars['Int']['input']>;
  4408. /** Specifies which properties to sort the results by */
  4409. sort?: InputMaybe<ProvinceSortParameter>;
  4410. /** Takes n results, for use in pagination */
  4411. take?: InputMaybe<Scalars['Int']['input']>;
  4412. };
  4413. export type ProvinceSortParameter = {
  4414. code?: InputMaybe<SortOrder>;
  4415. createdAt?: InputMaybe<SortOrder>;
  4416. id?: InputMaybe<SortOrder>;
  4417. name?: InputMaybe<SortOrder>;
  4418. parentId?: InputMaybe<SortOrder>;
  4419. type?: InputMaybe<SortOrder>;
  4420. updatedAt?: InputMaybe<SortOrder>;
  4421. };
  4422. export type ProvinceTranslationInput = {
  4423. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4424. id?: InputMaybe<Scalars['ID']['input']>;
  4425. languageCode: LanguageCode;
  4426. name?: InputMaybe<Scalars['String']['input']>;
  4427. };
  4428. /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
  4429. export type QuantityTooGreatError = ErrorResult & {
  4430. __typename?: 'QuantityTooGreatError';
  4431. errorCode: ErrorCode;
  4432. message: Scalars['String']['output'];
  4433. };
  4434. export type Query = {
  4435. __typename?: 'Query';
  4436. activeAdministrator?: Maybe<Administrator>;
  4437. activeChannel: Channel;
  4438. administrator?: Maybe<Administrator>;
  4439. administrators: AdministratorList;
  4440. /** Get a single Asset by id */
  4441. asset?: Maybe<Asset>;
  4442. /** Get a list of Assets */
  4443. assets: AssetList;
  4444. channel?: Maybe<Channel>;
  4445. channels: ChannelList;
  4446. /** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
  4447. collection?: Maybe<Collection>;
  4448. collectionFilters: Array<ConfigurableOperationDefinition>;
  4449. collections: CollectionList;
  4450. countries: CountryList;
  4451. country?: Maybe<Country>;
  4452. customer?: Maybe<Customer>;
  4453. customerGroup?: Maybe<CustomerGroup>;
  4454. customerGroups: CustomerGroupList;
  4455. customers: CustomerList;
  4456. /** Returns a list of eligible shipping methods for the draft Order */
  4457. eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
  4458. /** Returns all configured EntityDuplicators. */
  4459. entityDuplicators: Array<EntityDuplicatorDefinition>;
  4460. facet?: Maybe<Facet>;
  4461. facetValues: FacetValueList;
  4462. facets: FacetList;
  4463. fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
  4464. globalSettings: GlobalSettings;
  4465. job?: Maybe<Job>;
  4466. jobBufferSize: Array<JobBufferSize>;
  4467. jobQueues: Array<JobQueue>;
  4468. jobs: JobList;
  4469. jobsById: Array<Job>;
  4470. me?: Maybe<CurrentUser>;
  4471. /** Get metrics for the given interval and metric types. */
  4472. metricSummary: Array<MetricSummary>;
  4473. order?: Maybe<Order>;
  4474. orders: OrderList;
  4475. paymentMethod?: Maybe<PaymentMethod>;
  4476. paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4477. paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
  4478. paymentMethods: PaymentMethodList;
  4479. pendingSearchIndexUpdates: Scalars['Int']['output'];
  4480. /** Used for real-time previews of the contents of a Collection */
  4481. previewCollectionVariants: ProductVariantList;
  4482. /** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
  4483. product?: Maybe<Product>;
  4484. productOptionGroup?: Maybe<ProductOptionGroup>;
  4485. productOptionGroups: Array<ProductOptionGroup>;
  4486. /** Get a ProductVariant by id */
  4487. productVariant?: Maybe<ProductVariant>;
  4488. /** List ProductVariants either all or for the specific product. */
  4489. productVariants: ProductVariantList;
  4490. /** List Products */
  4491. products: ProductList;
  4492. promotion?: Maybe<Promotion>;
  4493. promotionActions: Array<ConfigurableOperationDefinition>;
  4494. promotionConditions: Array<ConfigurableOperationDefinition>;
  4495. promotions: PromotionList;
  4496. province?: Maybe<Province>;
  4497. provinces: ProvinceList;
  4498. role?: Maybe<Role>;
  4499. roles: RoleList;
  4500. search: SearchResponse;
  4501. seller?: Maybe<Seller>;
  4502. sellers: SellerList;
  4503. shippingCalculators: Array<ConfigurableOperationDefinition>;
  4504. shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4505. shippingMethod?: Maybe<ShippingMethod>;
  4506. shippingMethods: ShippingMethodList;
  4507. stockLocation?: Maybe<StockLocation>;
  4508. stockLocations: StockLocationList;
  4509. tag: Tag;
  4510. tags: TagList;
  4511. taxCategories: TaxCategoryList;
  4512. taxCategory?: Maybe<TaxCategory>;
  4513. taxRate?: Maybe<TaxRate>;
  4514. taxRates: TaxRateList;
  4515. testEligibleShippingMethods: Array<ShippingMethodQuote>;
  4516. testShippingMethod: TestShippingMethodResult;
  4517. zone?: Maybe<Zone>;
  4518. zones: ZoneList;
  4519. };
  4520. export type QueryAdministratorArgs = {
  4521. id: Scalars['ID']['input'];
  4522. };
  4523. export type QueryAdministratorsArgs = {
  4524. options?: InputMaybe<AdministratorListOptions>;
  4525. };
  4526. export type QueryAssetArgs = {
  4527. id: Scalars['ID']['input'];
  4528. };
  4529. export type QueryAssetsArgs = {
  4530. options?: InputMaybe<AssetListOptions>;
  4531. };
  4532. export type QueryChannelArgs = {
  4533. id: Scalars['ID']['input'];
  4534. };
  4535. export type QueryChannelsArgs = {
  4536. options?: InputMaybe<ChannelListOptions>;
  4537. };
  4538. export type QueryCollectionArgs = {
  4539. id?: InputMaybe<Scalars['ID']['input']>;
  4540. slug?: InputMaybe<Scalars['String']['input']>;
  4541. };
  4542. export type QueryCollectionsArgs = {
  4543. options?: InputMaybe<CollectionListOptions>;
  4544. };
  4545. export type QueryCountriesArgs = {
  4546. options?: InputMaybe<CountryListOptions>;
  4547. };
  4548. export type QueryCountryArgs = {
  4549. id: Scalars['ID']['input'];
  4550. };
  4551. export type QueryCustomerArgs = {
  4552. id: Scalars['ID']['input'];
  4553. };
  4554. export type QueryCustomerGroupArgs = {
  4555. id: Scalars['ID']['input'];
  4556. };
  4557. export type QueryCustomerGroupsArgs = {
  4558. options?: InputMaybe<CustomerGroupListOptions>;
  4559. };
  4560. export type QueryCustomersArgs = {
  4561. options?: InputMaybe<CustomerListOptions>;
  4562. };
  4563. export type QueryEligibleShippingMethodsForDraftOrderArgs = {
  4564. orderId: Scalars['ID']['input'];
  4565. };
  4566. export type QueryFacetArgs = {
  4567. id: Scalars['ID']['input'];
  4568. };
  4569. export type QueryFacetValuesArgs = {
  4570. options?: InputMaybe<FacetValueListOptions>;
  4571. };
  4572. export type QueryFacetsArgs = {
  4573. options?: InputMaybe<FacetListOptions>;
  4574. };
  4575. export type QueryJobArgs = {
  4576. jobId: Scalars['ID']['input'];
  4577. };
  4578. export type QueryJobBufferSizeArgs = {
  4579. bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
  4580. };
  4581. export type QueryJobsArgs = {
  4582. options?: InputMaybe<JobListOptions>;
  4583. };
  4584. export type QueryJobsByIdArgs = {
  4585. jobIds: Array<Scalars['ID']['input']>;
  4586. };
  4587. export type QueryMetricSummaryArgs = {
  4588. input?: InputMaybe<MetricSummaryInput>;
  4589. };
  4590. export type QueryOrderArgs = {
  4591. id: Scalars['ID']['input'];
  4592. };
  4593. export type QueryOrdersArgs = {
  4594. options?: InputMaybe<OrderListOptions>;
  4595. };
  4596. export type QueryPaymentMethodArgs = {
  4597. id: Scalars['ID']['input'];
  4598. };
  4599. export type QueryPaymentMethodsArgs = {
  4600. options?: InputMaybe<PaymentMethodListOptions>;
  4601. };
  4602. export type QueryPreviewCollectionVariantsArgs = {
  4603. input: PreviewCollectionVariantsInput;
  4604. options?: InputMaybe<ProductVariantListOptions>;
  4605. };
  4606. export type QueryProductArgs = {
  4607. id?: InputMaybe<Scalars['ID']['input']>;
  4608. slug?: InputMaybe<Scalars['String']['input']>;
  4609. };
  4610. export type QueryProductOptionGroupArgs = {
  4611. id: Scalars['ID']['input'];
  4612. };
  4613. export type QueryProductOptionGroupsArgs = {
  4614. filterTerm?: InputMaybe<Scalars['String']['input']>;
  4615. };
  4616. export type QueryProductVariantArgs = {
  4617. id: Scalars['ID']['input'];
  4618. };
  4619. export type QueryProductVariantsArgs = {
  4620. options?: InputMaybe<ProductVariantListOptions>;
  4621. productId?: InputMaybe<Scalars['ID']['input']>;
  4622. };
  4623. export type QueryProductsArgs = {
  4624. options?: InputMaybe<ProductListOptions>;
  4625. };
  4626. export type QueryPromotionArgs = {
  4627. id: Scalars['ID']['input'];
  4628. };
  4629. export type QueryPromotionsArgs = {
  4630. options?: InputMaybe<PromotionListOptions>;
  4631. };
  4632. export type QueryProvinceArgs = {
  4633. id: Scalars['ID']['input'];
  4634. };
  4635. export type QueryProvincesArgs = {
  4636. options?: InputMaybe<ProvinceListOptions>;
  4637. };
  4638. export type QueryRoleArgs = {
  4639. id: Scalars['ID']['input'];
  4640. };
  4641. export type QueryRolesArgs = {
  4642. options?: InputMaybe<RoleListOptions>;
  4643. };
  4644. export type QuerySearchArgs = {
  4645. input: SearchInput;
  4646. };
  4647. export type QuerySellerArgs = {
  4648. id: Scalars['ID']['input'];
  4649. };
  4650. export type QuerySellersArgs = {
  4651. options?: InputMaybe<SellerListOptions>;
  4652. };
  4653. export type QueryShippingMethodArgs = {
  4654. id: Scalars['ID']['input'];
  4655. };
  4656. export type QueryShippingMethodsArgs = {
  4657. options?: InputMaybe<ShippingMethodListOptions>;
  4658. };
  4659. export type QueryStockLocationArgs = {
  4660. id: Scalars['ID']['input'];
  4661. };
  4662. export type QueryStockLocationsArgs = {
  4663. options?: InputMaybe<StockLocationListOptions>;
  4664. };
  4665. export type QueryTagArgs = {
  4666. id: Scalars['ID']['input'];
  4667. };
  4668. export type QueryTagsArgs = {
  4669. options?: InputMaybe<TagListOptions>;
  4670. };
  4671. export type QueryTaxCategoriesArgs = {
  4672. options?: InputMaybe<TaxCategoryListOptions>;
  4673. };
  4674. export type QueryTaxCategoryArgs = {
  4675. id: Scalars['ID']['input'];
  4676. };
  4677. export type QueryTaxRateArgs = {
  4678. id: Scalars['ID']['input'];
  4679. };
  4680. export type QueryTaxRatesArgs = {
  4681. options?: InputMaybe<TaxRateListOptions>;
  4682. };
  4683. export type QueryTestEligibleShippingMethodsArgs = {
  4684. input: TestEligibleShippingMethodsInput;
  4685. };
  4686. export type QueryTestShippingMethodArgs = {
  4687. input: TestShippingMethodInput;
  4688. };
  4689. export type QueryZoneArgs = {
  4690. id: Scalars['ID']['input'];
  4691. };
  4692. export type QueryZonesArgs = {
  4693. options?: InputMaybe<ZoneListOptions>;
  4694. };
  4695. export type Refund = Node & {
  4696. __typename?: 'Refund';
  4697. adjustment: Scalars['Money']['output'];
  4698. createdAt: Scalars['DateTime']['output'];
  4699. customFields?: Maybe<Scalars['JSON']['output']>;
  4700. id: Scalars['ID']['output'];
  4701. items: Scalars['Money']['output'];
  4702. lines: Array<RefundLine>;
  4703. metadata?: Maybe<Scalars['JSON']['output']>;
  4704. method?: Maybe<Scalars['String']['output']>;
  4705. paymentId: Scalars['ID']['output'];
  4706. reason?: Maybe<Scalars['String']['output']>;
  4707. shipping: Scalars['Money']['output'];
  4708. state: Scalars['String']['output'];
  4709. total: Scalars['Money']['output'];
  4710. transactionId?: Maybe<Scalars['String']['output']>;
  4711. updatedAt: Scalars['DateTime']['output'];
  4712. };
  4713. /** Returned if `amount` is greater than the maximum un-refunded amount of the Payment */
  4714. export type RefundAmountError = ErrorResult & {
  4715. __typename?: 'RefundAmountError';
  4716. errorCode: ErrorCode;
  4717. maximumRefundable: Scalars['Int']['output'];
  4718. message: Scalars['String']['output'];
  4719. };
  4720. export type RefundLine = {
  4721. __typename?: 'RefundLine';
  4722. orderLine: OrderLine;
  4723. orderLineId: Scalars['ID']['output'];
  4724. quantity: Scalars['Int']['output'];
  4725. refund: Refund;
  4726. refundId: Scalars['ID']['output'];
  4727. };
  4728. export type RefundOrderInput = {
  4729. /** @deprecated Use the `amount` field instead */
  4730. adjustment?: InputMaybe<Scalars['Money']['input']>;
  4731. /**
  4732. * The amount to be refunded to this particular payment. This was introduced in v2.2.0 as the preferred way to specify the refund amount.
  4733. * Can be as much as the total amount of the payment minus the sum of all previous refunds.
  4734. */
  4735. amount?: InputMaybe<Scalars['Money']['input']>;
  4736. /** @deprecated Use the `amount` field instead */
  4737. lines?: InputMaybe<Array<OrderLineInput>>;
  4738. paymentId: Scalars['ID']['input'];
  4739. reason?: InputMaybe<Scalars['String']['input']>;
  4740. /** @deprecated Use the `amount` field instead */
  4741. shipping?: InputMaybe<Scalars['Money']['input']>;
  4742. };
  4743. export type RefundOrderResult = AlreadyRefundedError | MultipleOrderError | NothingToRefundError | OrderStateTransitionError | PaymentOrderMismatchError | QuantityTooGreatError | Refund | RefundAmountError | RefundOrderStateError | RefundStateTransitionError;
  4744. /** Returned if an attempting to refund an Order which is not in the expected state */
  4745. export type RefundOrderStateError = ErrorResult & {
  4746. __typename?: 'RefundOrderStateError';
  4747. errorCode: ErrorCode;
  4748. message: Scalars['String']['output'];
  4749. orderState: Scalars['String']['output'];
  4750. };
  4751. /**
  4752. * Returned when a call to modifyOrder fails to include a refundPaymentId even
  4753. * though the price has decreased as a result of the changes.
  4754. */
  4755. export type RefundPaymentIdMissingError = ErrorResult & {
  4756. __typename?: 'RefundPaymentIdMissingError';
  4757. errorCode: ErrorCode;
  4758. message: Scalars['String']['output'];
  4759. };
  4760. /** Returned when there is an error in transitioning the Refund state */
  4761. export type RefundStateTransitionError = ErrorResult & {
  4762. __typename?: 'RefundStateTransitionError';
  4763. errorCode: ErrorCode;
  4764. fromState: Scalars['String']['output'];
  4765. message: Scalars['String']['output'];
  4766. toState: Scalars['String']['output'];
  4767. transitionError: Scalars['String']['output'];
  4768. };
  4769. export type Region = {
  4770. code: Scalars['String']['output'];
  4771. createdAt: Scalars['DateTime']['output'];
  4772. enabled: Scalars['Boolean']['output'];
  4773. id: Scalars['ID']['output'];
  4774. languageCode: LanguageCode;
  4775. name: Scalars['String']['output'];
  4776. parent?: Maybe<Region>;
  4777. parentId?: Maybe<Scalars['ID']['output']>;
  4778. translations: Array<RegionTranslation>;
  4779. type: Scalars['String']['output'];
  4780. updatedAt: Scalars['DateTime']['output'];
  4781. };
  4782. export type RegionTranslation = {
  4783. __typename?: 'RegionTranslation';
  4784. createdAt: Scalars['DateTime']['output'];
  4785. id: Scalars['ID']['output'];
  4786. languageCode: LanguageCode;
  4787. name: Scalars['String']['output'];
  4788. updatedAt: Scalars['DateTime']['output'];
  4789. };
  4790. export type RelationCustomFieldConfig = CustomField & {
  4791. __typename?: 'RelationCustomFieldConfig';
  4792. description?: Maybe<Array<LocalizedString>>;
  4793. entity: Scalars['String']['output'];
  4794. internal?: Maybe<Scalars['Boolean']['output']>;
  4795. label?: Maybe<Array<LocalizedString>>;
  4796. list: Scalars['Boolean']['output'];
  4797. name: Scalars['String']['output'];
  4798. nullable?: Maybe<Scalars['Boolean']['output']>;
  4799. readonly?: Maybe<Scalars['Boolean']['output']>;
  4800. requiresPermission?: Maybe<Array<Permission>>;
  4801. scalarFields: Array<Scalars['String']['output']>;
  4802. type: Scalars['String']['output'];
  4803. ui?: Maybe<Scalars['JSON']['output']>;
  4804. };
  4805. export type Release = Node & StockMovement & {
  4806. __typename?: 'Release';
  4807. createdAt: Scalars['DateTime']['output'];
  4808. customFields?: Maybe<Scalars['JSON']['output']>;
  4809. id: Scalars['ID']['output'];
  4810. productVariant: ProductVariant;
  4811. quantity: Scalars['Int']['output'];
  4812. type: StockMovementType;
  4813. updatedAt: Scalars['DateTime']['output'];
  4814. };
  4815. export type RemoveCollectionsFromChannelInput = {
  4816. channelId: Scalars['ID']['input'];
  4817. collectionIds: Array<Scalars['ID']['input']>;
  4818. };
  4819. export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
  4820. export type RemoveFacetsFromChannelInput = {
  4821. channelId: Scalars['ID']['input'];
  4822. facetIds: Array<Scalars['ID']['input']>;
  4823. force?: InputMaybe<Scalars['Boolean']['input']>;
  4824. };
  4825. export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
  4826. export type RemoveOrderItemsResult = Order | OrderInterceptorError | OrderModificationError;
  4827. export type RemovePaymentMethodsFromChannelInput = {
  4828. channelId: Scalars['ID']['input'];
  4829. paymentMethodIds: Array<Scalars['ID']['input']>;
  4830. };
  4831. export type RemoveProductVariantsFromChannelInput = {
  4832. channelId: Scalars['ID']['input'];
  4833. productVariantIds: Array<Scalars['ID']['input']>;
  4834. };
  4835. export type RemoveProductsFromChannelInput = {
  4836. channelId: Scalars['ID']['input'];
  4837. productIds: Array<Scalars['ID']['input']>;
  4838. };
  4839. export type RemovePromotionsFromChannelInput = {
  4840. channelId: Scalars['ID']['input'];
  4841. promotionIds: Array<Scalars['ID']['input']>;
  4842. };
  4843. export type RemoveShippingMethodsFromChannelInput = {
  4844. channelId: Scalars['ID']['input'];
  4845. shippingMethodIds: Array<Scalars['ID']['input']>;
  4846. };
  4847. export type RemoveStockLocationsFromChannelInput = {
  4848. channelId: Scalars['ID']['input'];
  4849. stockLocationIds: Array<Scalars['ID']['input']>;
  4850. };
  4851. export type Return = Node & StockMovement & {
  4852. __typename?: 'Return';
  4853. createdAt: Scalars['DateTime']['output'];
  4854. customFields?: Maybe<Scalars['JSON']['output']>;
  4855. id: Scalars['ID']['output'];
  4856. productVariant: ProductVariant;
  4857. quantity: Scalars['Int']['output'];
  4858. type: StockMovementType;
  4859. updatedAt: Scalars['DateTime']['output'];
  4860. };
  4861. export type Role = Node & {
  4862. __typename?: 'Role';
  4863. channels: Array<Channel>;
  4864. code: Scalars['String']['output'];
  4865. createdAt: Scalars['DateTime']['output'];
  4866. description: Scalars['String']['output'];
  4867. id: Scalars['ID']['output'];
  4868. permissions: Array<Permission>;
  4869. updatedAt: Scalars['DateTime']['output'];
  4870. };
  4871. export type RoleFilterParameter = {
  4872. _and?: InputMaybe<Array<RoleFilterParameter>>;
  4873. _or?: InputMaybe<Array<RoleFilterParameter>>;
  4874. code?: InputMaybe<StringOperators>;
  4875. createdAt?: InputMaybe<DateOperators>;
  4876. description?: InputMaybe<StringOperators>;
  4877. id?: InputMaybe<IdOperators>;
  4878. updatedAt?: InputMaybe<DateOperators>;
  4879. };
  4880. export type RoleList = PaginatedList & {
  4881. __typename?: 'RoleList';
  4882. items: Array<Role>;
  4883. totalItems: Scalars['Int']['output'];
  4884. };
  4885. export type RoleListOptions = {
  4886. /** Allows the results to be filtered */
  4887. filter?: InputMaybe<RoleFilterParameter>;
  4888. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4889. filterOperator?: InputMaybe<LogicalOperator>;
  4890. /** Skips the first n results, for use in pagination */
  4891. skip?: InputMaybe<Scalars['Int']['input']>;
  4892. /** Specifies which properties to sort the results by */
  4893. sort?: InputMaybe<RoleSortParameter>;
  4894. /** Takes n results, for use in pagination */
  4895. take?: InputMaybe<Scalars['Int']['input']>;
  4896. };
  4897. export type RoleSortParameter = {
  4898. code?: InputMaybe<SortOrder>;
  4899. createdAt?: InputMaybe<SortOrder>;
  4900. description?: InputMaybe<SortOrder>;
  4901. id?: InputMaybe<SortOrder>;
  4902. updatedAt?: InputMaybe<SortOrder>;
  4903. };
  4904. export type Sale = Node & StockMovement & {
  4905. __typename?: 'Sale';
  4906. createdAt: Scalars['DateTime']['output'];
  4907. customFields?: Maybe<Scalars['JSON']['output']>;
  4908. id: Scalars['ID']['output'];
  4909. productVariant: ProductVariant;
  4910. quantity: Scalars['Int']['output'];
  4911. type: StockMovementType;
  4912. updatedAt: Scalars['DateTime']['output'];
  4913. };
  4914. export type SearchInput = {
  4915. collectionId?: InputMaybe<Scalars['ID']['input']>;
  4916. collectionSlug?: InputMaybe<Scalars['String']['input']>;
  4917. facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
  4918. /** @deprecated Use `facetValueFilters` instead */
  4919. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  4920. /** @deprecated Use `facetValueFilters` instead */
  4921. facetValueOperator?: InputMaybe<LogicalOperator>;
  4922. groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
  4923. skip?: InputMaybe<Scalars['Int']['input']>;
  4924. sort?: InputMaybe<SearchResultSortParameter>;
  4925. take?: InputMaybe<Scalars['Int']['input']>;
  4926. term?: InputMaybe<Scalars['String']['input']>;
  4927. };
  4928. export type SearchReindexResponse = {
  4929. __typename?: 'SearchReindexResponse';
  4930. success: Scalars['Boolean']['output'];
  4931. };
  4932. export type SearchResponse = {
  4933. __typename?: 'SearchResponse';
  4934. collections: Array<CollectionResult>;
  4935. facetValues: Array<FacetValueResult>;
  4936. items: Array<SearchResult>;
  4937. totalItems: Scalars['Int']['output'];
  4938. };
  4939. export type SearchResult = {
  4940. __typename?: 'SearchResult';
  4941. /** An array of ids of the Channels in which this result appears */
  4942. channelIds: Array<Scalars['ID']['output']>;
  4943. /** An array of ids of the Collections in which this result appears */
  4944. collectionIds: Array<Scalars['ID']['output']>;
  4945. currencyCode: CurrencyCode;
  4946. description: Scalars['String']['output'];
  4947. enabled: Scalars['Boolean']['output'];
  4948. facetIds: Array<Scalars['ID']['output']>;
  4949. facetValueIds: Array<Scalars['ID']['output']>;
  4950. price: SearchResultPrice;
  4951. priceWithTax: SearchResultPrice;
  4952. productAsset?: Maybe<SearchResultAsset>;
  4953. productId: Scalars['ID']['output'];
  4954. productName: Scalars['String']['output'];
  4955. productVariantAsset?: Maybe<SearchResultAsset>;
  4956. productVariantId: Scalars['ID']['output'];
  4957. productVariantName: Scalars['String']['output'];
  4958. /** A relevance score for the result. Differs between database implementations */
  4959. score: Scalars['Float']['output'];
  4960. sku: Scalars['String']['output'];
  4961. slug: Scalars['String']['output'];
  4962. };
  4963. export type SearchResultAsset = {
  4964. __typename?: 'SearchResultAsset';
  4965. focalPoint?: Maybe<Coordinate>;
  4966. id: Scalars['ID']['output'];
  4967. preview: Scalars['String']['output'];
  4968. };
  4969. /** The price of a search result product, either as a range or as a single price */
  4970. export type SearchResultPrice = PriceRange | SinglePrice;
  4971. export type SearchResultSortParameter = {
  4972. name?: InputMaybe<SortOrder>;
  4973. price?: InputMaybe<SortOrder>;
  4974. };
  4975. export type Seller = Node & {
  4976. __typename?: 'Seller';
  4977. createdAt: Scalars['DateTime']['output'];
  4978. customFields?: Maybe<Scalars['JSON']['output']>;
  4979. id: Scalars['ID']['output'];
  4980. name: Scalars['String']['output'];
  4981. updatedAt: Scalars['DateTime']['output'];
  4982. };
  4983. export type SellerFilterParameter = {
  4984. _and?: InputMaybe<Array<SellerFilterParameter>>;
  4985. _or?: InputMaybe<Array<SellerFilterParameter>>;
  4986. createdAt?: InputMaybe<DateOperators>;
  4987. id?: InputMaybe<IdOperators>;
  4988. name?: InputMaybe<StringOperators>;
  4989. updatedAt?: InputMaybe<DateOperators>;
  4990. };
  4991. export type SellerList = PaginatedList & {
  4992. __typename?: 'SellerList';
  4993. items: Array<Seller>;
  4994. totalItems: Scalars['Int']['output'];
  4995. };
  4996. export type SellerListOptions = {
  4997. /** Allows the results to be filtered */
  4998. filter?: InputMaybe<SellerFilterParameter>;
  4999. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5000. filterOperator?: InputMaybe<LogicalOperator>;
  5001. /** Skips the first n results, for use in pagination */
  5002. skip?: InputMaybe<Scalars['Int']['input']>;
  5003. /** Specifies which properties to sort the results by */
  5004. sort?: InputMaybe<SellerSortParameter>;
  5005. /** Takes n results, for use in pagination */
  5006. take?: InputMaybe<Scalars['Int']['input']>;
  5007. };
  5008. export type SellerSortParameter = {
  5009. createdAt?: InputMaybe<SortOrder>;
  5010. id?: InputMaybe<SortOrder>;
  5011. name?: InputMaybe<SortOrder>;
  5012. updatedAt?: InputMaybe<SortOrder>;
  5013. };
  5014. export type ServerConfig = {
  5015. __typename?: 'ServerConfig';
  5016. /**
  5017. * This field is deprecated in v2.2 in favor of the entityCustomFields field,
  5018. * which allows custom fields to be defined on user-supplies entities.
  5019. */
  5020. customFieldConfig: CustomFields;
  5021. entityCustomFields: Array<EntityCustomFields>;
  5022. moneyStrategyPrecision: Scalars['Int']['output'];
  5023. orderProcess: Array<OrderProcessState>;
  5024. permissions: Array<PermissionDefinition>;
  5025. permittedAssetTypes: Array<Scalars['String']['output']>;
  5026. };
  5027. export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
  5028. export type SetOrderCustomerInput = {
  5029. customerId: Scalars['ID']['input'];
  5030. note?: InputMaybe<Scalars['String']['input']>;
  5031. orderId: Scalars['ID']['input'];
  5032. };
  5033. export type SetOrderShippingMethodResult = IneligibleShippingMethodError | NoActiveOrderError | Order | OrderModificationError;
  5034. /** Returned if the Payment settlement fails */
  5035. export type SettlePaymentError = ErrorResult & {
  5036. __typename?: 'SettlePaymentError';
  5037. errorCode: ErrorCode;
  5038. message: Scalars['String']['output'];
  5039. paymentErrorMessage: Scalars['String']['output'];
  5040. };
  5041. export type SettlePaymentResult = OrderStateTransitionError | Payment | PaymentStateTransitionError | SettlePaymentError;
  5042. export type SettleRefundInput = {
  5043. id: Scalars['ID']['input'];
  5044. transactionId: Scalars['String']['input'];
  5045. };
  5046. export type SettleRefundResult = Refund | RefundStateTransitionError;
  5047. export type ShippingLine = {
  5048. __typename?: 'ShippingLine';
  5049. customFields?: Maybe<Scalars['JSON']['output']>;
  5050. discountedPrice: Scalars['Money']['output'];
  5051. discountedPriceWithTax: Scalars['Money']['output'];
  5052. discounts: Array<Discount>;
  5053. id: Scalars['ID']['output'];
  5054. price: Scalars['Money']['output'];
  5055. priceWithTax: Scalars['Money']['output'];
  5056. shippingMethod: ShippingMethod;
  5057. };
  5058. export type ShippingMethod = Node & {
  5059. __typename?: 'ShippingMethod';
  5060. calculator: ConfigurableOperation;
  5061. checker: ConfigurableOperation;
  5062. code: Scalars['String']['output'];
  5063. createdAt: Scalars['DateTime']['output'];
  5064. customFields?: Maybe<Scalars['JSON']['output']>;
  5065. description: Scalars['String']['output'];
  5066. fulfillmentHandlerCode: Scalars['String']['output'];
  5067. id: Scalars['ID']['output'];
  5068. languageCode: LanguageCode;
  5069. name: Scalars['String']['output'];
  5070. translations: Array<ShippingMethodTranslation>;
  5071. updatedAt: Scalars['DateTime']['output'];
  5072. };
  5073. export type ShippingMethodFilterParameter = {
  5074. _and?: InputMaybe<Array<ShippingMethodFilterParameter>>;
  5075. _or?: InputMaybe<Array<ShippingMethodFilterParameter>>;
  5076. code?: InputMaybe<StringOperators>;
  5077. createdAt?: InputMaybe<DateOperators>;
  5078. description?: InputMaybe<StringOperators>;
  5079. fulfillmentHandlerCode?: InputMaybe<StringOperators>;
  5080. id?: InputMaybe<IdOperators>;
  5081. languageCode?: InputMaybe<StringOperators>;
  5082. name?: InputMaybe<StringOperators>;
  5083. updatedAt?: InputMaybe<DateOperators>;
  5084. };
  5085. export type ShippingMethodList = PaginatedList & {
  5086. __typename?: 'ShippingMethodList';
  5087. items: Array<ShippingMethod>;
  5088. totalItems: Scalars['Int']['output'];
  5089. };
  5090. export type ShippingMethodListOptions = {
  5091. /** Allows the results to be filtered */
  5092. filter?: InputMaybe<ShippingMethodFilterParameter>;
  5093. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5094. filterOperator?: InputMaybe<LogicalOperator>;
  5095. /** Skips the first n results, for use in pagination */
  5096. skip?: InputMaybe<Scalars['Int']['input']>;
  5097. /** Specifies which properties to sort the results by */
  5098. sort?: InputMaybe<ShippingMethodSortParameter>;
  5099. /** Takes n results, for use in pagination */
  5100. take?: InputMaybe<Scalars['Int']['input']>;
  5101. };
  5102. export type ShippingMethodQuote = {
  5103. __typename?: 'ShippingMethodQuote';
  5104. code: Scalars['String']['output'];
  5105. customFields?: Maybe<Scalars['JSON']['output']>;
  5106. description: Scalars['String']['output'];
  5107. id: Scalars['ID']['output'];
  5108. /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
  5109. metadata?: Maybe<Scalars['JSON']['output']>;
  5110. name: Scalars['String']['output'];
  5111. price: Scalars['Money']['output'];
  5112. priceWithTax: Scalars['Money']['output'];
  5113. };
  5114. export type ShippingMethodSortParameter = {
  5115. code?: InputMaybe<SortOrder>;
  5116. createdAt?: InputMaybe<SortOrder>;
  5117. description?: InputMaybe<SortOrder>;
  5118. fulfillmentHandlerCode?: InputMaybe<SortOrder>;
  5119. id?: InputMaybe<SortOrder>;
  5120. name?: InputMaybe<SortOrder>;
  5121. updatedAt?: InputMaybe<SortOrder>;
  5122. };
  5123. export type ShippingMethodTranslation = {
  5124. __typename?: 'ShippingMethodTranslation';
  5125. createdAt: Scalars['DateTime']['output'];
  5126. description: Scalars['String']['output'];
  5127. id: Scalars['ID']['output'];
  5128. languageCode: LanguageCode;
  5129. name: Scalars['String']['output'];
  5130. updatedAt: Scalars['DateTime']['output'];
  5131. };
  5132. export type ShippingMethodTranslationInput = {
  5133. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5134. description?: InputMaybe<Scalars['String']['input']>;
  5135. id?: InputMaybe<Scalars['ID']['input']>;
  5136. languageCode: LanguageCode;
  5137. name?: InputMaybe<Scalars['String']['input']>;
  5138. };
  5139. /** The price value where the result has a single price */
  5140. export type SinglePrice = {
  5141. __typename?: 'SinglePrice';
  5142. value: Scalars['Money']['output'];
  5143. };
  5144. export enum SortOrder {
  5145. ASC = 'ASC',
  5146. DESC = 'DESC'
  5147. }
  5148. export type StockAdjustment = Node & StockMovement & {
  5149. __typename?: 'StockAdjustment';
  5150. createdAt: Scalars['DateTime']['output'];
  5151. customFields?: Maybe<Scalars['JSON']['output']>;
  5152. id: Scalars['ID']['output'];
  5153. productVariant: ProductVariant;
  5154. quantity: Scalars['Int']['output'];
  5155. type: StockMovementType;
  5156. updatedAt: Scalars['DateTime']['output'];
  5157. };
  5158. export type StockLevel = Node & {
  5159. __typename?: 'StockLevel';
  5160. createdAt: Scalars['DateTime']['output'];
  5161. customFields?: Maybe<Scalars['JSON']['output']>;
  5162. id: Scalars['ID']['output'];
  5163. stockAllocated: Scalars['Int']['output'];
  5164. stockLocation: StockLocation;
  5165. stockLocationId: Scalars['ID']['output'];
  5166. stockOnHand: Scalars['Int']['output'];
  5167. updatedAt: Scalars['DateTime']['output'];
  5168. };
  5169. export type StockLevelInput = {
  5170. stockLocationId: Scalars['ID']['input'];
  5171. stockOnHand: Scalars['Int']['input'];
  5172. };
  5173. export type StockLocation = Node & {
  5174. __typename?: 'StockLocation';
  5175. createdAt: Scalars['DateTime']['output'];
  5176. customFields?: Maybe<Scalars['JSON']['output']>;
  5177. description: Scalars['String']['output'];
  5178. id: Scalars['ID']['output'];
  5179. name: Scalars['String']['output'];
  5180. updatedAt: Scalars['DateTime']['output'];
  5181. };
  5182. export type StockLocationFilterParameter = {
  5183. _and?: InputMaybe<Array<StockLocationFilterParameter>>;
  5184. _or?: InputMaybe<Array<StockLocationFilterParameter>>;
  5185. createdAt?: InputMaybe<DateOperators>;
  5186. description?: InputMaybe<StringOperators>;
  5187. id?: InputMaybe<IdOperators>;
  5188. name?: InputMaybe<StringOperators>;
  5189. updatedAt?: InputMaybe<DateOperators>;
  5190. };
  5191. export type StockLocationList = PaginatedList & {
  5192. __typename?: 'StockLocationList';
  5193. items: Array<StockLocation>;
  5194. totalItems: Scalars['Int']['output'];
  5195. };
  5196. export type StockLocationListOptions = {
  5197. /** Allows the results to be filtered */
  5198. filter?: InputMaybe<StockLocationFilterParameter>;
  5199. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5200. filterOperator?: InputMaybe<LogicalOperator>;
  5201. /** Skips the first n results, for use in pagination */
  5202. skip?: InputMaybe<Scalars['Int']['input']>;
  5203. /** Specifies which properties to sort the results by */
  5204. sort?: InputMaybe<StockLocationSortParameter>;
  5205. /** Takes n results, for use in pagination */
  5206. take?: InputMaybe<Scalars['Int']['input']>;
  5207. };
  5208. export type StockLocationSortParameter = {
  5209. createdAt?: InputMaybe<SortOrder>;
  5210. description?: InputMaybe<SortOrder>;
  5211. id?: InputMaybe<SortOrder>;
  5212. name?: InputMaybe<SortOrder>;
  5213. updatedAt?: InputMaybe<SortOrder>;
  5214. };
  5215. export type StockMovement = {
  5216. createdAt: Scalars['DateTime']['output'];
  5217. id: Scalars['ID']['output'];
  5218. productVariant: ProductVariant;
  5219. quantity: Scalars['Int']['output'];
  5220. type: StockMovementType;
  5221. updatedAt: Scalars['DateTime']['output'];
  5222. };
  5223. export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
  5224. export type StockMovementList = {
  5225. __typename?: 'StockMovementList';
  5226. items: Array<StockMovementItem>;
  5227. totalItems: Scalars['Int']['output'];
  5228. };
  5229. export type StockMovementListOptions = {
  5230. skip?: InputMaybe<Scalars['Int']['input']>;
  5231. take?: InputMaybe<Scalars['Int']['input']>;
  5232. type?: InputMaybe<StockMovementType>;
  5233. };
  5234. export enum StockMovementType {
  5235. ADJUSTMENT = 'ADJUSTMENT',
  5236. ALLOCATION = 'ALLOCATION',
  5237. CANCELLATION = 'CANCELLATION',
  5238. RELEASE = 'RELEASE',
  5239. RETURN = 'RETURN',
  5240. SALE = 'SALE'
  5241. }
  5242. export type StringCustomFieldConfig = CustomField & {
  5243. __typename?: 'StringCustomFieldConfig';
  5244. description?: Maybe<Array<LocalizedString>>;
  5245. internal?: Maybe<Scalars['Boolean']['output']>;
  5246. label?: Maybe<Array<LocalizedString>>;
  5247. length?: Maybe<Scalars['Int']['output']>;
  5248. list: Scalars['Boolean']['output'];
  5249. name: Scalars['String']['output'];
  5250. nullable?: Maybe<Scalars['Boolean']['output']>;
  5251. options?: Maybe<Array<StringFieldOption>>;
  5252. pattern?: Maybe<Scalars['String']['output']>;
  5253. readonly?: Maybe<Scalars['Boolean']['output']>;
  5254. requiresPermission?: Maybe<Array<Permission>>;
  5255. type: Scalars['String']['output'];
  5256. ui?: Maybe<Scalars['JSON']['output']>;
  5257. };
  5258. export type StringFieldOption = {
  5259. __typename?: 'StringFieldOption';
  5260. label?: Maybe<Array<LocalizedString>>;
  5261. value: Scalars['String']['output'];
  5262. };
  5263. /** Operators for filtering on a list of String fields */
  5264. export type StringListOperators = {
  5265. inList: Scalars['String']['input'];
  5266. };
  5267. /** Operators for filtering on a String field */
  5268. export type StringOperators = {
  5269. contains?: InputMaybe<Scalars['String']['input']>;
  5270. eq?: InputMaybe<Scalars['String']['input']>;
  5271. in?: InputMaybe<Array<Scalars['String']['input']>>;
  5272. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  5273. notContains?: InputMaybe<Scalars['String']['input']>;
  5274. notEq?: InputMaybe<Scalars['String']['input']>;
  5275. notIn?: InputMaybe<Array<Scalars['String']['input']>>;
  5276. regex?: InputMaybe<Scalars['String']['input']>;
  5277. };
  5278. export type StringStructFieldConfig = StructField & {
  5279. __typename?: 'StringStructFieldConfig';
  5280. description?: Maybe<Array<LocalizedString>>;
  5281. label?: Maybe<Array<LocalizedString>>;
  5282. length?: Maybe<Scalars['Int']['output']>;
  5283. list: Scalars['Boolean']['output'];
  5284. name: Scalars['String']['output'];
  5285. options?: Maybe<Array<StringFieldOption>>;
  5286. pattern?: Maybe<Scalars['String']['output']>;
  5287. type: Scalars['String']['output'];
  5288. ui?: Maybe<Scalars['JSON']['output']>;
  5289. };
  5290. export type StructCustomFieldConfig = CustomField & {
  5291. __typename?: 'StructCustomFieldConfig';
  5292. description?: Maybe<Array<LocalizedString>>;
  5293. fields: Array<StructFieldConfig>;
  5294. internal?: Maybe<Scalars['Boolean']['output']>;
  5295. label?: Maybe<Array<LocalizedString>>;
  5296. list: Scalars['Boolean']['output'];
  5297. name: Scalars['String']['output'];
  5298. nullable?: Maybe<Scalars['Boolean']['output']>;
  5299. readonly?: Maybe<Scalars['Boolean']['output']>;
  5300. requiresPermission?: Maybe<Array<Permission>>;
  5301. type: Scalars['String']['output'];
  5302. ui?: Maybe<Scalars['JSON']['output']>;
  5303. };
  5304. export type StructField = {
  5305. description?: Maybe<Array<LocalizedString>>;
  5306. label?: Maybe<Array<LocalizedString>>;
  5307. list?: Maybe<Scalars['Boolean']['output']>;
  5308. name: Scalars['String']['output'];
  5309. type: Scalars['String']['output'];
  5310. ui?: Maybe<Scalars['JSON']['output']>;
  5311. };
  5312. export type StructFieldConfig = BooleanStructFieldConfig | DateTimeStructFieldConfig | FloatStructFieldConfig | IntStructFieldConfig | StringStructFieldConfig | TextStructFieldConfig;
  5313. /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
  5314. export type Success = {
  5315. __typename?: 'Success';
  5316. success: Scalars['Boolean']['output'];
  5317. };
  5318. export type Surcharge = Node & {
  5319. __typename?: 'Surcharge';
  5320. createdAt: Scalars['DateTime']['output'];
  5321. description: Scalars['String']['output'];
  5322. id: Scalars['ID']['output'];
  5323. price: Scalars['Money']['output'];
  5324. priceWithTax: Scalars['Money']['output'];
  5325. sku?: Maybe<Scalars['String']['output']>;
  5326. taxLines: Array<TaxLine>;
  5327. taxRate: Scalars['Float']['output'];
  5328. updatedAt: Scalars['DateTime']['output'];
  5329. };
  5330. export type SurchargeInput = {
  5331. description: Scalars['String']['input'];
  5332. price: Scalars['Money']['input'];
  5333. priceIncludesTax: Scalars['Boolean']['input'];
  5334. sku?: InputMaybe<Scalars['String']['input']>;
  5335. taxDescription?: InputMaybe<Scalars['String']['input']>;
  5336. taxRate?: InputMaybe<Scalars['Float']['input']>;
  5337. };
  5338. export type Tag = Node & {
  5339. __typename?: 'Tag';
  5340. createdAt: Scalars['DateTime']['output'];
  5341. id: Scalars['ID']['output'];
  5342. updatedAt: Scalars['DateTime']['output'];
  5343. value: Scalars['String']['output'];
  5344. };
  5345. export type TagFilterParameter = {
  5346. _and?: InputMaybe<Array<TagFilterParameter>>;
  5347. _or?: InputMaybe<Array<TagFilterParameter>>;
  5348. createdAt?: InputMaybe<DateOperators>;
  5349. id?: InputMaybe<IdOperators>;
  5350. updatedAt?: InputMaybe<DateOperators>;
  5351. value?: InputMaybe<StringOperators>;
  5352. };
  5353. export type TagList = PaginatedList & {
  5354. __typename?: 'TagList';
  5355. items: Array<Tag>;
  5356. totalItems: Scalars['Int']['output'];
  5357. };
  5358. export type TagListOptions = {
  5359. /** Allows the results to be filtered */
  5360. filter?: InputMaybe<TagFilterParameter>;
  5361. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5362. filterOperator?: InputMaybe<LogicalOperator>;
  5363. /** Skips the first n results, for use in pagination */
  5364. skip?: InputMaybe<Scalars['Int']['input']>;
  5365. /** Specifies which properties to sort the results by */
  5366. sort?: InputMaybe<TagSortParameter>;
  5367. /** Takes n results, for use in pagination */
  5368. take?: InputMaybe<Scalars['Int']['input']>;
  5369. };
  5370. export type TagSortParameter = {
  5371. createdAt?: InputMaybe<SortOrder>;
  5372. id?: InputMaybe<SortOrder>;
  5373. updatedAt?: InputMaybe<SortOrder>;
  5374. value?: InputMaybe<SortOrder>;
  5375. };
  5376. export type TaxCategory = Node & {
  5377. __typename?: 'TaxCategory';
  5378. createdAt: Scalars['DateTime']['output'];
  5379. customFields?: Maybe<Scalars['JSON']['output']>;
  5380. id: Scalars['ID']['output'];
  5381. isDefault: Scalars['Boolean']['output'];
  5382. name: Scalars['String']['output'];
  5383. updatedAt: Scalars['DateTime']['output'];
  5384. };
  5385. export type TaxCategoryFilterParameter = {
  5386. _and?: InputMaybe<Array<TaxCategoryFilterParameter>>;
  5387. _or?: InputMaybe<Array<TaxCategoryFilterParameter>>;
  5388. createdAt?: InputMaybe<DateOperators>;
  5389. id?: InputMaybe<IdOperators>;
  5390. isDefault?: InputMaybe<BooleanOperators>;
  5391. name?: InputMaybe<StringOperators>;
  5392. updatedAt?: InputMaybe<DateOperators>;
  5393. };
  5394. export type TaxCategoryList = PaginatedList & {
  5395. __typename?: 'TaxCategoryList';
  5396. items: Array<TaxCategory>;
  5397. totalItems: Scalars['Int']['output'];
  5398. };
  5399. export type TaxCategoryListOptions = {
  5400. /** Allows the results to be filtered */
  5401. filter?: InputMaybe<TaxCategoryFilterParameter>;
  5402. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5403. filterOperator?: InputMaybe<LogicalOperator>;
  5404. /** Skips the first n results, for use in pagination */
  5405. skip?: InputMaybe<Scalars['Int']['input']>;
  5406. /** Specifies which properties to sort the results by */
  5407. sort?: InputMaybe<TaxCategorySortParameter>;
  5408. /** Takes n results, for use in pagination */
  5409. take?: InputMaybe<Scalars['Int']['input']>;
  5410. };
  5411. export type TaxCategorySortParameter = {
  5412. createdAt?: InputMaybe<SortOrder>;
  5413. id?: InputMaybe<SortOrder>;
  5414. name?: InputMaybe<SortOrder>;
  5415. updatedAt?: InputMaybe<SortOrder>;
  5416. };
  5417. export type TaxLine = {
  5418. __typename?: 'TaxLine';
  5419. description: Scalars['String']['output'];
  5420. taxRate: Scalars['Float']['output'];
  5421. };
  5422. export type TaxRate = Node & {
  5423. __typename?: 'TaxRate';
  5424. category: TaxCategory;
  5425. createdAt: Scalars['DateTime']['output'];
  5426. customFields?: Maybe<Scalars['JSON']['output']>;
  5427. customerGroup?: Maybe<CustomerGroup>;
  5428. enabled: Scalars['Boolean']['output'];
  5429. id: Scalars['ID']['output'];
  5430. name: Scalars['String']['output'];
  5431. updatedAt: Scalars['DateTime']['output'];
  5432. value: Scalars['Float']['output'];
  5433. zone: Zone;
  5434. };
  5435. export type TaxRateFilterParameter = {
  5436. _and?: InputMaybe<Array<TaxRateFilterParameter>>;
  5437. _or?: InputMaybe<Array<TaxRateFilterParameter>>;
  5438. createdAt?: InputMaybe<DateOperators>;
  5439. enabled?: InputMaybe<BooleanOperators>;
  5440. id?: InputMaybe<IdOperators>;
  5441. name?: InputMaybe<StringOperators>;
  5442. updatedAt?: InputMaybe<DateOperators>;
  5443. value?: InputMaybe<NumberOperators>;
  5444. };
  5445. export type TaxRateList = PaginatedList & {
  5446. __typename?: 'TaxRateList';
  5447. items: Array<TaxRate>;
  5448. totalItems: Scalars['Int']['output'];
  5449. };
  5450. export type TaxRateListOptions = {
  5451. /** Allows the results to be filtered */
  5452. filter?: InputMaybe<TaxRateFilterParameter>;
  5453. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5454. filterOperator?: InputMaybe<LogicalOperator>;
  5455. /** Skips the first n results, for use in pagination */
  5456. skip?: InputMaybe<Scalars['Int']['input']>;
  5457. /** Specifies which properties to sort the results by */
  5458. sort?: InputMaybe<TaxRateSortParameter>;
  5459. /** Takes n results, for use in pagination */
  5460. take?: InputMaybe<Scalars['Int']['input']>;
  5461. };
  5462. export type TaxRateSortParameter = {
  5463. createdAt?: InputMaybe<SortOrder>;
  5464. id?: InputMaybe<SortOrder>;
  5465. name?: InputMaybe<SortOrder>;
  5466. updatedAt?: InputMaybe<SortOrder>;
  5467. value?: InputMaybe<SortOrder>;
  5468. };
  5469. export type TestEligibleShippingMethodsInput = {
  5470. lines: Array<TestShippingMethodOrderLineInput>;
  5471. shippingAddress: CreateAddressInput;
  5472. };
  5473. export type TestShippingMethodInput = {
  5474. calculator: ConfigurableOperationInput;
  5475. checker: ConfigurableOperationInput;
  5476. lines: Array<TestShippingMethodOrderLineInput>;
  5477. shippingAddress: CreateAddressInput;
  5478. };
  5479. export type TestShippingMethodOrderLineInput = {
  5480. productVariantId: Scalars['ID']['input'];
  5481. quantity: Scalars['Int']['input'];
  5482. };
  5483. export type TestShippingMethodQuote = {
  5484. __typename?: 'TestShippingMethodQuote';
  5485. metadata?: Maybe<Scalars['JSON']['output']>;
  5486. price: Scalars['Money']['output'];
  5487. priceWithTax: Scalars['Money']['output'];
  5488. };
  5489. export type TestShippingMethodResult = {
  5490. __typename?: 'TestShippingMethodResult';
  5491. eligible: Scalars['Boolean']['output'];
  5492. quote?: Maybe<TestShippingMethodQuote>;
  5493. };
  5494. export type TextCustomFieldConfig = CustomField & {
  5495. __typename?: 'TextCustomFieldConfig';
  5496. description?: Maybe<Array<LocalizedString>>;
  5497. internal?: Maybe<Scalars['Boolean']['output']>;
  5498. label?: Maybe<Array<LocalizedString>>;
  5499. list: Scalars['Boolean']['output'];
  5500. name: Scalars['String']['output'];
  5501. nullable?: Maybe<Scalars['Boolean']['output']>;
  5502. readonly?: Maybe<Scalars['Boolean']['output']>;
  5503. requiresPermission?: Maybe<Array<Permission>>;
  5504. type: Scalars['String']['output'];
  5505. ui?: Maybe<Scalars['JSON']['output']>;
  5506. };
  5507. export type TextStructFieldConfig = StructField & {
  5508. __typename?: 'TextStructFieldConfig';
  5509. description?: Maybe<Array<LocalizedString>>;
  5510. label?: Maybe<Array<LocalizedString>>;
  5511. list: Scalars['Boolean']['output'];
  5512. name: Scalars['String']['output'];
  5513. type: Scalars['String']['output'];
  5514. ui?: Maybe<Scalars['JSON']['output']>;
  5515. };
  5516. export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
  5517. export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
  5518. export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
  5519. export type UpdateActiveAdministratorInput = {
  5520. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5521. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5522. firstName?: InputMaybe<Scalars['String']['input']>;
  5523. lastName?: InputMaybe<Scalars['String']['input']>;
  5524. password?: InputMaybe<Scalars['String']['input']>;
  5525. };
  5526. /**
  5527. * Input used to update an Address.
  5528. *
  5529. * The countryCode must correspond to a `code` property of a Country that has been defined in the
  5530. * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
  5531. * If an invalid code is passed, the mutation will fail.
  5532. */
  5533. export type UpdateAddressInput = {
  5534. city?: InputMaybe<Scalars['String']['input']>;
  5535. company?: InputMaybe<Scalars['String']['input']>;
  5536. countryCode?: InputMaybe<Scalars['String']['input']>;
  5537. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5538. defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  5539. defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  5540. fullName?: InputMaybe<Scalars['String']['input']>;
  5541. id: Scalars['ID']['input'];
  5542. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5543. postalCode?: InputMaybe<Scalars['String']['input']>;
  5544. province?: InputMaybe<Scalars['String']['input']>;
  5545. streetLine1?: InputMaybe<Scalars['String']['input']>;
  5546. streetLine2?: InputMaybe<Scalars['String']['input']>;
  5547. };
  5548. export type UpdateAdministratorInput = {
  5549. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5550. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5551. firstName?: InputMaybe<Scalars['String']['input']>;
  5552. id: Scalars['ID']['input'];
  5553. lastName?: InputMaybe<Scalars['String']['input']>;
  5554. password?: InputMaybe<Scalars['String']['input']>;
  5555. roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5556. };
  5557. export type UpdateAssetInput = {
  5558. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5559. focalPoint?: InputMaybe<CoordinateInput>;
  5560. id: Scalars['ID']['input'];
  5561. name?: InputMaybe<Scalars['String']['input']>;
  5562. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  5563. };
  5564. export type UpdateChannelInput = {
  5565. availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
  5566. availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
  5567. code?: InputMaybe<Scalars['String']['input']>;
  5568. /** @deprecated Use defaultCurrencyCode instead */
  5569. currencyCode?: InputMaybe<CurrencyCode>;
  5570. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5571. defaultCurrencyCode?: InputMaybe<CurrencyCode>;
  5572. defaultLanguageCode?: InputMaybe<LanguageCode>;
  5573. defaultShippingZoneId?: InputMaybe<Scalars['ID']['input']>;
  5574. defaultTaxZoneId?: InputMaybe<Scalars['ID']['input']>;
  5575. id: Scalars['ID']['input'];
  5576. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5577. pricesIncludeTax?: InputMaybe<Scalars['Boolean']['input']>;
  5578. sellerId?: InputMaybe<Scalars['ID']['input']>;
  5579. token?: InputMaybe<Scalars['String']['input']>;
  5580. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  5581. };
  5582. export type UpdateChannelResult = Channel | LanguageNotAvailableError;
  5583. export type UpdateCollectionInput = {
  5584. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5585. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5586. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5587. filters?: InputMaybe<Array<ConfigurableOperationInput>>;
  5588. id: Scalars['ID']['input'];
  5589. inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
  5590. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  5591. parentId?: InputMaybe<Scalars['ID']['input']>;
  5592. translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
  5593. };
  5594. export type UpdateCollectionTranslationInput = {
  5595. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5596. description?: InputMaybe<Scalars['String']['input']>;
  5597. id?: InputMaybe<Scalars['ID']['input']>;
  5598. languageCode: LanguageCode;
  5599. name?: InputMaybe<Scalars['String']['input']>;
  5600. slug?: InputMaybe<Scalars['String']['input']>;
  5601. };
  5602. export type UpdateCountryInput = {
  5603. code?: InputMaybe<Scalars['String']['input']>;
  5604. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5605. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5606. id: Scalars['ID']['input'];
  5607. translations?: InputMaybe<Array<CountryTranslationInput>>;
  5608. };
  5609. export type UpdateCustomerGroupInput = {
  5610. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5611. id: Scalars['ID']['input'];
  5612. name?: InputMaybe<Scalars['String']['input']>;
  5613. };
  5614. export type UpdateCustomerInput = {
  5615. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5616. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5617. firstName?: InputMaybe<Scalars['String']['input']>;
  5618. id: Scalars['ID']['input'];
  5619. lastName?: InputMaybe<Scalars['String']['input']>;
  5620. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5621. title?: InputMaybe<Scalars['String']['input']>;
  5622. };
  5623. export type UpdateCustomerNoteInput = {
  5624. note: Scalars['String']['input'];
  5625. noteId: Scalars['ID']['input'];
  5626. };
  5627. export type UpdateCustomerResult = Customer | EmailAddressConflictError;
  5628. export type UpdateFacetInput = {
  5629. code?: InputMaybe<Scalars['String']['input']>;
  5630. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5631. id: Scalars['ID']['input'];
  5632. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  5633. translations?: InputMaybe<Array<FacetTranslationInput>>;
  5634. };
  5635. export type UpdateFacetValueInput = {
  5636. code?: InputMaybe<Scalars['String']['input']>;
  5637. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5638. id: Scalars['ID']['input'];
  5639. translations?: InputMaybe<Array<FacetValueTranslationInput>>;
  5640. };
  5641. export type UpdateGlobalSettingsInput = {
  5642. availableLanguages?: InputMaybe<Array<LanguageCode>>;
  5643. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5644. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5645. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  5646. };
  5647. export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
  5648. export type UpdateOrderAddressInput = {
  5649. city?: InputMaybe<Scalars['String']['input']>;
  5650. company?: InputMaybe<Scalars['String']['input']>;
  5651. countryCode?: InputMaybe<Scalars['String']['input']>;
  5652. fullName?: InputMaybe<Scalars['String']['input']>;
  5653. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5654. postalCode?: InputMaybe<Scalars['String']['input']>;
  5655. province?: InputMaybe<Scalars['String']['input']>;
  5656. streetLine1?: InputMaybe<Scalars['String']['input']>;
  5657. streetLine2?: InputMaybe<Scalars['String']['input']>;
  5658. };
  5659. export type UpdateOrderInput = {
  5660. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5661. id: Scalars['ID']['input'];
  5662. };
  5663. export type UpdateOrderItemsResult = InsufficientStockError | NegativeQuantityError | Order | OrderInterceptorError | OrderLimitError | OrderModificationError;
  5664. export type UpdateOrderNoteInput = {
  5665. isPublic?: InputMaybe<Scalars['Boolean']['input']>;
  5666. note?: InputMaybe<Scalars['String']['input']>;
  5667. noteId: Scalars['ID']['input'];
  5668. };
  5669. export type UpdatePaymentMethodInput = {
  5670. checker?: InputMaybe<ConfigurableOperationInput>;
  5671. code?: InputMaybe<Scalars['String']['input']>;
  5672. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5673. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5674. handler?: InputMaybe<ConfigurableOperationInput>;
  5675. id: Scalars['ID']['input'];
  5676. translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
  5677. };
  5678. export type UpdateProductInput = {
  5679. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5680. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5681. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5682. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5683. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5684. id: Scalars['ID']['input'];
  5685. translations?: InputMaybe<Array<ProductTranslationInput>>;
  5686. };
  5687. export type UpdateProductOptionGroupInput = {
  5688. code?: InputMaybe<Scalars['String']['input']>;
  5689. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5690. id: Scalars['ID']['input'];
  5691. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5692. };
  5693. export type UpdateProductOptionInput = {
  5694. code?: InputMaybe<Scalars['String']['input']>;
  5695. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5696. id: Scalars['ID']['input'];
  5697. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5698. };
  5699. export type UpdateProductVariantInput = {
  5700. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5701. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5702. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5703. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5704. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5705. id: Scalars['ID']['input'];
  5706. optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5707. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5708. /** Sets the price for the ProductVariant in the Channel's default currency */
  5709. price?: InputMaybe<Scalars['Money']['input']>;
  5710. /** Allows multiple prices to be set for the ProductVariant in different currencies. */
  5711. prices?: InputMaybe<Array<UpdateProductVariantPriceInput>>;
  5712. sku?: InputMaybe<Scalars['String']['input']>;
  5713. stockLevels?: InputMaybe<Array<StockLevelInput>>;
  5714. stockOnHand?: InputMaybe<Scalars['Int']['input']>;
  5715. taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
  5716. trackInventory?: InputMaybe<GlobalFlag>;
  5717. translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
  5718. useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
  5719. };
  5720. /**
  5721. * Used to set up update the price of a ProductVariant in a particular Channel.
  5722. * If the `delete` flag is `true`, the price will be deleted for the given Channel.
  5723. */
  5724. export type UpdateProductVariantPriceInput = {
  5725. currencyCode: CurrencyCode;
  5726. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5727. delete?: InputMaybe<Scalars['Boolean']['input']>;
  5728. price: Scalars['Money']['input'];
  5729. };
  5730. export type UpdatePromotionInput = {
  5731. actions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5732. conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5733. couponCode?: InputMaybe<Scalars['String']['input']>;
  5734. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5735. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5736. endsAt?: InputMaybe<Scalars['DateTime']['input']>;
  5737. id: Scalars['ID']['input'];
  5738. perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
  5739. startsAt?: InputMaybe<Scalars['DateTime']['input']>;
  5740. translations?: InputMaybe<Array<PromotionTranslationInput>>;
  5741. usageLimit?: InputMaybe<Scalars['Int']['input']>;
  5742. };
  5743. export type UpdatePromotionResult = MissingConditionsError | Promotion;
  5744. export type UpdateProvinceInput = {
  5745. code?: InputMaybe<Scalars['String']['input']>;
  5746. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5747. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5748. id: Scalars['ID']['input'];
  5749. translations?: InputMaybe<Array<ProvinceTranslationInput>>;
  5750. };
  5751. export type UpdateRoleInput = {
  5752. channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5753. code?: InputMaybe<Scalars['String']['input']>;
  5754. description?: InputMaybe<Scalars['String']['input']>;
  5755. id: Scalars['ID']['input'];
  5756. permissions?: InputMaybe<Array<Permission>>;
  5757. };
  5758. export type UpdateSellerInput = {
  5759. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5760. id: Scalars['ID']['input'];
  5761. name?: InputMaybe<Scalars['String']['input']>;
  5762. };
  5763. export type UpdateShippingMethodInput = {
  5764. calculator?: InputMaybe<ConfigurableOperationInput>;
  5765. checker?: InputMaybe<ConfigurableOperationInput>;
  5766. code?: InputMaybe<Scalars['String']['input']>;
  5767. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5768. fulfillmentHandler?: InputMaybe<Scalars['String']['input']>;
  5769. id: Scalars['ID']['input'];
  5770. translations: Array<ShippingMethodTranslationInput>;
  5771. };
  5772. export type UpdateStockLocationInput = {
  5773. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5774. description?: InputMaybe<Scalars['String']['input']>;
  5775. id: Scalars['ID']['input'];
  5776. name?: InputMaybe<Scalars['String']['input']>;
  5777. };
  5778. export type UpdateTagInput = {
  5779. id: Scalars['ID']['input'];
  5780. value?: InputMaybe<Scalars['String']['input']>;
  5781. };
  5782. export type UpdateTaxCategoryInput = {
  5783. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5784. id: Scalars['ID']['input'];
  5785. isDefault?: InputMaybe<Scalars['Boolean']['input']>;
  5786. name?: InputMaybe<Scalars['String']['input']>;
  5787. };
  5788. export type UpdateTaxRateInput = {
  5789. categoryId?: InputMaybe<Scalars['ID']['input']>;
  5790. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5791. customerGroupId?: InputMaybe<Scalars['ID']['input']>;
  5792. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5793. id: Scalars['ID']['input'];
  5794. name?: InputMaybe<Scalars['String']['input']>;
  5795. value?: InputMaybe<Scalars['Float']['input']>;
  5796. zoneId?: InputMaybe<Scalars['ID']['input']>;
  5797. };
  5798. export type UpdateZoneInput = {
  5799. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5800. id: Scalars['ID']['input'];
  5801. name?: InputMaybe<Scalars['String']['input']>;
  5802. };
  5803. export type User = Node & {
  5804. __typename?: 'User';
  5805. authenticationMethods: Array<AuthenticationMethod>;
  5806. createdAt: Scalars['DateTime']['output'];
  5807. customFields?: Maybe<Scalars['JSON']['output']>;
  5808. id: Scalars['ID']['output'];
  5809. identifier: Scalars['String']['output'];
  5810. lastLogin?: Maybe<Scalars['DateTime']['output']>;
  5811. roles: Array<Role>;
  5812. updatedAt: Scalars['DateTime']['output'];
  5813. verified: Scalars['Boolean']['output'];
  5814. };
  5815. export type Zone = Node & {
  5816. __typename?: 'Zone';
  5817. createdAt: Scalars['DateTime']['output'];
  5818. customFields?: Maybe<Scalars['JSON']['output']>;
  5819. id: Scalars['ID']['output'];
  5820. members: Array<Region>;
  5821. name: Scalars['String']['output'];
  5822. updatedAt: Scalars['DateTime']['output'];
  5823. };
  5824. export type ZoneFilterParameter = {
  5825. _and?: InputMaybe<Array<ZoneFilterParameter>>;
  5826. _or?: InputMaybe<Array<ZoneFilterParameter>>;
  5827. createdAt?: InputMaybe<DateOperators>;
  5828. id?: InputMaybe<IdOperators>;
  5829. name?: InputMaybe<StringOperators>;
  5830. updatedAt?: InputMaybe<DateOperators>;
  5831. };
  5832. export type ZoneList = PaginatedList & {
  5833. __typename?: 'ZoneList';
  5834. items: Array<Zone>;
  5835. totalItems: Scalars['Int']['output'];
  5836. };
  5837. export type ZoneListOptions = {
  5838. /** Allows the results to be filtered */
  5839. filter?: InputMaybe<ZoneFilterParameter>;
  5840. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5841. filterOperator?: InputMaybe<LogicalOperator>;
  5842. /** Skips the first n results, for use in pagination */
  5843. skip?: InputMaybe<Scalars['Int']['input']>;
  5844. /** Specifies which properties to sort the results by */
  5845. sort?: InputMaybe<ZoneSortParameter>;
  5846. /** Takes n results, for use in pagination */
  5847. take?: InputMaybe<Scalars['Int']['input']>;
  5848. };
  5849. export type ZoneSortParameter = {
  5850. createdAt?: InputMaybe<SortOrder>;
  5851. id?: InputMaybe<SortOrder>;
  5852. name?: InputMaybe<SortOrder>;
  5853. updatedAt?: InputMaybe<SortOrder>;
  5854. };