generated-types.ts 189 KB

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