generated-types.ts 132 KB

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