generated-types.ts 202 KB

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