generated-types.ts 139 KB

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