generated-types.ts 194 KB

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