generated-types.ts 132 KB

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