generated-types.ts 158 KB

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