generated-types.ts 167 KB

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