generated-types.ts 198 KB

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