generated-types.ts 157 KB

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