generated-types.ts 181 KB

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