generated-types.ts 153 KB

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