generated-types.ts 199 KB

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