generated-types.ts 145 KB

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