generated-types.ts 202 KB

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