generated-types.ts 166 KB

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