generated-types.ts 152 KB

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