generated-types.ts 178 KB

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