generated-types.ts 140 KB

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