1
0

generated-types.ts 202 KB

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