generated-types.ts 149 KB

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