generated-types.ts 166 KB

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