generated-types.ts 181 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416
  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. /** Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0. */
  1448. valueList: FacetValueList;
  1449. values: Array<FacetValue>;
  1450. };
  1451. export type FacetValueListArgs = {
  1452. options?: InputMaybe<FacetValueListOptions>;
  1453. };
  1454. export type FacetFilterParameter = {
  1455. code?: InputMaybe<StringOperators>;
  1456. createdAt?: InputMaybe<DateOperators>;
  1457. id?: InputMaybe<IdOperators>;
  1458. isPrivate?: InputMaybe<BooleanOperators>;
  1459. languageCode?: InputMaybe<StringOperators>;
  1460. name?: InputMaybe<StringOperators>;
  1461. updatedAt?: InputMaybe<DateOperators>;
  1462. };
  1463. export type FacetInUseError = ErrorResult & {
  1464. __typename?: 'FacetInUseError';
  1465. errorCode: ErrorCode;
  1466. facetCode: Scalars['String'];
  1467. message: Scalars['String'];
  1468. productCount: Scalars['Int'];
  1469. variantCount: Scalars['Int'];
  1470. };
  1471. export type FacetList = PaginatedList & {
  1472. __typename?: 'FacetList';
  1473. items: Array<Facet>;
  1474. totalItems: Scalars['Int'];
  1475. };
  1476. export type FacetListOptions = {
  1477. /** Allows the results to be filtered */
  1478. filter?: InputMaybe<FacetFilterParameter>;
  1479. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  1480. filterOperator?: InputMaybe<LogicalOperator>;
  1481. /** Skips the first n results, for use in pagination */
  1482. skip?: InputMaybe<Scalars['Int']>;
  1483. /** Specifies which properties to sort the results by */
  1484. sort?: InputMaybe<FacetSortParameter>;
  1485. /** Takes n results, for use in pagination */
  1486. take?: InputMaybe<Scalars['Int']>;
  1487. };
  1488. export type FacetSortParameter = {
  1489. code?: InputMaybe<SortOrder>;
  1490. createdAt?: InputMaybe<SortOrder>;
  1491. id?: InputMaybe<SortOrder>;
  1492. name?: InputMaybe<SortOrder>;
  1493. updatedAt?: InputMaybe<SortOrder>;
  1494. };
  1495. export type FacetTranslation = {
  1496. __typename?: 'FacetTranslation';
  1497. createdAt: Scalars['DateTime'];
  1498. id: Scalars['ID'];
  1499. languageCode: LanguageCode;
  1500. name: Scalars['String'];
  1501. updatedAt: Scalars['DateTime'];
  1502. };
  1503. export type FacetTranslationInput = {
  1504. customFields?: InputMaybe<Scalars['JSON']>;
  1505. id?: InputMaybe<Scalars['ID']>;
  1506. languageCode: LanguageCode;
  1507. name?: InputMaybe<Scalars['String']>;
  1508. };
  1509. export type FacetValue = Node & {
  1510. __typename?: 'FacetValue';
  1511. code: Scalars['String'];
  1512. createdAt: Scalars['DateTime'];
  1513. customFields?: Maybe<Scalars['JSON']>;
  1514. facet: Facet;
  1515. facetId: Scalars['ID'];
  1516. id: Scalars['ID'];
  1517. languageCode: LanguageCode;
  1518. name: Scalars['String'];
  1519. translations: Array<FacetValueTranslation>;
  1520. updatedAt: Scalars['DateTime'];
  1521. };
  1522. /**
  1523. * Used to construct boolean expressions for filtering search results
  1524. * by FacetValue ID. Examples:
  1525. *
  1526. * * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
  1527. * * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
  1528. * * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
  1529. */
  1530. export type FacetValueFilterInput = {
  1531. and?: InputMaybe<Scalars['ID']>;
  1532. or?: InputMaybe<Array<Scalars['ID']>>;
  1533. };
  1534. export type FacetValueFilterParameter = {
  1535. code?: InputMaybe<StringOperators>;
  1536. createdAt?: InputMaybe<DateOperators>;
  1537. facetId?: InputMaybe<IdOperators>;
  1538. id?: InputMaybe<IdOperators>;
  1539. languageCode?: InputMaybe<StringOperators>;
  1540. name?: InputMaybe<StringOperators>;
  1541. updatedAt?: InputMaybe<DateOperators>;
  1542. };
  1543. export type FacetValueList = PaginatedList & {
  1544. __typename?: 'FacetValueList';
  1545. items: Array<FacetValue>;
  1546. totalItems: Scalars['Int'];
  1547. };
  1548. export type FacetValueListOptions = {
  1549. /** Allows the results to be filtered */
  1550. filter?: InputMaybe<FacetValueFilterParameter>;
  1551. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  1552. filterOperator?: InputMaybe<LogicalOperator>;
  1553. /** Skips the first n results, for use in pagination */
  1554. skip?: InputMaybe<Scalars['Int']>;
  1555. /** Specifies which properties to sort the results by */
  1556. sort?: InputMaybe<FacetValueSortParameter>;
  1557. /** Takes n results, for use in pagination */
  1558. take?: InputMaybe<Scalars['Int']>;
  1559. };
  1560. /**
  1561. * Which FacetValues are present in the products returned
  1562. * by the search, and in what quantity.
  1563. */
  1564. export type FacetValueResult = {
  1565. __typename?: 'FacetValueResult';
  1566. count: Scalars['Int'];
  1567. facetValue: FacetValue;
  1568. };
  1569. export type FacetValueSortParameter = {
  1570. code?: InputMaybe<SortOrder>;
  1571. createdAt?: InputMaybe<SortOrder>;
  1572. facetId?: InputMaybe<SortOrder>;
  1573. id?: InputMaybe<SortOrder>;
  1574. name?: InputMaybe<SortOrder>;
  1575. updatedAt?: InputMaybe<SortOrder>;
  1576. };
  1577. export type FacetValueTranslation = {
  1578. __typename?: 'FacetValueTranslation';
  1579. createdAt: Scalars['DateTime'];
  1580. id: Scalars['ID'];
  1581. languageCode: LanguageCode;
  1582. name: Scalars['String'];
  1583. updatedAt: Scalars['DateTime'];
  1584. };
  1585. export type FacetValueTranslationInput = {
  1586. customFields?: InputMaybe<Scalars['JSON']>;
  1587. id?: InputMaybe<Scalars['ID']>;
  1588. languageCode: LanguageCode;
  1589. name?: InputMaybe<Scalars['String']>;
  1590. };
  1591. export type FloatCustomFieldConfig = CustomField & {
  1592. __typename?: 'FloatCustomFieldConfig';
  1593. description?: Maybe<Array<LocalizedString>>;
  1594. internal?: Maybe<Scalars['Boolean']>;
  1595. label?: Maybe<Array<LocalizedString>>;
  1596. list: Scalars['Boolean'];
  1597. max?: Maybe<Scalars['Float']>;
  1598. min?: Maybe<Scalars['Float']>;
  1599. name: Scalars['String'];
  1600. nullable?: Maybe<Scalars['Boolean']>;
  1601. readonly?: Maybe<Scalars['Boolean']>;
  1602. step?: Maybe<Scalars['Float']>;
  1603. type: Scalars['String'];
  1604. ui?: Maybe<Scalars['JSON']>;
  1605. };
  1606. export type FulfillOrderInput = {
  1607. handler: ConfigurableOperationInput;
  1608. lines: Array<OrderLineInput>;
  1609. };
  1610. export type Fulfillment = Node & {
  1611. __typename?: 'Fulfillment';
  1612. createdAt: Scalars['DateTime'];
  1613. customFields?: Maybe<Scalars['JSON']>;
  1614. id: Scalars['ID'];
  1615. lines: Array<FulfillmentLine>;
  1616. method: Scalars['String'];
  1617. nextStates: Array<Scalars['String']>;
  1618. state: Scalars['String'];
  1619. /** @deprecated Use the `lines` field instead */
  1620. summary: Array<FulfillmentLine>;
  1621. trackingCode?: Maybe<Scalars['String']>;
  1622. updatedAt: Scalars['DateTime'];
  1623. };
  1624. export type FulfillmentLine = {
  1625. __typename?: 'FulfillmentLine';
  1626. fulfillment: Fulfillment;
  1627. fulfillmentId: Scalars['ID'];
  1628. orderLine: OrderLine;
  1629. orderLineId: Scalars['ID'];
  1630. quantity: Scalars['Int'];
  1631. };
  1632. /** Returned when there is an error in transitioning the Fulfillment state */
  1633. export type FulfillmentStateTransitionError = ErrorResult & {
  1634. __typename?: 'FulfillmentStateTransitionError';
  1635. errorCode: ErrorCode;
  1636. fromState: Scalars['String'];
  1637. message: Scalars['String'];
  1638. toState: Scalars['String'];
  1639. transitionError: Scalars['String'];
  1640. };
  1641. export enum GlobalFlag {
  1642. FALSE = 'FALSE',
  1643. INHERIT = 'INHERIT',
  1644. TRUE = 'TRUE'
  1645. }
  1646. export type GlobalSettings = {
  1647. __typename?: 'GlobalSettings';
  1648. availableLanguages: Array<LanguageCode>;
  1649. createdAt: Scalars['DateTime'];
  1650. customFields?: Maybe<Scalars['JSON']>;
  1651. id: Scalars['ID'];
  1652. outOfStockThreshold: Scalars['Int'];
  1653. serverConfig: ServerConfig;
  1654. trackInventory: Scalars['Boolean'];
  1655. updatedAt: Scalars['DateTime'];
  1656. };
  1657. /** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
  1658. export type GuestCheckoutError = ErrorResult & {
  1659. __typename?: 'GuestCheckoutError';
  1660. errorCode: ErrorCode;
  1661. errorDetail: Scalars['String'];
  1662. message: Scalars['String'];
  1663. };
  1664. export type HistoryEntry = Node & {
  1665. __typename?: 'HistoryEntry';
  1666. administrator?: Maybe<Administrator>;
  1667. createdAt: Scalars['DateTime'];
  1668. data: Scalars['JSON'];
  1669. id: Scalars['ID'];
  1670. isPublic: Scalars['Boolean'];
  1671. type: HistoryEntryType;
  1672. updatedAt: Scalars['DateTime'];
  1673. };
  1674. export type HistoryEntryFilterParameter = {
  1675. createdAt?: InputMaybe<DateOperators>;
  1676. id?: InputMaybe<IdOperators>;
  1677. isPublic?: InputMaybe<BooleanOperators>;
  1678. type?: InputMaybe<StringOperators>;
  1679. updatedAt?: InputMaybe<DateOperators>;
  1680. };
  1681. export type HistoryEntryList = PaginatedList & {
  1682. __typename?: 'HistoryEntryList';
  1683. items: Array<HistoryEntry>;
  1684. totalItems: Scalars['Int'];
  1685. };
  1686. export type HistoryEntryListOptions = {
  1687. /** Allows the results to be filtered */
  1688. filter?: InputMaybe<HistoryEntryFilterParameter>;
  1689. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  1690. filterOperator?: InputMaybe<LogicalOperator>;
  1691. /** Skips the first n results, for use in pagination */
  1692. skip?: InputMaybe<Scalars['Int']>;
  1693. /** Specifies which properties to sort the results by */
  1694. sort?: InputMaybe<HistoryEntrySortParameter>;
  1695. /** Takes n results, for use in pagination */
  1696. take?: InputMaybe<Scalars['Int']>;
  1697. };
  1698. export type HistoryEntrySortParameter = {
  1699. createdAt?: InputMaybe<SortOrder>;
  1700. id?: InputMaybe<SortOrder>;
  1701. updatedAt?: InputMaybe<SortOrder>;
  1702. };
  1703. export enum HistoryEntryType {
  1704. CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
  1705. CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
  1706. CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
  1707. CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
  1708. CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
  1709. CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
  1710. CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
  1711. CUSTOMER_NOTE = 'CUSTOMER_NOTE',
  1712. CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
  1713. CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
  1714. CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
  1715. CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
  1716. CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
  1717. CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
  1718. ORDER_CANCELLATION = 'ORDER_CANCELLATION',
  1719. ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
  1720. ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
  1721. ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
  1722. ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
  1723. ORDER_MODIFIED = 'ORDER_MODIFIED',
  1724. ORDER_NOTE = 'ORDER_NOTE',
  1725. ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
  1726. ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
  1727. ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION'
  1728. }
  1729. /** Operators for filtering on a list of ID fields */
  1730. export type IdListOperators = {
  1731. inList: Scalars['ID'];
  1732. };
  1733. /** Operators for filtering on an ID field */
  1734. export type IdOperators = {
  1735. eq?: InputMaybe<Scalars['String']>;
  1736. in?: InputMaybe<Array<Scalars['String']>>;
  1737. isNull?: InputMaybe<Scalars['Boolean']>;
  1738. notEq?: InputMaybe<Scalars['String']>;
  1739. notIn?: InputMaybe<Array<Scalars['String']>>;
  1740. };
  1741. export type ImportInfo = {
  1742. __typename?: 'ImportInfo';
  1743. errors?: Maybe<Array<Scalars['String']>>;
  1744. imported: Scalars['Int'];
  1745. processed: Scalars['Int'];
  1746. };
  1747. /** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
  1748. export type IneligibleShippingMethodError = ErrorResult & {
  1749. __typename?: 'IneligibleShippingMethodError';
  1750. errorCode: ErrorCode;
  1751. message: Scalars['String'];
  1752. };
  1753. /** Returned when attempting to add more items to the Order than are available */
  1754. export type InsufficientStockError = ErrorResult & {
  1755. __typename?: 'InsufficientStockError';
  1756. errorCode: ErrorCode;
  1757. message: Scalars['String'];
  1758. order: Order;
  1759. quantityAvailable: Scalars['Int'];
  1760. };
  1761. /**
  1762. * Returned if attempting to create a Fulfillment when there is insufficient
  1763. * stockOnHand of a ProductVariant to satisfy the requested quantity.
  1764. */
  1765. export type InsufficientStockOnHandError = ErrorResult & {
  1766. __typename?: 'InsufficientStockOnHandError';
  1767. errorCode: ErrorCode;
  1768. message: Scalars['String'];
  1769. productVariantId: Scalars['ID'];
  1770. productVariantName: Scalars['String'];
  1771. stockOnHand: Scalars['Int'];
  1772. };
  1773. export type IntCustomFieldConfig = CustomField & {
  1774. __typename?: 'IntCustomFieldConfig';
  1775. description?: Maybe<Array<LocalizedString>>;
  1776. internal?: Maybe<Scalars['Boolean']>;
  1777. label?: Maybe<Array<LocalizedString>>;
  1778. list: Scalars['Boolean'];
  1779. max?: Maybe<Scalars['Int']>;
  1780. min?: Maybe<Scalars['Int']>;
  1781. name: Scalars['String'];
  1782. nullable?: Maybe<Scalars['Boolean']>;
  1783. readonly?: Maybe<Scalars['Boolean']>;
  1784. step?: Maybe<Scalars['Int']>;
  1785. type: Scalars['String'];
  1786. ui?: Maybe<Scalars['JSON']>;
  1787. };
  1788. /** Returned if the user authentication credentials are not valid */
  1789. export type InvalidCredentialsError = ErrorResult & {
  1790. __typename?: 'InvalidCredentialsError';
  1791. authenticationError: Scalars['String'];
  1792. errorCode: ErrorCode;
  1793. message: Scalars['String'];
  1794. };
  1795. /** Returned if the specified FulfillmentHandler code is not valid */
  1796. export type InvalidFulfillmentHandlerError = ErrorResult & {
  1797. __typename?: 'InvalidFulfillmentHandlerError';
  1798. errorCode: ErrorCode;
  1799. message: Scalars['String'];
  1800. };
  1801. /** Returned if the specified items are already part of a Fulfillment */
  1802. export type ItemsAlreadyFulfilledError = ErrorResult & {
  1803. __typename?: 'ItemsAlreadyFulfilledError';
  1804. errorCode: ErrorCode;
  1805. message: Scalars['String'];
  1806. };
  1807. export type Job = Node & {
  1808. __typename?: 'Job';
  1809. attempts: Scalars['Int'];
  1810. createdAt: Scalars['DateTime'];
  1811. data?: Maybe<Scalars['JSON']>;
  1812. duration: Scalars['Int'];
  1813. error?: Maybe<Scalars['JSON']>;
  1814. id: Scalars['ID'];
  1815. isSettled: Scalars['Boolean'];
  1816. progress: Scalars['Float'];
  1817. queueName: Scalars['String'];
  1818. result?: Maybe<Scalars['JSON']>;
  1819. retries: Scalars['Int'];
  1820. settledAt?: Maybe<Scalars['DateTime']>;
  1821. startedAt?: Maybe<Scalars['DateTime']>;
  1822. state: JobState;
  1823. };
  1824. export type JobBufferSize = {
  1825. __typename?: 'JobBufferSize';
  1826. bufferId: Scalars['String'];
  1827. size: Scalars['Int'];
  1828. };
  1829. export type JobFilterParameter = {
  1830. attempts?: InputMaybe<NumberOperators>;
  1831. createdAt?: InputMaybe<DateOperators>;
  1832. duration?: InputMaybe<NumberOperators>;
  1833. id?: InputMaybe<IdOperators>;
  1834. isSettled?: InputMaybe<BooleanOperators>;
  1835. progress?: InputMaybe<NumberOperators>;
  1836. queueName?: InputMaybe<StringOperators>;
  1837. retries?: InputMaybe<NumberOperators>;
  1838. settledAt?: InputMaybe<DateOperators>;
  1839. startedAt?: InputMaybe<DateOperators>;
  1840. state?: InputMaybe<StringOperators>;
  1841. };
  1842. export type JobList = PaginatedList & {
  1843. __typename?: 'JobList';
  1844. items: Array<Job>;
  1845. totalItems: Scalars['Int'];
  1846. };
  1847. export type JobListOptions = {
  1848. /** Allows the results to be filtered */
  1849. filter?: InputMaybe<JobFilterParameter>;
  1850. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  1851. filterOperator?: InputMaybe<LogicalOperator>;
  1852. /** Skips the first n results, for use in pagination */
  1853. skip?: InputMaybe<Scalars['Int']>;
  1854. /** Specifies which properties to sort the results by */
  1855. sort?: InputMaybe<JobSortParameter>;
  1856. /** Takes n results, for use in pagination */
  1857. take?: InputMaybe<Scalars['Int']>;
  1858. };
  1859. export type JobQueue = {
  1860. __typename?: 'JobQueue';
  1861. name: Scalars['String'];
  1862. running: Scalars['Boolean'];
  1863. };
  1864. export type JobSortParameter = {
  1865. attempts?: InputMaybe<SortOrder>;
  1866. createdAt?: InputMaybe<SortOrder>;
  1867. duration?: InputMaybe<SortOrder>;
  1868. id?: InputMaybe<SortOrder>;
  1869. progress?: InputMaybe<SortOrder>;
  1870. queueName?: InputMaybe<SortOrder>;
  1871. retries?: InputMaybe<SortOrder>;
  1872. settledAt?: InputMaybe<SortOrder>;
  1873. startedAt?: InputMaybe<SortOrder>;
  1874. };
  1875. /**
  1876. * @description
  1877. * The state of a Job in the JobQueue
  1878. *
  1879. * @docsCategory common
  1880. */
  1881. export enum JobState {
  1882. CANCELLED = 'CANCELLED',
  1883. COMPLETED = 'COMPLETED',
  1884. FAILED = 'FAILED',
  1885. PENDING = 'PENDING',
  1886. RETRYING = 'RETRYING',
  1887. RUNNING = 'RUNNING'
  1888. }
  1889. /**
  1890. * @description
  1891. * Languages in the form of a ISO 639-1 language code with optional
  1892. * region or script modifier (e.g. de_AT). The selection available is based
  1893. * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  1894. * and includes the major spoken languages of the world and any widely-used variants.
  1895. *
  1896. * @docsCategory common
  1897. */
  1898. export enum LanguageCode {
  1899. /** Afrikaans */
  1900. af = 'af',
  1901. /** Akan */
  1902. ak = 'ak',
  1903. /** Amharic */
  1904. am = 'am',
  1905. /** Arabic */
  1906. ar = 'ar',
  1907. /** Assamese */
  1908. as = 'as',
  1909. /** Azerbaijani */
  1910. az = 'az',
  1911. /** Belarusian */
  1912. be = 'be',
  1913. /** Bulgarian */
  1914. bg = 'bg',
  1915. /** Bambara */
  1916. bm = 'bm',
  1917. /** Bangla */
  1918. bn = 'bn',
  1919. /** Tibetan */
  1920. bo = 'bo',
  1921. /** Breton */
  1922. br = 'br',
  1923. /** Bosnian */
  1924. bs = 'bs',
  1925. /** Catalan */
  1926. ca = 'ca',
  1927. /** Chechen */
  1928. ce = 'ce',
  1929. /** Corsican */
  1930. co = 'co',
  1931. /** Czech */
  1932. cs = 'cs',
  1933. /** Church Slavic */
  1934. cu = 'cu',
  1935. /** Welsh */
  1936. cy = 'cy',
  1937. /** Danish */
  1938. da = 'da',
  1939. /** German */
  1940. de = 'de',
  1941. /** Austrian German */
  1942. de_AT = 'de_AT',
  1943. /** Swiss High German */
  1944. de_CH = 'de_CH',
  1945. /** Dzongkha */
  1946. dz = 'dz',
  1947. /** Ewe */
  1948. ee = 'ee',
  1949. /** Greek */
  1950. el = 'el',
  1951. /** English */
  1952. en = 'en',
  1953. /** Australian English */
  1954. en_AU = 'en_AU',
  1955. /** Canadian English */
  1956. en_CA = 'en_CA',
  1957. /** British English */
  1958. en_GB = 'en_GB',
  1959. /** American English */
  1960. en_US = 'en_US',
  1961. /** Esperanto */
  1962. eo = 'eo',
  1963. /** Spanish */
  1964. es = 'es',
  1965. /** European Spanish */
  1966. es_ES = 'es_ES',
  1967. /** Mexican Spanish */
  1968. es_MX = 'es_MX',
  1969. /** Estonian */
  1970. et = 'et',
  1971. /** Basque */
  1972. eu = 'eu',
  1973. /** Persian */
  1974. fa = 'fa',
  1975. /** Dari */
  1976. fa_AF = 'fa_AF',
  1977. /** Fulah */
  1978. ff = 'ff',
  1979. /** Finnish */
  1980. fi = 'fi',
  1981. /** Faroese */
  1982. fo = 'fo',
  1983. /** French */
  1984. fr = 'fr',
  1985. /** Canadian French */
  1986. fr_CA = 'fr_CA',
  1987. /** Swiss French */
  1988. fr_CH = 'fr_CH',
  1989. /** Western Frisian */
  1990. fy = 'fy',
  1991. /** Irish */
  1992. ga = 'ga',
  1993. /** Scottish Gaelic */
  1994. gd = 'gd',
  1995. /** Galician */
  1996. gl = 'gl',
  1997. /** Gujarati */
  1998. gu = 'gu',
  1999. /** Manx */
  2000. gv = 'gv',
  2001. /** Hausa */
  2002. ha = 'ha',
  2003. /** Hebrew */
  2004. he = 'he',
  2005. /** Hindi */
  2006. hi = 'hi',
  2007. /** Croatian */
  2008. hr = 'hr',
  2009. /** Haitian Creole */
  2010. ht = 'ht',
  2011. /** Hungarian */
  2012. hu = 'hu',
  2013. /** Armenian */
  2014. hy = 'hy',
  2015. /** Interlingua */
  2016. ia = 'ia',
  2017. /** Indonesian */
  2018. id = 'id',
  2019. /** Igbo */
  2020. ig = 'ig',
  2021. /** Sichuan Yi */
  2022. ii = 'ii',
  2023. /** Icelandic */
  2024. is = 'is',
  2025. /** Italian */
  2026. it = 'it',
  2027. /** Japanese */
  2028. ja = 'ja',
  2029. /** Javanese */
  2030. jv = 'jv',
  2031. /** Georgian */
  2032. ka = 'ka',
  2033. /** Kikuyu */
  2034. ki = 'ki',
  2035. /** Kazakh */
  2036. kk = 'kk',
  2037. /** Kalaallisut */
  2038. kl = 'kl',
  2039. /** Khmer */
  2040. km = 'km',
  2041. /** Kannada */
  2042. kn = 'kn',
  2043. /** Korean */
  2044. ko = 'ko',
  2045. /** Kashmiri */
  2046. ks = 'ks',
  2047. /** Kurdish */
  2048. ku = 'ku',
  2049. /** Cornish */
  2050. kw = 'kw',
  2051. /** Kyrgyz */
  2052. ky = 'ky',
  2053. /** Latin */
  2054. la = 'la',
  2055. /** Luxembourgish */
  2056. lb = 'lb',
  2057. /** Ganda */
  2058. lg = 'lg',
  2059. /** Lingala */
  2060. ln = 'ln',
  2061. /** Lao */
  2062. lo = 'lo',
  2063. /** Lithuanian */
  2064. lt = 'lt',
  2065. /** Luba-Katanga */
  2066. lu = 'lu',
  2067. /** Latvian */
  2068. lv = 'lv',
  2069. /** Malagasy */
  2070. mg = 'mg',
  2071. /** Maori */
  2072. mi = 'mi',
  2073. /** Macedonian */
  2074. mk = 'mk',
  2075. /** Malayalam */
  2076. ml = 'ml',
  2077. /** Mongolian */
  2078. mn = 'mn',
  2079. /** Marathi */
  2080. mr = 'mr',
  2081. /** Malay */
  2082. ms = 'ms',
  2083. /** Maltese */
  2084. mt = 'mt',
  2085. /** Burmese */
  2086. my = 'my',
  2087. /** Norwegian Bokmål */
  2088. nb = 'nb',
  2089. /** North Ndebele */
  2090. nd = 'nd',
  2091. /** Nepali */
  2092. ne = 'ne',
  2093. /** Dutch */
  2094. nl = 'nl',
  2095. /** Flemish */
  2096. nl_BE = 'nl_BE',
  2097. /** Norwegian Nynorsk */
  2098. nn = 'nn',
  2099. /** Nyanja */
  2100. ny = 'ny',
  2101. /** Oromo */
  2102. om = 'om',
  2103. /** Odia */
  2104. or = 'or',
  2105. /** Ossetic */
  2106. os = 'os',
  2107. /** Punjabi */
  2108. pa = 'pa',
  2109. /** Polish */
  2110. pl = 'pl',
  2111. /** Pashto */
  2112. ps = 'ps',
  2113. /** Portuguese */
  2114. pt = 'pt',
  2115. /** Brazilian Portuguese */
  2116. pt_BR = 'pt_BR',
  2117. /** European Portuguese */
  2118. pt_PT = 'pt_PT',
  2119. /** Quechua */
  2120. qu = 'qu',
  2121. /** Romansh */
  2122. rm = 'rm',
  2123. /** Rundi */
  2124. rn = 'rn',
  2125. /** Romanian */
  2126. ro = 'ro',
  2127. /** Moldavian */
  2128. ro_MD = 'ro_MD',
  2129. /** Russian */
  2130. ru = 'ru',
  2131. /** Kinyarwanda */
  2132. rw = 'rw',
  2133. /** Sanskrit */
  2134. sa = 'sa',
  2135. /** Sindhi */
  2136. sd = 'sd',
  2137. /** Northern Sami */
  2138. se = 'se',
  2139. /** Sango */
  2140. sg = 'sg',
  2141. /** Sinhala */
  2142. si = 'si',
  2143. /** Slovak */
  2144. sk = 'sk',
  2145. /** Slovenian */
  2146. sl = 'sl',
  2147. /** Samoan */
  2148. sm = 'sm',
  2149. /** Shona */
  2150. sn = 'sn',
  2151. /** Somali */
  2152. so = 'so',
  2153. /** Albanian */
  2154. sq = 'sq',
  2155. /** Serbian */
  2156. sr = 'sr',
  2157. /** Southern Sotho */
  2158. st = 'st',
  2159. /** Sundanese */
  2160. su = 'su',
  2161. /** Swedish */
  2162. sv = 'sv',
  2163. /** Swahili */
  2164. sw = 'sw',
  2165. /** Congo Swahili */
  2166. sw_CD = 'sw_CD',
  2167. /** Tamil */
  2168. ta = 'ta',
  2169. /** Telugu */
  2170. te = 'te',
  2171. /** Tajik */
  2172. tg = 'tg',
  2173. /** Thai */
  2174. th = 'th',
  2175. /** Tigrinya */
  2176. ti = 'ti',
  2177. /** Turkmen */
  2178. tk = 'tk',
  2179. /** Tongan */
  2180. to = 'to',
  2181. /** Turkish */
  2182. tr = 'tr',
  2183. /** Tatar */
  2184. tt = 'tt',
  2185. /** Uyghur */
  2186. ug = 'ug',
  2187. /** Ukrainian */
  2188. uk = 'uk',
  2189. /** Urdu */
  2190. ur = 'ur',
  2191. /** Uzbek */
  2192. uz = 'uz',
  2193. /** Vietnamese */
  2194. vi = 'vi',
  2195. /** Volapük */
  2196. vo = 'vo',
  2197. /** Wolof */
  2198. wo = 'wo',
  2199. /** Xhosa */
  2200. xh = 'xh',
  2201. /** Yiddish */
  2202. yi = 'yi',
  2203. /** Yoruba */
  2204. yo = 'yo',
  2205. /** Chinese */
  2206. zh = 'zh',
  2207. /** Simplified Chinese */
  2208. zh_Hans = 'zh_Hans',
  2209. /** Traditional Chinese */
  2210. zh_Hant = 'zh_Hant',
  2211. /** Zulu */
  2212. zu = 'zu'
  2213. }
  2214. /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
  2215. export type LanguageNotAvailableError = ErrorResult & {
  2216. __typename?: 'LanguageNotAvailableError';
  2217. errorCode: ErrorCode;
  2218. languageCode: Scalars['String'];
  2219. message: Scalars['String'];
  2220. };
  2221. export type LocaleStringCustomFieldConfig = CustomField & {
  2222. __typename?: 'LocaleStringCustomFieldConfig';
  2223. description?: Maybe<Array<LocalizedString>>;
  2224. internal?: Maybe<Scalars['Boolean']>;
  2225. label?: Maybe<Array<LocalizedString>>;
  2226. length?: Maybe<Scalars['Int']>;
  2227. list: Scalars['Boolean'];
  2228. name: Scalars['String'];
  2229. nullable?: Maybe<Scalars['Boolean']>;
  2230. pattern?: Maybe<Scalars['String']>;
  2231. readonly?: Maybe<Scalars['Boolean']>;
  2232. type: Scalars['String'];
  2233. ui?: Maybe<Scalars['JSON']>;
  2234. };
  2235. export type LocaleTextCustomFieldConfig = CustomField & {
  2236. __typename?: 'LocaleTextCustomFieldConfig';
  2237. description?: Maybe<Array<LocalizedString>>;
  2238. internal?: Maybe<Scalars['Boolean']>;
  2239. label?: Maybe<Array<LocalizedString>>;
  2240. list: Scalars['Boolean'];
  2241. name: Scalars['String'];
  2242. nullable?: Maybe<Scalars['Boolean']>;
  2243. readonly?: Maybe<Scalars['Boolean']>;
  2244. type: Scalars['String'];
  2245. ui?: Maybe<Scalars['JSON']>;
  2246. };
  2247. export type LocalizedString = {
  2248. __typename?: 'LocalizedString';
  2249. languageCode: LanguageCode;
  2250. value: Scalars['String'];
  2251. };
  2252. export enum LogicalOperator {
  2253. AND = 'AND',
  2254. OR = 'OR'
  2255. }
  2256. export type ManualPaymentInput = {
  2257. metadata?: InputMaybe<Scalars['JSON']>;
  2258. method: Scalars['String'];
  2259. orderId: Scalars['ID'];
  2260. transactionId?: InputMaybe<Scalars['String']>;
  2261. };
  2262. /**
  2263. * Returned when a call to addManualPaymentToOrder is made but the Order
  2264. * is not in the required state.
  2265. */
  2266. export type ManualPaymentStateError = ErrorResult & {
  2267. __typename?: 'ManualPaymentStateError';
  2268. errorCode: ErrorCode;
  2269. message: Scalars['String'];
  2270. };
  2271. export enum MetricInterval {
  2272. Daily = 'Daily'
  2273. }
  2274. export type MetricSummary = {
  2275. __typename?: 'MetricSummary';
  2276. entries: Array<MetricSummaryEntry>;
  2277. interval: MetricInterval;
  2278. title: Scalars['String'];
  2279. type: MetricType;
  2280. };
  2281. export type MetricSummaryEntry = {
  2282. __typename?: 'MetricSummaryEntry';
  2283. label: Scalars['String'];
  2284. value: Scalars['Float'];
  2285. };
  2286. export type MetricSummaryInput = {
  2287. interval: MetricInterval;
  2288. refresh?: InputMaybe<Scalars['Boolean']>;
  2289. types: Array<MetricType>;
  2290. };
  2291. export enum MetricType {
  2292. AverageOrderValue = 'AverageOrderValue',
  2293. OrderCount = 'OrderCount',
  2294. OrderTotal = 'OrderTotal'
  2295. }
  2296. export type MimeTypeError = ErrorResult & {
  2297. __typename?: 'MimeTypeError';
  2298. errorCode: ErrorCode;
  2299. fileName: Scalars['String'];
  2300. message: Scalars['String'];
  2301. mimeType: Scalars['String'];
  2302. };
  2303. /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
  2304. export type MissingConditionsError = ErrorResult & {
  2305. __typename?: 'MissingConditionsError';
  2306. errorCode: ErrorCode;
  2307. message: Scalars['String'];
  2308. };
  2309. export type ModifyOrderInput = {
  2310. addItems?: InputMaybe<Array<AddItemInput>>;
  2311. adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
  2312. couponCodes?: InputMaybe<Array<Scalars['String']>>;
  2313. dryRun: Scalars['Boolean'];
  2314. note?: InputMaybe<Scalars['String']>;
  2315. options?: InputMaybe<ModifyOrderOptions>;
  2316. orderId: Scalars['ID'];
  2317. refund?: InputMaybe<AdministratorRefundInput>;
  2318. surcharges?: InputMaybe<Array<SurchargeInput>>;
  2319. updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2320. updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2321. };
  2322. export type ModifyOrderOptions = {
  2323. freezePromotions?: InputMaybe<Scalars['Boolean']>;
  2324. recalculateShipping?: InputMaybe<Scalars['Boolean']>;
  2325. };
  2326. export type ModifyOrderResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | InsufficientStockError | NegativeQuantityError | NoChangesSpecifiedError | Order | OrderLimitError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError;
  2327. export type MoveCollectionInput = {
  2328. collectionId: Scalars['ID'];
  2329. index: Scalars['Int'];
  2330. parentId: Scalars['ID'];
  2331. };
  2332. /** Returned if an operation has specified OrderLines from multiple Orders */
  2333. export type MultipleOrderError = ErrorResult & {
  2334. __typename?: 'MultipleOrderError';
  2335. errorCode: ErrorCode;
  2336. message: Scalars['String'];
  2337. };
  2338. export type Mutation = {
  2339. __typename?: 'Mutation';
  2340. /** Add Customers to a CustomerGroup */
  2341. addCustomersToGroup: CustomerGroup;
  2342. addFulfillmentToOrder: AddFulfillmentToOrderResult;
  2343. /** Adds an item to the draft Order. */
  2344. addItemToDraftOrder: UpdateOrderItemsResult;
  2345. /**
  2346. * Used to manually create a new Payment against an Order.
  2347. * This can be used by an Administrator when an Order is in the ArrangingPayment state.
  2348. *
  2349. * It is also used when a completed Order
  2350. * has been modified (using `modifyOrder`) and the price has increased. The extra payment
  2351. * can then be manually arranged by the administrator, and the details used to create a new
  2352. * Payment.
  2353. */
  2354. addManualPaymentToOrder: AddManualPaymentToOrderResult;
  2355. /** Add members to a Zone */
  2356. addMembersToZone: Zone;
  2357. addNoteToCustomer: Customer;
  2358. addNoteToOrder: Order;
  2359. /** Add an OptionGroup to a Product */
  2360. addOptionGroupToProduct: Product;
  2361. /** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
  2362. adjustDraftOrderLine: UpdateOrderItemsResult;
  2363. /** Applies the given coupon code to the draft Order */
  2364. applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
  2365. /** Assign assets to channel */
  2366. assignAssetsToChannel: Array<Asset>;
  2367. /** Assigns Collections to the specified Channel */
  2368. assignCollectionsToChannel: Array<Collection>;
  2369. /** Assigns Facets to the specified Channel */
  2370. assignFacetsToChannel: Array<Facet>;
  2371. /** Assigns PaymentMethods to the specified Channel */
  2372. assignPaymentMethodsToChannel: Array<PaymentMethod>;
  2373. /** Assigns ProductVariants to the specified Channel */
  2374. assignProductVariantsToChannel: Array<ProductVariant>;
  2375. /** Assigns all ProductVariants of Product to the specified Channel */
  2376. assignProductsToChannel: Array<Product>;
  2377. /** Assigns Promotions to the specified Channel */
  2378. assignPromotionsToChannel: Array<Promotion>;
  2379. /** Assign a Role to an Administrator */
  2380. assignRoleToAdministrator: Administrator;
  2381. /** Assigns ShippingMethods to the specified Channel */
  2382. assignShippingMethodsToChannel: Array<ShippingMethod>;
  2383. /** Assigns StockLocations to the specified Channel */
  2384. assignStockLocationsToChannel: Array<StockLocation>;
  2385. /** Authenticates the user using a named authentication strategy */
  2386. authenticate: AuthenticationResult;
  2387. cancelJob: Job;
  2388. cancelOrder: CancelOrderResult;
  2389. cancelPayment: CancelPaymentResult;
  2390. /** Create a new Administrator */
  2391. createAdministrator: Administrator;
  2392. /** Create a new Asset */
  2393. createAssets: Array<CreateAssetResult>;
  2394. /** Create a new Channel */
  2395. createChannel: CreateChannelResult;
  2396. /** Create a new Collection */
  2397. createCollection: Collection;
  2398. /** Create a new Country */
  2399. createCountry: Country;
  2400. /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
  2401. createCustomer: CreateCustomerResult;
  2402. /** Create a new Address and associate it with the Customer specified by customerId */
  2403. createCustomerAddress: Address;
  2404. /** Create a new CustomerGroup */
  2405. createCustomerGroup: CustomerGroup;
  2406. /** Creates a draft Order */
  2407. createDraftOrder: Order;
  2408. /** Create a new Facet */
  2409. createFacet: Facet;
  2410. /** Create one or more FacetValues */
  2411. createFacetValues: Array<FacetValue>;
  2412. /** Create existing PaymentMethod */
  2413. createPaymentMethod: PaymentMethod;
  2414. /** Create a new Product */
  2415. createProduct: Product;
  2416. /** Create a new ProductOption within a ProductOptionGroup */
  2417. createProductOption: ProductOption;
  2418. /** Create a new ProductOptionGroup */
  2419. createProductOptionGroup: ProductOptionGroup;
  2420. /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
  2421. createProductVariants: Array<Maybe<ProductVariant>>;
  2422. createPromotion: CreatePromotionResult;
  2423. /** Create a new Province */
  2424. createProvince: Province;
  2425. /** Create a new Role */
  2426. createRole: Role;
  2427. /** Create a new Seller */
  2428. createSeller: Seller;
  2429. /** Create a new ShippingMethod */
  2430. createShippingMethod: ShippingMethod;
  2431. createStockLocation: StockLocation;
  2432. /** Create a new Tag */
  2433. createTag: Tag;
  2434. /** Create a new TaxCategory */
  2435. createTaxCategory: TaxCategory;
  2436. /** Create a new TaxRate */
  2437. createTaxRate: TaxRate;
  2438. /** Create a new Zone */
  2439. createZone: Zone;
  2440. /** Delete an Administrator */
  2441. deleteAdministrator: DeletionResponse;
  2442. /** Delete multiple Administrators */
  2443. deleteAdministrators: Array<DeletionResponse>;
  2444. /** Delete an Asset */
  2445. deleteAsset: DeletionResponse;
  2446. /** Delete multiple Assets */
  2447. deleteAssets: DeletionResponse;
  2448. /** Delete a Channel */
  2449. deleteChannel: DeletionResponse;
  2450. /** Delete multiple Channels */
  2451. deleteChannels: Array<DeletionResponse>;
  2452. /** Delete a Collection and all of its descendants */
  2453. deleteCollection: DeletionResponse;
  2454. /** Delete multiple Collections and all of their descendants */
  2455. deleteCollections: Array<DeletionResponse>;
  2456. /** Delete multiple Countries */
  2457. deleteCountries: Array<DeletionResponse>;
  2458. /** Delete a Country */
  2459. deleteCountry: DeletionResponse;
  2460. /** Delete a Customer */
  2461. deleteCustomer: DeletionResponse;
  2462. /** Update an existing Address */
  2463. deleteCustomerAddress: Success;
  2464. /** Delete a CustomerGroup */
  2465. deleteCustomerGroup: DeletionResponse;
  2466. /** Delete multiple CustomerGroups */
  2467. deleteCustomerGroups: Array<DeletionResponse>;
  2468. deleteCustomerNote: DeletionResponse;
  2469. /** Deletes Customers */
  2470. deleteCustomers: Array<DeletionResponse>;
  2471. /** Deletes a draft Order */
  2472. deleteDraftOrder: DeletionResponse;
  2473. /** Delete an existing Facet */
  2474. deleteFacet: DeletionResponse;
  2475. /** Delete one or more FacetValues */
  2476. deleteFacetValues: Array<DeletionResponse>;
  2477. /** Delete multiple existing Facets */
  2478. deleteFacets: Array<DeletionResponse>;
  2479. deleteOrderNote: DeletionResponse;
  2480. /** Delete a PaymentMethod */
  2481. deletePaymentMethod: DeletionResponse;
  2482. /** Delete multiple PaymentMethods */
  2483. deletePaymentMethods: Array<DeletionResponse>;
  2484. /** Delete a Product */
  2485. deleteProduct: DeletionResponse;
  2486. /** Delete a ProductOption */
  2487. deleteProductOption: DeletionResponse;
  2488. /** Delete a ProductVariant */
  2489. deleteProductVariant: DeletionResponse;
  2490. /** Delete multiple ProductVariants */
  2491. deleteProductVariants: Array<DeletionResponse>;
  2492. /** Delete multiple Products */
  2493. deleteProducts: Array<DeletionResponse>;
  2494. deletePromotion: DeletionResponse;
  2495. deletePromotions: Array<DeletionResponse>;
  2496. /** Delete a Province */
  2497. deleteProvince: DeletionResponse;
  2498. /** Delete an existing Role */
  2499. deleteRole: DeletionResponse;
  2500. /** Delete multiple Roles */
  2501. deleteRoles: Array<DeletionResponse>;
  2502. /** Delete a Seller */
  2503. deleteSeller: DeletionResponse;
  2504. /** Delete multiple Sellers */
  2505. deleteSellers: Array<DeletionResponse>;
  2506. /** Delete a ShippingMethod */
  2507. deleteShippingMethod: DeletionResponse;
  2508. /** Delete multiple ShippingMethods */
  2509. deleteShippingMethods: Array<DeletionResponse>;
  2510. deleteStockLocation: DeletionResponse;
  2511. deleteStockLocations: Array<DeletionResponse>;
  2512. /** Delete an existing Tag */
  2513. deleteTag: DeletionResponse;
  2514. /** Deletes multiple TaxCategories */
  2515. deleteTaxCategories: Array<DeletionResponse>;
  2516. /** Deletes a TaxCategory */
  2517. deleteTaxCategory: DeletionResponse;
  2518. /** Delete a TaxRate */
  2519. deleteTaxRate: DeletionResponse;
  2520. /** Delete multiple TaxRates */
  2521. deleteTaxRates: Array<DeletionResponse>;
  2522. /** Delete a Zone */
  2523. deleteZone: DeletionResponse;
  2524. /** Delete a Zone */
  2525. deleteZones: Array<DeletionResponse>;
  2526. flushBufferedJobs: Success;
  2527. importProducts?: Maybe<ImportInfo>;
  2528. /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
  2529. login: NativeAuthenticationResult;
  2530. logout: Success;
  2531. /**
  2532. * Allows an Order to be modified after it has been completed by the Customer. The Order must first
  2533. * be in the `Modifying` state.
  2534. */
  2535. modifyOrder: ModifyOrderResult;
  2536. /** Move a Collection to a different parent or index */
  2537. moveCollection: Collection;
  2538. refundOrder: RefundOrderResult;
  2539. reindex: Job;
  2540. /** Removes Collections from the specified Channel */
  2541. removeCollectionsFromChannel: Array<Collection>;
  2542. /** Removes the given coupon code from the draft Order */
  2543. removeCouponCodeFromDraftOrder?: Maybe<Order>;
  2544. /** Remove Customers from a CustomerGroup */
  2545. removeCustomersFromGroup: CustomerGroup;
  2546. /** Remove an OrderLine from the draft Order */
  2547. removeDraftOrderLine: RemoveOrderItemsResult;
  2548. /** Removes Facets from the specified Channel */
  2549. removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
  2550. /** Remove members from a Zone */
  2551. removeMembersFromZone: Zone;
  2552. /**
  2553. * Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
  2554. * the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
  2555. * Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
  2556. * as well as removing any of the group's options from the Product's ProductVariants.
  2557. */
  2558. removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
  2559. /** Removes PaymentMethods from the specified Channel */
  2560. removePaymentMethodsFromChannel: Array<PaymentMethod>;
  2561. /** Removes ProductVariants from the specified Channel */
  2562. removeProductVariantsFromChannel: Array<ProductVariant>;
  2563. /** Removes all ProductVariants of Product from the specified Channel */
  2564. removeProductsFromChannel: Array<Product>;
  2565. /** Removes Promotions from the specified Channel */
  2566. removePromotionsFromChannel: Array<Promotion>;
  2567. /** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
  2568. removeSettledJobs: Scalars['Int'];
  2569. /** Removes ShippingMethods from the specified Channel */
  2570. removeShippingMethodsFromChannel: Array<ShippingMethod>;
  2571. /** Removes StockLocations from the specified Channel */
  2572. removeStockLocationsFromChannel: Array<StockLocation>;
  2573. runPendingSearchIndexUpdates: Success;
  2574. setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
  2575. /** Sets the billing address for a draft Order */
  2576. setDraftOrderBillingAddress: Order;
  2577. /** Allows any custom fields to be set for the active order */
  2578. setDraftOrderCustomFields: Order;
  2579. /** Sets the shipping address for a draft Order */
  2580. setDraftOrderShippingAddress: Order;
  2581. /** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
  2582. setDraftOrderShippingMethod: SetOrderShippingMethodResult;
  2583. setOrderCustomFields?: Maybe<Order>;
  2584. settlePayment: SettlePaymentResult;
  2585. settleRefund: SettleRefundResult;
  2586. transitionFulfillmentToState: TransitionFulfillmentToStateResult;
  2587. transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
  2588. transitionPaymentToState: TransitionPaymentToStateResult;
  2589. /** Update the active (currently logged-in) Administrator */
  2590. updateActiveAdministrator: Administrator;
  2591. /** Update an existing Administrator */
  2592. updateAdministrator: Administrator;
  2593. /** Update an existing Asset */
  2594. updateAsset: Asset;
  2595. /** Update an existing Channel */
  2596. updateChannel: UpdateChannelResult;
  2597. /** Update an existing Collection */
  2598. updateCollection: Collection;
  2599. /** Update an existing Country */
  2600. updateCountry: Country;
  2601. /** Update an existing Customer */
  2602. updateCustomer: UpdateCustomerResult;
  2603. /** Update an existing Address */
  2604. updateCustomerAddress: Address;
  2605. /** Update an existing CustomerGroup */
  2606. updateCustomerGroup: CustomerGroup;
  2607. updateCustomerNote: HistoryEntry;
  2608. /** Update an existing Facet */
  2609. updateFacet: Facet;
  2610. /** Update one or more FacetValues */
  2611. updateFacetValues: Array<FacetValue>;
  2612. updateGlobalSettings: UpdateGlobalSettingsResult;
  2613. updateOrderNote: HistoryEntry;
  2614. /** Update an existing PaymentMethod */
  2615. updatePaymentMethod: PaymentMethod;
  2616. /** Update an existing Product */
  2617. updateProduct: Product;
  2618. /** Create a new ProductOption within a ProductOptionGroup */
  2619. updateProductOption: ProductOption;
  2620. /** Update an existing ProductOptionGroup */
  2621. updateProductOptionGroup: ProductOptionGroup;
  2622. /** Update existing ProductVariants */
  2623. updateProductVariants: Array<Maybe<ProductVariant>>;
  2624. /** Update multiple existing Products */
  2625. updateProducts: Array<Product>;
  2626. updatePromotion: UpdatePromotionResult;
  2627. /** Update an existing Province */
  2628. updateProvince: Province;
  2629. /** Update an existing Role */
  2630. updateRole: Role;
  2631. /** Update an existing Seller */
  2632. updateSeller: Seller;
  2633. /** Update an existing ShippingMethod */
  2634. updateShippingMethod: ShippingMethod;
  2635. updateStockLocation: StockLocation;
  2636. /** Update an existing Tag */
  2637. updateTag: Tag;
  2638. /** Update an existing TaxCategory */
  2639. updateTaxCategory: TaxCategory;
  2640. /** Update an existing TaxRate */
  2641. updateTaxRate: TaxRate;
  2642. /** Update an existing Zone */
  2643. updateZone: Zone;
  2644. };
  2645. export type MutationAddCustomersToGroupArgs = {
  2646. customerGroupId: Scalars['ID'];
  2647. customerIds: Array<Scalars['ID']>;
  2648. };
  2649. export type MutationAddFulfillmentToOrderArgs = {
  2650. input: FulfillOrderInput;
  2651. };
  2652. export type MutationAddItemToDraftOrderArgs = {
  2653. input: AddItemToDraftOrderInput;
  2654. orderId: Scalars['ID'];
  2655. };
  2656. export type MutationAddManualPaymentToOrderArgs = {
  2657. input: ManualPaymentInput;
  2658. };
  2659. export type MutationAddMembersToZoneArgs = {
  2660. memberIds: Array<Scalars['ID']>;
  2661. zoneId: Scalars['ID'];
  2662. };
  2663. export type MutationAddNoteToCustomerArgs = {
  2664. input: AddNoteToCustomerInput;
  2665. };
  2666. export type MutationAddNoteToOrderArgs = {
  2667. input: AddNoteToOrderInput;
  2668. };
  2669. export type MutationAddOptionGroupToProductArgs = {
  2670. optionGroupId: Scalars['ID'];
  2671. productId: Scalars['ID'];
  2672. };
  2673. export type MutationAdjustDraftOrderLineArgs = {
  2674. input: AdjustDraftOrderLineInput;
  2675. orderId: Scalars['ID'];
  2676. };
  2677. export type MutationApplyCouponCodeToDraftOrderArgs = {
  2678. couponCode: Scalars['String'];
  2679. orderId: Scalars['ID'];
  2680. };
  2681. export type MutationAssignAssetsToChannelArgs = {
  2682. input: AssignAssetsToChannelInput;
  2683. };
  2684. export type MutationAssignCollectionsToChannelArgs = {
  2685. input: AssignCollectionsToChannelInput;
  2686. };
  2687. export type MutationAssignFacetsToChannelArgs = {
  2688. input: AssignFacetsToChannelInput;
  2689. };
  2690. export type MutationAssignPaymentMethodsToChannelArgs = {
  2691. input: AssignPaymentMethodsToChannelInput;
  2692. };
  2693. export type MutationAssignProductVariantsToChannelArgs = {
  2694. input: AssignProductVariantsToChannelInput;
  2695. };
  2696. export type MutationAssignProductsToChannelArgs = {
  2697. input: AssignProductsToChannelInput;
  2698. };
  2699. export type MutationAssignPromotionsToChannelArgs = {
  2700. input: AssignPromotionsToChannelInput;
  2701. };
  2702. export type MutationAssignRoleToAdministratorArgs = {
  2703. administratorId: Scalars['ID'];
  2704. roleId: Scalars['ID'];
  2705. };
  2706. export type MutationAssignShippingMethodsToChannelArgs = {
  2707. input: AssignShippingMethodsToChannelInput;
  2708. };
  2709. export type MutationAssignStockLocationsToChannelArgs = {
  2710. input: AssignStockLocationsToChannelInput;
  2711. };
  2712. export type MutationAuthenticateArgs = {
  2713. input: AuthenticationInput;
  2714. rememberMe?: InputMaybe<Scalars['Boolean']>;
  2715. };
  2716. export type MutationCancelJobArgs = {
  2717. jobId: Scalars['ID'];
  2718. };
  2719. export type MutationCancelOrderArgs = {
  2720. input: CancelOrderInput;
  2721. };
  2722. export type MutationCancelPaymentArgs = {
  2723. id: Scalars['ID'];
  2724. };
  2725. export type MutationCreateAdministratorArgs = {
  2726. input: CreateAdministratorInput;
  2727. };
  2728. export type MutationCreateAssetsArgs = {
  2729. input: Array<CreateAssetInput>;
  2730. };
  2731. export type MutationCreateChannelArgs = {
  2732. input: CreateChannelInput;
  2733. };
  2734. export type MutationCreateCollectionArgs = {
  2735. input: CreateCollectionInput;
  2736. };
  2737. export type MutationCreateCountryArgs = {
  2738. input: CreateCountryInput;
  2739. };
  2740. export type MutationCreateCustomerArgs = {
  2741. input: CreateCustomerInput;
  2742. password?: InputMaybe<Scalars['String']>;
  2743. };
  2744. export type MutationCreateCustomerAddressArgs = {
  2745. customerId: Scalars['ID'];
  2746. input: CreateAddressInput;
  2747. };
  2748. export type MutationCreateCustomerGroupArgs = {
  2749. input: CreateCustomerGroupInput;
  2750. };
  2751. export type MutationCreateFacetArgs = {
  2752. input: CreateFacetInput;
  2753. };
  2754. export type MutationCreateFacetValuesArgs = {
  2755. input: Array<CreateFacetValueInput>;
  2756. };
  2757. export type MutationCreatePaymentMethodArgs = {
  2758. input: CreatePaymentMethodInput;
  2759. };
  2760. export type MutationCreateProductArgs = {
  2761. input: CreateProductInput;
  2762. };
  2763. export type MutationCreateProductOptionArgs = {
  2764. input: CreateProductOptionInput;
  2765. };
  2766. export type MutationCreateProductOptionGroupArgs = {
  2767. input: CreateProductOptionGroupInput;
  2768. };
  2769. export type MutationCreateProductVariantsArgs = {
  2770. input: Array<CreateProductVariantInput>;
  2771. };
  2772. export type MutationCreatePromotionArgs = {
  2773. input: CreatePromotionInput;
  2774. };
  2775. export type MutationCreateProvinceArgs = {
  2776. input: CreateProvinceInput;
  2777. };
  2778. export type MutationCreateRoleArgs = {
  2779. input: CreateRoleInput;
  2780. };
  2781. export type MutationCreateSellerArgs = {
  2782. input: CreateSellerInput;
  2783. };
  2784. export type MutationCreateShippingMethodArgs = {
  2785. input: CreateShippingMethodInput;
  2786. };
  2787. export type MutationCreateStockLocationArgs = {
  2788. input: CreateStockLocationInput;
  2789. };
  2790. export type MutationCreateTagArgs = {
  2791. input: CreateTagInput;
  2792. };
  2793. export type MutationCreateTaxCategoryArgs = {
  2794. input: CreateTaxCategoryInput;
  2795. };
  2796. export type MutationCreateTaxRateArgs = {
  2797. input: CreateTaxRateInput;
  2798. };
  2799. export type MutationCreateZoneArgs = {
  2800. input: CreateZoneInput;
  2801. };
  2802. export type MutationDeleteAdministratorArgs = {
  2803. id: Scalars['ID'];
  2804. };
  2805. export type MutationDeleteAdministratorsArgs = {
  2806. ids: Array<Scalars['ID']>;
  2807. };
  2808. export type MutationDeleteAssetArgs = {
  2809. input: DeleteAssetInput;
  2810. };
  2811. export type MutationDeleteAssetsArgs = {
  2812. input: DeleteAssetsInput;
  2813. };
  2814. export type MutationDeleteChannelArgs = {
  2815. id: Scalars['ID'];
  2816. };
  2817. export type MutationDeleteChannelsArgs = {
  2818. ids: Array<Scalars['ID']>;
  2819. };
  2820. export type MutationDeleteCollectionArgs = {
  2821. id: Scalars['ID'];
  2822. };
  2823. export type MutationDeleteCollectionsArgs = {
  2824. ids: Array<Scalars['ID']>;
  2825. };
  2826. export type MutationDeleteCountriesArgs = {
  2827. ids: Array<Scalars['ID']>;
  2828. };
  2829. export type MutationDeleteCountryArgs = {
  2830. id: Scalars['ID'];
  2831. };
  2832. export type MutationDeleteCustomerArgs = {
  2833. id: Scalars['ID'];
  2834. };
  2835. export type MutationDeleteCustomerAddressArgs = {
  2836. id: Scalars['ID'];
  2837. };
  2838. export type MutationDeleteCustomerGroupArgs = {
  2839. id: Scalars['ID'];
  2840. };
  2841. export type MutationDeleteCustomerGroupsArgs = {
  2842. ids: Array<Scalars['ID']>;
  2843. };
  2844. export type MutationDeleteCustomerNoteArgs = {
  2845. id: Scalars['ID'];
  2846. };
  2847. export type MutationDeleteCustomersArgs = {
  2848. ids: Array<Scalars['ID']>;
  2849. };
  2850. export type MutationDeleteDraftOrderArgs = {
  2851. orderId: Scalars['ID'];
  2852. };
  2853. export type MutationDeleteFacetArgs = {
  2854. force?: InputMaybe<Scalars['Boolean']>;
  2855. id: Scalars['ID'];
  2856. };
  2857. export type MutationDeleteFacetValuesArgs = {
  2858. force?: InputMaybe<Scalars['Boolean']>;
  2859. ids: Array<Scalars['ID']>;
  2860. };
  2861. export type MutationDeleteFacetsArgs = {
  2862. force?: InputMaybe<Scalars['Boolean']>;
  2863. ids: Array<Scalars['ID']>;
  2864. };
  2865. export type MutationDeleteOrderNoteArgs = {
  2866. id: Scalars['ID'];
  2867. };
  2868. export type MutationDeletePaymentMethodArgs = {
  2869. force?: InputMaybe<Scalars['Boolean']>;
  2870. id: Scalars['ID'];
  2871. };
  2872. export type MutationDeletePaymentMethodsArgs = {
  2873. force?: InputMaybe<Scalars['Boolean']>;
  2874. ids: Array<Scalars['ID']>;
  2875. };
  2876. export type MutationDeleteProductArgs = {
  2877. id: Scalars['ID'];
  2878. };
  2879. export type MutationDeleteProductOptionArgs = {
  2880. id: Scalars['ID'];
  2881. };
  2882. export type MutationDeleteProductVariantArgs = {
  2883. id: Scalars['ID'];
  2884. };
  2885. export type MutationDeleteProductVariantsArgs = {
  2886. ids: Array<Scalars['ID']>;
  2887. };
  2888. export type MutationDeleteProductsArgs = {
  2889. ids: Array<Scalars['ID']>;
  2890. };
  2891. export type MutationDeletePromotionArgs = {
  2892. id: Scalars['ID'];
  2893. };
  2894. export type MutationDeletePromotionsArgs = {
  2895. ids: Array<Scalars['ID']>;
  2896. };
  2897. export type MutationDeleteProvinceArgs = {
  2898. id: Scalars['ID'];
  2899. };
  2900. export type MutationDeleteRoleArgs = {
  2901. id: Scalars['ID'];
  2902. };
  2903. export type MutationDeleteRolesArgs = {
  2904. ids: Array<Scalars['ID']>;
  2905. };
  2906. export type MutationDeleteSellerArgs = {
  2907. id: Scalars['ID'];
  2908. };
  2909. export type MutationDeleteSellersArgs = {
  2910. ids: Array<Scalars['ID']>;
  2911. };
  2912. export type MutationDeleteShippingMethodArgs = {
  2913. id: Scalars['ID'];
  2914. };
  2915. export type MutationDeleteShippingMethodsArgs = {
  2916. ids: Array<Scalars['ID']>;
  2917. };
  2918. export type MutationDeleteStockLocationArgs = {
  2919. input: DeleteStockLocationInput;
  2920. };
  2921. export type MutationDeleteStockLocationsArgs = {
  2922. input: Array<DeleteStockLocationInput>;
  2923. };
  2924. export type MutationDeleteTagArgs = {
  2925. id: Scalars['ID'];
  2926. };
  2927. export type MutationDeleteTaxCategoriesArgs = {
  2928. ids: Array<Scalars['ID']>;
  2929. };
  2930. export type MutationDeleteTaxCategoryArgs = {
  2931. id: Scalars['ID'];
  2932. };
  2933. export type MutationDeleteTaxRateArgs = {
  2934. id: Scalars['ID'];
  2935. };
  2936. export type MutationDeleteTaxRatesArgs = {
  2937. ids: Array<Scalars['ID']>;
  2938. };
  2939. export type MutationDeleteZoneArgs = {
  2940. id: Scalars['ID'];
  2941. };
  2942. export type MutationDeleteZonesArgs = {
  2943. ids: Array<Scalars['ID']>;
  2944. };
  2945. export type MutationFlushBufferedJobsArgs = {
  2946. bufferIds?: InputMaybe<Array<Scalars['String']>>;
  2947. };
  2948. export type MutationImportProductsArgs = {
  2949. csvFile: Scalars['Upload'];
  2950. };
  2951. export type MutationLoginArgs = {
  2952. password: Scalars['String'];
  2953. rememberMe?: InputMaybe<Scalars['Boolean']>;
  2954. username: Scalars['String'];
  2955. };
  2956. export type MutationModifyOrderArgs = {
  2957. input: ModifyOrderInput;
  2958. };
  2959. export type MutationMoveCollectionArgs = {
  2960. input: MoveCollectionInput;
  2961. };
  2962. export type MutationRefundOrderArgs = {
  2963. input: RefundOrderInput;
  2964. };
  2965. export type MutationRemoveCollectionsFromChannelArgs = {
  2966. input: RemoveCollectionsFromChannelInput;
  2967. };
  2968. export type MutationRemoveCouponCodeFromDraftOrderArgs = {
  2969. couponCode: Scalars['String'];
  2970. orderId: Scalars['ID'];
  2971. };
  2972. export type MutationRemoveCustomersFromGroupArgs = {
  2973. customerGroupId: Scalars['ID'];
  2974. customerIds: Array<Scalars['ID']>;
  2975. };
  2976. export type MutationRemoveDraftOrderLineArgs = {
  2977. orderId: Scalars['ID'];
  2978. orderLineId: Scalars['ID'];
  2979. };
  2980. export type MutationRemoveFacetsFromChannelArgs = {
  2981. input: RemoveFacetsFromChannelInput;
  2982. };
  2983. export type MutationRemoveMembersFromZoneArgs = {
  2984. memberIds: Array<Scalars['ID']>;
  2985. zoneId: Scalars['ID'];
  2986. };
  2987. export type MutationRemoveOptionGroupFromProductArgs = {
  2988. force?: InputMaybe<Scalars['Boolean']>;
  2989. optionGroupId: Scalars['ID'];
  2990. productId: Scalars['ID'];
  2991. };
  2992. export type MutationRemovePaymentMethodsFromChannelArgs = {
  2993. input: RemovePaymentMethodsFromChannelInput;
  2994. };
  2995. export type MutationRemoveProductVariantsFromChannelArgs = {
  2996. input: RemoveProductVariantsFromChannelInput;
  2997. };
  2998. export type MutationRemoveProductsFromChannelArgs = {
  2999. input: RemoveProductsFromChannelInput;
  3000. };
  3001. export type MutationRemovePromotionsFromChannelArgs = {
  3002. input: RemovePromotionsFromChannelInput;
  3003. };
  3004. export type MutationRemoveSettledJobsArgs = {
  3005. olderThan?: InputMaybe<Scalars['DateTime']>;
  3006. queueNames?: InputMaybe<Array<Scalars['String']>>;
  3007. };
  3008. export type MutationRemoveShippingMethodsFromChannelArgs = {
  3009. input: RemoveShippingMethodsFromChannelInput;
  3010. };
  3011. export type MutationRemoveStockLocationsFromChannelArgs = {
  3012. input: RemoveStockLocationsFromChannelInput;
  3013. };
  3014. export type MutationSetCustomerForDraftOrderArgs = {
  3015. customerId?: InputMaybe<Scalars['ID']>;
  3016. input?: InputMaybe<CreateCustomerInput>;
  3017. orderId: Scalars['ID'];
  3018. };
  3019. export type MutationSetDraftOrderBillingAddressArgs = {
  3020. input: CreateAddressInput;
  3021. orderId: Scalars['ID'];
  3022. };
  3023. export type MutationSetDraftOrderCustomFieldsArgs = {
  3024. input: UpdateOrderInput;
  3025. orderId: Scalars['ID'];
  3026. };
  3027. export type MutationSetDraftOrderShippingAddressArgs = {
  3028. input: CreateAddressInput;
  3029. orderId: Scalars['ID'];
  3030. };
  3031. export type MutationSetDraftOrderShippingMethodArgs = {
  3032. orderId: Scalars['ID'];
  3033. shippingMethodId: Scalars['ID'];
  3034. };
  3035. export type MutationSetOrderCustomFieldsArgs = {
  3036. input: UpdateOrderInput;
  3037. };
  3038. export type MutationSettlePaymentArgs = {
  3039. id: Scalars['ID'];
  3040. };
  3041. export type MutationSettleRefundArgs = {
  3042. input: SettleRefundInput;
  3043. };
  3044. export type MutationTransitionFulfillmentToStateArgs = {
  3045. id: Scalars['ID'];
  3046. state: Scalars['String'];
  3047. };
  3048. export type MutationTransitionOrderToStateArgs = {
  3049. id: Scalars['ID'];
  3050. state: Scalars['String'];
  3051. };
  3052. export type MutationTransitionPaymentToStateArgs = {
  3053. id: Scalars['ID'];
  3054. state: Scalars['String'];
  3055. };
  3056. export type MutationUpdateActiveAdministratorArgs = {
  3057. input: UpdateActiveAdministratorInput;
  3058. };
  3059. export type MutationUpdateAdministratorArgs = {
  3060. input: UpdateAdministratorInput;
  3061. };
  3062. export type MutationUpdateAssetArgs = {
  3063. input: UpdateAssetInput;
  3064. };
  3065. export type MutationUpdateChannelArgs = {
  3066. input: UpdateChannelInput;
  3067. };
  3068. export type MutationUpdateCollectionArgs = {
  3069. input: UpdateCollectionInput;
  3070. };
  3071. export type MutationUpdateCountryArgs = {
  3072. input: UpdateCountryInput;
  3073. };
  3074. export type MutationUpdateCustomerArgs = {
  3075. input: UpdateCustomerInput;
  3076. };
  3077. export type MutationUpdateCustomerAddressArgs = {
  3078. input: UpdateAddressInput;
  3079. };
  3080. export type MutationUpdateCustomerGroupArgs = {
  3081. input: UpdateCustomerGroupInput;
  3082. };
  3083. export type MutationUpdateCustomerNoteArgs = {
  3084. input: UpdateCustomerNoteInput;
  3085. };
  3086. export type MutationUpdateFacetArgs = {
  3087. input: UpdateFacetInput;
  3088. };
  3089. export type MutationUpdateFacetValuesArgs = {
  3090. input: Array<UpdateFacetValueInput>;
  3091. };
  3092. export type MutationUpdateGlobalSettingsArgs = {
  3093. input: UpdateGlobalSettingsInput;
  3094. };
  3095. export type MutationUpdateOrderNoteArgs = {
  3096. input: UpdateOrderNoteInput;
  3097. };
  3098. export type MutationUpdatePaymentMethodArgs = {
  3099. input: UpdatePaymentMethodInput;
  3100. };
  3101. export type MutationUpdateProductArgs = {
  3102. input: UpdateProductInput;
  3103. };
  3104. export type MutationUpdateProductOptionArgs = {
  3105. input: UpdateProductOptionInput;
  3106. };
  3107. export type MutationUpdateProductOptionGroupArgs = {
  3108. input: UpdateProductOptionGroupInput;
  3109. };
  3110. export type MutationUpdateProductVariantsArgs = {
  3111. input: Array<UpdateProductVariantInput>;
  3112. };
  3113. export type MutationUpdateProductsArgs = {
  3114. input: Array<UpdateProductInput>;
  3115. };
  3116. export type MutationUpdatePromotionArgs = {
  3117. input: UpdatePromotionInput;
  3118. };
  3119. export type MutationUpdateProvinceArgs = {
  3120. input: UpdateProvinceInput;
  3121. };
  3122. export type MutationUpdateRoleArgs = {
  3123. input: UpdateRoleInput;
  3124. };
  3125. export type MutationUpdateSellerArgs = {
  3126. input: UpdateSellerInput;
  3127. };
  3128. export type MutationUpdateShippingMethodArgs = {
  3129. input: UpdateShippingMethodInput;
  3130. };
  3131. export type MutationUpdateStockLocationArgs = {
  3132. input: UpdateStockLocationInput;
  3133. };
  3134. export type MutationUpdateTagArgs = {
  3135. input: UpdateTagInput;
  3136. };
  3137. export type MutationUpdateTaxCategoryArgs = {
  3138. input: UpdateTaxCategoryInput;
  3139. };
  3140. export type MutationUpdateTaxRateArgs = {
  3141. input: UpdateTaxRateInput;
  3142. };
  3143. export type MutationUpdateZoneArgs = {
  3144. input: UpdateZoneInput;
  3145. };
  3146. export type NativeAuthInput = {
  3147. password: Scalars['String'];
  3148. username: Scalars['String'];
  3149. };
  3150. /** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
  3151. export type NativeAuthStrategyError = ErrorResult & {
  3152. __typename?: 'NativeAuthStrategyError';
  3153. errorCode: ErrorCode;
  3154. message: Scalars['String'];
  3155. };
  3156. export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
  3157. /** Returned when attempting to set a negative OrderLine quantity. */
  3158. export type NegativeQuantityError = ErrorResult & {
  3159. __typename?: 'NegativeQuantityError';
  3160. errorCode: ErrorCode;
  3161. message: Scalars['String'];
  3162. };
  3163. /**
  3164. * Returned when invoking a mutation which depends on there being an active Order on the
  3165. * current session.
  3166. */
  3167. export type NoActiveOrderError = ErrorResult & {
  3168. __typename?: 'NoActiveOrderError';
  3169. errorCode: ErrorCode;
  3170. message: Scalars['String'];
  3171. };
  3172. /** Returned when a call to modifyOrder fails to specify any changes */
  3173. export type NoChangesSpecifiedError = ErrorResult & {
  3174. __typename?: 'NoChangesSpecifiedError';
  3175. errorCode: ErrorCode;
  3176. message: Scalars['String'];
  3177. };
  3178. export type Node = {
  3179. id: Scalars['ID'];
  3180. };
  3181. /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
  3182. export type NothingToRefundError = ErrorResult & {
  3183. __typename?: 'NothingToRefundError';
  3184. errorCode: ErrorCode;
  3185. message: Scalars['String'];
  3186. };
  3187. /** Operators for filtering on a list of Number fields */
  3188. export type NumberListOperators = {
  3189. inList: Scalars['Float'];
  3190. };
  3191. /** Operators for filtering on a Int or Float field */
  3192. export type NumberOperators = {
  3193. between?: InputMaybe<NumberRange>;
  3194. eq?: InputMaybe<Scalars['Float']>;
  3195. gt?: InputMaybe<Scalars['Float']>;
  3196. gte?: InputMaybe<Scalars['Float']>;
  3197. isNull?: InputMaybe<Scalars['Boolean']>;
  3198. lt?: InputMaybe<Scalars['Float']>;
  3199. lte?: InputMaybe<Scalars['Float']>;
  3200. };
  3201. export type NumberRange = {
  3202. end: Scalars['Float'];
  3203. start: Scalars['Float'];
  3204. };
  3205. export type Order = Node & {
  3206. __typename?: 'Order';
  3207. /** An order is active as long as the payment process has not been completed */
  3208. active: Scalars['Boolean'];
  3209. aggregateOrder?: Maybe<Order>;
  3210. aggregateOrderId?: Maybe<Scalars['ID']>;
  3211. billingAddress?: Maybe<OrderAddress>;
  3212. channels: Array<Channel>;
  3213. /** A unique code for the Order */
  3214. code: Scalars['String'];
  3215. /** An array of all coupon codes applied to the Order */
  3216. couponCodes: Array<Scalars['String']>;
  3217. createdAt: Scalars['DateTime'];
  3218. currencyCode: CurrencyCode;
  3219. customFields?: Maybe<Scalars['JSON']>;
  3220. customer?: Maybe<Customer>;
  3221. discounts: Array<Discount>;
  3222. fulfillments?: Maybe<Array<Fulfillment>>;
  3223. history: HistoryEntryList;
  3224. id: Scalars['ID'];
  3225. lines: Array<OrderLine>;
  3226. modifications: Array<OrderModification>;
  3227. nextStates: Array<Scalars['String']>;
  3228. /**
  3229. * The date & time that the Order was placed, i.e. the Customer
  3230. * completed the checkout and the Order is no longer "active"
  3231. */
  3232. orderPlacedAt?: Maybe<Scalars['DateTime']>;
  3233. payments?: Maybe<Array<Payment>>;
  3234. /** Promotions applied to the order. Only gets populated after the payment process has completed. */
  3235. promotions: Array<Promotion>;
  3236. sellerOrders?: Maybe<Array<Order>>;
  3237. shipping: Scalars['Money'];
  3238. shippingAddress?: Maybe<OrderAddress>;
  3239. shippingLines: Array<ShippingLine>;
  3240. shippingWithTax: Scalars['Money'];
  3241. state: Scalars['String'];
  3242. /**
  3243. * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  3244. * discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
  3245. * To get a total of all OrderLines which does not account for prorated discounts, use the
  3246. * sum of `OrderLine.discountedLinePrice` values.
  3247. */
  3248. subTotal: Scalars['Money'];
  3249. /** Same as subTotal, but inclusive of tax */
  3250. subTotalWithTax: Scalars['Money'];
  3251. /**
  3252. * Surcharges are arbitrary modifications to the Order total which are neither
  3253. * ProductVariants nor discounts resulting from applied Promotions. For example,
  3254. * one-off discounts based on customer interaction, or surcharges based on payment
  3255. * methods.
  3256. */
  3257. surcharges: Array<Surcharge>;
  3258. /** A summary of the taxes being applied to this Order */
  3259. taxSummary: Array<OrderTaxSummary>;
  3260. /** Equal to subTotal plus shipping */
  3261. total: Scalars['Money'];
  3262. totalQuantity: Scalars['Int'];
  3263. /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
  3264. totalWithTax: Scalars['Money'];
  3265. type: OrderType;
  3266. updatedAt: Scalars['DateTime'];
  3267. };
  3268. export type OrderHistoryArgs = {
  3269. options?: InputMaybe<HistoryEntryListOptions>;
  3270. };
  3271. export type OrderAddress = {
  3272. __typename?: 'OrderAddress';
  3273. city?: Maybe<Scalars['String']>;
  3274. company?: Maybe<Scalars['String']>;
  3275. country?: Maybe<Scalars['String']>;
  3276. countryCode?: Maybe<Scalars['String']>;
  3277. customFields?: Maybe<Scalars['JSON']>;
  3278. fullName?: Maybe<Scalars['String']>;
  3279. phoneNumber?: Maybe<Scalars['String']>;
  3280. postalCode?: Maybe<Scalars['String']>;
  3281. province?: Maybe<Scalars['String']>;
  3282. streetLine1?: Maybe<Scalars['String']>;
  3283. streetLine2?: Maybe<Scalars['String']>;
  3284. };
  3285. export type OrderFilterParameter = {
  3286. active?: InputMaybe<BooleanOperators>;
  3287. aggregateOrderId?: InputMaybe<IdOperators>;
  3288. code?: InputMaybe<StringOperators>;
  3289. createdAt?: InputMaybe<DateOperators>;
  3290. currencyCode?: InputMaybe<StringOperators>;
  3291. customerLastName?: InputMaybe<StringOperators>;
  3292. id?: InputMaybe<IdOperators>;
  3293. orderPlacedAt?: InputMaybe<DateOperators>;
  3294. shipping?: InputMaybe<NumberOperators>;
  3295. shippingWithTax?: InputMaybe<NumberOperators>;
  3296. state?: InputMaybe<StringOperators>;
  3297. subTotal?: InputMaybe<NumberOperators>;
  3298. subTotalWithTax?: InputMaybe<NumberOperators>;
  3299. total?: InputMaybe<NumberOperators>;
  3300. totalQuantity?: InputMaybe<NumberOperators>;
  3301. totalWithTax?: InputMaybe<NumberOperators>;
  3302. transactionId?: InputMaybe<StringOperators>;
  3303. type?: InputMaybe<StringOperators>;
  3304. updatedAt?: InputMaybe<DateOperators>;
  3305. };
  3306. /** Returned when the maximum order size limit has been reached. */
  3307. export type OrderLimitError = ErrorResult & {
  3308. __typename?: 'OrderLimitError';
  3309. errorCode: ErrorCode;
  3310. maxItems: Scalars['Int'];
  3311. message: Scalars['String'];
  3312. };
  3313. export type OrderLine = Node & {
  3314. __typename?: 'OrderLine';
  3315. createdAt: Scalars['DateTime'];
  3316. customFields?: Maybe<Scalars['JSON']>;
  3317. /** The price of the line including discounts, excluding tax */
  3318. discountedLinePrice: Scalars['Money'];
  3319. /** The price of the line including discounts and tax */
  3320. discountedLinePriceWithTax: Scalars['Money'];
  3321. /**
  3322. * The price of a single unit including discounts, excluding tax.
  3323. *
  3324. * If Order-level discounts have been applied, this will not be the
  3325. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  3326. * correct price to display to customers to avoid confusion
  3327. * about the internal handling of distributed Order-level discounts.
  3328. */
  3329. discountedUnitPrice: Scalars['Money'];
  3330. /** The price of a single unit including discounts and tax */
  3331. discountedUnitPriceWithTax: Scalars['Money'];
  3332. discounts: Array<Discount>;
  3333. featuredAsset?: Maybe<Asset>;
  3334. fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
  3335. id: Scalars['ID'];
  3336. /** The total price of the line excluding tax and discounts. */
  3337. linePrice: Scalars['Money'];
  3338. /** The total price of the line including tax but excluding discounts. */
  3339. linePriceWithTax: Scalars['Money'];
  3340. /** The total tax on this line */
  3341. lineTax: Scalars['Money'];
  3342. order: Order;
  3343. /** The quantity at the time the Order was placed */
  3344. orderPlacedQuantity: Scalars['Int'];
  3345. productVariant: ProductVariant;
  3346. /**
  3347. * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3348. * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
  3349. * and refund calculations.
  3350. */
  3351. proratedLinePrice: Scalars['Money'];
  3352. /** The proratedLinePrice including tax */
  3353. proratedLinePriceWithTax: Scalars['Money'];
  3354. /**
  3355. * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3356. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  3357. * and refund calculations.
  3358. */
  3359. proratedUnitPrice: Scalars['Money'];
  3360. /** The proratedUnitPrice including tax */
  3361. proratedUnitPriceWithTax: Scalars['Money'];
  3362. quantity: Scalars['Int'];
  3363. taxLines: Array<TaxLine>;
  3364. taxRate: Scalars['Float'];
  3365. /** The price of a single unit, excluding tax and discounts */
  3366. unitPrice: Scalars['Money'];
  3367. /** Non-zero if the unitPrice has changed since it was initially added to Order */
  3368. unitPriceChangeSinceAdded: Scalars['Money'];
  3369. /** The price of a single unit, including tax but excluding discounts */
  3370. unitPriceWithTax: Scalars['Money'];
  3371. /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
  3372. unitPriceWithTaxChangeSinceAdded: Scalars['Money'];
  3373. updatedAt: Scalars['DateTime'];
  3374. };
  3375. export type OrderLineInput = {
  3376. orderLineId: Scalars['ID'];
  3377. quantity: Scalars['Int'];
  3378. };
  3379. export type OrderList = PaginatedList & {
  3380. __typename?: 'OrderList';
  3381. items: Array<Order>;
  3382. totalItems: Scalars['Int'];
  3383. };
  3384. export type OrderListOptions = {
  3385. /** Allows the results to be filtered */
  3386. filter?: InputMaybe<OrderFilterParameter>;
  3387. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  3388. filterOperator?: InputMaybe<LogicalOperator>;
  3389. /** Skips the first n results, for use in pagination */
  3390. skip?: InputMaybe<Scalars['Int']>;
  3391. /** Specifies which properties to sort the results by */
  3392. sort?: InputMaybe<OrderSortParameter>;
  3393. /** Takes n results, for use in pagination */
  3394. take?: InputMaybe<Scalars['Int']>;
  3395. };
  3396. export type OrderModification = Node & {
  3397. __typename?: 'OrderModification';
  3398. createdAt: Scalars['DateTime'];
  3399. id: Scalars['ID'];
  3400. isSettled: Scalars['Boolean'];
  3401. lines: Array<OrderModificationLine>;
  3402. note: Scalars['String'];
  3403. payment?: Maybe<Payment>;
  3404. priceChange: Scalars['Money'];
  3405. refund?: Maybe<Refund>;
  3406. surcharges?: Maybe<Array<Surcharge>>;
  3407. updatedAt: Scalars['DateTime'];
  3408. };
  3409. /** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
  3410. export type OrderModificationError = ErrorResult & {
  3411. __typename?: 'OrderModificationError';
  3412. errorCode: ErrorCode;
  3413. message: Scalars['String'];
  3414. };
  3415. export type OrderModificationLine = {
  3416. __typename?: 'OrderModificationLine';
  3417. modification: OrderModification;
  3418. modificationId: Scalars['ID'];
  3419. orderLine: OrderLine;
  3420. orderLineId: Scalars['ID'];
  3421. quantity: Scalars['Int'];
  3422. };
  3423. /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
  3424. export type OrderModificationStateError = ErrorResult & {
  3425. __typename?: 'OrderModificationStateError';
  3426. errorCode: ErrorCode;
  3427. message: Scalars['String'];
  3428. };
  3429. export type OrderProcessState = {
  3430. __typename?: 'OrderProcessState';
  3431. name: Scalars['String'];
  3432. to: Array<Scalars['String']>;
  3433. };
  3434. export type OrderSortParameter = {
  3435. aggregateOrderId?: InputMaybe<SortOrder>;
  3436. code?: InputMaybe<SortOrder>;
  3437. createdAt?: InputMaybe<SortOrder>;
  3438. customerLastName?: InputMaybe<SortOrder>;
  3439. id?: InputMaybe<SortOrder>;
  3440. orderPlacedAt?: InputMaybe<SortOrder>;
  3441. shipping?: InputMaybe<SortOrder>;
  3442. shippingWithTax?: InputMaybe<SortOrder>;
  3443. state?: InputMaybe<SortOrder>;
  3444. subTotal?: InputMaybe<SortOrder>;
  3445. subTotalWithTax?: InputMaybe<SortOrder>;
  3446. total?: InputMaybe<SortOrder>;
  3447. totalQuantity?: InputMaybe<SortOrder>;
  3448. totalWithTax?: InputMaybe<SortOrder>;
  3449. transactionId?: InputMaybe<SortOrder>;
  3450. updatedAt?: InputMaybe<SortOrder>;
  3451. };
  3452. /** Returned if there is an error in transitioning the Order state */
  3453. export type OrderStateTransitionError = ErrorResult & {
  3454. __typename?: 'OrderStateTransitionError';
  3455. errorCode: ErrorCode;
  3456. fromState: Scalars['String'];
  3457. message: Scalars['String'];
  3458. toState: Scalars['String'];
  3459. transitionError: Scalars['String'];
  3460. };
  3461. /**
  3462. * A summary of the taxes being applied to this order, grouped
  3463. * by taxRate.
  3464. */
  3465. export type OrderTaxSummary = {
  3466. __typename?: 'OrderTaxSummary';
  3467. /** A description of this tax */
  3468. description: Scalars['String'];
  3469. /** The total net price of OrderLines to which this taxRate applies */
  3470. taxBase: Scalars['Money'];
  3471. /** The taxRate as a percentage */
  3472. taxRate: Scalars['Float'];
  3473. /** The total tax being applied to the Order at this taxRate */
  3474. taxTotal: Scalars['Money'];
  3475. };
  3476. export enum OrderType {
  3477. Aggregate = 'Aggregate',
  3478. Regular = 'Regular',
  3479. Seller = 'Seller'
  3480. }
  3481. export type PaginatedList = {
  3482. items: Array<Node>;
  3483. totalItems: Scalars['Int'];
  3484. };
  3485. export type Payment = Node & {
  3486. __typename?: 'Payment';
  3487. amount: Scalars['Money'];
  3488. createdAt: Scalars['DateTime'];
  3489. errorMessage?: Maybe<Scalars['String']>;
  3490. id: Scalars['ID'];
  3491. metadata?: Maybe<Scalars['JSON']>;
  3492. method: Scalars['String'];
  3493. nextStates: Array<Scalars['String']>;
  3494. refunds: Array<Refund>;
  3495. state: Scalars['String'];
  3496. transactionId?: Maybe<Scalars['String']>;
  3497. updatedAt: Scalars['DateTime'];
  3498. };
  3499. export type PaymentMethod = Node & {
  3500. __typename?: 'PaymentMethod';
  3501. checker?: Maybe<ConfigurableOperation>;
  3502. code: Scalars['String'];
  3503. createdAt: Scalars['DateTime'];
  3504. customFields?: Maybe<Scalars['JSON']>;
  3505. description: Scalars['String'];
  3506. enabled: Scalars['Boolean'];
  3507. handler: ConfigurableOperation;
  3508. id: Scalars['ID'];
  3509. name: Scalars['String'];
  3510. translations: Array<PaymentMethodTranslation>;
  3511. updatedAt: Scalars['DateTime'];
  3512. };
  3513. export type PaymentMethodFilterParameter = {
  3514. code?: InputMaybe<StringOperators>;
  3515. createdAt?: InputMaybe<DateOperators>;
  3516. description?: InputMaybe<StringOperators>;
  3517. enabled?: InputMaybe<BooleanOperators>;
  3518. id?: InputMaybe<IdOperators>;
  3519. name?: InputMaybe<StringOperators>;
  3520. updatedAt?: InputMaybe<DateOperators>;
  3521. };
  3522. export type PaymentMethodList = PaginatedList & {
  3523. __typename?: 'PaymentMethodList';
  3524. items: Array<PaymentMethod>;
  3525. totalItems: Scalars['Int'];
  3526. };
  3527. export type PaymentMethodListOptions = {
  3528. /** Allows the results to be filtered */
  3529. filter?: InputMaybe<PaymentMethodFilterParameter>;
  3530. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  3531. filterOperator?: InputMaybe<LogicalOperator>;
  3532. /** Skips the first n results, for use in pagination */
  3533. skip?: InputMaybe<Scalars['Int']>;
  3534. /** Specifies which properties to sort the results by */
  3535. sort?: InputMaybe<PaymentMethodSortParameter>;
  3536. /** Takes n results, for use in pagination */
  3537. take?: InputMaybe<Scalars['Int']>;
  3538. };
  3539. /**
  3540. * Returned when a call to modifyOrder fails to include a paymentMethod even
  3541. * though the price has increased as a result of the changes.
  3542. */
  3543. export type PaymentMethodMissingError = ErrorResult & {
  3544. __typename?: 'PaymentMethodMissingError';
  3545. errorCode: ErrorCode;
  3546. message: Scalars['String'];
  3547. };
  3548. export type PaymentMethodQuote = {
  3549. __typename?: 'PaymentMethodQuote';
  3550. code: Scalars['String'];
  3551. customFields?: Maybe<Scalars['JSON']>;
  3552. description: Scalars['String'];
  3553. eligibilityMessage?: Maybe<Scalars['String']>;
  3554. id: Scalars['ID'];
  3555. isEligible: Scalars['Boolean'];
  3556. name: Scalars['String'];
  3557. };
  3558. export type PaymentMethodSortParameter = {
  3559. code?: InputMaybe<SortOrder>;
  3560. createdAt?: InputMaybe<SortOrder>;
  3561. description?: InputMaybe<SortOrder>;
  3562. id?: InputMaybe<SortOrder>;
  3563. name?: InputMaybe<SortOrder>;
  3564. updatedAt?: InputMaybe<SortOrder>;
  3565. };
  3566. export type PaymentMethodTranslation = {
  3567. __typename?: 'PaymentMethodTranslation';
  3568. createdAt: Scalars['DateTime'];
  3569. description: Scalars['String'];
  3570. id: Scalars['ID'];
  3571. languageCode: LanguageCode;
  3572. name: Scalars['String'];
  3573. updatedAt: Scalars['DateTime'];
  3574. };
  3575. export type PaymentMethodTranslationInput = {
  3576. customFields?: InputMaybe<Scalars['JSON']>;
  3577. description?: InputMaybe<Scalars['String']>;
  3578. id?: InputMaybe<Scalars['ID']>;
  3579. languageCode: LanguageCode;
  3580. name?: InputMaybe<Scalars['String']>;
  3581. };
  3582. /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
  3583. export type PaymentOrderMismatchError = ErrorResult & {
  3584. __typename?: 'PaymentOrderMismatchError';
  3585. errorCode: ErrorCode;
  3586. message: Scalars['String'];
  3587. };
  3588. /** Returned when there is an error in transitioning the Payment state */
  3589. export type PaymentStateTransitionError = ErrorResult & {
  3590. __typename?: 'PaymentStateTransitionError';
  3591. errorCode: ErrorCode;
  3592. fromState: Scalars['String'];
  3593. message: Scalars['String'];
  3594. toState: Scalars['String'];
  3595. transitionError: Scalars['String'];
  3596. };
  3597. /**
  3598. * @description
  3599. * Permissions for administrators and customers. Used to control access to
  3600. * GraphQL resolvers via the {@link Allow} decorator.
  3601. *
  3602. * ## Understanding Permission.Owner
  3603. *
  3604. * `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
  3605. * be accessible to the "owner" of that resource.
  3606. *
  3607. * For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
  3608. * based on the activeUserId of the current session. As a result, the resolver code looks like this:
  3609. *
  3610. * @example
  3611. * ```TypeScript
  3612. * \@Query()
  3613. * \@Allow(Permission.Owner)
  3614. * async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
  3615. * const userId = ctx.activeUserId;
  3616. * if (userId) {
  3617. * return this.customerService.findOneByUserId(ctx, userId);
  3618. * }
  3619. * }
  3620. * ```
  3621. *
  3622. * Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
  3623. * nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
  3624. * of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
  3625. *
  3626. *
  3627. * @docsCategory common
  3628. */
  3629. export enum Permission {
  3630. /** Authenticated means simply that the user is logged in */
  3631. Authenticated = 'Authenticated',
  3632. /** Grants permission to create Administrator */
  3633. CreateAdministrator = 'CreateAdministrator',
  3634. /** Grants permission to create Asset */
  3635. CreateAsset = 'CreateAsset',
  3636. /** Grants permission to create Products, Facets, Assets, Collections */
  3637. CreateCatalog = 'CreateCatalog',
  3638. /** Grants permission to create Channel */
  3639. CreateChannel = 'CreateChannel',
  3640. /** Grants permission to create Collection */
  3641. CreateCollection = 'CreateCollection',
  3642. /** Grants permission to create Country */
  3643. CreateCountry = 'CreateCountry',
  3644. /** Grants permission to create Customer */
  3645. CreateCustomer = 'CreateCustomer',
  3646. /** Grants permission to create CustomerGroup */
  3647. CreateCustomerGroup = 'CreateCustomerGroup',
  3648. /** Grants permission to create Facet */
  3649. CreateFacet = 'CreateFacet',
  3650. /** Grants permission to create Order */
  3651. CreateOrder = 'CreateOrder',
  3652. /** Grants permission to create PaymentMethod */
  3653. CreatePaymentMethod = 'CreatePaymentMethod',
  3654. /** Grants permission to create Product */
  3655. CreateProduct = 'CreateProduct',
  3656. /** Grants permission to create Promotion */
  3657. CreatePromotion = 'CreatePromotion',
  3658. /** Grants permission to create Seller */
  3659. CreateSeller = 'CreateSeller',
  3660. /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3661. CreateSettings = 'CreateSettings',
  3662. /** Grants permission to create ShippingMethod */
  3663. CreateShippingMethod = 'CreateShippingMethod',
  3664. /** Grants permission to create StockLocation */
  3665. CreateStockLocation = 'CreateStockLocation',
  3666. /** Grants permission to create System */
  3667. CreateSystem = 'CreateSystem',
  3668. /** Grants permission to create Tag */
  3669. CreateTag = 'CreateTag',
  3670. /** Grants permission to create TaxCategory */
  3671. CreateTaxCategory = 'CreateTaxCategory',
  3672. /** Grants permission to create TaxRate */
  3673. CreateTaxRate = 'CreateTaxRate',
  3674. /** Grants permission to create Zone */
  3675. CreateZone = 'CreateZone',
  3676. /** Grants permission to delete Administrator */
  3677. DeleteAdministrator = 'DeleteAdministrator',
  3678. /** Grants permission to delete Asset */
  3679. DeleteAsset = 'DeleteAsset',
  3680. /** Grants permission to delete Products, Facets, Assets, Collections */
  3681. DeleteCatalog = 'DeleteCatalog',
  3682. /** Grants permission to delete Channel */
  3683. DeleteChannel = 'DeleteChannel',
  3684. /** Grants permission to delete Collection */
  3685. DeleteCollection = 'DeleteCollection',
  3686. /** Grants permission to delete Country */
  3687. DeleteCountry = 'DeleteCountry',
  3688. /** Grants permission to delete Customer */
  3689. DeleteCustomer = 'DeleteCustomer',
  3690. /** Grants permission to delete CustomerGroup */
  3691. DeleteCustomerGroup = 'DeleteCustomerGroup',
  3692. /** Grants permission to delete Facet */
  3693. DeleteFacet = 'DeleteFacet',
  3694. /** Grants permission to delete Order */
  3695. DeleteOrder = 'DeleteOrder',
  3696. /** Grants permission to delete PaymentMethod */
  3697. DeletePaymentMethod = 'DeletePaymentMethod',
  3698. /** Grants permission to delete Product */
  3699. DeleteProduct = 'DeleteProduct',
  3700. /** Grants permission to delete Promotion */
  3701. DeletePromotion = 'DeletePromotion',
  3702. /** Grants permission to delete Seller */
  3703. DeleteSeller = 'DeleteSeller',
  3704. /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3705. DeleteSettings = 'DeleteSettings',
  3706. /** Grants permission to delete ShippingMethod */
  3707. DeleteShippingMethod = 'DeleteShippingMethod',
  3708. /** Grants permission to delete StockLocation */
  3709. DeleteStockLocation = 'DeleteStockLocation',
  3710. /** Grants permission to delete System */
  3711. DeleteSystem = 'DeleteSystem',
  3712. /** Grants permission to delete Tag */
  3713. DeleteTag = 'DeleteTag',
  3714. /** Grants permission to delete TaxCategory */
  3715. DeleteTaxCategory = 'DeleteTaxCategory',
  3716. /** Grants permission to delete TaxRate */
  3717. DeleteTaxRate = 'DeleteTaxRate',
  3718. /** Grants permission to delete Zone */
  3719. DeleteZone = 'DeleteZone',
  3720. /** Owner means the user owns this entity, e.g. a Customer's own Order */
  3721. Owner = 'Owner',
  3722. /** Public means any unauthenticated user may perform the operation */
  3723. Public = 'Public',
  3724. /** Grants permission to read Administrator */
  3725. ReadAdministrator = 'ReadAdministrator',
  3726. /** Grants permission to read Asset */
  3727. ReadAsset = 'ReadAsset',
  3728. /** Grants permission to read Products, Facets, Assets, Collections */
  3729. ReadCatalog = 'ReadCatalog',
  3730. /** Grants permission to read Channel */
  3731. ReadChannel = 'ReadChannel',
  3732. /** Grants permission to read Collection */
  3733. ReadCollection = 'ReadCollection',
  3734. /** Grants permission to read Country */
  3735. ReadCountry = 'ReadCountry',
  3736. /** Grants permission to read Customer */
  3737. ReadCustomer = 'ReadCustomer',
  3738. /** Grants permission to read CustomerGroup */
  3739. ReadCustomerGroup = 'ReadCustomerGroup',
  3740. /** Grants permission to read Facet */
  3741. ReadFacet = 'ReadFacet',
  3742. /** Grants permission to read Order */
  3743. ReadOrder = 'ReadOrder',
  3744. /** Grants permission to read PaymentMethod */
  3745. ReadPaymentMethod = 'ReadPaymentMethod',
  3746. /** Grants permission to read Product */
  3747. ReadProduct = 'ReadProduct',
  3748. /** Grants permission to read Promotion */
  3749. ReadPromotion = 'ReadPromotion',
  3750. /** Grants permission to read Seller */
  3751. ReadSeller = 'ReadSeller',
  3752. /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3753. ReadSettings = 'ReadSettings',
  3754. /** Grants permission to read ShippingMethod */
  3755. ReadShippingMethod = 'ReadShippingMethod',
  3756. /** Grants permission to read StockLocation */
  3757. ReadStockLocation = 'ReadStockLocation',
  3758. /** Grants permission to read System */
  3759. ReadSystem = 'ReadSystem',
  3760. /** Grants permission to read Tag */
  3761. ReadTag = 'ReadTag',
  3762. /** Grants permission to read TaxCategory */
  3763. ReadTaxCategory = 'ReadTaxCategory',
  3764. /** Grants permission to read TaxRate */
  3765. ReadTaxRate = 'ReadTaxRate',
  3766. /** Grants permission to read Zone */
  3767. ReadZone = 'ReadZone',
  3768. /** SuperAdmin has unrestricted access to all operations */
  3769. SuperAdmin = 'SuperAdmin',
  3770. /** Grants permission to update Administrator */
  3771. UpdateAdministrator = 'UpdateAdministrator',
  3772. /** Grants permission to update Asset */
  3773. UpdateAsset = 'UpdateAsset',
  3774. /** Grants permission to update Products, Facets, Assets, Collections */
  3775. UpdateCatalog = 'UpdateCatalog',
  3776. /** Grants permission to update Channel */
  3777. UpdateChannel = 'UpdateChannel',
  3778. /** Grants permission to update Collection */
  3779. UpdateCollection = 'UpdateCollection',
  3780. /** Grants permission to update Country */
  3781. UpdateCountry = 'UpdateCountry',
  3782. /** Grants permission to update Customer */
  3783. UpdateCustomer = 'UpdateCustomer',
  3784. /** Grants permission to update CustomerGroup */
  3785. UpdateCustomerGroup = 'UpdateCustomerGroup',
  3786. /** Grants permission to update Facet */
  3787. UpdateFacet = 'UpdateFacet',
  3788. /** Grants permission to update GlobalSettings */
  3789. UpdateGlobalSettings = 'UpdateGlobalSettings',
  3790. /** Grants permission to update Order */
  3791. UpdateOrder = 'UpdateOrder',
  3792. /** Grants permission to update PaymentMethod */
  3793. UpdatePaymentMethod = 'UpdatePaymentMethod',
  3794. /** Grants permission to update Product */
  3795. UpdateProduct = 'UpdateProduct',
  3796. /** Grants permission to update Promotion */
  3797. UpdatePromotion = 'UpdatePromotion',
  3798. /** Grants permission to update Seller */
  3799. UpdateSeller = 'UpdateSeller',
  3800. /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3801. UpdateSettings = 'UpdateSettings',
  3802. /** Grants permission to update ShippingMethod */
  3803. UpdateShippingMethod = 'UpdateShippingMethod',
  3804. /** Grants permission to update StockLocation */
  3805. UpdateStockLocation = 'UpdateStockLocation',
  3806. /** Grants permission to update System */
  3807. UpdateSystem = 'UpdateSystem',
  3808. /** Grants permission to update Tag */
  3809. UpdateTag = 'UpdateTag',
  3810. /** Grants permission to update TaxCategory */
  3811. UpdateTaxCategory = 'UpdateTaxCategory',
  3812. /** Grants permission to update TaxRate */
  3813. UpdateTaxRate = 'UpdateTaxRate',
  3814. /** Grants permission to update Zone */
  3815. UpdateZone = 'UpdateZone'
  3816. }
  3817. export type PermissionDefinition = {
  3818. __typename?: 'PermissionDefinition';
  3819. assignable: Scalars['Boolean'];
  3820. description: Scalars['String'];
  3821. name: Scalars['String'];
  3822. };
  3823. export type PreviewCollectionVariantsInput = {
  3824. filters: Array<ConfigurableOperationInput>;
  3825. inheritFilters: Scalars['Boolean'];
  3826. parentId?: InputMaybe<Scalars['ID']>;
  3827. };
  3828. /** The price range where the result has more than one price */
  3829. export type PriceRange = {
  3830. __typename?: 'PriceRange';
  3831. max: Scalars['Money'];
  3832. min: Scalars['Money'];
  3833. };
  3834. export type Product = Node & {
  3835. __typename?: 'Product';
  3836. assets: Array<Asset>;
  3837. channels: Array<Channel>;
  3838. collections: Array<Collection>;
  3839. createdAt: Scalars['DateTime'];
  3840. customFields?: Maybe<Scalars['JSON']>;
  3841. description: Scalars['String'];
  3842. enabled: Scalars['Boolean'];
  3843. facetValues: Array<FacetValue>;
  3844. featuredAsset?: Maybe<Asset>;
  3845. id: Scalars['ID'];
  3846. languageCode: LanguageCode;
  3847. name: Scalars['String'];
  3848. optionGroups: Array<ProductOptionGroup>;
  3849. slug: Scalars['String'];
  3850. translations: Array<ProductTranslation>;
  3851. updatedAt: Scalars['DateTime'];
  3852. /** Returns a paginated, sortable, filterable list of ProductVariants */
  3853. variantList: ProductVariantList;
  3854. /** Returns all ProductVariants */
  3855. variants: Array<ProductVariant>;
  3856. };
  3857. export type ProductVariantListArgs = {
  3858. options?: InputMaybe<ProductVariantListOptions>;
  3859. };
  3860. export type ProductFilterParameter = {
  3861. createdAt?: InputMaybe<DateOperators>;
  3862. description?: InputMaybe<StringOperators>;
  3863. enabled?: InputMaybe<BooleanOperators>;
  3864. facetValueId?: InputMaybe<IdOperators>;
  3865. id?: InputMaybe<IdOperators>;
  3866. languageCode?: InputMaybe<StringOperators>;
  3867. name?: InputMaybe<StringOperators>;
  3868. slug?: InputMaybe<StringOperators>;
  3869. updatedAt?: InputMaybe<DateOperators>;
  3870. };
  3871. export type ProductList = PaginatedList & {
  3872. __typename?: 'ProductList';
  3873. items: Array<Product>;
  3874. totalItems: Scalars['Int'];
  3875. };
  3876. export type ProductListOptions = {
  3877. /** Allows the results to be filtered */
  3878. filter?: InputMaybe<ProductFilterParameter>;
  3879. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  3880. filterOperator?: InputMaybe<LogicalOperator>;
  3881. /** Skips the first n results, for use in pagination */
  3882. skip?: InputMaybe<Scalars['Int']>;
  3883. /** Specifies which properties to sort the results by */
  3884. sort?: InputMaybe<ProductSortParameter>;
  3885. /** Takes n results, for use in pagination */
  3886. take?: InputMaybe<Scalars['Int']>;
  3887. };
  3888. export type ProductOption = Node & {
  3889. __typename?: 'ProductOption';
  3890. code: Scalars['String'];
  3891. createdAt: Scalars['DateTime'];
  3892. customFields?: Maybe<Scalars['JSON']>;
  3893. group: ProductOptionGroup;
  3894. groupId: Scalars['ID'];
  3895. id: Scalars['ID'];
  3896. languageCode: LanguageCode;
  3897. name: Scalars['String'];
  3898. translations: Array<ProductOptionTranslation>;
  3899. updatedAt: Scalars['DateTime'];
  3900. };
  3901. export type ProductOptionGroup = Node & {
  3902. __typename?: 'ProductOptionGroup';
  3903. code: Scalars['String'];
  3904. createdAt: Scalars['DateTime'];
  3905. customFields?: Maybe<Scalars['JSON']>;
  3906. id: Scalars['ID'];
  3907. languageCode: LanguageCode;
  3908. name: Scalars['String'];
  3909. options: Array<ProductOption>;
  3910. translations: Array<ProductOptionGroupTranslation>;
  3911. updatedAt: Scalars['DateTime'];
  3912. };
  3913. export type ProductOptionGroupTranslation = {
  3914. __typename?: 'ProductOptionGroupTranslation';
  3915. createdAt: Scalars['DateTime'];
  3916. id: Scalars['ID'];
  3917. languageCode: LanguageCode;
  3918. name: Scalars['String'];
  3919. updatedAt: Scalars['DateTime'];
  3920. };
  3921. export type ProductOptionGroupTranslationInput = {
  3922. customFields?: InputMaybe<Scalars['JSON']>;
  3923. id?: InputMaybe<Scalars['ID']>;
  3924. languageCode: LanguageCode;
  3925. name?: InputMaybe<Scalars['String']>;
  3926. };
  3927. export type ProductOptionInUseError = ErrorResult & {
  3928. __typename?: 'ProductOptionInUseError';
  3929. errorCode: ErrorCode;
  3930. message: Scalars['String'];
  3931. optionGroupCode: Scalars['String'];
  3932. productVariantCount: Scalars['Int'];
  3933. };
  3934. export type ProductOptionTranslation = {
  3935. __typename?: 'ProductOptionTranslation';
  3936. createdAt: Scalars['DateTime'];
  3937. id: Scalars['ID'];
  3938. languageCode: LanguageCode;
  3939. name: Scalars['String'];
  3940. updatedAt: Scalars['DateTime'];
  3941. };
  3942. export type ProductOptionTranslationInput = {
  3943. customFields?: InputMaybe<Scalars['JSON']>;
  3944. id?: InputMaybe<Scalars['ID']>;
  3945. languageCode: LanguageCode;
  3946. name?: InputMaybe<Scalars['String']>;
  3947. };
  3948. export type ProductSortParameter = {
  3949. createdAt?: InputMaybe<SortOrder>;
  3950. description?: InputMaybe<SortOrder>;
  3951. id?: InputMaybe<SortOrder>;
  3952. name?: InputMaybe<SortOrder>;
  3953. slug?: InputMaybe<SortOrder>;
  3954. updatedAt?: InputMaybe<SortOrder>;
  3955. };
  3956. export type ProductTranslation = {
  3957. __typename?: 'ProductTranslation';
  3958. createdAt: Scalars['DateTime'];
  3959. description: Scalars['String'];
  3960. id: Scalars['ID'];
  3961. languageCode: LanguageCode;
  3962. name: Scalars['String'];
  3963. slug: Scalars['String'];
  3964. updatedAt: Scalars['DateTime'];
  3965. };
  3966. export type ProductTranslationInput = {
  3967. customFields?: InputMaybe<Scalars['JSON']>;
  3968. description?: InputMaybe<Scalars['String']>;
  3969. id?: InputMaybe<Scalars['ID']>;
  3970. languageCode: LanguageCode;
  3971. name?: InputMaybe<Scalars['String']>;
  3972. slug?: InputMaybe<Scalars['String']>;
  3973. };
  3974. export type ProductVariant = Node & {
  3975. __typename?: 'ProductVariant';
  3976. assets: Array<Asset>;
  3977. channels: Array<Channel>;
  3978. createdAt: Scalars['DateTime'];
  3979. currencyCode: CurrencyCode;
  3980. customFields?: Maybe<Scalars['JSON']>;
  3981. enabled: Scalars['Boolean'];
  3982. facetValues: Array<FacetValue>;
  3983. featuredAsset?: Maybe<Asset>;
  3984. id: Scalars['ID'];
  3985. languageCode: LanguageCode;
  3986. name: Scalars['String'];
  3987. options: Array<ProductOption>;
  3988. outOfStockThreshold: Scalars['Int'];
  3989. price: Scalars['Money'];
  3990. priceWithTax: Scalars['Money'];
  3991. prices: Array<ProductVariantPrice>;
  3992. product: Product;
  3993. productId: Scalars['ID'];
  3994. sku: Scalars['String'];
  3995. /** @deprecated use stockLevels */
  3996. stockAllocated: Scalars['Int'];
  3997. stockLevel: Scalars['String'];
  3998. stockLevels: Array<StockLevel>;
  3999. stockMovements: StockMovementList;
  4000. /** @deprecated use stockLevels */
  4001. stockOnHand: Scalars['Int'];
  4002. taxCategory: TaxCategory;
  4003. taxRateApplied: TaxRate;
  4004. trackInventory: GlobalFlag;
  4005. translations: Array<ProductVariantTranslation>;
  4006. updatedAt: Scalars['DateTime'];
  4007. useGlobalOutOfStockThreshold: Scalars['Boolean'];
  4008. };
  4009. export type ProductVariantStockMovementsArgs = {
  4010. options?: InputMaybe<StockMovementListOptions>;
  4011. };
  4012. export type ProductVariantFilterParameter = {
  4013. createdAt?: InputMaybe<DateOperators>;
  4014. currencyCode?: InputMaybe<StringOperators>;
  4015. enabled?: InputMaybe<BooleanOperators>;
  4016. facetValueId?: InputMaybe<IdOperators>;
  4017. id?: InputMaybe<IdOperators>;
  4018. languageCode?: InputMaybe<StringOperators>;
  4019. name?: InputMaybe<StringOperators>;
  4020. outOfStockThreshold?: InputMaybe<NumberOperators>;
  4021. price?: InputMaybe<NumberOperators>;
  4022. priceWithTax?: InputMaybe<NumberOperators>;
  4023. productId?: InputMaybe<IdOperators>;
  4024. sku?: InputMaybe<StringOperators>;
  4025. stockAllocated?: InputMaybe<NumberOperators>;
  4026. stockLevel?: InputMaybe<StringOperators>;
  4027. stockOnHand?: InputMaybe<NumberOperators>;
  4028. trackInventory?: InputMaybe<StringOperators>;
  4029. updatedAt?: InputMaybe<DateOperators>;
  4030. useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
  4031. };
  4032. export type ProductVariantList = PaginatedList & {
  4033. __typename?: 'ProductVariantList';
  4034. items: Array<ProductVariant>;
  4035. totalItems: Scalars['Int'];
  4036. };
  4037. export type ProductVariantListOptions = {
  4038. /** Allows the results to be filtered */
  4039. filter?: InputMaybe<ProductVariantFilterParameter>;
  4040. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4041. filterOperator?: InputMaybe<LogicalOperator>;
  4042. /** Skips the first n results, for use in pagination */
  4043. skip?: InputMaybe<Scalars['Int']>;
  4044. /** Specifies which properties to sort the results by */
  4045. sort?: InputMaybe<ProductVariantSortParameter>;
  4046. /** Takes n results, for use in pagination */
  4047. take?: InputMaybe<Scalars['Int']>;
  4048. };
  4049. export type ProductVariantPrice = {
  4050. __typename?: 'ProductVariantPrice';
  4051. currencyCode: CurrencyCode;
  4052. price: Scalars['Int'];
  4053. };
  4054. /**
  4055. * Used to set up update the price of a ProductVariant in a particular Channel.
  4056. * If the `delete` flag is `true`, the price will be deleted for the given Channel.
  4057. */
  4058. export type ProductVariantPriceInput = {
  4059. currencyCode: CurrencyCode;
  4060. delete?: InputMaybe<Scalars['Boolean']>;
  4061. price: Scalars['Money'];
  4062. };
  4063. export type ProductVariantSortParameter = {
  4064. createdAt?: InputMaybe<SortOrder>;
  4065. id?: InputMaybe<SortOrder>;
  4066. name?: InputMaybe<SortOrder>;
  4067. outOfStockThreshold?: InputMaybe<SortOrder>;
  4068. price?: InputMaybe<SortOrder>;
  4069. priceWithTax?: InputMaybe<SortOrder>;
  4070. productId?: InputMaybe<SortOrder>;
  4071. sku?: InputMaybe<SortOrder>;
  4072. stockAllocated?: InputMaybe<SortOrder>;
  4073. stockLevel?: InputMaybe<SortOrder>;
  4074. stockOnHand?: InputMaybe<SortOrder>;
  4075. updatedAt?: InputMaybe<SortOrder>;
  4076. };
  4077. export type ProductVariantTranslation = {
  4078. __typename?: 'ProductVariantTranslation';
  4079. createdAt: Scalars['DateTime'];
  4080. id: Scalars['ID'];
  4081. languageCode: LanguageCode;
  4082. name: Scalars['String'];
  4083. updatedAt: Scalars['DateTime'];
  4084. };
  4085. export type ProductVariantTranslationInput = {
  4086. customFields?: InputMaybe<Scalars['JSON']>;
  4087. id?: InputMaybe<Scalars['ID']>;
  4088. languageCode: LanguageCode;
  4089. name?: InputMaybe<Scalars['String']>;
  4090. };
  4091. export type Promotion = Node & {
  4092. __typename?: 'Promotion';
  4093. actions: Array<ConfigurableOperation>;
  4094. conditions: Array<ConfigurableOperation>;
  4095. couponCode?: Maybe<Scalars['String']>;
  4096. createdAt: Scalars['DateTime'];
  4097. customFields?: Maybe<Scalars['JSON']>;
  4098. description: Scalars['String'];
  4099. enabled: Scalars['Boolean'];
  4100. endsAt?: Maybe<Scalars['DateTime']>;
  4101. id: Scalars['ID'];
  4102. name: Scalars['String'];
  4103. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  4104. startsAt?: Maybe<Scalars['DateTime']>;
  4105. translations: Array<PromotionTranslation>;
  4106. updatedAt: Scalars['DateTime'];
  4107. };
  4108. export type PromotionFilterParameter = {
  4109. couponCode?: InputMaybe<StringOperators>;
  4110. createdAt?: InputMaybe<DateOperators>;
  4111. description?: InputMaybe<StringOperators>;
  4112. enabled?: InputMaybe<BooleanOperators>;
  4113. endsAt?: InputMaybe<DateOperators>;
  4114. id?: InputMaybe<IdOperators>;
  4115. name?: InputMaybe<StringOperators>;
  4116. perCustomerUsageLimit?: InputMaybe<NumberOperators>;
  4117. startsAt?: InputMaybe<DateOperators>;
  4118. updatedAt?: InputMaybe<DateOperators>;
  4119. };
  4120. export type PromotionList = PaginatedList & {
  4121. __typename?: 'PromotionList';
  4122. items: Array<Promotion>;
  4123. totalItems: Scalars['Int'];
  4124. };
  4125. export type PromotionListOptions = {
  4126. /** Allows the results to be filtered */
  4127. filter?: InputMaybe<PromotionFilterParameter>;
  4128. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4129. filterOperator?: InputMaybe<LogicalOperator>;
  4130. /** Skips the first n results, for use in pagination */
  4131. skip?: InputMaybe<Scalars['Int']>;
  4132. /** Specifies which properties to sort the results by */
  4133. sort?: InputMaybe<PromotionSortParameter>;
  4134. /** Takes n results, for use in pagination */
  4135. take?: InputMaybe<Scalars['Int']>;
  4136. };
  4137. export type PromotionSortParameter = {
  4138. couponCode?: InputMaybe<SortOrder>;
  4139. createdAt?: InputMaybe<SortOrder>;
  4140. description?: InputMaybe<SortOrder>;
  4141. endsAt?: InputMaybe<SortOrder>;
  4142. id?: InputMaybe<SortOrder>;
  4143. name?: InputMaybe<SortOrder>;
  4144. perCustomerUsageLimit?: InputMaybe<SortOrder>;
  4145. startsAt?: InputMaybe<SortOrder>;
  4146. updatedAt?: InputMaybe<SortOrder>;
  4147. };
  4148. export type PromotionTranslation = {
  4149. __typename?: 'PromotionTranslation';
  4150. createdAt: Scalars['DateTime'];
  4151. description: Scalars['String'];
  4152. id: Scalars['ID'];
  4153. languageCode: LanguageCode;
  4154. name: Scalars['String'];
  4155. updatedAt: Scalars['DateTime'];
  4156. };
  4157. export type PromotionTranslationInput = {
  4158. customFields?: InputMaybe<Scalars['JSON']>;
  4159. description?: InputMaybe<Scalars['String']>;
  4160. id?: InputMaybe<Scalars['ID']>;
  4161. languageCode: LanguageCode;
  4162. name?: InputMaybe<Scalars['String']>;
  4163. };
  4164. export type Province = Node & Region & {
  4165. __typename?: 'Province';
  4166. code: Scalars['String'];
  4167. createdAt: Scalars['DateTime'];
  4168. customFields?: Maybe<Scalars['JSON']>;
  4169. enabled: Scalars['Boolean'];
  4170. id: Scalars['ID'];
  4171. languageCode: LanguageCode;
  4172. name: Scalars['String'];
  4173. parent?: Maybe<Region>;
  4174. parentId?: Maybe<Scalars['ID']>;
  4175. translations: Array<RegionTranslation>;
  4176. type: Scalars['String'];
  4177. updatedAt: Scalars['DateTime'];
  4178. };
  4179. export type ProvinceFilterParameter = {
  4180. code?: InputMaybe<StringOperators>;
  4181. createdAt?: InputMaybe<DateOperators>;
  4182. enabled?: InputMaybe<BooleanOperators>;
  4183. id?: InputMaybe<IdOperators>;
  4184. languageCode?: InputMaybe<StringOperators>;
  4185. name?: InputMaybe<StringOperators>;
  4186. parentId?: InputMaybe<IdOperators>;
  4187. type?: InputMaybe<StringOperators>;
  4188. updatedAt?: InputMaybe<DateOperators>;
  4189. };
  4190. export type ProvinceList = PaginatedList & {
  4191. __typename?: 'ProvinceList';
  4192. items: Array<Province>;
  4193. totalItems: Scalars['Int'];
  4194. };
  4195. export type ProvinceListOptions = {
  4196. /** Allows the results to be filtered */
  4197. filter?: InputMaybe<ProvinceFilterParameter>;
  4198. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4199. filterOperator?: InputMaybe<LogicalOperator>;
  4200. /** Skips the first n results, for use in pagination */
  4201. skip?: InputMaybe<Scalars['Int']>;
  4202. /** Specifies which properties to sort the results by */
  4203. sort?: InputMaybe<ProvinceSortParameter>;
  4204. /** Takes n results, for use in pagination */
  4205. take?: InputMaybe<Scalars['Int']>;
  4206. };
  4207. export type ProvinceSortParameter = {
  4208. code?: InputMaybe<SortOrder>;
  4209. createdAt?: InputMaybe<SortOrder>;
  4210. id?: InputMaybe<SortOrder>;
  4211. name?: InputMaybe<SortOrder>;
  4212. parentId?: InputMaybe<SortOrder>;
  4213. type?: InputMaybe<SortOrder>;
  4214. updatedAt?: InputMaybe<SortOrder>;
  4215. };
  4216. export type ProvinceTranslationInput = {
  4217. customFields?: InputMaybe<Scalars['JSON']>;
  4218. id?: InputMaybe<Scalars['ID']>;
  4219. languageCode: LanguageCode;
  4220. name?: InputMaybe<Scalars['String']>;
  4221. };
  4222. /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
  4223. export type QuantityTooGreatError = ErrorResult & {
  4224. __typename?: 'QuantityTooGreatError';
  4225. errorCode: ErrorCode;
  4226. message: Scalars['String'];
  4227. };
  4228. export type Query = {
  4229. __typename?: 'Query';
  4230. activeAdministrator?: Maybe<Administrator>;
  4231. activeChannel: Channel;
  4232. administrator?: Maybe<Administrator>;
  4233. administrators: AdministratorList;
  4234. /** Get a single Asset by id */
  4235. asset?: Maybe<Asset>;
  4236. /** Get a list of Assets */
  4237. assets: AssetList;
  4238. channel?: Maybe<Channel>;
  4239. channels: ChannelList;
  4240. /** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
  4241. collection?: Maybe<Collection>;
  4242. collectionFilters: Array<ConfigurableOperationDefinition>;
  4243. collections: CollectionList;
  4244. countries: CountryList;
  4245. country?: Maybe<Country>;
  4246. customer?: Maybe<Customer>;
  4247. customerGroup?: Maybe<CustomerGroup>;
  4248. customerGroups: CustomerGroupList;
  4249. customers: CustomerList;
  4250. /** Returns a list of eligible shipping methods for the draft Order */
  4251. eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
  4252. facet?: Maybe<Facet>;
  4253. facetValues: FacetValueList;
  4254. facets: FacetList;
  4255. fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
  4256. globalSettings: GlobalSettings;
  4257. job?: Maybe<Job>;
  4258. jobBufferSize: Array<JobBufferSize>;
  4259. jobQueues: Array<JobQueue>;
  4260. jobs: JobList;
  4261. jobsById: Array<Job>;
  4262. me?: Maybe<CurrentUser>;
  4263. /** Get metrics for the given interval and metric types. */
  4264. metricSummary: Array<MetricSummary>;
  4265. order?: Maybe<Order>;
  4266. orders: OrderList;
  4267. paymentMethod?: Maybe<PaymentMethod>;
  4268. paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4269. paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
  4270. paymentMethods: PaymentMethodList;
  4271. pendingSearchIndexUpdates: Scalars['Int'];
  4272. /** Used for real-time previews of the contents of a Collection */
  4273. previewCollectionVariants: ProductVariantList;
  4274. /** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
  4275. product?: Maybe<Product>;
  4276. productOptionGroup?: Maybe<ProductOptionGroup>;
  4277. productOptionGroups: Array<ProductOptionGroup>;
  4278. /** Get a ProductVariant by id */
  4279. productVariant?: Maybe<ProductVariant>;
  4280. /** List ProductVariants either all or for the specific product. */
  4281. productVariants: ProductVariantList;
  4282. /** List Products */
  4283. products: ProductList;
  4284. promotion?: Maybe<Promotion>;
  4285. promotionActions: Array<ConfigurableOperationDefinition>;
  4286. promotionConditions: Array<ConfigurableOperationDefinition>;
  4287. promotions: PromotionList;
  4288. province?: Maybe<Province>;
  4289. provinces: ProvinceList;
  4290. role?: Maybe<Role>;
  4291. roles: RoleList;
  4292. search: SearchResponse;
  4293. seller?: Maybe<Seller>;
  4294. sellers: SellerList;
  4295. shippingCalculators: Array<ConfigurableOperationDefinition>;
  4296. shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4297. shippingMethod?: Maybe<ShippingMethod>;
  4298. shippingMethods: ShippingMethodList;
  4299. stockLocation?: Maybe<StockLocation>;
  4300. stockLocations: StockLocationList;
  4301. tag: Tag;
  4302. tags: TagList;
  4303. taxCategories: TaxCategoryList;
  4304. taxCategory?: Maybe<TaxCategory>;
  4305. taxRate?: Maybe<TaxRate>;
  4306. taxRates: TaxRateList;
  4307. testEligibleShippingMethods: Array<ShippingMethodQuote>;
  4308. testShippingMethod: TestShippingMethodResult;
  4309. zone?: Maybe<Zone>;
  4310. zones: ZoneList;
  4311. };
  4312. export type QueryAdministratorArgs = {
  4313. id: Scalars['ID'];
  4314. };
  4315. export type QueryAdministratorsArgs = {
  4316. options?: InputMaybe<AdministratorListOptions>;
  4317. };
  4318. export type QueryAssetArgs = {
  4319. id: Scalars['ID'];
  4320. };
  4321. export type QueryAssetsArgs = {
  4322. options?: InputMaybe<AssetListOptions>;
  4323. };
  4324. export type QueryChannelArgs = {
  4325. id: Scalars['ID'];
  4326. };
  4327. export type QueryChannelsArgs = {
  4328. options?: InputMaybe<ChannelListOptions>;
  4329. };
  4330. export type QueryCollectionArgs = {
  4331. id?: InputMaybe<Scalars['ID']>;
  4332. slug?: InputMaybe<Scalars['String']>;
  4333. };
  4334. export type QueryCollectionsArgs = {
  4335. options?: InputMaybe<CollectionListOptions>;
  4336. };
  4337. export type QueryCountriesArgs = {
  4338. options?: InputMaybe<CountryListOptions>;
  4339. };
  4340. export type QueryCountryArgs = {
  4341. id: Scalars['ID'];
  4342. };
  4343. export type QueryCustomerArgs = {
  4344. id: Scalars['ID'];
  4345. };
  4346. export type QueryCustomerGroupArgs = {
  4347. id: Scalars['ID'];
  4348. };
  4349. export type QueryCustomerGroupsArgs = {
  4350. options?: InputMaybe<CustomerGroupListOptions>;
  4351. };
  4352. export type QueryCustomersArgs = {
  4353. options?: InputMaybe<CustomerListOptions>;
  4354. };
  4355. export type QueryEligibleShippingMethodsForDraftOrderArgs = {
  4356. orderId: Scalars['ID'];
  4357. };
  4358. export type QueryFacetArgs = {
  4359. id: Scalars['ID'];
  4360. };
  4361. export type QueryFacetValuesArgs = {
  4362. options?: InputMaybe<FacetValueListOptions>;
  4363. };
  4364. export type QueryFacetsArgs = {
  4365. options?: InputMaybe<FacetListOptions>;
  4366. };
  4367. export type QueryJobArgs = {
  4368. jobId: Scalars['ID'];
  4369. };
  4370. export type QueryJobBufferSizeArgs = {
  4371. bufferIds?: InputMaybe<Array<Scalars['String']>>;
  4372. };
  4373. export type QueryJobsArgs = {
  4374. options?: InputMaybe<JobListOptions>;
  4375. };
  4376. export type QueryJobsByIdArgs = {
  4377. jobIds: Array<Scalars['ID']>;
  4378. };
  4379. export type QueryMetricSummaryArgs = {
  4380. input?: InputMaybe<MetricSummaryInput>;
  4381. };
  4382. export type QueryOrderArgs = {
  4383. id: Scalars['ID'];
  4384. };
  4385. export type QueryOrdersArgs = {
  4386. options?: InputMaybe<OrderListOptions>;
  4387. };
  4388. export type QueryPaymentMethodArgs = {
  4389. id: Scalars['ID'];
  4390. };
  4391. export type QueryPaymentMethodsArgs = {
  4392. options?: InputMaybe<PaymentMethodListOptions>;
  4393. };
  4394. export type QueryPreviewCollectionVariantsArgs = {
  4395. input: PreviewCollectionVariantsInput;
  4396. options?: InputMaybe<ProductVariantListOptions>;
  4397. };
  4398. export type QueryProductArgs = {
  4399. id?: InputMaybe<Scalars['ID']>;
  4400. slug?: InputMaybe<Scalars['String']>;
  4401. };
  4402. export type QueryProductOptionGroupArgs = {
  4403. id: Scalars['ID'];
  4404. };
  4405. export type QueryProductOptionGroupsArgs = {
  4406. filterTerm?: InputMaybe<Scalars['String']>;
  4407. };
  4408. export type QueryProductVariantArgs = {
  4409. id: Scalars['ID'];
  4410. };
  4411. export type QueryProductVariantsArgs = {
  4412. options?: InputMaybe<ProductVariantListOptions>;
  4413. productId?: InputMaybe<Scalars['ID']>;
  4414. };
  4415. export type QueryProductsArgs = {
  4416. options?: InputMaybe<ProductListOptions>;
  4417. };
  4418. export type QueryPromotionArgs = {
  4419. id: Scalars['ID'];
  4420. };
  4421. export type QueryPromotionsArgs = {
  4422. options?: InputMaybe<PromotionListOptions>;
  4423. };
  4424. export type QueryProvinceArgs = {
  4425. id: Scalars['ID'];
  4426. };
  4427. export type QueryProvincesArgs = {
  4428. options?: InputMaybe<ProvinceListOptions>;
  4429. };
  4430. export type QueryRoleArgs = {
  4431. id: Scalars['ID'];
  4432. };
  4433. export type QueryRolesArgs = {
  4434. options?: InputMaybe<RoleListOptions>;
  4435. };
  4436. export type QuerySearchArgs = {
  4437. input: SearchInput;
  4438. };
  4439. export type QuerySellerArgs = {
  4440. id: Scalars['ID'];
  4441. };
  4442. export type QuerySellersArgs = {
  4443. options?: InputMaybe<SellerListOptions>;
  4444. };
  4445. export type QueryShippingMethodArgs = {
  4446. id: Scalars['ID'];
  4447. };
  4448. export type QueryShippingMethodsArgs = {
  4449. options?: InputMaybe<ShippingMethodListOptions>;
  4450. };
  4451. export type QueryStockLocationArgs = {
  4452. id: Scalars['ID'];
  4453. };
  4454. export type QueryStockLocationsArgs = {
  4455. options?: InputMaybe<StockLocationListOptions>;
  4456. };
  4457. export type QueryTagArgs = {
  4458. id: Scalars['ID'];
  4459. };
  4460. export type QueryTagsArgs = {
  4461. options?: InputMaybe<TagListOptions>;
  4462. };
  4463. export type QueryTaxCategoriesArgs = {
  4464. options?: InputMaybe<TaxCategoryListOptions>;
  4465. };
  4466. export type QueryTaxCategoryArgs = {
  4467. id: Scalars['ID'];
  4468. };
  4469. export type QueryTaxRateArgs = {
  4470. id: Scalars['ID'];
  4471. };
  4472. export type QueryTaxRatesArgs = {
  4473. options?: InputMaybe<TaxRateListOptions>;
  4474. };
  4475. export type QueryTestEligibleShippingMethodsArgs = {
  4476. input: TestEligibleShippingMethodsInput;
  4477. };
  4478. export type QueryTestShippingMethodArgs = {
  4479. input: TestShippingMethodInput;
  4480. };
  4481. export type QueryZoneArgs = {
  4482. id: Scalars['ID'];
  4483. };
  4484. export type QueryZonesArgs = {
  4485. options?: InputMaybe<ZoneListOptions>;
  4486. };
  4487. export type Refund = Node & {
  4488. __typename?: 'Refund';
  4489. adjustment: Scalars['Money'];
  4490. createdAt: Scalars['DateTime'];
  4491. id: Scalars['ID'];
  4492. items: Scalars['Money'];
  4493. lines: Array<RefundLine>;
  4494. metadata?: Maybe<Scalars['JSON']>;
  4495. method?: Maybe<Scalars['String']>;
  4496. paymentId: Scalars['ID'];
  4497. reason?: Maybe<Scalars['String']>;
  4498. shipping: Scalars['Money'];
  4499. state: Scalars['String'];
  4500. total: Scalars['Money'];
  4501. transactionId?: Maybe<Scalars['String']>;
  4502. updatedAt: Scalars['DateTime'];
  4503. };
  4504. export type RefundLine = {
  4505. __typename?: 'RefundLine';
  4506. orderLine: OrderLine;
  4507. orderLineId: Scalars['ID'];
  4508. quantity: Scalars['Int'];
  4509. refund: Refund;
  4510. refundId: Scalars['ID'];
  4511. };
  4512. export type RefundOrderInput = {
  4513. adjustment: Scalars['Money'];
  4514. lines: Array<OrderLineInput>;
  4515. paymentId: Scalars['ID'];
  4516. reason?: InputMaybe<Scalars['String']>;
  4517. shipping: Scalars['Money'];
  4518. };
  4519. export type RefundOrderResult = AlreadyRefundedError | MultipleOrderError | NothingToRefundError | OrderStateTransitionError | PaymentOrderMismatchError | QuantityTooGreatError | Refund | RefundOrderStateError | RefundStateTransitionError;
  4520. /** Returned if an attempting to refund an Order which is not in the expected state */
  4521. export type RefundOrderStateError = ErrorResult & {
  4522. __typename?: 'RefundOrderStateError';
  4523. errorCode: ErrorCode;
  4524. message: Scalars['String'];
  4525. orderState: Scalars['String'];
  4526. };
  4527. /**
  4528. * Returned when a call to modifyOrder fails to include a refundPaymentId even
  4529. * though the price has decreased as a result of the changes.
  4530. */
  4531. export type RefundPaymentIdMissingError = ErrorResult & {
  4532. __typename?: 'RefundPaymentIdMissingError';
  4533. errorCode: ErrorCode;
  4534. message: Scalars['String'];
  4535. };
  4536. /** Returned when there is an error in transitioning the Refund state */
  4537. export type RefundStateTransitionError = ErrorResult & {
  4538. __typename?: 'RefundStateTransitionError';
  4539. errorCode: ErrorCode;
  4540. fromState: Scalars['String'];
  4541. message: Scalars['String'];
  4542. toState: Scalars['String'];
  4543. transitionError: Scalars['String'];
  4544. };
  4545. export type Region = {
  4546. code: Scalars['String'];
  4547. createdAt: Scalars['DateTime'];
  4548. enabled: Scalars['Boolean'];
  4549. id: Scalars['ID'];
  4550. languageCode: LanguageCode;
  4551. name: Scalars['String'];
  4552. parent?: Maybe<Region>;
  4553. parentId?: Maybe<Scalars['ID']>;
  4554. translations: Array<RegionTranslation>;
  4555. type: Scalars['String'];
  4556. updatedAt: Scalars['DateTime'];
  4557. };
  4558. export type RegionTranslation = {
  4559. __typename?: 'RegionTranslation';
  4560. createdAt: Scalars['DateTime'];
  4561. id: Scalars['ID'];
  4562. languageCode: LanguageCode;
  4563. name: Scalars['String'];
  4564. updatedAt: Scalars['DateTime'];
  4565. };
  4566. export type RelationCustomFieldConfig = CustomField & {
  4567. __typename?: 'RelationCustomFieldConfig';
  4568. description?: Maybe<Array<LocalizedString>>;
  4569. entity: Scalars['String'];
  4570. internal?: Maybe<Scalars['Boolean']>;
  4571. label?: Maybe<Array<LocalizedString>>;
  4572. list: Scalars['Boolean'];
  4573. name: Scalars['String'];
  4574. nullable?: Maybe<Scalars['Boolean']>;
  4575. readonly?: Maybe<Scalars['Boolean']>;
  4576. scalarFields: Array<Scalars['String']>;
  4577. type: Scalars['String'];
  4578. ui?: Maybe<Scalars['JSON']>;
  4579. };
  4580. export type Release = Node & StockMovement & {
  4581. __typename?: 'Release';
  4582. createdAt: Scalars['DateTime'];
  4583. id: Scalars['ID'];
  4584. productVariant: ProductVariant;
  4585. quantity: Scalars['Int'];
  4586. type: StockMovementType;
  4587. updatedAt: Scalars['DateTime'];
  4588. };
  4589. export type RemoveCollectionsFromChannelInput = {
  4590. channelId: Scalars['ID'];
  4591. collectionIds: Array<Scalars['ID']>;
  4592. };
  4593. export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
  4594. export type RemoveFacetsFromChannelInput = {
  4595. channelId: Scalars['ID'];
  4596. facetIds: Array<Scalars['ID']>;
  4597. force?: InputMaybe<Scalars['Boolean']>;
  4598. };
  4599. export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
  4600. export type RemoveOrderItemsResult = Order | OrderModificationError;
  4601. export type RemovePaymentMethodsFromChannelInput = {
  4602. channelId: Scalars['ID'];
  4603. paymentMethodIds: Array<Scalars['ID']>;
  4604. };
  4605. export type RemoveProductVariantsFromChannelInput = {
  4606. channelId: Scalars['ID'];
  4607. productVariantIds: Array<Scalars['ID']>;
  4608. };
  4609. export type RemoveProductsFromChannelInput = {
  4610. channelId: Scalars['ID'];
  4611. productIds: Array<Scalars['ID']>;
  4612. };
  4613. export type RemovePromotionsFromChannelInput = {
  4614. channelId: Scalars['ID'];
  4615. promotionIds: Array<Scalars['ID']>;
  4616. };
  4617. export type RemoveShippingMethodsFromChannelInput = {
  4618. channelId: Scalars['ID'];
  4619. shippingMethodIds: Array<Scalars['ID']>;
  4620. };
  4621. export type RemoveStockLocationsFromChannelInput = {
  4622. channelId: Scalars['ID'];
  4623. stockLocationIds: Array<Scalars['ID']>;
  4624. };
  4625. export type Return = Node & StockMovement & {
  4626. __typename?: 'Return';
  4627. createdAt: Scalars['DateTime'];
  4628. id: Scalars['ID'];
  4629. productVariant: ProductVariant;
  4630. quantity: Scalars['Int'];
  4631. type: StockMovementType;
  4632. updatedAt: Scalars['DateTime'];
  4633. };
  4634. export type Role = Node & {
  4635. __typename?: 'Role';
  4636. channels: Array<Channel>;
  4637. code: Scalars['String'];
  4638. createdAt: Scalars['DateTime'];
  4639. description: Scalars['String'];
  4640. id: Scalars['ID'];
  4641. permissions: Array<Permission>;
  4642. updatedAt: Scalars['DateTime'];
  4643. };
  4644. export type RoleFilterParameter = {
  4645. code?: InputMaybe<StringOperators>;
  4646. createdAt?: InputMaybe<DateOperators>;
  4647. description?: InputMaybe<StringOperators>;
  4648. id?: InputMaybe<IdOperators>;
  4649. updatedAt?: InputMaybe<DateOperators>;
  4650. };
  4651. export type RoleList = PaginatedList & {
  4652. __typename?: 'RoleList';
  4653. items: Array<Role>;
  4654. totalItems: Scalars['Int'];
  4655. };
  4656. export type RoleListOptions = {
  4657. /** Allows the results to be filtered */
  4658. filter?: InputMaybe<RoleFilterParameter>;
  4659. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4660. filterOperator?: InputMaybe<LogicalOperator>;
  4661. /** Skips the first n results, for use in pagination */
  4662. skip?: InputMaybe<Scalars['Int']>;
  4663. /** Specifies which properties to sort the results by */
  4664. sort?: InputMaybe<RoleSortParameter>;
  4665. /** Takes n results, for use in pagination */
  4666. take?: InputMaybe<Scalars['Int']>;
  4667. };
  4668. export type RoleSortParameter = {
  4669. code?: InputMaybe<SortOrder>;
  4670. createdAt?: InputMaybe<SortOrder>;
  4671. description?: InputMaybe<SortOrder>;
  4672. id?: InputMaybe<SortOrder>;
  4673. updatedAt?: InputMaybe<SortOrder>;
  4674. };
  4675. export type Sale = Node & StockMovement & {
  4676. __typename?: 'Sale';
  4677. createdAt: Scalars['DateTime'];
  4678. id: Scalars['ID'];
  4679. productVariant: ProductVariant;
  4680. quantity: Scalars['Int'];
  4681. type: StockMovementType;
  4682. updatedAt: Scalars['DateTime'];
  4683. };
  4684. export type SearchInput = {
  4685. collectionId?: InputMaybe<Scalars['ID']>;
  4686. collectionSlug?: InputMaybe<Scalars['String']>;
  4687. facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
  4688. /** @deprecated Use `facetValueFilters` instead */
  4689. facetValueIds?: InputMaybe<Array<Scalars['ID']>>;
  4690. /** @deprecated Use `facetValueFilters` instead */
  4691. facetValueOperator?: InputMaybe<LogicalOperator>;
  4692. groupByProduct?: InputMaybe<Scalars['Boolean']>;
  4693. skip?: InputMaybe<Scalars['Int']>;
  4694. sort?: InputMaybe<SearchResultSortParameter>;
  4695. take?: InputMaybe<Scalars['Int']>;
  4696. term?: InputMaybe<Scalars['String']>;
  4697. };
  4698. export type SearchReindexResponse = {
  4699. __typename?: 'SearchReindexResponse';
  4700. success: Scalars['Boolean'];
  4701. };
  4702. export type SearchResponse = {
  4703. __typename?: 'SearchResponse';
  4704. collections: Array<CollectionResult>;
  4705. facetValues: Array<FacetValueResult>;
  4706. items: Array<SearchResult>;
  4707. totalItems: Scalars['Int'];
  4708. };
  4709. export type SearchResult = {
  4710. __typename?: 'SearchResult';
  4711. /** An array of ids of the Channels in which this result appears */
  4712. channelIds: Array<Scalars['ID']>;
  4713. /** An array of ids of the Collections in which this result appears */
  4714. collectionIds: Array<Scalars['ID']>;
  4715. currencyCode: CurrencyCode;
  4716. description: Scalars['String'];
  4717. enabled: Scalars['Boolean'];
  4718. facetIds: Array<Scalars['ID']>;
  4719. facetValueIds: Array<Scalars['ID']>;
  4720. price: SearchResultPrice;
  4721. priceWithTax: SearchResultPrice;
  4722. productAsset?: Maybe<SearchResultAsset>;
  4723. productId: Scalars['ID'];
  4724. productName: Scalars['String'];
  4725. productVariantAsset?: Maybe<SearchResultAsset>;
  4726. productVariantId: Scalars['ID'];
  4727. productVariantName: Scalars['String'];
  4728. /** A relevance score for the result. Differs between database implementations */
  4729. score: Scalars['Float'];
  4730. sku: Scalars['String'];
  4731. slug: Scalars['String'];
  4732. };
  4733. export type SearchResultAsset = {
  4734. __typename?: 'SearchResultAsset';
  4735. focalPoint?: Maybe<Coordinate>;
  4736. id: Scalars['ID'];
  4737. preview: Scalars['String'];
  4738. };
  4739. /** The price of a search result product, either as a range or as a single price */
  4740. export type SearchResultPrice = PriceRange | SinglePrice;
  4741. export type SearchResultSortParameter = {
  4742. name?: InputMaybe<SortOrder>;
  4743. price?: InputMaybe<SortOrder>;
  4744. };
  4745. export type Seller = Node & {
  4746. __typename?: 'Seller';
  4747. createdAt: Scalars['DateTime'];
  4748. customFields?: Maybe<Scalars['JSON']>;
  4749. id: Scalars['ID'];
  4750. name: Scalars['String'];
  4751. updatedAt: Scalars['DateTime'];
  4752. };
  4753. export type SellerFilterParameter = {
  4754. createdAt?: InputMaybe<DateOperators>;
  4755. id?: InputMaybe<IdOperators>;
  4756. name?: InputMaybe<StringOperators>;
  4757. updatedAt?: InputMaybe<DateOperators>;
  4758. };
  4759. export type SellerList = PaginatedList & {
  4760. __typename?: 'SellerList';
  4761. items: Array<Seller>;
  4762. totalItems: Scalars['Int'];
  4763. };
  4764. export type SellerListOptions = {
  4765. /** Allows the results to be filtered */
  4766. filter?: InputMaybe<SellerFilterParameter>;
  4767. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4768. filterOperator?: InputMaybe<LogicalOperator>;
  4769. /** Skips the first n results, for use in pagination */
  4770. skip?: InputMaybe<Scalars['Int']>;
  4771. /** Specifies which properties to sort the results by */
  4772. sort?: InputMaybe<SellerSortParameter>;
  4773. /** Takes n results, for use in pagination */
  4774. take?: InputMaybe<Scalars['Int']>;
  4775. };
  4776. export type SellerSortParameter = {
  4777. createdAt?: InputMaybe<SortOrder>;
  4778. id?: InputMaybe<SortOrder>;
  4779. name?: InputMaybe<SortOrder>;
  4780. updatedAt?: InputMaybe<SortOrder>;
  4781. };
  4782. export type ServerConfig = {
  4783. __typename?: 'ServerConfig';
  4784. customFieldConfig: CustomFields;
  4785. orderProcess: Array<OrderProcessState>;
  4786. permissions: Array<PermissionDefinition>;
  4787. permittedAssetTypes: Array<Scalars['String']>;
  4788. };
  4789. export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
  4790. export type SetOrderShippingMethodResult = IneligibleShippingMethodError | NoActiveOrderError | Order | OrderModificationError;
  4791. /** Returned if the Payment settlement fails */
  4792. export type SettlePaymentError = ErrorResult & {
  4793. __typename?: 'SettlePaymentError';
  4794. errorCode: ErrorCode;
  4795. message: Scalars['String'];
  4796. paymentErrorMessage: Scalars['String'];
  4797. };
  4798. export type SettlePaymentResult = OrderStateTransitionError | Payment | PaymentStateTransitionError | SettlePaymentError;
  4799. export type SettleRefundInput = {
  4800. id: Scalars['ID'];
  4801. transactionId: Scalars['String'];
  4802. };
  4803. export type SettleRefundResult = Refund | RefundStateTransitionError;
  4804. export type ShippingLine = {
  4805. __typename?: 'ShippingLine';
  4806. discountedPrice: Scalars['Money'];
  4807. discountedPriceWithTax: Scalars['Money'];
  4808. discounts: Array<Discount>;
  4809. id: Scalars['ID'];
  4810. price: Scalars['Money'];
  4811. priceWithTax: Scalars['Money'];
  4812. shippingMethod: ShippingMethod;
  4813. };
  4814. export type ShippingMethod = Node & {
  4815. __typename?: 'ShippingMethod';
  4816. calculator: ConfigurableOperation;
  4817. checker: ConfigurableOperation;
  4818. code: Scalars['String'];
  4819. createdAt: Scalars['DateTime'];
  4820. customFields?: Maybe<Scalars['JSON']>;
  4821. description: Scalars['String'];
  4822. fulfillmentHandlerCode: Scalars['String'];
  4823. id: Scalars['ID'];
  4824. languageCode: LanguageCode;
  4825. name: Scalars['String'];
  4826. translations: Array<ShippingMethodTranslation>;
  4827. updatedAt: Scalars['DateTime'];
  4828. };
  4829. export type ShippingMethodFilterParameter = {
  4830. code?: InputMaybe<StringOperators>;
  4831. createdAt?: InputMaybe<DateOperators>;
  4832. description?: InputMaybe<StringOperators>;
  4833. fulfillmentHandlerCode?: InputMaybe<StringOperators>;
  4834. id?: InputMaybe<IdOperators>;
  4835. languageCode?: InputMaybe<StringOperators>;
  4836. name?: InputMaybe<StringOperators>;
  4837. updatedAt?: InputMaybe<DateOperators>;
  4838. };
  4839. export type ShippingMethodList = PaginatedList & {
  4840. __typename?: 'ShippingMethodList';
  4841. items: Array<ShippingMethod>;
  4842. totalItems: Scalars['Int'];
  4843. };
  4844. export type ShippingMethodListOptions = {
  4845. /** Allows the results to be filtered */
  4846. filter?: InputMaybe<ShippingMethodFilterParameter>;
  4847. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4848. filterOperator?: InputMaybe<LogicalOperator>;
  4849. /** Skips the first n results, for use in pagination */
  4850. skip?: InputMaybe<Scalars['Int']>;
  4851. /** Specifies which properties to sort the results by */
  4852. sort?: InputMaybe<ShippingMethodSortParameter>;
  4853. /** Takes n results, for use in pagination */
  4854. take?: InputMaybe<Scalars['Int']>;
  4855. };
  4856. export type ShippingMethodQuote = {
  4857. __typename?: 'ShippingMethodQuote';
  4858. code: Scalars['String'];
  4859. customFields?: Maybe<Scalars['JSON']>;
  4860. description: Scalars['String'];
  4861. id: Scalars['ID'];
  4862. /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
  4863. metadata?: Maybe<Scalars['JSON']>;
  4864. name: Scalars['String'];
  4865. price: Scalars['Money'];
  4866. priceWithTax: Scalars['Money'];
  4867. };
  4868. export type ShippingMethodSortParameter = {
  4869. code?: InputMaybe<SortOrder>;
  4870. createdAt?: InputMaybe<SortOrder>;
  4871. description?: InputMaybe<SortOrder>;
  4872. fulfillmentHandlerCode?: InputMaybe<SortOrder>;
  4873. id?: InputMaybe<SortOrder>;
  4874. name?: InputMaybe<SortOrder>;
  4875. updatedAt?: InputMaybe<SortOrder>;
  4876. };
  4877. export type ShippingMethodTranslation = {
  4878. __typename?: 'ShippingMethodTranslation';
  4879. createdAt: Scalars['DateTime'];
  4880. description: Scalars['String'];
  4881. id: Scalars['ID'];
  4882. languageCode: LanguageCode;
  4883. name: Scalars['String'];
  4884. updatedAt: Scalars['DateTime'];
  4885. };
  4886. export type ShippingMethodTranslationInput = {
  4887. customFields?: InputMaybe<Scalars['JSON']>;
  4888. description?: InputMaybe<Scalars['String']>;
  4889. id?: InputMaybe<Scalars['ID']>;
  4890. languageCode: LanguageCode;
  4891. name?: InputMaybe<Scalars['String']>;
  4892. };
  4893. /** The price value where the result has a single price */
  4894. export type SinglePrice = {
  4895. __typename?: 'SinglePrice';
  4896. value: Scalars['Money'];
  4897. };
  4898. export enum SortOrder {
  4899. ASC = 'ASC',
  4900. DESC = 'DESC'
  4901. }
  4902. export type StockAdjustment = Node & StockMovement & {
  4903. __typename?: 'StockAdjustment';
  4904. createdAt: Scalars['DateTime'];
  4905. id: Scalars['ID'];
  4906. productVariant: ProductVariant;
  4907. quantity: Scalars['Int'];
  4908. type: StockMovementType;
  4909. updatedAt: Scalars['DateTime'];
  4910. };
  4911. export type StockLevel = Node & {
  4912. __typename?: 'StockLevel';
  4913. createdAt: Scalars['DateTime'];
  4914. id: Scalars['ID'];
  4915. stockAllocated: Scalars['Int'];
  4916. stockLocation: StockLocation;
  4917. stockLocationId: Scalars['ID'];
  4918. stockOnHand: Scalars['Int'];
  4919. updatedAt: Scalars['DateTime'];
  4920. };
  4921. export type StockLevelInput = {
  4922. stockLocationId: Scalars['ID'];
  4923. stockOnHand: Scalars['Int'];
  4924. };
  4925. export type StockLocation = Node & {
  4926. __typename?: 'StockLocation';
  4927. createdAt: Scalars['DateTime'];
  4928. customFields?: Maybe<Scalars['JSON']>;
  4929. description: Scalars['String'];
  4930. id: Scalars['ID'];
  4931. name: Scalars['String'];
  4932. updatedAt: Scalars['DateTime'];
  4933. };
  4934. export type StockLocationFilterParameter = {
  4935. createdAt?: InputMaybe<DateOperators>;
  4936. description?: InputMaybe<StringOperators>;
  4937. id?: InputMaybe<IdOperators>;
  4938. name?: InputMaybe<StringOperators>;
  4939. updatedAt?: InputMaybe<DateOperators>;
  4940. };
  4941. export type StockLocationList = PaginatedList & {
  4942. __typename?: 'StockLocationList';
  4943. items: Array<StockLocation>;
  4944. totalItems: Scalars['Int'];
  4945. };
  4946. export type StockLocationListOptions = {
  4947. /** Allows the results to be filtered */
  4948. filter?: InputMaybe<StockLocationFilterParameter>;
  4949. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  4950. filterOperator?: InputMaybe<LogicalOperator>;
  4951. /** Skips the first n results, for use in pagination */
  4952. skip?: InputMaybe<Scalars['Int']>;
  4953. /** Specifies which properties to sort the results by */
  4954. sort?: InputMaybe<StockLocationSortParameter>;
  4955. /** Takes n results, for use in pagination */
  4956. take?: InputMaybe<Scalars['Int']>;
  4957. };
  4958. export type StockLocationSortParameter = {
  4959. createdAt?: InputMaybe<SortOrder>;
  4960. description?: InputMaybe<SortOrder>;
  4961. id?: InputMaybe<SortOrder>;
  4962. name?: InputMaybe<SortOrder>;
  4963. updatedAt?: InputMaybe<SortOrder>;
  4964. };
  4965. export type StockMovement = {
  4966. createdAt: Scalars['DateTime'];
  4967. id: Scalars['ID'];
  4968. productVariant: ProductVariant;
  4969. quantity: Scalars['Int'];
  4970. type: StockMovementType;
  4971. updatedAt: Scalars['DateTime'];
  4972. };
  4973. export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
  4974. export type StockMovementList = {
  4975. __typename?: 'StockMovementList';
  4976. items: Array<StockMovementItem>;
  4977. totalItems: Scalars['Int'];
  4978. };
  4979. export type StockMovementListOptions = {
  4980. skip?: InputMaybe<Scalars['Int']>;
  4981. take?: InputMaybe<Scalars['Int']>;
  4982. type?: InputMaybe<StockMovementType>;
  4983. };
  4984. export enum StockMovementType {
  4985. ADJUSTMENT = 'ADJUSTMENT',
  4986. ALLOCATION = 'ALLOCATION',
  4987. CANCELLATION = 'CANCELLATION',
  4988. RELEASE = 'RELEASE',
  4989. RETURN = 'RETURN',
  4990. SALE = 'SALE'
  4991. }
  4992. export type StringCustomFieldConfig = CustomField & {
  4993. __typename?: 'StringCustomFieldConfig';
  4994. description?: Maybe<Array<LocalizedString>>;
  4995. internal?: Maybe<Scalars['Boolean']>;
  4996. label?: Maybe<Array<LocalizedString>>;
  4997. length?: Maybe<Scalars['Int']>;
  4998. list: Scalars['Boolean'];
  4999. name: Scalars['String'];
  5000. nullable?: Maybe<Scalars['Boolean']>;
  5001. options?: Maybe<Array<StringFieldOption>>;
  5002. pattern?: Maybe<Scalars['String']>;
  5003. readonly?: Maybe<Scalars['Boolean']>;
  5004. type: Scalars['String'];
  5005. ui?: Maybe<Scalars['JSON']>;
  5006. };
  5007. export type StringFieldOption = {
  5008. __typename?: 'StringFieldOption';
  5009. label?: Maybe<Array<LocalizedString>>;
  5010. value: Scalars['String'];
  5011. };
  5012. /** Operators for filtering on a list of String fields */
  5013. export type StringListOperators = {
  5014. inList: Scalars['String'];
  5015. };
  5016. /** Operators for filtering on a String field */
  5017. export type StringOperators = {
  5018. contains?: InputMaybe<Scalars['String']>;
  5019. eq?: InputMaybe<Scalars['String']>;
  5020. in?: InputMaybe<Array<Scalars['String']>>;
  5021. isNull?: InputMaybe<Scalars['Boolean']>;
  5022. notContains?: InputMaybe<Scalars['String']>;
  5023. notEq?: InputMaybe<Scalars['String']>;
  5024. notIn?: InputMaybe<Array<Scalars['String']>>;
  5025. regex?: InputMaybe<Scalars['String']>;
  5026. };
  5027. /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
  5028. export type Success = {
  5029. __typename?: 'Success';
  5030. success: Scalars['Boolean'];
  5031. };
  5032. export type Surcharge = Node & {
  5033. __typename?: 'Surcharge';
  5034. createdAt: Scalars['DateTime'];
  5035. description: Scalars['String'];
  5036. id: Scalars['ID'];
  5037. price: Scalars['Money'];
  5038. priceWithTax: Scalars['Money'];
  5039. sku?: Maybe<Scalars['String']>;
  5040. taxLines: Array<TaxLine>;
  5041. taxRate: Scalars['Float'];
  5042. updatedAt: Scalars['DateTime'];
  5043. };
  5044. export type SurchargeInput = {
  5045. description: Scalars['String'];
  5046. price: Scalars['Money'];
  5047. priceIncludesTax: Scalars['Boolean'];
  5048. sku?: InputMaybe<Scalars['String']>;
  5049. taxDescription?: InputMaybe<Scalars['String']>;
  5050. taxRate?: InputMaybe<Scalars['Float']>;
  5051. };
  5052. export type Tag = Node & {
  5053. __typename?: 'Tag';
  5054. createdAt: Scalars['DateTime'];
  5055. id: Scalars['ID'];
  5056. updatedAt: Scalars['DateTime'];
  5057. value: Scalars['String'];
  5058. };
  5059. export type TagFilterParameter = {
  5060. createdAt?: InputMaybe<DateOperators>;
  5061. id?: InputMaybe<IdOperators>;
  5062. updatedAt?: InputMaybe<DateOperators>;
  5063. value?: InputMaybe<StringOperators>;
  5064. };
  5065. export type TagList = PaginatedList & {
  5066. __typename?: 'TagList';
  5067. items: Array<Tag>;
  5068. totalItems: Scalars['Int'];
  5069. };
  5070. export type TagListOptions = {
  5071. /** Allows the results to be filtered */
  5072. filter?: InputMaybe<TagFilterParameter>;
  5073. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  5074. filterOperator?: InputMaybe<LogicalOperator>;
  5075. /** Skips the first n results, for use in pagination */
  5076. skip?: InputMaybe<Scalars['Int']>;
  5077. /** Specifies which properties to sort the results by */
  5078. sort?: InputMaybe<TagSortParameter>;
  5079. /** Takes n results, for use in pagination */
  5080. take?: InputMaybe<Scalars['Int']>;
  5081. };
  5082. export type TagSortParameter = {
  5083. createdAt?: InputMaybe<SortOrder>;
  5084. id?: InputMaybe<SortOrder>;
  5085. updatedAt?: InputMaybe<SortOrder>;
  5086. value?: InputMaybe<SortOrder>;
  5087. };
  5088. export type TaxCategory = Node & {
  5089. __typename?: 'TaxCategory';
  5090. createdAt: Scalars['DateTime'];
  5091. customFields?: Maybe<Scalars['JSON']>;
  5092. id: Scalars['ID'];
  5093. isDefault: Scalars['Boolean'];
  5094. name: Scalars['String'];
  5095. updatedAt: Scalars['DateTime'];
  5096. };
  5097. export type TaxCategoryFilterParameter = {
  5098. createdAt?: InputMaybe<DateOperators>;
  5099. id?: InputMaybe<IdOperators>;
  5100. isDefault?: InputMaybe<BooleanOperators>;
  5101. name?: InputMaybe<StringOperators>;
  5102. updatedAt?: InputMaybe<DateOperators>;
  5103. };
  5104. export type TaxCategoryList = PaginatedList & {
  5105. __typename?: 'TaxCategoryList';
  5106. items: Array<TaxCategory>;
  5107. totalItems: Scalars['Int'];
  5108. };
  5109. export type TaxCategoryListOptions = {
  5110. /** Allows the results to be filtered */
  5111. filter?: InputMaybe<TaxCategoryFilterParameter>;
  5112. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  5113. filterOperator?: InputMaybe<LogicalOperator>;
  5114. /** Skips the first n results, for use in pagination */
  5115. skip?: InputMaybe<Scalars['Int']>;
  5116. /** Specifies which properties to sort the results by */
  5117. sort?: InputMaybe<TaxCategorySortParameter>;
  5118. /** Takes n results, for use in pagination */
  5119. take?: InputMaybe<Scalars['Int']>;
  5120. };
  5121. export type TaxCategorySortParameter = {
  5122. createdAt?: InputMaybe<SortOrder>;
  5123. id?: InputMaybe<SortOrder>;
  5124. name?: InputMaybe<SortOrder>;
  5125. updatedAt?: InputMaybe<SortOrder>;
  5126. };
  5127. export type TaxLine = {
  5128. __typename?: 'TaxLine';
  5129. description: Scalars['String'];
  5130. taxRate: Scalars['Float'];
  5131. };
  5132. export type TaxRate = Node & {
  5133. __typename?: 'TaxRate';
  5134. category: TaxCategory;
  5135. createdAt: Scalars['DateTime'];
  5136. customFields?: Maybe<Scalars['JSON']>;
  5137. customerGroup?: Maybe<CustomerGroup>;
  5138. enabled: Scalars['Boolean'];
  5139. id: Scalars['ID'];
  5140. name: Scalars['String'];
  5141. updatedAt: Scalars['DateTime'];
  5142. value: Scalars['Float'];
  5143. zone: Zone;
  5144. };
  5145. export type TaxRateFilterParameter = {
  5146. createdAt?: InputMaybe<DateOperators>;
  5147. enabled?: InputMaybe<BooleanOperators>;
  5148. id?: InputMaybe<IdOperators>;
  5149. name?: InputMaybe<StringOperators>;
  5150. updatedAt?: InputMaybe<DateOperators>;
  5151. value?: InputMaybe<NumberOperators>;
  5152. };
  5153. export type TaxRateList = PaginatedList & {
  5154. __typename?: 'TaxRateList';
  5155. items: Array<TaxRate>;
  5156. totalItems: Scalars['Int'];
  5157. };
  5158. export type TaxRateListOptions = {
  5159. /** Allows the results to be filtered */
  5160. filter?: InputMaybe<TaxRateFilterParameter>;
  5161. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  5162. filterOperator?: InputMaybe<LogicalOperator>;
  5163. /** Skips the first n results, for use in pagination */
  5164. skip?: InputMaybe<Scalars['Int']>;
  5165. /** Specifies which properties to sort the results by */
  5166. sort?: InputMaybe<TaxRateSortParameter>;
  5167. /** Takes n results, for use in pagination */
  5168. take?: InputMaybe<Scalars['Int']>;
  5169. };
  5170. export type TaxRateSortParameter = {
  5171. createdAt?: InputMaybe<SortOrder>;
  5172. id?: InputMaybe<SortOrder>;
  5173. name?: InputMaybe<SortOrder>;
  5174. updatedAt?: InputMaybe<SortOrder>;
  5175. value?: InputMaybe<SortOrder>;
  5176. };
  5177. export type TestEligibleShippingMethodsInput = {
  5178. lines: Array<TestShippingMethodOrderLineInput>;
  5179. shippingAddress: CreateAddressInput;
  5180. };
  5181. export type TestShippingMethodInput = {
  5182. calculator: ConfigurableOperationInput;
  5183. checker: ConfigurableOperationInput;
  5184. lines: Array<TestShippingMethodOrderLineInput>;
  5185. shippingAddress: CreateAddressInput;
  5186. };
  5187. export type TestShippingMethodOrderLineInput = {
  5188. productVariantId: Scalars['ID'];
  5189. quantity: Scalars['Int'];
  5190. };
  5191. export type TestShippingMethodQuote = {
  5192. __typename?: 'TestShippingMethodQuote';
  5193. metadata?: Maybe<Scalars['JSON']>;
  5194. price: Scalars['Money'];
  5195. priceWithTax: Scalars['Money'];
  5196. };
  5197. export type TestShippingMethodResult = {
  5198. __typename?: 'TestShippingMethodResult';
  5199. eligible: Scalars['Boolean'];
  5200. quote?: Maybe<TestShippingMethodQuote>;
  5201. };
  5202. export type TextCustomFieldConfig = CustomField & {
  5203. __typename?: 'TextCustomFieldConfig';
  5204. description?: Maybe<Array<LocalizedString>>;
  5205. internal?: Maybe<Scalars['Boolean']>;
  5206. label?: Maybe<Array<LocalizedString>>;
  5207. list: Scalars['Boolean'];
  5208. name: Scalars['String'];
  5209. nullable?: Maybe<Scalars['Boolean']>;
  5210. readonly?: Maybe<Scalars['Boolean']>;
  5211. type: Scalars['String'];
  5212. ui?: Maybe<Scalars['JSON']>;
  5213. };
  5214. export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
  5215. export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
  5216. export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
  5217. export type UpdateActiveAdministratorInput = {
  5218. customFields?: InputMaybe<Scalars['JSON']>;
  5219. emailAddress?: InputMaybe<Scalars['String']>;
  5220. firstName?: InputMaybe<Scalars['String']>;
  5221. lastName?: InputMaybe<Scalars['String']>;
  5222. password?: InputMaybe<Scalars['String']>;
  5223. };
  5224. export type UpdateAddressInput = {
  5225. city?: InputMaybe<Scalars['String']>;
  5226. company?: InputMaybe<Scalars['String']>;
  5227. countryCode?: InputMaybe<Scalars['String']>;
  5228. customFields?: InputMaybe<Scalars['JSON']>;
  5229. defaultBillingAddress?: InputMaybe<Scalars['Boolean']>;
  5230. defaultShippingAddress?: InputMaybe<Scalars['Boolean']>;
  5231. fullName?: InputMaybe<Scalars['String']>;
  5232. id: Scalars['ID'];
  5233. phoneNumber?: InputMaybe<Scalars['String']>;
  5234. postalCode?: InputMaybe<Scalars['String']>;
  5235. province?: InputMaybe<Scalars['String']>;
  5236. streetLine1?: InputMaybe<Scalars['String']>;
  5237. streetLine2?: InputMaybe<Scalars['String']>;
  5238. };
  5239. export type UpdateAdministratorInput = {
  5240. customFields?: InputMaybe<Scalars['JSON']>;
  5241. emailAddress?: InputMaybe<Scalars['String']>;
  5242. firstName?: InputMaybe<Scalars['String']>;
  5243. id: Scalars['ID'];
  5244. lastName?: InputMaybe<Scalars['String']>;
  5245. password?: InputMaybe<Scalars['String']>;
  5246. roleIds?: InputMaybe<Array<Scalars['ID']>>;
  5247. };
  5248. export type UpdateAssetInput = {
  5249. customFields?: InputMaybe<Scalars['JSON']>;
  5250. focalPoint?: InputMaybe<CoordinateInput>;
  5251. id: Scalars['ID'];
  5252. name?: InputMaybe<Scalars['String']>;
  5253. tags?: InputMaybe<Array<Scalars['String']>>;
  5254. };
  5255. export type UpdateChannelInput = {
  5256. availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
  5257. availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
  5258. code?: InputMaybe<Scalars['String']>;
  5259. /** @deprecated Use defaultCurrencyCode instead */
  5260. currencyCode?: InputMaybe<CurrencyCode>;
  5261. customFields?: InputMaybe<Scalars['JSON']>;
  5262. defaultCurrencyCode?: InputMaybe<CurrencyCode>;
  5263. defaultLanguageCode?: InputMaybe<LanguageCode>;
  5264. defaultShippingZoneId?: InputMaybe<Scalars['ID']>;
  5265. defaultTaxZoneId?: InputMaybe<Scalars['ID']>;
  5266. id: Scalars['ID'];
  5267. outOfStockThreshold?: InputMaybe<Scalars['Int']>;
  5268. pricesIncludeTax?: InputMaybe<Scalars['Boolean']>;
  5269. sellerId?: InputMaybe<Scalars['ID']>;
  5270. token?: InputMaybe<Scalars['String']>;
  5271. trackInventory?: InputMaybe<Scalars['Boolean']>;
  5272. };
  5273. export type UpdateChannelResult = Channel | LanguageNotAvailableError;
  5274. export type UpdateCollectionInput = {
  5275. assetIds?: InputMaybe<Array<Scalars['ID']>>;
  5276. customFields?: InputMaybe<Scalars['JSON']>;
  5277. featuredAssetId?: InputMaybe<Scalars['ID']>;
  5278. filters?: InputMaybe<Array<ConfigurableOperationInput>>;
  5279. id: Scalars['ID'];
  5280. inheritFilters?: InputMaybe<Scalars['Boolean']>;
  5281. isPrivate?: InputMaybe<Scalars['Boolean']>;
  5282. parentId?: InputMaybe<Scalars['ID']>;
  5283. translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
  5284. };
  5285. export type UpdateCollectionTranslationInput = {
  5286. customFields?: InputMaybe<Scalars['JSON']>;
  5287. description?: InputMaybe<Scalars['String']>;
  5288. id?: InputMaybe<Scalars['ID']>;
  5289. languageCode: LanguageCode;
  5290. name?: InputMaybe<Scalars['String']>;
  5291. slug?: InputMaybe<Scalars['String']>;
  5292. };
  5293. export type UpdateCountryInput = {
  5294. code?: InputMaybe<Scalars['String']>;
  5295. customFields?: InputMaybe<Scalars['JSON']>;
  5296. enabled?: InputMaybe<Scalars['Boolean']>;
  5297. id: Scalars['ID'];
  5298. translations?: InputMaybe<Array<CountryTranslationInput>>;
  5299. };
  5300. export type UpdateCustomerGroupInput = {
  5301. customFields?: InputMaybe<Scalars['JSON']>;
  5302. id: Scalars['ID'];
  5303. name?: InputMaybe<Scalars['String']>;
  5304. };
  5305. export type UpdateCustomerInput = {
  5306. customFields?: InputMaybe<Scalars['JSON']>;
  5307. emailAddress?: InputMaybe<Scalars['String']>;
  5308. firstName?: InputMaybe<Scalars['String']>;
  5309. id: Scalars['ID'];
  5310. lastName?: InputMaybe<Scalars['String']>;
  5311. phoneNumber?: InputMaybe<Scalars['String']>;
  5312. title?: InputMaybe<Scalars['String']>;
  5313. };
  5314. export type UpdateCustomerNoteInput = {
  5315. note: Scalars['String'];
  5316. noteId: Scalars['ID'];
  5317. };
  5318. export type UpdateCustomerResult = Customer | EmailAddressConflictError;
  5319. export type UpdateFacetInput = {
  5320. code?: InputMaybe<Scalars['String']>;
  5321. customFields?: InputMaybe<Scalars['JSON']>;
  5322. id: Scalars['ID'];
  5323. isPrivate?: InputMaybe<Scalars['Boolean']>;
  5324. translations?: InputMaybe<Array<FacetTranslationInput>>;
  5325. };
  5326. export type UpdateFacetValueInput = {
  5327. code?: InputMaybe<Scalars['String']>;
  5328. customFields?: InputMaybe<Scalars['JSON']>;
  5329. id: Scalars['ID'];
  5330. translations?: InputMaybe<Array<FacetValueTranslationInput>>;
  5331. };
  5332. export type UpdateGlobalSettingsInput = {
  5333. availableLanguages?: InputMaybe<Array<LanguageCode>>;
  5334. customFields?: InputMaybe<Scalars['JSON']>;
  5335. outOfStockThreshold?: InputMaybe<Scalars['Int']>;
  5336. trackInventory?: InputMaybe<Scalars['Boolean']>;
  5337. };
  5338. export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
  5339. export type UpdateOrderAddressInput = {
  5340. city?: InputMaybe<Scalars['String']>;
  5341. company?: InputMaybe<Scalars['String']>;
  5342. countryCode?: InputMaybe<Scalars['String']>;
  5343. fullName?: InputMaybe<Scalars['String']>;
  5344. phoneNumber?: InputMaybe<Scalars['String']>;
  5345. postalCode?: InputMaybe<Scalars['String']>;
  5346. province?: InputMaybe<Scalars['String']>;
  5347. streetLine1?: InputMaybe<Scalars['String']>;
  5348. streetLine2?: InputMaybe<Scalars['String']>;
  5349. };
  5350. export type UpdateOrderInput = {
  5351. customFields?: InputMaybe<Scalars['JSON']>;
  5352. id: Scalars['ID'];
  5353. };
  5354. export type UpdateOrderItemsResult = InsufficientStockError | NegativeQuantityError | Order | OrderLimitError | OrderModificationError;
  5355. export type UpdateOrderNoteInput = {
  5356. isPublic?: InputMaybe<Scalars['Boolean']>;
  5357. note?: InputMaybe<Scalars['String']>;
  5358. noteId: Scalars['ID'];
  5359. };
  5360. export type UpdatePaymentMethodInput = {
  5361. checker?: InputMaybe<ConfigurableOperationInput>;
  5362. code?: InputMaybe<Scalars['String']>;
  5363. customFields?: InputMaybe<Scalars['JSON']>;
  5364. enabled?: InputMaybe<Scalars['Boolean']>;
  5365. handler?: InputMaybe<ConfigurableOperationInput>;
  5366. id: Scalars['ID'];
  5367. translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
  5368. };
  5369. export type UpdateProductInput = {
  5370. assetIds?: InputMaybe<Array<Scalars['ID']>>;
  5371. customFields?: InputMaybe<Scalars['JSON']>;
  5372. enabled?: InputMaybe<Scalars['Boolean']>;
  5373. facetValueIds?: InputMaybe<Array<Scalars['ID']>>;
  5374. featuredAssetId?: InputMaybe<Scalars['ID']>;
  5375. id: Scalars['ID'];
  5376. translations?: InputMaybe<Array<ProductTranslationInput>>;
  5377. };
  5378. export type UpdateProductOptionGroupInput = {
  5379. code?: InputMaybe<Scalars['String']>;
  5380. customFields?: InputMaybe<Scalars['JSON']>;
  5381. id: Scalars['ID'];
  5382. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5383. };
  5384. export type UpdateProductOptionInput = {
  5385. code?: InputMaybe<Scalars['String']>;
  5386. customFields?: InputMaybe<Scalars['JSON']>;
  5387. id: Scalars['ID'];
  5388. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5389. };
  5390. export type UpdateProductVariantInput = {
  5391. assetIds?: InputMaybe<Array<Scalars['ID']>>;
  5392. customFields?: InputMaybe<Scalars['JSON']>;
  5393. enabled?: InputMaybe<Scalars['Boolean']>;
  5394. facetValueIds?: InputMaybe<Array<Scalars['ID']>>;
  5395. featuredAssetId?: InputMaybe<Scalars['ID']>;
  5396. id: Scalars['ID'];
  5397. optionIds?: InputMaybe<Array<Scalars['ID']>>;
  5398. outOfStockThreshold?: InputMaybe<Scalars['Int']>;
  5399. /** Sets the price for the ProductVariant in the Channel's default currency */
  5400. price?: InputMaybe<Scalars['Money']>;
  5401. /** Allows multiple prices to be set for the ProductVariant in different currencies. */
  5402. prices?: InputMaybe<Array<ProductVariantPriceInput>>;
  5403. sku?: InputMaybe<Scalars['String']>;
  5404. stockLevels?: InputMaybe<Array<StockLevelInput>>;
  5405. stockOnHand?: InputMaybe<Scalars['Int']>;
  5406. taxCategoryId?: InputMaybe<Scalars['ID']>;
  5407. trackInventory?: InputMaybe<GlobalFlag>;
  5408. translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
  5409. useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']>;
  5410. };
  5411. export type UpdatePromotionInput = {
  5412. actions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5413. conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5414. couponCode?: InputMaybe<Scalars['String']>;
  5415. customFields?: InputMaybe<Scalars['JSON']>;
  5416. enabled?: InputMaybe<Scalars['Boolean']>;
  5417. endsAt?: InputMaybe<Scalars['DateTime']>;
  5418. id: Scalars['ID'];
  5419. perCustomerUsageLimit?: InputMaybe<Scalars['Int']>;
  5420. startsAt?: InputMaybe<Scalars['DateTime']>;
  5421. translations?: InputMaybe<Array<PromotionTranslationInput>>;
  5422. };
  5423. export type UpdatePromotionResult = MissingConditionsError | Promotion;
  5424. export type UpdateProvinceInput = {
  5425. code?: InputMaybe<Scalars['String']>;
  5426. customFields?: InputMaybe<Scalars['JSON']>;
  5427. enabled?: InputMaybe<Scalars['Boolean']>;
  5428. id: Scalars['ID'];
  5429. translations?: InputMaybe<Array<ProvinceTranslationInput>>;
  5430. };
  5431. export type UpdateRoleInput = {
  5432. channelIds?: InputMaybe<Array<Scalars['ID']>>;
  5433. code?: InputMaybe<Scalars['String']>;
  5434. description?: InputMaybe<Scalars['String']>;
  5435. id: Scalars['ID'];
  5436. permissions?: InputMaybe<Array<Permission>>;
  5437. };
  5438. export type UpdateSellerInput = {
  5439. customFields?: InputMaybe<Scalars['JSON']>;
  5440. id: Scalars['ID'];
  5441. name?: InputMaybe<Scalars['String']>;
  5442. };
  5443. export type UpdateShippingMethodInput = {
  5444. calculator?: InputMaybe<ConfigurableOperationInput>;
  5445. checker?: InputMaybe<ConfigurableOperationInput>;
  5446. code?: InputMaybe<Scalars['String']>;
  5447. customFields?: InputMaybe<Scalars['JSON']>;
  5448. fulfillmentHandler?: InputMaybe<Scalars['String']>;
  5449. id: Scalars['ID'];
  5450. translations: Array<ShippingMethodTranslationInput>;
  5451. };
  5452. export type UpdateStockLocationInput = {
  5453. customFields?: InputMaybe<Scalars['JSON']>;
  5454. description?: InputMaybe<Scalars['String']>;
  5455. id: Scalars['ID'];
  5456. name?: InputMaybe<Scalars['String']>;
  5457. };
  5458. export type UpdateTagInput = {
  5459. id: Scalars['ID'];
  5460. value?: InputMaybe<Scalars['String']>;
  5461. };
  5462. export type UpdateTaxCategoryInput = {
  5463. customFields?: InputMaybe<Scalars['JSON']>;
  5464. id: Scalars['ID'];
  5465. isDefault?: InputMaybe<Scalars['Boolean']>;
  5466. name?: InputMaybe<Scalars['String']>;
  5467. };
  5468. export type UpdateTaxRateInput = {
  5469. categoryId?: InputMaybe<Scalars['ID']>;
  5470. customFields?: InputMaybe<Scalars['JSON']>;
  5471. customerGroupId?: InputMaybe<Scalars['ID']>;
  5472. enabled?: InputMaybe<Scalars['Boolean']>;
  5473. id: Scalars['ID'];
  5474. name?: InputMaybe<Scalars['String']>;
  5475. value?: InputMaybe<Scalars['Float']>;
  5476. zoneId?: InputMaybe<Scalars['ID']>;
  5477. };
  5478. export type UpdateZoneInput = {
  5479. customFields?: InputMaybe<Scalars['JSON']>;
  5480. id: Scalars['ID'];
  5481. name?: InputMaybe<Scalars['String']>;
  5482. };
  5483. export type User = Node & {
  5484. __typename?: 'User';
  5485. authenticationMethods: Array<AuthenticationMethod>;
  5486. createdAt: Scalars['DateTime'];
  5487. customFields?: Maybe<Scalars['JSON']>;
  5488. id: Scalars['ID'];
  5489. identifier: Scalars['String'];
  5490. lastLogin?: Maybe<Scalars['DateTime']>;
  5491. roles: Array<Role>;
  5492. updatedAt: Scalars['DateTime'];
  5493. verified: Scalars['Boolean'];
  5494. };
  5495. export type Zone = Node & {
  5496. __typename?: 'Zone';
  5497. createdAt: Scalars['DateTime'];
  5498. customFields?: Maybe<Scalars['JSON']>;
  5499. id: Scalars['ID'];
  5500. members: Array<Region>;
  5501. name: Scalars['String'];
  5502. updatedAt: Scalars['DateTime'];
  5503. };
  5504. export type ZoneFilterParameter = {
  5505. createdAt?: InputMaybe<DateOperators>;
  5506. id?: InputMaybe<IdOperators>;
  5507. name?: InputMaybe<StringOperators>;
  5508. updatedAt?: InputMaybe<DateOperators>;
  5509. };
  5510. export type ZoneList = PaginatedList & {
  5511. __typename?: 'ZoneList';
  5512. items: Array<Zone>;
  5513. totalItems: Scalars['Int'];
  5514. };
  5515. export type ZoneListOptions = {
  5516. /** Allows the results to be filtered */
  5517. filter?: InputMaybe<ZoneFilterParameter>;
  5518. /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
  5519. filterOperator?: InputMaybe<LogicalOperator>;
  5520. /** Skips the first n results, for use in pagination */
  5521. skip?: InputMaybe<Scalars['Int']>;
  5522. /** Specifies which properties to sort the results by */
  5523. sort?: InputMaybe<ZoneSortParameter>;
  5524. /** Takes n results, for use in pagination */
  5525. take?: InputMaybe<Scalars['Int']>;
  5526. };
  5527. export type ZoneSortParameter = {
  5528. createdAt?: InputMaybe<SortOrder>;
  5529. id?: InputMaybe<SortOrder>;
  5530. name?: InputMaybe<SortOrder>;
  5531. updatedAt?: InputMaybe<SortOrder>;
  5532. };