generated-types.ts 148 KB

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