generated-types.ts 182 KB

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