generated-types.ts 131 KB

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