generated-types.ts 176 KB

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