generated-types.ts 150 KB

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