generated-types.ts 170 KB

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