generated-types.ts 211 KB

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