generated-types.ts 210 KB

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