generated-types.ts 163 KB

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