generated-types.ts 194 KB

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