generated-types.ts 208 KB

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