generated-types.ts 132 KB

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