generated-types.ts 131 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975
  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. };
  1495. export type JobFilterParameter = {
  1496. createdAt?: Maybe<DateOperators>;
  1497. startedAt?: Maybe<DateOperators>;
  1498. settledAt?: Maybe<DateOperators>;
  1499. queueName?: Maybe<StringOperators>;
  1500. state?: Maybe<StringOperators>;
  1501. progress?: Maybe<NumberOperators>;
  1502. isSettled?: Maybe<BooleanOperators>;
  1503. duration?: Maybe<NumberOperators>;
  1504. };
  1505. export type JobList = PaginatedList & {
  1506. __typename?: 'JobList';
  1507. items: Array<Job>;
  1508. totalItems: Scalars['Int'];
  1509. };
  1510. export type JobListOptions = {
  1511. skip?: Maybe<Scalars['Int']>;
  1512. take?: Maybe<Scalars['Int']>;
  1513. sort?: Maybe<JobSortParameter>;
  1514. filter?: Maybe<JobFilterParameter>;
  1515. };
  1516. export type JobQueue = {
  1517. __typename?: 'JobQueue';
  1518. name: Scalars['String'];
  1519. running: Scalars['Boolean'];
  1520. };
  1521. export type JobSortParameter = {
  1522. id?: Maybe<SortOrder>;
  1523. createdAt?: Maybe<SortOrder>;
  1524. startedAt?: Maybe<SortOrder>;
  1525. settledAt?: Maybe<SortOrder>;
  1526. queueName?: Maybe<SortOrder>;
  1527. progress?: Maybe<SortOrder>;
  1528. duration?: Maybe<SortOrder>;
  1529. };
  1530. /**
  1531. * @description
  1532. * The state of a Job in the JobQueue
  1533. *
  1534. * @docsCategory common
  1535. */
  1536. export enum JobState {
  1537. PENDING = 'PENDING',
  1538. RUNNING = 'RUNNING',
  1539. COMPLETED = 'COMPLETED',
  1540. RETRYING = 'RETRYING',
  1541. FAILED = 'FAILED',
  1542. CANCELLED = 'CANCELLED'
  1543. }
  1544. /**
  1545. * @description
  1546. * Languages in the form of a ISO 639-1 language code with optional
  1547. * region or script modifier (e.g. de_AT). The selection available is based
  1548. * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  1549. * and includes the major spoken languages of the world and any widely-used variants.
  1550. *
  1551. * @docsCategory common
  1552. */
  1553. export enum LanguageCode {
  1554. /** Afrikaans */
  1555. af = 'af',
  1556. /** Akan */
  1557. ak = 'ak',
  1558. /** Albanian */
  1559. sq = 'sq',
  1560. /** Amharic */
  1561. am = 'am',
  1562. /** Arabic */
  1563. ar = 'ar',
  1564. /** Armenian */
  1565. hy = 'hy',
  1566. /** Assamese */
  1567. as = 'as',
  1568. /** Azerbaijani */
  1569. az = 'az',
  1570. /** Bambara */
  1571. bm = 'bm',
  1572. /** Bangla */
  1573. bn = 'bn',
  1574. /** Basque */
  1575. eu = 'eu',
  1576. /** Belarusian */
  1577. be = 'be',
  1578. /** Bosnian */
  1579. bs = 'bs',
  1580. /** Breton */
  1581. br = 'br',
  1582. /** Bulgarian */
  1583. bg = 'bg',
  1584. /** Burmese */
  1585. my = 'my',
  1586. /** Catalan */
  1587. ca = 'ca',
  1588. /** Chechen */
  1589. ce = 'ce',
  1590. /** Chinese */
  1591. zh = 'zh',
  1592. /** Simplified Chinese */
  1593. zh_Hans = 'zh_Hans',
  1594. /** Traditional Chinese */
  1595. zh_Hant = 'zh_Hant',
  1596. /** Church Slavic */
  1597. cu = 'cu',
  1598. /** Cornish */
  1599. kw = 'kw',
  1600. /** Corsican */
  1601. co = 'co',
  1602. /** Croatian */
  1603. hr = 'hr',
  1604. /** Czech */
  1605. cs = 'cs',
  1606. /** Danish */
  1607. da = 'da',
  1608. /** Dutch */
  1609. nl = 'nl',
  1610. /** Flemish */
  1611. nl_BE = 'nl_BE',
  1612. /** Dzongkha */
  1613. dz = 'dz',
  1614. /** English */
  1615. en = 'en',
  1616. /** Australian English */
  1617. en_AU = 'en_AU',
  1618. /** Canadian English */
  1619. en_CA = 'en_CA',
  1620. /** British English */
  1621. en_GB = 'en_GB',
  1622. /** American English */
  1623. en_US = 'en_US',
  1624. /** Esperanto */
  1625. eo = 'eo',
  1626. /** Estonian */
  1627. et = 'et',
  1628. /** Ewe */
  1629. ee = 'ee',
  1630. /** Faroese */
  1631. fo = 'fo',
  1632. /** Finnish */
  1633. fi = 'fi',
  1634. /** French */
  1635. fr = 'fr',
  1636. /** Canadian French */
  1637. fr_CA = 'fr_CA',
  1638. /** Swiss French */
  1639. fr_CH = 'fr_CH',
  1640. /** Fulah */
  1641. ff = 'ff',
  1642. /** Galician */
  1643. gl = 'gl',
  1644. /** Ganda */
  1645. lg = 'lg',
  1646. /** Georgian */
  1647. ka = 'ka',
  1648. /** German */
  1649. de = 'de',
  1650. /** Austrian German */
  1651. de_AT = 'de_AT',
  1652. /** Swiss High German */
  1653. de_CH = 'de_CH',
  1654. /** Greek */
  1655. el = 'el',
  1656. /** Gujarati */
  1657. gu = 'gu',
  1658. /** Haitian Creole */
  1659. ht = 'ht',
  1660. /** Hausa */
  1661. ha = 'ha',
  1662. /** Hebrew */
  1663. he = 'he',
  1664. /** Hindi */
  1665. hi = 'hi',
  1666. /** Hungarian */
  1667. hu = 'hu',
  1668. /** Icelandic */
  1669. is = 'is',
  1670. /** Igbo */
  1671. ig = 'ig',
  1672. /** Indonesian */
  1673. id = 'id',
  1674. /** Interlingua */
  1675. ia = 'ia',
  1676. /** Irish */
  1677. ga = 'ga',
  1678. /** Italian */
  1679. it = 'it',
  1680. /** Japanese */
  1681. ja = 'ja',
  1682. /** Javanese */
  1683. jv = 'jv',
  1684. /** Kalaallisut */
  1685. kl = 'kl',
  1686. /** Kannada */
  1687. kn = 'kn',
  1688. /** Kashmiri */
  1689. ks = 'ks',
  1690. /** Kazakh */
  1691. kk = 'kk',
  1692. /** Khmer */
  1693. km = 'km',
  1694. /** Kikuyu */
  1695. ki = 'ki',
  1696. /** Kinyarwanda */
  1697. rw = 'rw',
  1698. /** Korean */
  1699. ko = 'ko',
  1700. /** Kurdish */
  1701. ku = 'ku',
  1702. /** Kyrgyz */
  1703. ky = 'ky',
  1704. /** Lao */
  1705. lo = 'lo',
  1706. /** Latin */
  1707. la = 'la',
  1708. /** Latvian */
  1709. lv = 'lv',
  1710. /** Lingala */
  1711. ln = 'ln',
  1712. /** Lithuanian */
  1713. lt = 'lt',
  1714. /** Luba-Katanga */
  1715. lu = 'lu',
  1716. /** Luxembourgish */
  1717. lb = 'lb',
  1718. /** Macedonian */
  1719. mk = 'mk',
  1720. /** Malagasy */
  1721. mg = 'mg',
  1722. /** Malay */
  1723. ms = 'ms',
  1724. /** Malayalam */
  1725. ml = 'ml',
  1726. /** Maltese */
  1727. mt = 'mt',
  1728. /** Manx */
  1729. gv = 'gv',
  1730. /** Maori */
  1731. mi = 'mi',
  1732. /** Marathi */
  1733. mr = 'mr',
  1734. /** Mongolian */
  1735. mn = 'mn',
  1736. /** Nepali */
  1737. ne = 'ne',
  1738. /** North Ndebele */
  1739. nd = 'nd',
  1740. /** Northern Sami */
  1741. se = 'se',
  1742. /** Norwegian Bokmål */
  1743. nb = 'nb',
  1744. /** Norwegian Nynorsk */
  1745. nn = 'nn',
  1746. /** Nyanja */
  1747. ny = 'ny',
  1748. /** Odia */
  1749. or = 'or',
  1750. /** Oromo */
  1751. om = 'om',
  1752. /** Ossetic */
  1753. os = 'os',
  1754. /** Pashto */
  1755. ps = 'ps',
  1756. /** Persian */
  1757. fa = 'fa',
  1758. /** Dari */
  1759. fa_AF = 'fa_AF',
  1760. /** Polish */
  1761. pl = 'pl',
  1762. /** Portuguese */
  1763. pt = 'pt',
  1764. /** Brazilian Portuguese */
  1765. pt_BR = 'pt_BR',
  1766. /** European Portuguese */
  1767. pt_PT = 'pt_PT',
  1768. /** Punjabi */
  1769. pa = 'pa',
  1770. /** Quechua */
  1771. qu = 'qu',
  1772. /** Romanian */
  1773. ro = 'ro',
  1774. /** Moldavian */
  1775. ro_MD = 'ro_MD',
  1776. /** Romansh */
  1777. rm = 'rm',
  1778. /** Rundi */
  1779. rn = 'rn',
  1780. /** Russian */
  1781. ru = 'ru',
  1782. /** Samoan */
  1783. sm = 'sm',
  1784. /** Sango */
  1785. sg = 'sg',
  1786. /** Sanskrit */
  1787. sa = 'sa',
  1788. /** Scottish Gaelic */
  1789. gd = 'gd',
  1790. /** Serbian */
  1791. sr = 'sr',
  1792. /** Shona */
  1793. sn = 'sn',
  1794. /** Sichuan Yi */
  1795. ii = 'ii',
  1796. /** Sindhi */
  1797. sd = 'sd',
  1798. /** Sinhala */
  1799. si = 'si',
  1800. /** Slovak */
  1801. sk = 'sk',
  1802. /** Slovenian */
  1803. sl = 'sl',
  1804. /** Somali */
  1805. so = 'so',
  1806. /** Southern Sotho */
  1807. st = 'st',
  1808. /** Spanish */
  1809. es = 'es',
  1810. /** European Spanish */
  1811. es_ES = 'es_ES',
  1812. /** Mexican Spanish */
  1813. es_MX = 'es_MX',
  1814. /** Sundanese */
  1815. su = 'su',
  1816. /** Swahili */
  1817. sw = 'sw',
  1818. /** Congo Swahili */
  1819. sw_CD = 'sw_CD',
  1820. /** Swedish */
  1821. sv = 'sv',
  1822. /** Tajik */
  1823. tg = 'tg',
  1824. /** Tamil */
  1825. ta = 'ta',
  1826. /** Tatar */
  1827. tt = 'tt',
  1828. /** Telugu */
  1829. te = 'te',
  1830. /** Thai */
  1831. th = 'th',
  1832. /** Tibetan */
  1833. bo = 'bo',
  1834. /** Tigrinya */
  1835. ti = 'ti',
  1836. /** Tongan */
  1837. to = 'to',
  1838. /** Turkish */
  1839. tr = 'tr',
  1840. /** Turkmen */
  1841. tk = 'tk',
  1842. /** Ukrainian */
  1843. uk = 'uk',
  1844. /** Urdu */
  1845. ur = 'ur',
  1846. /** Uyghur */
  1847. ug = 'ug',
  1848. /** Uzbek */
  1849. uz = 'uz',
  1850. /** Vietnamese */
  1851. vi = 'vi',
  1852. /** Volapük */
  1853. vo = 'vo',
  1854. /** Welsh */
  1855. cy = 'cy',
  1856. /** Western Frisian */
  1857. fy = 'fy',
  1858. /** Wolof */
  1859. wo = 'wo',
  1860. /** Xhosa */
  1861. xh = 'xh',
  1862. /** Yiddish */
  1863. yi = 'yi',
  1864. /** Yoruba */
  1865. yo = 'yo',
  1866. /** Zulu */
  1867. zu = 'zu'
  1868. }
  1869. /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
  1870. export type LanguageNotAvailableError = ErrorResult & {
  1871. __typename?: 'LanguageNotAvailableError';
  1872. errorCode: ErrorCode;
  1873. message: Scalars['String'];
  1874. languageCode: Scalars['String'];
  1875. };
  1876. export type LocaleStringCustomFieldConfig = CustomField & {
  1877. __typename?: 'LocaleStringCustomFieldConfig';
  1878. name: Scalars['String'];
  1879. type: Scalars['String'];
  1880. list: Scalars['Boolean'];
  1881. length?: Maybe<Scalars['Int']>;
  1882. label?: Maybe<Array<LocalizedString>>;
  1883. description?: Maybe<Array<LocalizedString>>;
  1884. readonly?: Maybe<Scalars['Boolean']>;
  1885. internal?: Maybe<Scalars['Boolean']>;
  1886. pattern?: Maybe<Scalars['String']>;
  1887. };
  1888. export type LocalizedString = {
  1889. __typename?: 'LocalizedString';
  1890. languageCode: LanguageCode;
  1891. value: Scalars['String'];
  1892. };
  1893. export enum LogicalOperator {
  1894. AND = 'AND',
  1895. OR = 'OR'
  1896. }
  1897. export type ManualPaymentInput = {
  1898. orderId: Scalars['ID'];
  1899. method: Scalars['String'];
  1900. transactionId?: Maybe<Scalars['String']>;
  1901. metadata?: Maybe<Scalars['JSON']>;
  1902. };
  1903. /**
  1904. * Returned when a call to addManualPaymentToOrder is made but the Order
  1905. * is not in the required state.
  1906. */
  1907. export type ManualPaymentStateError = ErrorResult & {
  1908. __typename?: 'ManualPaymentStateError';
  1909. errorCode: ErrorCode;
  1910. message: Scalars['String'];
  1911. };
  1912. export type MimeTypeError = ErrorResult & {
  1913. __typename?: 'MimeTypeError';
  1914. errorCode: ErrorCode;
  1915. message: Scalars['String'];
  1916. fileName: Scalars['String'];
  1917. mimeType: Scalars['String'];
  1918. };
  1919. /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
  1920. export type MissingConditionsError = ErrorResult & {
  1921. __typename?: 'MissingConditionsError';
  1922. errorCode: ErrorCode;
  1923. message: Scalars['String'];
  1924. };
  1925. export type ModifyOrderInput = {
  1926. dryRun: Scalars['Boolean'];
  1927. orderId: Scalars['ID'];
  1928. addItems?: Maybe<Array<AddItemInput>>;
  1929. adjustOrderLines?: Maybe<Array<AdjustOrderLineInput>>;
  1930. surcharges?: Maybe<Array<SurchargeInput>>;
  1931. updateShippingAddress?: Maybe<UpdateOrderAddressInput>;
  1932. updateBillingAddress?: Maybe<UpdateOrderAddressInput>;
  1933. note?: Maybe<Scalars['String']>;
  1934. refund?: Maybe<AdministratorRefundInput>;
  1935. options?: Maybe<ModifyOrderOptions>;
  1936. };
  1937. export type ModifyOrderOptions = {
  1938. freezePromotions?: Maybe<Scalars['Boolean']>;
  1939. recalculateShipping?: Maybe<Scalars['Boolean']>;
  1940. };
  1941. export type ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError;
  1942. export type MoveCollectionInput = {
  1943. collectionId: Scalars['ID'];
  1944. parentId: Scalars['ID'];
  1945. index: Scalars['Int'];
  1946. };
  1947. /** Returned if an operation has specified OrderLines from multiple Orders */
  1948. export type MultipleOrderError = ErrorResult & {
  1949. __typename?: 'MultipleOrderError';
  1950. errorCode: ErrorCode;
  1951. message: Scalars['String'];
  1952. };
  1953. export type Mutation = {
  1954. __typename?: 'Mutation';
  1955. /** Create a new Administrator */
  1956. createAdministrator: Administrator;
  1957. /** Update an existing Administrator */
  1958. updateAdministrator: Administrator;
  1959. /** Update the active (currently logged-in) Administrator */
  1960. updateActiveAdministrator: Administrator;
  1961. /** Delete an Administrator */
  1962. deleteAdministrator: DeletionResponse;
  1963. /** Assign a Role to an Administrator */
  1964. assignRoleToAdministrator: Administrator;
  1965. /** Create a new Asset */
  1966. createAssets: Array<CreateAssetResult>;
  1967. /** Update an existing Asset */
  1968. updateAsset: Asset;
  1969. /** Delete an Asset */
  1970. deleteAsset: DeletionResponse;
  1971. /** Delete multiple Assets */
  1972. deleteAssets: DeletionResponse;
  1973. /** Assign assets to channel */
  1974. assignAssetsToChannel: Array<Asset>;
  1975. /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
  1976. login: NativeAuthenticationResult;
  1977. /** Authenticates the user using a named authentication strategy */
  1978. authenticate: AuthenticationResult;
  1979. logout: Success;
  1980. /** Create a new Channel */
  1981. createChannel: CreateChannelResult;
  1982. /** Update an existing Channel */
  1983. updateChannel: UpdateChannelResult;
  1984. /** Delete a Channel */
  1985. deleteChannel: DeletionResponse;
  1986. /** Create a new Collection */
  1987. createCollection: Collection;
  1988. /** Update an existing Collection */
  1989. updateCollection: Collection;
  1990. /** Delete a Collection and all of its descendants */
  1991. deleteCollection: DeletionResponse;
  1992. /** Move a Collection to a different parent or index */
  1993. moveCollection: Collection;
  1994. /** Create a new Country */
  1995. createCountry: Country;
  1996. /** Update an existing Country */
  1997. updateCountry: Country;
  1998. /** Delete a Country */
  1999. deleteCountry: DeletionResponse;
  2000. /** Create a new CustomerGroup */
  2001. createCustomerGroup: CustomerGroup;
  2002. /** Update an existing CustomerGroup */
  2003. updateCustomerGroup: CustomerGroup;
  2004. /** Delete a CustomerGroup */
  2005. deleteCustomerGroup: DeletionResponse;
  2006. /** Add Customers to a CustomerGroup */
  2007. addCustomersToGroup: CustomerGroup;
  2008. /** Remove Customers from a CustomerGroup */
  2009. removeCustomersFromGroup: CustomerGroup;
  2010. /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
  2011. createCustomer: CreateCustomerResult;
  2012. /** Update an existing Customer */
  2013. updateCustomer: UpdateCustomerResult;
  2014. /** Delete a Customer */
  2015. deleteCustomer: DeletionResponse;
  2016. /** Create a new Address and associate it with the Customer specified by customerId */
  2017. createCustomerAddress: Address;
  2018. /** Update an existing Address */
  2019. updateCustomerAddress: Address;
  2020. /** Update an existing Address */
  2021. deleteCustomerAddress: Success;
  2022. addNoteToCustomer: Customer;
  2023. updateCustomerNote: HistoryEntry;
  2024. deleteCustomerNote: DeletionResponse;
  2025. /** Create a new Facet */
  2026. createFacet: Facet;
  2027. /** Update an existing Facet */
  2028. updateFacet: Facet;
  2029. /** Delete an existing Facet */
  2030. deleteFacet: DeletionResponse;
  2031. /** Create one or more FacetValues */
  2032. createFacetValues: Array<FacetValue>;
  2033. /** Update one or more FacetValues */
  2034. updateFacetValues: Array<FacetValue>;
  2035. /** Delete one or more FacetValues */
  2036. deleteFacetValues: Array<DeletionResponse>;
  2037. updateGlobalSettings: UpdateGlobalSettingsResult;
  2038. importProducts?: Maybe<ImportInfo>;
  2039. /** Remove all settled jobs in the given queues olfer than the given date. Returns the number of jobs deleted. */
  2040. removeSettledJobs: Scalars['Int'];
  2041. cancelJob: Job;
  2042. settlePayment: SettlePaymentResult;
  2043. addFulfillmentToOrder: AddFulfillmentToOrderResult;
  2044. cancelOrder: CancelOrderResult;
  2045. refundOrder: RefundOrderResult;
  2046. settleRefund: SettleRefundResult;
  2047. addNoteToOrder: Order;
  2048. updateOrderNote: HistoryEntry;
  2049. deleteOrderNote: DeletionResponse;
  2050. transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
  2051. transitionFulfillmentToState: TransitionFulfillmentToStateResult;
  2052. transitionPaymentToState: TransitionPaymentToStateResult;
  2053. setOrderCustomFields?: Maybe<Order>;
  2054. /**
  2055. * Allows an Order to be modified after it has been completed by the Customer. The Order must first
  2056. * be in the `Modifying` state.
  2057. */
  2058. modifyOrder: ModifyOrderResult;
  2059. /**
  2060. * Used to manually create a new Payment against an Order. This is used when a completed Order
  2061. * has been modified (using `modifyOrder`) and the price has increased. The extra payment
  2062. * can then be manually arranged by the administrator, and the details used to create a new
  2063. * Payment.
  2064. */
  2065. addManualPaymentToOrder: AddManualPaymentToOrderResult;
  2066. /** Create existing PaymentMethod */
  2067. createPaymentMethod: PaymentMethod;
  2068. /** Update an existing PaymentMethod */
  2069. updatePaymentMethod: PaymentMethod;
  2070. /** Delete a PaymentMethod */
  2071. deletePaymentMethod: DeletionResponse;
  2072. /** Create a new ProductOptionGroup */
  2073. createProductOptionGroup: ProductOptionGroup;
  2074. /** Update an existing ProductOptionGroup */
  2075. updateProductOptionGroup: ProductOptionGroup;
  2076. /** Create a new ProductOption within a ProductOptionGroup */
  2077. createProductOption: ProductOption;
  2078. /** Create a new ProductOption within a ProductOptionGroup */
  2079. updateProductOption: ProductOption;
  2080. reindex: Job;
  2081. /** Create a new Product */
  2082. createProduct: Product;
  2083. /** Update an existing Product */
  2084. updateProduct: Product;
  2085. /** Delete a Product */
  2086. deleteProduct: DeletionResponse;
  2087. /** Add an OptionGroup to a Product */
  2088. addOptionGroupToProduct: Product;
  2089. /** Remove an OptionGroup from a Product */
  2090. removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
  2091. /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
  2092. createProductVariants: Array<Maybe<ProductVariant>>;
  2093. /** Update existing ProductVariants */
  2094. updateProductVariants: Array<Maybe<ProductVariant>>;
  2095. /** Delete a ProductVariant */
  2096. deleteProductVariant: DeletionResponse;
  2097. /** Assigns all ProductVariants of Product to the specified Channel */
  2098. assignProductsToChannel: Array<Product>;
  2099. /** Removes all ProductVariants of Product from the specified Channel */
  2100. removeProductsFromChannel: Array<Product>;
  2101. /** Assigns ProductVariants to the specified Channel */
  2102. assignProductVariantsToChannel: Array<ProductVariant>;
  2103. /** Removes ProductVariants from the specified Channel */
  2104. removeProductVariantsFromChannel: Array<ProductVariant>;
  2105. createPromotion: CreatePromotionResult;
  2106. updatePromotion: UpdatePromotionResult;
  2107. deletePromotion: DeletionResponse;
  2108. /** Assigns Promotions to the specified Channel */
  2109. assignPromotionsToChannel: Array<Promotion>;
  2110. /** Removes Promotions from the specified Channel */
  2111. removePromotionsFromChannel: Array<Promotion>;
  2112. /** Create a new Role */
  2113. createRole: Role;
  2114. /** Update an existing Role */
  2115. updateRole: Role;
  2116. /** Delete an existing Role */
  2117. deleteRole: DeletionResponse;
  2118. /** Create a new ShippingMethod */
  2119. createShippingMethod: ShippingMethod;
  2120. /** Update an existing ShippingMethod */
  2121. updateShippingMethod: ShippingMethod;
  2122. /** Delete a ShippingMethod */
  2123. deleteShippingMethod: DeletionResponse;
  2124. /** Create a new Tag */
  2125. createTag: Tag;
  2126. /** Update an existing Tag */
  2127. updateTag: Tag;
  2128. /** Delete an existing Tag */
  2129. deleteTag: DeletionResponse;
  2130. /** Create a new TaxCategory */
  2131. createTaxCategory: TaxCategory;
  2132. /** Update an existing TaxCategory */
  2133. updateTaxCategory: TaxCategory;
  2134. /** Deletes a TaxCategory */
  2135. deleteTaxCategory: DeletionResponse;
  2136. /** Create a new TaxRate */
  2137. createTaxRate: TaxRate;
  2138. /** Update an existing TaxRate */
  2139. updateTaxRate: TaxRate;
  2140. /** Delete a TaxRate */
  2141. deleteTaxRate: DeletionResponse;
  2142. /** Create a new Zone */
  2143. createZone: Zone;
  2144. /** Update an existing Zone */
  2145. updateZone: Zone;
  2146. /** Delete a Zone */
  2147. deleteZone: DeletionResponse;
  2148. /** Add members to a Zone */
  2149. addMembersToZone: Zone;
  2150. /** Remove members from a Zone */
  2151. removeMembersFromZone: Zone;
  2152. };
  2153. export type MutationCreateAdministratorArgs = {
  2154. input: CreateAdministratorInput;
  2155. };
  2156. export type MutationUpdateAdministratorArgs = {
  2157. input: UpdateAdministratorInput;
  2158. };
  2159. export type MutationUpdateActiveAdministratorArgs = {
  2160. input: UpdateActiveAdministratorInput;
  2161. };
  2162. export type MutationDeleteAdministratorArgs = {
  2163. id: Scalars['ID'];
  2164. };
  2165. export type MutationAssignRoleToAdministratorArgs = {
  2166. administratorId: Scalars['ID'];
  2167. roleId: Scalars['ID'];
  2168. };
  2169. export type MutationCreateAssetsArgs = {
  2170. input: Array<CreateAssetInput>;
  2171. };
  2172. export type MutationUpdateAssetArgs = {
  2173. input: UpdateAssetInput;
  2174. };
  2175. export type MutationDeleteAssetArgs = {
  2176. input: DeleteAssetInput;
  2177. };
  2178. export type MutationDeleteAssetsArgs = {
  2179. input: DeleteAssetsInput;
  2180. };
  2181. export type MutationAssignAssetsToChannelArgs = {
  2182. input: AssignAssetsToChannelInput;
  2183. };
  2184. export type MutationLoginArgs = {
  2185. username: Scalars['String'];
  2186. password: Scalars['String'];
  2187. rememberMe?: Maybe<Scalars['Boolean']>;
  2188. };
  2189. export type MutationAuthenticateArgs = {
  2190. input: AuthenticationInput;
  2191. rememberMe?: Maybe<Scalars['Boolean']>;
  2192. };
  2193. export type MutationCreateChannelArgs = {
  2194. input: CreateChannelInput;
  2195. };
  2196. export type MutationUpdateChannelArgs = {
  2197. input: UpdateChannelInput;
  2198. };
  2199. export type MutationDeleteChannelArgs = {
  2200. id: Scalars['ID'];
  2201. };
  2202. export type MutationCreateCollectionArgs = {
  2203. input: CreateCollectionInput;
  2204. };
  2205. export type MutationUpdateCollectionArgs = {
  2206. input: UpdateCollectionInput;
  2207. };
  2208. export type MutationDeleteCollectionArgs = {
  2209. id: Scalars['ID'];
  2210. };
  2211. export type MutationMoveCollectionArgs = {
  2212. input: MoveCollectionInput;
  2213. };
  2214. export type MutationCreateCountryArgs = {
  2215. input: CreateCountryInput;
  2216. };
  2217. export type MutationUpdateCountryArgs = {
  2218. input: UpdateCountryInput;
  2219. };
  2220. export type MutationDeleteCountryArgs = {
  2221. id: Scalars['ID'];
  2222. };
  2223. export type MutationCreateCustomerGroupArgs = {
  2224. input: CreateCustomerGroupInput;
  2225. };
  2226. export type MutationUpdateCustomerGroupArgs = {
  2227. input: UpdateCustomerGroupInput;
  2228. };
  2229. export type MutationDeleteCustomerGroupArgs = {
  2230. id: Scalars['ID'];
  2231. };
  2232. export type MutationAddCustomersToGroupArgs = {
  2233. customerGroupId: Scalars['ID'];
  2234. customerIds: Array<Scalars['ID']>;
  2235. };
  2236. export type MutationRemoveCustomersFromGroupArgs = {
  2237. customerGroupId: Scalars['ID'];
  2238. customerIds: Array<Scalars['ID']>;
  2239. };
  2240. export type MutationCreateCustomerArgs = {
  2241. input: CreateCustomerInput;
  2242. password?: Maybe<Scalars['String']>;
  2243. };
  2244. export type MutationUpdateCustomerArgs = {
  2245. input: UpdateCustomerInput;
  2246. };
  2247. export type MutationDeleteCustomerArgs = {
  2248. id: Scalars['ID'];
  2249. };
  2250. export type MutationCreateCustomerAddressArgs = {
  2251. customerId: Scalars['ID'];
  2252. input: CreateAddressInput;
  2253. };
  2254. export type MutationUpdateCustomerAddressArgs = {
  2255. input: UpdateAddressInput;
  2256. };
  2257. export type MutationDeleteCustomerAddressArgs = {
  2258. id: Scalars['ID'];
  2259. };
  2260. export type MutationAddNoteToCustomerArgs = {
  2261. input: AddNoteToCustomerInput;
  2262. };
  2263. export type MutationUpdateCustomerNoteArgs = {
  2264. input: UpdateCustomerNoteInput;
  2265. };
  2266. export type MutationDeleteCustomerNoteArgs = {
  2267. id: Scalars['ID'];
  2268. };
  2269. export type MutationCreateFacetArgs = {
  2270. input: CreateFacetInput;
  2271. };
  2272. export type MutationUpdateFacetArgs = {
  2273. input: UpdateFacetInput;
  2274. };
  2275. export type MutationDeleteFacetArgs = {
  2276. id: Scalars['ID'];
  2277. force?: Maybe<Scalars['Boolean']>;
  2278. };
  2279. export type MutationCreateFacetValuesArgs = {
  2280. input: Array<CreateFacetValueInput>;
  2281. };
  2282. export type MutationUpdateFacetValuesArgs = {
  2283. input: Array<UpdateFacetValueInput>;
  2284. };
  2285. export type MutationDeleteFacetValuesArgs = {
  2286. ids: Array<Scalars['ID']>;
  2287. force?: Maybe<Scalars['Boolean']>;
  2288. };
  2289. export type MutationUpdateGlobalSettingsArgs = {
  2290. input: UpdateGlobalSettingsInput;
  2291. };
  2292. export type MutationImportProductsArgs = {
  2293. csvFile: Scalars['Upload'];
  2294. };
  2295. export type MutationRemoveSettledJobsArgs = {
  2296. queueNames?: Maybe<Array<Scalars['String']>>;
  2297. olderThan?: Maybe<Scalars['DateTime']>;
  2298. };
  2299. export type MutationCancelJobArgs = {
  2300. jobId: Scalars['ID'];
  2301. };
  2302. export type MutationSettlePaymentArgs = {
  2303. id: Scalars['ID'];
  2304. };
  2305. export type MutationAddFulfillmentToOrderArgs = {
  2306. input: FulfillOrderInput;
  2307. };
  2308. export type MutationCancelOrderArgs = {
  2309. input: CancelOrderInput;
  2310. };
  2311. export type MutationRefundOrderArgs = {
  2312. input: RefundOrderInput;
  2313. };
  2314. export type MutationSettleRefundArgs = {
  2315. input: SettleRefundInput;
  2316. };
  2317. export type MutationAddNoteToOrderArgs = {
  2318. input: AddNoteToOrderInput;
  2319. };
  2320. export type MutationUpdateOrderNoteArgs = {
  2321. input: UpdateOrderNoteInput;
  2322. };
  2323. export type MutationDeleteOrderNoteArgs = {
  2324. id: Scalars['ID'];
  2325. };
  2326. export type MutationTransitionOrderToStateArgs = {
  2327. id: Scalars['ID'];
  2328. state: Scalars['String'];
  2329. };
  2330. export type MutationTransitionFulfillmentToStateArgs = {
  2331. id: Scalars['ID'];
  2332. state: Scalars['String'];
  2333. };
  2334. export type MutationTransitionPaymentToStateArgs = {
  2335. id: Scalars['ID'];
  2336. state: Scalars['String'];
  2337. };
  2338. export type MutationSetOrderCustomFieldsArgs = {
  2339. input: UpdateOrderInput;
  2340. };
  2341. export type MutationModifyOrderArgs = {
  2342. input: ModifyOrderInput;
  2343. };
  2344. export type MutationAddManualPaymentToOrderArgs = {
  2345. input: ManualPaymentInput;
  2346. };
  2347. export type MutationCreatePaymentMethodArgs = {
  2348. input: CreatePaymentMethodInput;
  2349. };
  2350. export type MutationUpdatePaymentMethodArgs = {
  2351. input: UpdatePaymentMethodInput;
  2352. };
  2353. export type MutationDeletePaymentMethodArgs = {
  2354. id: Scalars['ID'];
  2355. force?: Maybe<Scalars['Boolean']>;
  2356. };
  2357. export type MutationCreateProductOptionGroupArgs = {
  2358. input: CreateProductOptionGroupInput;
  2359. };
  2360. export type MutationUpdateProductOptionGroupArgs = {
  2361. input: UpdateProductOptionGroupInput;
  2362. };
  2363. export type MutationCreateProductOptionArgs = {
  2364. input: CreateProductOptionInput;
  2365. };
  2366. export type MutationUpdateProductOptionArgs = {
  2367. input: UpdateProductOptionInput;
  2368. };
  2369. export type MutationCreateProductArgs = {
  2370. input: CreateProductInput;
  2371. };
  2372. export type MutationUpdateProductArgs = {
  2373. input: UpdateProductInput;
  2374. };
  2375. export type MutationDeleteProductArgs = {
  2376. id: Scalars['ID'];
  2377. };
  2378. export type MutationAddOptionGroupToProductArgs = {
  2379. productId: Scalars['ID'];
  2380. optionGroupId: Scalars['ID'];
  2381. };
  2382. export type MutationRemoveOptionGroupFromProductArgs = {
  2383. productId: Scalars['ID'];
  2384. optionGroupId: Scalars['ID'];
  2385. };
  2386. export type MutationCreateProductVariantsArgs = {
  2387. input: Array<CreateProductVariantInput>;
  2388. };
  2389. export type MutationUpdateProductVariantsArgs = {
  2390. input: Array<UpdateProductVariantInput>;
  2391. };
  2392. export type MutationDeleteProductVariantArgs = {
  2393. id: Scalars['ID'];
  2394. };
  2395. export type MutationAssignProductsToChannelArgs = {
  2396. input: AssignProductsToChannelInput;
  2397. };
  2398. export type MutationRemoveProductsFromChannelArgs = {
  2399. input: RemoveProductsFromChannelInput;
  2400. };
  2401. export type MutationAssignProductVariantsToChannelArgs = {
  2402. input: AssignProductVariantsToChannelInput;
  2403. };
  2404. export type MutationRemoveProductVariantsFromChannelArgs = {
  2405. input: RemoveProductVariantsFromChannelInput;
  2406. };
  2407. export type MutationCreatePromotionArgs = {
  2408. input: CreatePromotionInput;
  2409. };
  2410. export type MutationUpdatePromotionArgs = {
  2411. input: UpdatePromotionInput;
  2412. };
  2413. export type MutationDeletePromotionArgs = {
  2414. id: Scalars['ID'];
  2415. };
  2416. export type MutationAssignPromotionsToChannelArgs = {
  2417. input: AssignPromotionsToChannelInput;
  2418. };
  2419. export type MutationRemovePromotionsFromChannelArgs = {
  2420. input: RemovePromotionsFromChannelInput;
  2421. };
  2422. export type MutationCreateRoleArgs = {
  2423. input: CreateRoleInput;
  2424. };
  2425. export type MutationUpdateRoleArgs = {
  2426. input: UpdateRoleInput;
  2427. };
  2428. export type MutationDeleteRoleArgs = {
  2429. id: Scalars['ID'];
  2430. };
  2431. export type MutationCreateShippingMethodArgs = {
  2432. input: CreateShippingMethodInput;
  2433. };
  2434. export type MutationUpdateShippingMethodArgs = {
  2435. input: UpdateShippingMethodInput;
  2436. };
  2437. export type MutationDeleteShippingMethodArgs = {
  2438. id: Scalars['ID'];
  2439. };
  2440. export type MutationCreateTagArgs = {
  2441. input: CreateTagInput;
  2442. };
  2443. export type MutationUpdateTagArgs = {
  2444. input: UpdateTagInput;
  2445. };
  2446. export type MutationDeleteTagArgs = {
  2447. id: Scalars['ID'];
  2448. };
  2449. export type MutationCreateTaxCategoryArgs = {
  2450. input: CreateTaxCategoryInput;
  2451. };
  2452. export type MutationUpdateTaxCategoryArgs = {
  2453. input: UpdateTaxCategoryInput;
  2454. };
  2455. export type MutationDeleteTaxCategoryArgs = {
  2456. id: Scalars['ID'];
  2457. };
  2458. export type MutationCreateTaxRateArgs = {
  2459. input: CreateTaxRateInput;
  2460. };
  2461. export type MutationUpdateTaxRateArgs = {
  2462. input: UpdateTaxRateInput;
  2463. };
  2464. export type MutationDeleteTaxRateArgs = {
  2465. id: Scalars['ID'];
  2466. };
  2467. export type MutationCreateZoneArgs = {
  2468. input: CreateZoneInput;
  2469. };
  2470. export type MutationUpdateZoneArgs = {
  2471. input: UpdateZoneInput;
  2472. };
  2473. export type MutationDeleteZoneArgs = {
  2474. id: Scalars['ID'];
  2475. };
  2476. export type MutationAddMembersToZoneArgs = {
  2477. zoneId: Scalars['ID'];
  2478. memberIds: Array<Scalars['ID']>;
  2479. };
  2480. export type MutationRemoveMembersFromZoneArgs = {
  2481. zoneId: Scalars['ID'];
  2482. memberIds: Array<Scalars['ID']>;
  2483. };
  2484. export type NativeAuthInput = {
  2485. username: Scalars['String'];
  2486. password: Scalars['String'];
  2487. };
  2488. /** Retured when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
  2489. export type NativeAuthStrategyError = ErrorResult & {
  2490. __typename?: 'NativeAuthStrategyError';
  2491. errorCode: ErrorCode;
  2492. message: Scalars['String'];
  2493. };
  2494. export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
  2495. /** Retured when attemting to set a negative OrderLine quantity. */
  2496. export type NegativeQuantityError = ErrorResult & {
  2497. __typename?: 'NegativeQuantityError';
  2498. errorCode: ErrorCode;
  2499. message: Scalars['String'];
  2500. };
  2501. /** Returned when a call to modifyOrder fails to specify any changes */
  2502. export type NoChangesSpecifiedError = ErrorResult & {
  2503. __typename?: 'NoChangesSpecifiedError';
  2504. errorCode: ErrorCode;
  2505. message: Scalars['String'];
  2506. };
  2507. export type Node = {
  2508. id: Scalars['ID'];
  2509. };
  2510. /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
  2511. export type NothingToRefundError = ErrorResult & {
  2512. __typename?: 'NothingToRefundError';
  2513. errorCode: ErrorCode;
  2514. message: Scalars['String'];
  2515. };
  2516. export type NumberOperators = {
  2517. eq?: Maybe<Scalars['Float']>;
  2518. lt?: Maybe<Scalars['Float']>;
  2519. lte?: Maybe<Scalars['Float']>;
  2520. gt?: Maybe<Scalars['Float']>;
  2521. gte?: Maybe<Scalars['Float']>;
  2522. between?: Maybe<NumberRange>;
  2523. };
  2524. export type NumberRange = {
  2525. start: Scalars['Float'];
  2526. end: Scalars['Float'];
  2527. };
  2528. export type Order = Node & {
  2529. __typename?: 'Order';
  2530. nextStates: Array<Scalars['String']>;
  2531. modifications: Array<OrderModification>;
  2532. id: Scalars['ID'];
  2533. createdAt: Scalars['DateTime'];
  2534. updatedAt: Scalars['DateTime'];
  2535. /**
  2536. * The date & time that the Order was placed, i.e. the Customer
  2537. * completed the checkout and the Order is no longer "active"
  2538. */
  2539. orderPlacedAt?: Maybe<Scalars['DateTime']>;
  2540. /** A unique code for the Order */
  2541. code: Scalars['String'];
  2542. state: Scalars['String'];
  2543. /** An order is active as long as the payment process has not been completed */
  2544. active: Scalars['Boolean'];
  2545. customer?: Maybe<Customer>;
  2546. shippingAddress?: Maybe<OrderAddress>;
  2547. billingAddress?: Maybe<OrderAddress>;
  2548. lines: Array<OrderLine>;
  2549. /**
  2550. * Surcharges are arbitrary modifications to the Order total which are neither
  2551. * ProductVariants nor discounts resulting from applied Promotions. For example,
  2552. * one-off discounts based on customer interaction, or surcharges based on payment
  2553. * methods.
  2554. */
  2555. surcharges: Array<Surcharge>;
  2556. discounts: Array<Discount>;
  2557. /** An array of all coupon codes applied to the Order */
  2558. couponCodes: Array<Scalars['String']>;
  2559. /** Promotions applied to the order. Only gets populated after the payment process has completed. */
  2560. promotions: Array<Promotion>;
  2561. payments?: Maybe<Array<Payment>>;
  2562. fulfillments?: Maybe<Array<Fulfillment>>;
  2563. totalQuantity: Scalars['Int'];
  2564. /**
  2565. * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  2566. * discounts which have been prorated (proportionally distributed) amongst the OrderItems.
  2567. * To get a total of all OrderLines which does not account for prorated discounts, use the
  2568. * sum of `OrderLine.discountedLinePrice` values.
  2569. */
  2570. subTotal: Scalars['Int'];
  2571. /** Same as subTotal, but inclusive of tax */
  2572. subTotalWithTax: Scalars['Int'];
  2573. currencyCode: CurrencyCode;
  2574. shippingLines: Array<ShippingLine>;
  2575. shipping: Scalars['Int'];
  2576. shippingWithTax: Scalars['Int'];
  2577. /** Equal to subTotal plus shipping */
  2578. total: Scalars['Int'];
  2579. /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
  2580. totalWithTax: Scalars['Int'];
  2581. /** A summary of the taxes being applied to this Order */
  2582. taxSummary: Array<OrderTaxSummary>;
  2583. history: HistoryEntryList;
  2584. customFields?: Maybe<Scalars['JSON']>;
  2585. };
  2586. export type OrderHistoryArgs = {
  2587. options?: Maybe<HistoryEntryListOptions>;
  2588. };
  2589. export type OrderAddress = {
  2590. __typename?: 'OrderAddress';
  2591. fullName?: Maybe<Scalars['String']>;
  2592. company?: Maybe<Scalars['String']>;
  2593. streetLine1?: Maybe<Scalars['String']>;
  2594. streetLine2?: Maybe<Scalars['String']>;
  2595. city?: Maybe<Scalars['String']>;
  2596. province?: Maybe<Scalars['String']>;
  2597. postalCode?: Maybe<Scalars['String']>;
  2598. country?: Maybe<Scalars['String']>;
  2599. countryCode?: Maybe<Scalars['String']>;
  2600. phoneNumber?: Maybe<Scalars['String']>;
  2601. customFields?: Maybe<Scalars['JSON']>;
  2602. };
  2603. export type OrderFilterParameter = {
  2604. customerLastName?: Maybe<StringOperators>;
  2605. createdAt?: Maybe<DateOperators>;
  2606. updatedAt?: Maybe<DateOperators>;
  2607. orderPlacedAt?: Maybe<DateOperators>;
  2608. code?: Maybe<StringOperators>;
  2609. state?: Maybe<StringOperators>;
  2610. active?: Maybe<BooleanOperators>;
  2611. totalQuantity?: Maybe<NumberOperators>;
  2612. subTotal?: Maybe<NumberOperators>;
  2613. subTotalWithTax?: Maybe<NumberOperators>;
  2614. currencyCode?: Maybe<StringOperators>;
  2615. shipping?: Maybe<NumberOperators>;
  2616. shippingWithTax?: Maybe<NumberOperators>;
  2617. total?: Maybe<NumberOperators>;
  2618. totalWithTax?: Maybe<NumberOperators>;
  2619. };
  2620. export type OrderItem = Node & {
  2621. __typename?: 'OrderItem';
  2622. id: Scalars['ID'];
  2623. createdAt: Scalars['DateTime'];
  2624. updatedAt: Scalars['DateTime'];
  2625. cancelled: Scalars['Boolean'];
  2626. /** The price of a single unit, excluding tax and discounts */
  2627. unitPrice: Scalars['Int'];
  2628. /** The price of a single unit, including tax but excluding discounts */
  2629. unitPriceWithTax: Scalars['Int'];
  2630. /**
  2631. * The price of a single unit including discounts, excluding tax.
  2632. *
  2633. * If Order-level discounts have been applied, this will not be the
  2634. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  2635. * correct price to display to customers to avoid confusion
  2636. * about the internal handling of distributed Order-level discounts.
  2637. */
  2638. discountedUnitPrice: Scalars['Int'];
  2639. /** The price of a single unit including discounts and tax */
  2640. discountedUnitPriceWithTax: Scalars['Int'];
  2641. /**
  2642. * The actual unit price, taking into account both item discounts _and_ prorated (proportially-distributed)
  2643. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  2644. * and refund calculations.
  2645. */
  2646. proratedUnitPrice: Scalars['Int'];
  2647. /** The proratedUnitPrice including tax */
  2648. proratedUnitPriceWithTax: Scalars['Int'];
  2649. unitTax: Scalars['Int'];
  2650. taxRate: Scalars['Float'];
  2651. adjustments: Array<Adjustment>;
  2652. taxLines: Array<TaxLine>;
  2653. fulfillment?: Maybe<Fulfillment>;
  2654. refundId?: Maybe<Scalars['ID']>;
  2655. };
  2656. /** Retured when the maximum order size limit has been reached. */
  2657. export type OrderLimitError = ErrorResult & {
  2658. __typename?: 'OrderLimitError';
  2659. errorCode: ErrorCode;
  2660. message: Scalars['String'];
  2661. maxItems: Scalars['Int'];
  2662. };
  2663. export type OrderLine = Node & {
  2664. __typename?: 'OrderLine';
  2665. id: Scalars['ID'];
  2666. createdAt: Scalars['DateTime'];
  2667. updatedAt: Scalars['DateTime'];
  2668. productVariant: ProductVariant;
  2669. featuredAsset?: Maybe<Asset>;
  2670. /** The price of a single unit, excluding tax and discounts */
  2671. unitPrice: Scalars['Int'];
  2672. /** The price of a single unit, including tax but excluding discounts */
  2673. unitPriceWithTax: Scalars['Int'];
  2674. /** Non-zero if the unitPrice has changed since it was initially added to Order */
  2675. unitPriceChangeSinceAdded: Scalars['Int'];
  2676. /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
  2677. unitPriceWithTaxChangeSinceAdded: Scalars['Int'];
  2678. /**
  2679. * The price of a single unit including discounts, excluding tax.
  2680. *
  2681. * If Order-level discounts have been applied, this will not be the
  2682. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  2683. * correct price to display to customers to avoid confusion
  2684. * about the internal handling of distributed Order-level discounts.
  2685. */
  2686. discountedUnitPrice: Scalars['Int'];
  2687. /** The price of a single unit including discounts and tax */
  2688. discountedUnitPriceWithTax: Scalars['Int'];
  2689. /**
  2690. * The actual unit price, taking into account both item discounts _and_ prorated (proportially-distributed)
  2691. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  2692. * and refund calculations.
  2693. */
  2694. proratedUnitPrice: Scalars['Int'];
  2695. /** The proratedUnitPrice including tax */
  2696. proratedUnitPriceWithTax: Scalars['Int'];
  2697. quantity: Scalars['Int'];
  2698. items: Array<OrderItem>;
  2699. taxRate: Scalars['Float'];
  2700. /** The total price of the line excluding tax and discounts. */
  2701. linePrice: Scalars['Int'];
  2702. /** The total price of the line including tax bit excluding discounts. */
  2703. linePriceWithTax: Scalars['Int'];
  2704. /** The price of the line including discounts, excluding tax */
  2705. discountedLinePrice: Scalars['Int'];
  2706. /** The price of the line including discounts and tax */
  2707. discountedLinePriceWithTax: Scalars['Int'];
  2708. /**
  2709. * The actual line price, taking into account both item discounts _and_ prorated (proportially-distributed)
  2710. * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
  2711. * and refund calculations.
  2712. */
  2713. proratedLinePrice: Scalars['Int'];
  2714. /** The proratedLinePrice including tax */
  2715. proratedLinePriceWithTax: Scalars['Int'];
  2716. /** The total tax on this line */
  2717. lineTax: Scalars['Int'];
  2718. discounts: Array<Discount>;
  2719. taxLines: Array<TaxLine>;
  2720. order: Order;
  2721. customFields?: Maybe<Scalars['JSON']>;
  2722. };
  2723. export type OrderLineInput = {
  2724. orderLineId: Scalars['ID'];
  2725. quantity: Scalars['Int'];
  2726. };
  2727. export type OrderList = PaginatedList & {
  2728. __typename?: 'OrderList';
  2729. items: Array<Order>;
  2730. totalItems: Scalars['Int'];
  2731. };
  2732. export type OrderListOptions = {
  2733. skip?: Maybe<Scalars['Int']>;
  2734. take?: Maybe<Scalars['Int']>;
  2735. sort?: Maybe<OrderSortParameter>;
  2736. filter?: Maybe<OrderFilterParameter>;
  2737. };
  2738. export type OrderModification = Node & {
  2739. __typename?: 'OrderModification';
  2740. id: Scalars['ID'];
  2741. createdAt: Scalars['DateTime'];
  2742. updatedAt: Scalars['DateTime'];
  2743. priceChange: Scalars['Int'];
  2744. note: Scalars['String'];
  2745. orderItems?: Maybe<Array<OrderItem>>;
  2746. surcharges?: Maybe<Array<Surcharge>>;
  2747. payment?: Maybe<Payment>;
  2748. refund?: Maybe<Refund>;
  2749. isSettled: Scalars['Boolean'];
  2750. };
  2751. /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
  2752. export type OrderModificationStateError = ErrorResult & {
  2753. __typename?: 'OrderModificationStateError';
  2754. errorCode: ErrorCode;
  2755. message: Scalars['String'];
  2756. };
  2757. export type OrderProcessState = {
  2758. __typename?: 'OrderProcessState';
  2759. name: Scalars['String'];
  2760. to: Array<Scalars['String']>;
  2761. };
  2762. export type OrderSortParameter = {
  2763. customerLastName?: Maybe<SortOrder>;
  2764. id?: Maybe<SortOrder>;
  2765. createdAt?: Maybe<SortOrder>;
  2766. updatedAt?: Maybe<SortOrder>;
  2767. orderPlacedAt?: Maybe<SortOrder>;
  2768. code?: Maybe<SortOrder>;
  2769. state?: Maybe<SortOrder>;
  2770. totalQuantity?: Maybe<SortOrder>;
  2771. subTotal?: Maybe<SortOrder>;
  2772. subTotalWithTax?: Maybe<SortOrder>;
  2773. shipping?: Maybe<SortOrder>;
  2774. shippingWithTax?: Maybe<SortOrder>;
  2775. total?: Maybe<SortOrder>;
  2776. totalWithTax?: Maybe<SortOrder>;
  2777. };
  2778. /** Returned if there is an error in transitioning the Order state */
  2779. export type OrderStateTransitionError = ErrorResult & {
  2780. __typename?: 'OrderStateTransitionError';
  2781. errorCode: ErrorCode;
  2782. message: Scalars['String'];
  2783. transitionError: Scalars['String'];
  2784. fromState: Scalars['String'];
  2785. toState: Scalars['String'];
  2786. };
  2787. /**
  2788. * A summary of the taxes being applied to this order, grouped
  2789. * by taxRate.
  2790. */
  2791. export type OrderTaxSummary = {
  2792. __typename?: 'OrderTaxSummary';
  2793. /** A description of this tax */
  2794. description: Scalars['String'];
  2795. /** The taxRate as a percentage */
  2796. taxRate: Scalars['Float'];
  2797. /** The total net price or OrderItems to which this taxRate applies */
  2798. taxBase: Scalars['Int'];
  2799. /** The total tax being applied to the Order at this taxRate */
  2800. taxTotal: Scalars['Int'];
  2801. };
  2802. export type PaginatedList = {
  2803. items: Array<Node>;
  2804. totalItems: Scalars['Int'];
  2805. };
  2806. export type Payment = Node & {
  2807. __typename?: 'Payment';
  2808. nextStates: Array<Scalars['String']>;
  2809. id: Scalars['ID'];
  2810. createdAt: Scalars['DateTime'];
  2811. updatedAt: Scalars['DateTime'];
  2812. method: Scalars['String'];
  2813. amount: Scalars['Int'];
  2814. state: Scalars['String'];
  2815. transactionId?: Maybe<Scalars['String']>;
  2816. errorMessage?: Maybe<Scalars['String']>;
  2817. refunds: Array<Refund>;
  2818. metadata?: Maybe<Scalars['JSON']>;
  2819. };
  2820. export type PaymentMethod = Node & {
  2821. __typename?: 'PaymentMethod';
  2822. id: Scalars['ID'];
  2823. createdAt: Scalars['DateTime'];
  2824. updatedAt: Scalars['DateTime'];
  2825. name: Scalars['String'];
  2826. code: Scalars['String'];
  2827. description: Scalars['String'];
  2828. enabled: Scalars['Boolean'];
  2829. checker?: Maybe<ConfigurableOperation>;
  2830. handler: ConfigurableOperation;
  2831. };
  2832. export type PaymentMethodFilterParameter = {
  2833. createdAt?: Maybe<DateOperators>;
  2834. updatedAt?: Maybe<DateOperators>;
  2835. name?: Maybe<StringOperators>;
  2836. code?: Maybe<StringOperators>;
  2837. description?: Maybe<StringOperators>;
  2838. enabled?: Maybe<BooleanOperators>;
  2839. };
  2840. export type PaymentMethodList = PaginatedList & {
  2841. __typename?: 'PaymentMethodList';
  2842. items: Array<PaymentMethod>;
  2843. totalItems: Scalars['Int'];
  2844. };
  2845. export type PaymentMethodListOptions = {
  2846. skip?: Maybe<Scalars['Int']>;
  2847. take?: Maybe<Scalars['Int']>;
  2848. sort?: Maybe<PaymentMethodSortParameter>;
  2849. filter?: Maybe<PaymentMethodFilterParameter>;
  2850. };
  2851. /**
  2852. * Returned when a call to modifyOrder fails to include a paymentMethod even
  2853. * though the price has increased as a result of the changes.
  2854. */
  2855. export type PaymentMethodMissingError = ErrorResult & {
  2856. __typename?: 'PaymentMethodMissingError';
  2857. errorCode: ErrorCode;
  2858. message: Scalars['String'];
  2859. };
  2860. export type PaymentMethodQuote = {
  2861. __typename?: 'PaymentMethodQuote';
  2862. id: Scalars['ID'];
  2863. code: Scalars['String'];
  2864. name: Scalars['String'];
  2865. description: Scalars['String'];
  2866. isEligible: Scalars['Boolean'];
  2867. eligibilityMessage?: Maybe<Scalars['String']>;
  2868. };
  2869. export type PaymentMethodSortParameter = {
  2870. id?: Maybe<SortOrder>;
  2871. createdAt?: Maybe<SortOrder>;
  2872. updatedAt?: Maybe<SortOrder>;
  2873. name?: Maybe<SortOrder>;
  2874. code?: Maybe<SortOrder>;
  2875. description?: Maybe<SortOrder>;
  2876. };
  2877. /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
  2878. export type PaymentOrderMismatchError = ErrorResult & {
  2879. __typename?: 'PaymentOrderMismatchError';
  2880. errorCode: ErrorCode;
  2881. message: Scalars['String'];
  2882. };
  2883. /** Returned when there is an error in transitioning the Payment state */
  2884. export type PaymentStateTransitionError = ErrorResult & {
  2885. __typename?: 'PaymentStateTransitionError';
  2886. errorCode: ErrorCode;
  2887. message: Scalars['String'];
  2888. transitionError: Scalars['String'];
  2889. fromState: Scalars['String'];
  2890. toState: Scalars['String'];
  2891. };
  2892. /**
  2893. * @description
  2894. * Permissions for administrators and customers. Used to control access to
  2895. * GraphQL resolvers via the {@link Allow} decorator.
  2896. *
  2897. * @docsCategory common
  2898. */
  2899. export enum Permission {
  2900. /** Authenticated means simply that the user is logged in */
  2901. Authenticated = 'Authenticated',
  2902. /** SuperAdmin has unrestricted access to all operations */
  2903. SuperAdmin = 'SuperAdmin',
  2904. /** Owner means the user owns this entity, e.g. a Customer's own Order */
  2905. Owner = 'Owner',
  2906. /** Public means any unauthenticated user may perform the operation */
  2907. Public = 'Public',
  2908. /** Grants permission to update GlobalSettings */
  2909. UpdateGlobalSettings = 'UpdateGlobalSettings',
  2910. /** Grants permission to create Products, Facets, Assets, Collections */
  2911. CreateCatalog = 'CreateCatalog',
  2912. /** Grants permission to read Products, Facets, Assets, Collections */
  2913. ReadCatalog = 'ReadCatalog',
  2914. /** Grants permission to update Products, Facets, Assets, Collections */
  2915. UpdateCatalog = 'UpdateCatalog',
  2916. /** Grants permission to delete Products, Facets, Assets, Collections */
  2917. DeleteCatalog = 'DeleteCatalog',
  2918. /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  2919. CreateSettings = 'CreateSettings',
  2920. /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  2921. ReadSettings = 'ReadSettings',
  2922. /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  2923. UpdateSettings = 'UpdateSettings',
  2924. /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  2925. DeleteSettings = 'DeleteSettings',
  2926. /** Grants permission to create Administrator */
  2927. CreateAdministrator = 'CreateAdministrator',
  2928. /** Grants permission to read Administrator */
  2929. ReadAdministrator = 'ReadAdministrator',
  2930. /** Grants permission to update Administrator */
  2931. UpdateAdministrator = 'UpdateAdministrator',
  2932. /** Grants permission to delete Administrator */
  2933. DeleteAdministrator = 'DeleteAdministrator',
  2934. /** Grants permission to create Asset */
  2935. CreateAsset = 'CreateAsset',
  2936. /** Grants permission to read Asset */
  2937. ReadAsset = 'ReadAsset',
  2938. /** Grants permission to update Asset */
  2939. UpdateAsset = 'UpdateAsset',
  2940. /** Grants permission to delete Asset */
  2941. DeleteAsset = 'DeleteAsset',
  2942. /** Grants permission to create Channel */
  2943. CreateChannel = 'CreateChannel',
  2944. /** Grants permission to read Channel */
  2945. ReadChannel = 'ReadChannel',
  2946. /** Grants permission to update Channel */
  2947. UpdateChannel = 'UpdateChannel',
  2948. /** Grants permission to delete Channel */
  2949. DeleteChannel = 'DeleteChannel',
  2950. /** Grants permission to create Collection */
  2951. CreateCollection = 'CreateCollection',
  2952. /** Grants permission to read Collection */
  2953. ReadCollection = 'ReadCollection',
  2954. /** Grants permission to update Collection */
  2955. UpdateCollection = 'UpdateCollection',
  2956. /** Grants permission to delete Collection */
  2957. DeleteCollection = 'DeleteCollection',
  2958. /** Grants permission to create Country */
  2959. CreateCountry = 'CreateCountry',
  2960. /** Grants permission to read Country */
  2961. ReadCountry = 'ReadCountry',
  2962. /** Grants permission to update Country */
  2963. UpdateCountry = 'UpdateCountry',
  2964. /** Grants permission to delete Country */
  2965. DeleteCountry = 'DeleteCountry',
  2966. /** Grants permission to create Customer */
  2967. CreateCustomer = 'CreateCustomer',
  2968. /** Grants permission to read Customer */
  2969. ReadCustomer = 'ReadCustomer',
  2970. /** Grants permission to update Customer */
  2971. UpdateCustomer = 'UpdateCustomer',
  2972. /** Grants permission to delete Customer */
  2973. DeleteCustomer = 'DeleteCustomer',
  2974. /** Grants permission to create CustomerGroup */
  2975. CreateCustomerGroup = 'CreateCustomerGroup',
  2976. /** Grants permission to read CustomerGroup */
  2977. ReadCustomerGroup = 'ReadCustomerGroup',
  2978. /** Grants permission to update CustomerGroup */
  2979. UpdateCustomerGroup = 'UpdateCustomerGroup',
  2980. /** Grants permission to delete CustomerGroup */
  2981. DeleteCustomerGroup = 'DeleteCustomerGroup',
  2982. /** Grants permission to create Facet */
  2983. CreateFacet = 'CreateFacet',
  2984. /** Grants permission to read Facet */
  2985. ReadFacet = 'ReadFacet',
  2986. /** Grants permission to update Facet */
  2987. UpdateFacet = 'UpdateFacet',
  2988. /** Grants permission to delete Facet */
  2989. DeleteFacet = 'DeleteFacet',
  2990. /** Grants permission to create Order */
  2991. CreateOrder = 'CreateOrder',
  2992. /** Grants permission to read Order */
  2993. ReadOrder = 'ReadOrder',
  2994. /** Grants permission to update Order */
  2995. UpdateOrder = 'UpdateOrder',
  2996. /** Grants permission to delete Order */
  2997. DeleteOrder = 'DeleteOrder',
  2998. /** Grants permission to create PaymentMethod */
  2999. CreatePaymentMethod = 'CreatePaymentMethod',
  3000. /** Grants permission to read PaymentMethod */
  3001. ReadPaymentMethod = 'ReadPaymentMethod',
  3002. /** Grants permission to update PaymentMethod */
  3003. UpdatePaymentMethod = 'UpdatePaymentMethod',
  3004. /** Grants permission to delete PaymentMethod */
  3005. DeletePaymentMethod = 'DeletePaymentMethod',
  3006. /** Grants permission to create Product */
  3007. CreateProduct = 'CreateProduct',
  3008. /** Grants permission to read Product */
  3009. ReadProduct = 'ReadProduct',
  3010. /** Grants permission to update Product */
  3011. UpdateProduct = 'UpdateProduct',
  3012. /** Grants permission to delete Product */
  3013. DeleteProduct = 'DeleteProduct',
  3014. /** Grants permission to create Promotion */
  3015. CreatePromotion = 'CreatePromotion',
  3016. /** Grants permission to read Promotion */
  3017. ReadPromotion = 'ReadPromotion',
  3018. /** Grants permission to update Promotion */
  3019. UpdatePromotion = 'UpdatePromotion',
  3020. /** Grants permission to delete Promotion */
  3021. DeletePromotion = 'DeletePromotion',
  3022. /** Grants permission to create ShippingMethod */
  3023. CreateShippingMethod = 'CreateShippingMethod',
  3024. /** Grants permission to read ShippingMethod */
  3025. ReadShippingMethod = 'ReadShippingMethod',
  3026. /** Grants permission to update ShippingMethod */
  3027. UpdateShippingMethod = 'UpdateShippingMethod',
  3028. /** Grants permission to delete ShippingMethod */
  3029. DeleteShippingMethod = 'DeleteShippingMethod',
  3030. /** Grants permission to create Tag */
  3031. CreateTag = 'CreateTag',
  3032. /** Grants permission to read Tag */
  3033. ReadTag = 'ReadTag',
  3034. /** Grants permission to update Tag */
  3035. UpdateTag = 'UpdateTag',
  3036. /** Grants permission to delete Tag */
  3037. DeleteTag = 'DeleteTag',
  3038. /** Grants permission to create TaxCategory */
  3039. CreateTaxCategory = 'CreateTaxCategory',
  3040. /** Grants permission to read TaxCategory */
  3041. ReadTaxCategory = 'ReadTaxCategory',
  3042. /** Grants permission to update TaxCategory */
  3043. UpdateTaxCategory = 'UpdateTaxCategory',
  3044. /** Grants permission to delete TaxCategory */
  3045. DeleteTaxCategory = 'DeleteTaxCategory',
  3046. /** Grants permission to create TaxRate */
  3047. CreateTaxRate = 'CreateTaxRate',
  3048. /** Grants permission to read TaxRate */
  3049. ReadTaxRate = 'ReadTaxRate',
  3050. /** Grants permission to update TaxRate */
  3051. UpdateTaxRate = 'UpdateTaxRate',
  3052. /** Grants permission to delete TaxRate */
  3053. DeleteTaxRate = 'DeleteTaxRate',
  3054. /** Grants permission to create System */
  3055. CreateSystem = 'CreateSystem',
  3056. /** Grants permission to read System */
  3057. ReadSystem = 'ReadSystem',
  3058. /** Grants permission to update System */
  3059. UpdateSystem = 'UpdateSystem',
  3060. /** Grants permission to delete System */
  3061. DeleteSystem = 'DeleteSystem',
  3062. /** Grants permission to create Zone */
  3063. CreateZone = 'CreateZone',
  3064. /** Grants permission to read Zone */
  3065. ReadZone = 'ReadZone',
  3066. /** Grants permission to update Zone */
  3067. UpdateZone = 'UpdateZone',
  3068. /** Grants permission to delete Zone */
  3069. DeleteZone = 'DeleteZone'
  3070. }
  3071. export type PermissionDefinition = {
  3072. __typename?: 'PermissionDefinition';
  3073. name: Scalars['String'];
  3074. description: Scalars['String'];
  3075. assignable: Scalars['Boolean'];
  3076. };
  3077. /** The price range where the result has more than one price */
  3078. export type PriceRange = {
  3079. __typename?: 'PriceRange';
  3080. min: Scalars['Int'];
  3081. max: Scalars['Int'];
  3082. };
  3083. export type Product = Node & {
  3084. __typename?: 'Product';
  3085. enabled: Scalars['Boolean'];
  3086. channels: Array<Channel>;
  3087. id: Scalars['ID'];
  3088. createdAt: Scalars['DateTime'];
  3089. updatedAt: Scalars['DateTime'];
  3090. languageCode: LanguageCode;
  3091. name: Scalars['String'];
  3092. slug: Scalars['String'];
  3093. description: Scalars['String'];
  3094. featuredAsset?: Maybe<Asset>;
  3095. assets: Array<Asset>;
  3096. /** Returns all ProductVariants */
  3097. variants: Array<ProductVariant>;
  3098. /** Returns a paginated, sortable, filterable list of ProductVariants */
  3099. variantList: ProductVariantList;
  3100. optionGroups: Array<ProductOptionGroup>;
  3101. facetValues: Array<FacetValue>;
  3102. translations: Array<ProductTranslation>;
  3103. collections: Array<Collection>;
  3104. customFields?: Maybe<Scalars['JSON']>;
  3105. };
  3106. export type ProductVariantListArgs = {
  3107. options?: Maybe<ProductVariantListOptions>;
  3108. };
  3109. export type ProductFilterParameter = {
  3110. enabled?: Maybe<BooleanOperators>;
  3111. createdAt?: Maybe<DateOperators>;
  3112. updatedAt?: Maybe<DateOperators>;
  3113. languageCode?: Maybe<StringOperators>;
  3114. name?: Maybe<StringOperators>;
  3115. slug?: Maybe<StringOperators>;
  3116. description?: Maybe<StringOperators>;
  3117. };
  3118. export type ProductList = PaginatedList & {
  3119. __typename?: 'ProductList';
  3120. items: Array<Product>;
  3121. totalItems: Scalars['Int'];
  3122. };
  3123. export type ProductListOptions = {
  3124. skip?: Maybe<Scalars['Int']>;
  3125. take?: Maybe<Scalars['Int']>;
  3126. sort?: Maybe<ProductSortParameter>;
  3127. filter?: Maybe<ProductFilterParameter>;
  3128. };
  3129. export type ProductOption = Node & {
  3130. __typename?: 'ProductOption';
  3131. id: Scalars['ID'];
  3132. createdAt: Scalars['DateTime'];
  3133. updatedAt: Scalars['DateTime'];
  3134. languageCode: LanguageCode;
  3135. code: Scalars['String'];
  3136. name: Scalars['String'];
  3137. groupId: Scalars['ID'];
  3138. group: ProductOptionGroup;
  3139. translations: Array<ProductOptionTranslation>;
  3140. customFields?: Maybe<Scalars['JSON']>;
  3141. };
  3142. export type ProductOptionGroup = Node & {
  3143. __typename?: 'ProductOptionGroup';
  3144. id: Scalars['ID'];
  3145. createdAt: Scalars['DateTime'];
  3146. updatedAt: Scalars['DateTime'];
  3147. languageCode: LanguageCode;
  3148. code: Scalars['String'];
  3149. name: Scalars['String'];
  3150. options: Array<ProductOption>;
  3151. translations: Array<ProductOptionGroupTranslation>;
  3152. customFields?: Maybe<Scalars['JSON']>;
  3153. };
  3154. export type ProductOptionGroupTranslation = {
  3155. __typename?: 'ProductOptionGroupTranslation';
  3156. id: Scalars['ID'];
  3157. createdAt: Scalars['DateTime'];
  3158. updatedAt: Scalars['DateTime'];
  3159. languageCode: LanguageCode;
  3160. name: Scalars['String'];
  3161. };
  3162. export type ProductOptionGroupTranslationInput = {
  3163. id?: Maybe<Scalars['ID']>;
  3164. languageCode: LanguageCode;
  3165. name?: Maybe<Scalars['String']>;
  3166. customFields?: Maybe<Scalars['JSON']>;
  3167. };
  3168. export type ProductOptionInUseError = ErrorResult & {
  3169. __typename?: 'ProductOptionInUseError';
  3170. errorCode: ErrorCode;
  3171. message: Scalars['String'];
  3172. optionGroupCode: Scalars['String'];
  3173. productVariantCount: Scalars['Int'];
  3174. };
  3175. export type ProductOptionTranslation = {
  3176. __typename?: 'ProductOptionTranslation';
  3177. id: Scalars['ID'];
  3178. createdAt: Scalars['DateTime'];
  3179. updatedAt: Scalars['DateTime'];
  3180. languageCode: LanguageCode;
  3181. name: Scalars['String'];
  3182. };
  3183. export type ProductOptionTranslationInput = {
  3184. id?: Maybe<Scalars['ID']>;
  3185. languageCode: LanguageCode;
  3186. name?: Maybe<Scalars['String']>;
  3187. customFields?: Maybe<Scalars['JSON']>;
  3188. };
  3189. export type ProductSortParameter = {
  3190. id?: Maybe<SortOrder>;
  3191. createdAt?: Maybe<SortOrder>;
  3192. updatedAt?: Maybe<SortOrder>;
  3193. name?: Maybe<SortOrder>;
  3194. slug?: Maybe<SortOrder>;
  3195. description?: Maybe<SortOrder>;
  3196. };
  3197. export type ProductTranslation = {
  3198. __typename?: 'ProductTranslation';
  3199. id: Scalars['ID'];
  3200. createdAt: Scalars['DateTime'];
  3201. updatedAt: Scalars['DateTime'];
  3202. languageCode: LanguageCode;
  3203. name: Scalars['String'];
  3204. slug: Scalars['String'];
  3205. description: Scalars['String'];
  3206. };
  3207. export type ProductTranslationInput = {
  3208. id?: Maybe<Scalars['ID']>;
  3209. languageCode: LanguageCode;
  3210. name?: Maybe<Scalars['String']>;
  3211. slug?: Maybe<Scalars['String']>;
  3212. description?: Maybe<Scalars['String']>;
  3213. customFields?: Maybe<Scalars['JSON']>;
  3214. };
  3215. export type ProductVariant = Node & {
  3216. __typename?: 'ProductVariant';
  3217. enabled: Scalars['Boolean'];
  3218. trackInventory: GlobalFlag;
  3219. stockOnHand: Scalars['Int'];
  3220. stockAllocated: Scalars['Int'];
  3221. outOfStockThreshold: Scalars['Int'];
  3222. useGlobalOutOfStockThreshold: Scalars['Boolean'];
  3223. stockMovements: StockMovementList;
  3224. channels: Array<Channel>;
  3225. id: Scalars['ID'];
  3226. product: Product;
  3227. productId: Scalars['ID'];
  3228. createdAt: Scalars['DateTime'];
  3229. updatedAt: Scalars['DateTime'];
  3230. languageCode: LanguageCode;
  3231. sku: Scalars['String'];
  3232. name: Scalars['String'];
  3233. featuredAsset?: Maybe<Asset>;
  3234. assets: Array<Asset>;
  3235. price: Scalars['Int'];
  3236. currencyCode: CurrencyCode;
  3237. priceWithTax: Scalars['Int'];
  3238. stockLevel: Scalars['String'];
  3239. taxRateApplied: TaxRate;
  3240. taxCategory: TaxCategory;
  3241. options: Array<ProductOption>;
  3242. facetValues: Array<FacetValue>;
  3243. translations: Array<ProductVariantTranslation>;
  3244. customFields?: Maybe<Scalars['JSON']>;
  3245. };
  3246. export type ProductVariantStockMovementsArgs = {
  3247. options?: Maybe<StockMovementListOptions>;
  3248. };
  3249. export type ProductVariantFilterParameter = {
  3250. enabled?: Maybe<BooleanOperators>;
  3251. trackInventory?: Maybe<StringOperators>;
  3252. stockOnHand?: Maybe<NumberOperators>;
  3253. stockAllocated?: Maybe<NumberOperators>;
  3254. outOfStockThreshold?: Maybe<NumberOperators>;
  3255. useGlobalOutOfStockThreshold?: Maybe<BooleanOperators>;
  3256. createdAt?: Maybe<DateOperators>;
  3257. updatedAt?: Maybe<DateOperators>;
  3258. languageCode?: Maybe<StringOperators>;
  3259. sku?: Maybe<StringOperators>;
  3260. name?: Maybe<StringOperators>;
  3261. price?: Maybe<NumberOperators>;
  3262. currencyCode?: Maybe<StringOperators>;
  3263. priceWithTax?: Maybe<NumberOperators>;
  3264. stockLevel?: Maybe<StringOperators>;
  3265. };
  3266. export type ProductVariantList = PaginatedList & {
  3267. __typename?: 'ProductVariantList';
  3268. items: Array<ProductVariant>;
  3269. totalItems: Scalars['Int'];
  3270. };
  3271. export type ProductVariantListOptions = {
  3272. skip?: Maybe<Scalars['Int']>;
  3273. take?: Maybe<Scalars['Int']>;
  3274. sort?: Maybe<ProductVariantSortParameter>;
  3275. filter?: Maybe<ProductVariantFilterParameter>;
  3276. };
  3277. export type ProductVariantSortParameter = {
  3278. stockOnHand?: Maybe<SortOrder>;
  3279. stockAllocated?: Maybe<SortOrder>;
  3280. outOfStockThreshold?: Maybe<SortOrder>;
  3281. id?: Maybe<SortOrder>;
  3282. productId?: Maybe<SortOrder>;
  3283. createdAt?: Maybe<SortOrder>;
  3284. updatedAt?: Maybe<SortOrder>;
  3285. sku?: Maybe<SortOrder>;
  3286. name?: Maybe<SortOrder>;
  3287. price?: Maybe<SortOrder>;
  3288. priceWithTax?: Maybe<SortOrder>;
  3289. stockLevel?: Maybe<SortOrder>;
  3290. };
  3291. export type ProductVariantTranslation = {
  3292. __typename?: 'ProductVariantTranslation';
  3293. id: Scalars['ID'];
  3294. createdAt: Scalars['DateTime'];
  3295. updatedAt: Scalars['DateTime'];
  3296. languageCode: LanguageCode;
  3297. name: Scalars['String'];
  3298. };
  3299. export type ProductVariantTranslationInput = {
  3300. id?: Maybe<Scalars['ID']>;
  3301. languageCode: LanguageCode;
  3302. name?: Maybe<Scalars['String']>;
  3303. customFields?: Maybe<Scalars['JSON']>;
  3304. };
  3305. export type Promotion = Node & {
  3306. __typename?: 'Promotion';
  3307. id: Scalars['ID'];
  3308. createdAt: Scalars['DateTime'];
  3309. updatedAt: Scalars['DateTime'];
  3310. startsAt?: Maybe<Scalars['DateTime']>;
  3311. endsAt?: Maybe<Scalars['DateTime']>;
  3312. couponCode?: Maybe<Scalars['String']>;
  3313. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  3314. name: Scalars['String'];
  3315. enabled: Scalars['Boolean'];
  3316. conditions: Array<ConfigurableOperation>;
  3317. actions: Array<ConfigurableOperation>;
  3318. };
  3319. export type PromotionFilterParameter = {
  3320. createdAt?: Maybe<DateOperators>;
  3321. updatedAt?: Maybe<DateOperators>;
  3322. startsAt?: Maybe<DateOperators>;
  3323. endsAt?: Maybe<DateOperators>;
  3324. couponCode?: Maybe<StringOperators>;
  3325. perCustomerUsageLimit?: Maybe<NumberOperators>;
  3326. name?: Maybe<StringOperators>;
  3327. enabled?: Maybe<BooleanOperators>;
  3328. };
  3329. export type PromotionList = PaginatedList & {
  3330. __typename?: 'PromotionList';
  3331. items: Array<Promotion>;
  3332. totalItems: Scalars['Int'];
  3333. };
  3334. export type PromotionListOptions = {
  3335. skip?: Maybe<Scalars['Int']>;
  3336. take?: Maybe<Scalars['Int']>;
  3337. sort?: Maybe<PromotionSortParameter>;
  3338. filter?: Maybe<PromotionFilterParameter>;
  3339. };
  3340. export type PromotionSortParameter = {
  3341. id?: Maybe<SortOrder>;
  3342. createdAt?: Maybe<SortOrder>;
  3343. updatedAt?: Maybe<SortOrder>;
  3344. startsAt?: Maybe<SortOrder>;
  3345. endsAt?: Maybe<SortOrder>;
  3346. couponCode?: Maybe<SortOrder>;
  3347. perCustomerUsageLimit?: Maybe<SortOrder>;
  3348. name?: Maybe<SortOrder>;
  3349. };
  3350. /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
  3351. export type QuantityTooGreatError = ErrorResult & {
  3352. __typename?: 'QuantityTooGreatError';
  3353. errorCode: ErrorCode;
  3354. message: Scalars['String'];
  3355. };
  3356. export type Query = {
  3357. __typename?: 'Query';
  3358. administrators: AdministratorList;
  3359. administrator?: Maybe<Administrator>;
  3360. activeAdministrator?: Maybe<Administrator>;
  3361. /** Get a list of Assets */
  3362. assets: AssetList;
  3363. /** Get a single Asset by id */
  3364. asset?: Maybe<Asset>;
  3365. me?: Maybe<CurrentUser>;
  3366. channels: Array<Channel>;
  3367. channel?: Maybe<Channel>;
  3368. activeChannel: Channel;
  3369. collections: CollectionList;
  3370. /** Get a Collection either by id or slug. If neither id nor slug is speicified, an error will result. */
  3371. collection?: Maybe<Collection>;
  3372. collectionFilters: Array<ConfigurableOperationDefinition>;
  3373. countries: CountryList;
  3374. country?: Maybe<Country>;
  3375. customerGroups: CustomerGroupList;
  3376. customerGroup?: Maybe<CustomerGroup>;
  3377. customers: CustomerList;
  3378. customer?: Maybe<Customer>;
  3379. facets: FacetList;
  3380. facet?: Maybe<Facet>;
  3381. globalSettings: GlobalSettings;
  3382. job?: Maybe<Job>;
  3383. jobs: JobList;
  3384. jobsById: Array<Job>;
  3385. jobQueues: Array<JobQueue>;
  3386. order?: Maybe<Order>;
  3387. orders: OrderList;
  3388. paymentMethods: PaymentMethodList;
  3389. paymentMethod?: Maybe<PaymentMethod>;
  3390. paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  3391. paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
  3392. productOptionGroups: Array<ProductOptionGroup>;
  3393. productOptionGroup?: Maybe<ProductOptionGroup>;
  3394. search: SearchResponse;
  3395. /** List Products */
  3396. products: ProductList;
  3397. /** Get a Product either by id or slug. If neither id nor slug is speicified, an error will result. */
  3398. product?: Maybe<Product>;
  3399. /** List ProductVariants either all or for the specific product. */
  3400. productVariants: ProductVariantList;
  3401. /** Get a ProductVariant by id */
  3402. productVariant?: Maybe<ProductVariant>;
  3403. promotion?: Maybe<Promotion>;
  3404. promotions: PromotionList;
  3405. promotionConditions: Array<ConfigurableOperationDefinition>;
  3406. promotionActions: Array<ConfigurableOperationDefinition>;
  3407. roles: RoleList;
  3408. role?: Maybe<Role>;
  3409. shippingMethods: ShippingMethodList;
  3410. shippingMethod?: Maybe<ShippingMethod>;
  3411. shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  3412. shippingCalculators: Array<ConfigurableOperationDefinition>;
  3413. fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
  3414. testShippingMethod: TestShippingMethodResult;
  3415. testEligibleShippingMethods: Array<ShippingMethodQuote>;
  3416. tag: Tag;
  3417. tags: TagList;
  3418. taxCategories: Array<TaxCategory>;
  3419. taxCategory?: Maybe<TaxCategory>;
  3420. taxRates: TaxRateList;
  3421. taxRate?: Maybe<TaxRate>;
  3422. zones: Array<Zone>;
  3423. zone?: Maybe<Zone>;
  3424. };
  3425. export type QueryAdministratorsArgs = {
  3426. options?: Maybe<AdministratorListOptions>;
  3427. };
  3428. export type QueryAdministratorArgs = {
  3429. id: Scalars['ID'];
  3430. };
  3431. export type QueryAssetsArgs = {
  3432. options?: Maybe<AssetListOptions>;
  3433. };
  3434. export type QueryAssetArgs = {
  3435. id: Scalars['ID'];
  3436. };
  3437. export type QueryChannelArgs = {
  3438. id: Scalars['ID'];
  3439. };
  3440. export type QueryCollectionsArgs = {
  3441. options?: Maybe<CollectionListOptions>;
  3442. };
  3443. export type QueryCollectionArgs = {
  3444. id?: Maybe<Scalars['ID']>;
  3445. slug?: Maybe<Scalars['String']>;
  3446. };
  3447. export type QueryCountriesArgs = {
  3448. options?: Maybe<CountryListOptions>;
  3449. };
  3450. export type QueryCountryArgs = {
  3451. id: Scalars['ID'];
  3452. };
  3453. export type QueryCustomerGroupsArgs = {
  3454. options?: Maybe<CustomerGroupListOptions>;
  3455. };
  3456. export type QueryCustomerGroupArgs = {
  3457. id: Scalars['ID'];
  3458. };
  3459. export type QueryCustomersArgs = {
  3460. options?: Maybe<CustomerListOptions>;
  3461. };
  3462. export type QueryCustomerArgs = {
  3463. id: Scalars['ID'];
  3464. };
  3465. export type QueryFacetsArgs = {
  3466. options?: Maybe<FacetListOptions>;
  3467. };
  3468. export type QueryFacetArgs = {
  3469. id: Scalars['ID'];
  3470. };
  3471. export type QueryJobArgs = {
  3472. jobId: Scalars['ID'];
  3473. };
  3474. export type QueryJobsArgs = {
  3475. options?: Maybe<JobListOptions>;
  3476. };
  3477. export type QueryJobsByIdArgs = {
  3478. jobIds: Array<Scalars['ID']>;
  3479. };
  3480. export type QueryOrderArgs = {
  3481. id: Scalars['ID'];
  3482. };
  3483. export type QueryOrdersArgs = {
  3484. options?: Maybe<OrderListOptions>;
  3485. };
  3486. export type QueryPaymentMethodsArgs = {
  3487. options?: Maybe<PaymentMethodListOptions>;
  3488. };
  3489. export type QueryPaymentMethodArgs = {
  3490. id: Scalars['ID'];
  3491. };
  3492. export type QueryProductOptionGroupsArgs = {
  3493. filterTerm?: Maybe<Scalars['String']>;
  3494. };
  3495. export type QueryProductOptionGroupArgs = {
  3496. id: Scalars['ID'];
  3497. };
  3498. export type QuerySearchArgs = {
  3499. input: SearchInput;
  3500. };
  3501. export type QueryProductsArgs = {
  3502. options?: Maybe<ProductListOptions>;
  3503. };
  3504. export type QueryProductArgs = {
  3505. id?: Maybe<Scalars['ID']>;
  3506. slug?: Maybe<Scalars['String']>;
  3507. };
  3508. export type QueryProductVariantsArgs = {
  3509. options?: Maybe<ProductVariantListOptions>;
  3510. productId?: Maybe<Scalars['ID']>;
  3511. };
  3512. export type QueryProductVariantArgs = {
  3513. id: Scalars['ID'];
  3514. };
  3515. export type QueryPromotionArgs = {
  3516. id: Scalars['ID'];
  3517. };
  3518. export type QueryPromotionsArgs = {
  3519. options?: Maybe<PromotionListOptions>;
  3520. };
  3521. export type QueryRolesArgs = {
  3522. options?: Maybe<RoleListOptions>;
  3523. };
  3524. export type QueryRoleArgs = {
  3525. id: Scalars['ID'];
  3526. };
  3527. export type QueryShippingMethodsArgs = {
  3528. options?: Maybe<ShippingMethodListOptions>;
  3529. };
  3530. export type QueryShippingMethodArgs = {
  3531. id: Scalars['ID'];
  3532. };
  3533. export type QueryTestShippingMethodArgs = {
  3534. input: TestShippingMethodInput;
  3535. };
  3536. export type QueryTestEligibleShippingMethodsArgs = {
  3537. input: TestEligibleShippingMethodsInput;
  3538. };
  3539. export type QueryTagArgs = {
  3540. id: Scalars['ID'];
  3541. };
  3542. export type QueryTagsArgs = {
  3543. options?: Maybe<TagListOptions>;
  3544. };
  3545. export type QueryTaxCategoryArgs = {
  3546. id: Scalars['ID'];
  3547. };
  3548. export type QueryTaxRatesArgs = {
  3549. options?: Maybe<TaxRateListOptions>;
  3550. };
  3551. export type QueryTaxRateArgs = {
  3552. id: Scalars['ID'];
  3553. };
  3554. export type QueryZoneArgs = {
  3555. id: Scalars['ID'];
  3556. };
  3557. export type Refund = Node & {
  3558. __typename?: 'Refund';
  3559. id: Scalars['ID'];
  3560. createdAt: Scalars['DateTime'];
  3561. updatedAt: Scalars['DateTime'];
  3562. items: Scalars['Int'];
  3563. shipping: Scalars['Int'];
  3564. adjustment: Scalars['Int'];
  3565. total: Scalars['Int'];
  3566. method?: Maybe<Scalars['String']>;
  3567. state: Scalars['String'];
  3568. transactionId?: Maybe<Scalars['String']>;
  3569. reason?: Maybe<Scalars['String']>;
  3570. orderItems: Array<OrderItem>;
  3571. paymentId: Scalars['ID'];
  3572. metadata?: Maybe<Scalars['JSON']>;
  3573. };
  3574. export type RefundOrderInput = {
  3575. lines: Array<OrderLineInput>;
  3576. shipping: Scalars['Int'];
  3577. adjustment: Scalars['Int'];
  3578. paymentId: Scalars['ID'];
  3579. reason?: Maybe<Scalars['String']>;
  3580. };
  3581. export type RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError;
  3582. /** Returned if an attempting to refund an Order which is not in the expected state */
  3583. export type RefundOrderStateError = ErrorResult & {
  3584. __typename?: 'RefundOrderStateError';
  3585. errorCode: ErrorCode;
  3586. message: Scalars['String'];
  3587. orderState: Scalars['String'];
  3588. };
  3589. /**
  3590. * Returned when a call to modifyOrder fails to include a refundPaymentId even
  3591. * though the price has decreased as a result of the changes.
  3592. */
  3593. export type RefundPaymentIdMissingError = ErrorResult & {
  3594. __typename?: 'RefundPaymentIdMissingError';
  3595. errorCode: ErrorCode;
  3596. message: Scalars['String'];
  3597. };
  3598. /** Returned when there is an error in transitioning the Refund state */
  3599. export type RefundStateTransitionError = ErrorResult & {
  3600. __typename?: 'RefundStateTransitionError';
  3601. errorCode: ErrorCode;
  3602. message: Scalars['String'];
  3603. transitionError: Scalars['String'];
  3604. fromState: Scalars['String'];
  3605. toState: Scalars['String'];
  3606. };
  3607. export type RelationCustomFieldConfig = CustomField & {
  3608. __typename?: 'RelationCustomFieldConfig';
  3609. name: Scalars['String'];
  3610. type: Scalars['String'];
  3611. list: Scalars['Boolean'];
  3612. label?: Maybe<Array<LocalizedString>>;
  3613. description?: Maybe<Array<LocalizedString>>;
  3614. readonly?: Maybe<Scalars['Boolean']>;
  3615. internal?: Maybe<Scalars['Boolean']>;
  3616. entity: Scalars['String'];
  3617. scalarFields: Array<Scalars['String']>;
  3618. };
  3619. export type Release = Node & StockMovement & {
  3620. __typename?: 'Release';
  3621. id: Scalars['ID'];
  3622. createdAt: Scalars['DateTime'];
  3623. updatedAt: Scalars['DateTime'];
  3624. productVariant: ProductVariant;
  3625. type: StockMovementType;
  3626. quantity: Scalars['Int'];
  3627. orderItem: OrderItem;
  3628. };
  3629. export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
  3630. export type RemoveProductVariantsFromChannelInput = {
  3631. productVariantIds: Array<Scalars['ID']>;
  3632. channelId: Scalars['ID'];
  3633. };
  3634. export type RemoveProductsFromChannelInput = {
  3635. productIds: Array<Scalars['ID']>;
  3636. channelId: Scalars['ID'];
  3637. };
  3638. export type RemovePromotionsFromChannelInput = {
  3639. promotionIds: Array<Scalars['ID']>;
  3640. channelId: Scalars['ID'];
  3641. };
  3642. export type Return = Node & StockMovement & {
  3643. __typename?: 'Return';
  3644. id: Scalars['ID'];
  3645. createdAt: Scalars['DateTime'];
  3646. updatedAt: Scalars['DateTime'];
  3647. productVariant: ProductVariant;
  3648. type: StockMovementType;
  3649. quantity: Scalars['Int'];
  3650. orderItem: OrderItem;
  3651. };
  3652. export type Role = Node & {
  3653. __typename?: 'Role';
  3654. id: Scalars['ID'];
  3655. createdAt: Scalars['DateTime'];
  3656. updatedAt: Scalars['DateTime'];
  3657. code: Scalars['String'];
  3658. description: Scalars['String'];
  3659. permissions: Array<Permission>;
  3660. channels: Array<Channel>;
  3661. };
  3662. export type RoleFilterParameter = {
  3663. createdAt?: Maybe<DateOperators>;
  3664. updatedAt?: Maybe<DateOperators>;
  3665. code?: Maybe<StringOperators>;
  3666. description?: Maybe<StringOperators>;
  3667. };
  3668. export type RoleList = PaginatedList & {
  3669. __typename?: 'RoleList';
  3670. items: Array<Role>;
  3671. totalItems: Scalars['Int'];
  3672. };
  3673. export type RoleListOptions = {
  3674. skip?: Maybe<Scalars['Int']>;
  3675. take?: Maybe<Scalars['Int']>;
  3676. sort?: Maybe<RoleSortParameter>;
  3677. filter?: Maybe<RoleFilterParameter>;
  3678. };
  3679. export type RoleSortParameter = {
  3680. id?: Maybe<SortOrder>;
  3681. createdAt?: Maybe<SortOrder>;
  3682. updatedAt?: Maybe<SortOrder>;
  3683. code?: Maybe<SortOrder>;
  3684. description?: Maybe<SortOrder>;
  3685. };
  3686. export type Sale = Node & StockMovement & {
  3687. __typename?: 'Sale';
  3688. id: Scalars['ID'];
  3689. createdAt: Scalars['DateTime'];
  3690. updatedAt: Scalars['DateTime'];
  3691. productVariant: ProductVariant;
  3692. type: StockMovementType;
  3693. quantity: Scalars['Int'];
  3694. orderItem: OrderItem;
  3695. };
  3696. export type SearchInput = {
  3697. term?: Maybe<Scalars['String']>;
  3698. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  3699. facetValueOperator?: Maybe<LogicalOperator>;
  3700. facetValueFilters?: Maybe<Array<FacetValueFilterInput>>;
  3701. collectionId?: Maybe<Scalars['ID']>;
  3702. collectionSlug?: Maybe<Scalars['String']>;
  3703. groupByProduct?: Maybe<Scalars['Boolean']>;
  3704. take?: Maybe<Scalars['Int']>;
  3705. skip?: Maybe<Scalars['Int']>;
  3706. sort?: Maybe<SearchResultSortParameter>;
  3707. };
  3708. export type SearchReindexResponse = {
  3709. __typename?: 'SearchReindexResponse';
  3710. success: Scalars['Boolean'];
  3711. };
  3712. export type SearchResponse = {
  3713. __typename?: 'SearchResponse';
  3714. items: Array<SearchResult>;
  3715. totalItems: Scalars['Int'];
  3716. facetValues: Array<FacetValueResult>;
  3717. collections: Array<CollectionResult>;
  3718. };
  3719. export type SearchResult = {
  3720. __typename?: 'SearchResult';
  3721. enabled: Scalars['Boolean'];
  3722. /** An array of ids of the Channels in which this result appears */
  3723. channelIds: Array<Scalars['ID']>;
  3724. sku: Scalars['String'];
  3725. slug: Scalars['String'];
  3726. productId: Scalars['ID'];
  3727. productName: Scalars['String'];
  3728. productAsset?: Maybe<SearchResultAsset>;
  3729. productVariantId: Scalars['ID'];
  3730. productVariantName: Scalars['String'];
  3731. productVariantAsset?: Maybe<SearchResultAsset>;
  3732. price: SearchResultPrice;
  3733. priceWithTax: SearchResultPrice;
  3734. currencyCode: CurrencyCode;
  3735. description: Scalars['String'];
  3736. facetIds: Array<Scalars['ID']>;
  3737. facetValueIds: Array<Scalars['ID']>;
  3738. /** An array of ids of the Collections in which this result appears */
  3739. collectionIds: Array<Scalars['ID']>;
  3740. /** A relevence score for the result. Differs between database implementations */
  3741. score: Scalars['Float'];
  3742. };
  3743. export type SearchResultAsset = {
  3744. __typename?: 'SearchResultAsset';
  3745. id: Scalars['ID'];
  3746. preview: Scalars['String'];
  3747. focalPoint?: Maybe<Coordinate>;
  3748. };
  3749. /** The price of a search result product, either as a range or as a single price */
  3750. export type SearchResultPrice = PriceRange | SinglePrice;
  3751. export type SearchResultSortParameter = {
  3752. name?: Maybe<SortOrder>;
  3753. price?: Maybe<SortOrder>;
  3754. };
  3755. export type ServerConfig = {
  3756. __typename?: 'ServerConfig';
  3757. orderProcess: Array<OrderProcessState>;
  3758. permittedAssetTypes: Array<Scalars['String']>;
  3759. permissions: Array<PermissionDefinition>;
  3760. customFieldConfig: CustomFields;
  3761. };
  3762. /** Returned if the Payment settlement fails */
  3763. export type SettlePaymentError = ErrorResult & {
  3764. __typename?: 'SettlePaymentError';
  3765. errorCode: ErrorCode;
  3766. message: Scalars['String'];
  3767. paymentErrorMessage: Scalars['String'];
  3768. };
  3769. export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError;
  3770. export type SettleRefundInput = {
  3771. id: Scalars['ID'];
  3772. transactionId: Scalars['String'];
  3773. };
  3774. export type SettleRefundResult = Refund | RefundStateTransitionError;
  3775. export type ShippingLine = {
  3776. __typename?: 'ShippingLine';
  3777. shippingMethod: ShippingMethod;
  3778. price: Scalars['Int'];
  3779. priceWithTax: Scalars['Int'];
  3780. discountedPrice: Scalars['Int'];
  3781. discountedPriceWithTax: Scalars['Int'];
  3782. discounts: Array<Discount>;
  3783. };
  3784. export type ShippingMethod = Node & {
  3785. __typename?: 'ShippingMethod';
  3786. id: Scalars['ID'];
  3787. createdAt: Scalars['DateTime'];
  3788. updatedAt: Scalars['DateTime'];
  3789. code: Scalars['String'];
  3790. name: Scalars['String'];
  3791. description: Scalars['String'];
  3792. fulfillmentHandlerCode: Scalars['String'];
  3793. checker: ConfigurableOperation;
  3794. calculator: ConfigurableOperation;
  3795. translations: Array<ShippingMethodTranslation>;
  3796. customFields?: Maybe<Scalars['JSON']>;
  3797. };
  3798. export type ShippingMethodFilterParameter = {
  3799. createdAt?: Maybe<DateOperators>;
  3800. updatedAt?: Maybe<DateOperators>;
  3801. code?: Maybe<StringOperators>;
  3802. name?: Maybe<StringOperators>;
  3803. description?: Maybe<StringOperators>;
  3804. fulfillmentHandlerCode?: Maybe<StringOperators>;
  3805. };
  3806. export type ShippingMethodList = PaginatedList & {
  3807. __typename?: 'ShippingMethodList';
  3808. items: Array<ShippingMethod>;
  3809. totalItems: Scalars['Int'];
  3810. };
  3811. export type ShippingMethodListOptions = {
  3812. skip?: Maybe<Scalars['Int']>;
  3813. take?: Maybe<Scalars['Int']>;
  3814. sort?: Maybe<ShippingMethodSortParameter>;
  3815. filter?: Maybe<ShippingMethodFilterParameter>;
  3816. };
  3817. export type ShippingMethodQuote = {
  3818. __typename?: 'ShippingMethodQuote';
  3819. id: Scalars['ID'];
  3820. price: Scalars['Int'];
  3821. priceWithTax: Scalars['Int'];
  3822. code: Scalars['String'];
  3823. name: Scalars['String'];
  3824. description: Scalars['String'];
  3825. /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
  3826. metadata?: Maybe<Scalars['JSON']>;
  3827. };
  3828. export type ShippingMethodSortParameter = {
  3829. id?: Maybe<SortOrder>;
  3830. createdAt?: Maybe<SortOrder>;
  3831. updatedAt?: Maybe<SortOrder>;
  3832. code?: Maybe<SortOrder>;
  3833. name?: Maybe<SortOrder>;
  3834. description?: Maybe<SortOrder>;
  3835. fulfillmentHandlerCode?: Maybe<SortOrder>;
  3836. };
  3837. export type ShippingMethodTranslation = {
  3838. __typename?: 'ShippingMethodTranslation';
  3839. id: Scalars['ID'];
  3840. createdAt: Scalars['DateTime'];
  3841. updatedAt: Scalars['DateTime'];
  3842. languageCode: LanguageCode;
  3843. name: Scalars['String'];
  3844. description: Scalars['String'];
  3845. };
  3846. export type ShippingMethodTranslationInput = {
  3847. id?: Maybe<Scalars['ID']>;
  3848. languageCode: LanguageCode;
  3849. name?: Maybe<Scalars['String']>;
  3850. description?: Maybe<Scalars['String']>;
  3851. customFields?: Maybe<Scalars['JSON']>;
  3852. };
  3853. /** The price value where the result has a single price */
  3854. export type SinglePrice = {
  3855. __typename?: 'SinglePrice';
  3856. value: Scalars['Int'];
  3857. };
  3858. export enum SortOrder {
  3859. ASC = 'ASC',
  3860. DESC = 'DESC'
  3861. }
  3862. export type StockAdjustment = Node & StockMovement & {
  3863. __typename?: 'StockAdjustment';
  3864. id: Scalars['ID'];
  3865. createdAt: Scalars['DateTime'];
  3866. updatedAt: Scalars['DateTime'];
  3867. productVariant: ProductVariant;
  3868. type: StockMovementType;
  3869. quantity: Scalars['Int'];
  3870. };
  3871. export type StockMovement = {
  3872. id: Scalars['ID'];
  3873. createdAt: Scalars['DateTime'];
  3874. updatedAt: Scalars['DateTime'];
  3875. productVariant: ProductVariant;
  3876. type: StockMovementType;
  3877. quantity: Scalars['Int'];
  3878. };
  3879. export type StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release;
  3880. export type StockMovementList = {
  3881. __typename?: 'StockMovementList';
  3882. items: Array<StockMovementItem>;
  3883. totalItems: Scalars['Int'];
  3884. };
  3885. export type StockMovementListOptions = {
  3886. type?: Maybe<StockMovementType>;
  3887. skip?: Maybe<Scalars['Int']>;
  3888. take?: Maybe<Scalars['Int']>;
  3889. };
  3890. export enum StockMovementType {
  3891. ADJUSTMENT = 'ADJUSTMENT',
  3892. ALLOCATION = 'ALLOCATION',
  3893. RELEASE = 'RELEASE',
  3894. SALE = 'SALE',
  3895. CANCELLATION = 'CANCELLATION',
  3896. RETURN = 'RETURN'
  3897. }
  3898. export type StringCustomFieldConfig = CustomField & {
  3899. __typename?: 'StringCustomFieldConfig';
  3900. name: Scalars['String'];
  3901. type: Scalars['String'];
  3902. list: Scalars['Boolean'];
  3903. length?: Maybe<Scalars['Int']>;
  3904. label?: Maybe<Array<LocalizedString>>;
  3905. description?: Maybe<Array<LocalizedString>>;
  3906. readonly?: Maybe<Scalars['Boolean']>;
  3907. internal?: Maybe<Scalars['Boolean']>;
  3908. pattern?: Maybe<Scalars['String']>;
  3909. options?: Maybe<Array<StringFieldOption>>;
  3910. };
  3911. export type StringFieldOption = {
  3912. __typename?: 'StringFieldOption';
  3913. value: Scalars['String'];
  3914. label?: Maybe<Array<LocalizedString>>;
  3915. };
  3916. export type StringOperators = {
  3917. eq?: Maybe<Scalars['String']>;
  3918. notEq?: Maybe<Scalars['String']>;
  3919. contains?: Maybe<Scalars['String']>;
  3920. notContains?: Maybe<Scalars['String']>;
  3921. in?: Maybe<Array<Scalars['String']>>;
  3922. notIn?: Maybe<Array<Scalars['String']>>;
  3923. regex?: Maybe<Scalars['String']>;
  3924. };
  3925. /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
  3926. export type Success = {
  3927. __typename?: 'Success';
  3928. success: Scalars['Boolean'];
  3929. };
  3930. export type Surcharge = Node & {
  3931. __typename?: 'Surcharge';
  3932. id: Scalars['ID'];
  3933. createdAt: Scalars['DateTime'];
  3934. updatedAt: Scalars['DateTime'];
  3935. description: Scalars['String'];
  3936. sku?: Maybe<Scalars['String']>;
  3937. taxLines: Array<TaxLine>;
  3938. price: Scalars['Int'];
  3939. priceWithTax: Scalars['Int'];
  3940. taxRate: Scalars['Float'];
  3941. };
  3942. export type SurchargeInput = {
  3943. description: Scalars['String'];
  3944. sku?: Maybe<Scalars['String']>;
  3945. price: Scalars['Int'];
  3946. priceIncludesTax: Scalars['Boolean'];
  3947. taxRate?: Maybe<Scalars['Float']>;
  3948. taxDescription?: Maybe<Scalars['String']>;
  3949. };
  3950. export type Tag = Node & {
  3951. __typename?: 'Tag';
  3952. id: Scalars['ID'];
  3953. createdAt: Scalars['DateTime'];
  3954. updatedAt: Scalars['DateTime'];
  3955. value: Scalars['String'];
  3956. };
  3957. export type TagFilterParameter = {
  3958. createdAt?: Maybe<DateOperators>;
  3959. updatedAt?: Maybe<DateOperators>;
  3960. value?: Maybe<StringOperators>;
  3961. };
  3962. export type TagList = PaginatedList & {
  3963. __typename?: 'TagList';
  3964. items: Array<Tag>;
  3965. totalItems: Scalars['Int'];
  3966. };
  3967. export type TagListOptions = {
  3968. skip?: Maybe<Scalars['Int']>;
  3969. take?: Maybe<Scalars['Int']>;
  3970. sort?: Maybe<TagSortParameter>;
  3971. filter?: Maybe<TagFilterParameter>;
  3972. };
  3973. export type TagSortParameter = {
  3974. id?: Maybe<SortOrder>;
  3975. createdAt?: Maybe<SortOrder>;
  3976. updatedAt?: Maybe<SortOrder>;
  3977. value?: Maybe<SortOrder>;
  3978. };
  3979. export type TaxCategory = Node & {
  3980. __typename?: 'TaxCategory';
  3981. id: Scalars['ID'];
  3982. createdAt: Scalars['DateTime'];
  3983. updatedAt: Scalars['DateTime'];
  3984. name: Scalars['String'];
  3985. isDefault: Scalars['Boolean'];
  3986. };
  3987. export type TaxLine = {
  3988. __typename?: 'TaxLine';
  3989. description: Scalars['String'];
  3990. taxRate: Scalars['Float'];
  3991. };
  3992. export type TaxRate = Node & {
  3993. __typename?: 'TaxRate';
  3994. id: Scalars['ID'];
  3995. createdAt: Scalars['DateTime'];
  3996. updatedAt: Scalars['DateTime'];
  3997. name: Scalars['String'];
  3998. enabled: Scalars['Boolean'];
  3999. value: Scalars['Float'];
  4000. category: TaxCategory;
  4001. zone: Zone;
  4002. customerGroup?: Maybe<CustomerGroup>;
  4003. };
  4004. export type TaxRateFilterParameter = {
  4005. createdAt?: Maybe<DateOperators>;
  4006. updatedAt?: Maybe<DateOperators>;
  4007. name?: Maybe<StringOperators>;
  4008. enabled?: Maybe<BooleanOperators>;
  4009. value?: Maybe<NumberOperators>;
  4010. };
  4011. export type TaxRateList = PaginatedList & {
  4012. __typename?: 'TaxRateList';
  4013. items: Array<TaxRate>;
  4014. totalItems: Scalars['Int'];
  4015. };
  4016. export type TaxRateListOptions = {
  4017. skip?: Maybe<Scalars['Int']>;
  4018. take?: Maybe<Scalars['Int']>;
  4019. sort?: Maybe<TaxRateSortParameter>;
  4020. filter?: Maybe<TaxRateFilterParameter>;
  4021. };
  4022. export type TaxRateSortParameter = {
  4023. id?: Maybe<SortOrder>;
  4024. createdAt?: Maybe<SortOrder>;
  4025. updatedAt?: Maybe<SortOrder>;
  4026. name?: Maybe<SortOrder>;
  4027. value?: Maybe<SortOrder>;
  4028. };
  4029. export type TestEligibleShippingMethodsInput = {
  4030. shippingAddress: CreateAddressInput;
  4031. lines: Array<TestShippingMethodOrderLineInput>;
  4032. };
  4033. export type TestShippingMethodInput = {
  4034. checker: ConfigurableOperationInput;
  4035. calculator: ConfigurableOperationInput;
  4036. shippingAddress: CreateAddressInput;
  4037. lines: Array<TestShippingMethodOrderLineInput>;
  4038. };
  4039. export type TestShippingMethodOrderLineInput = {
  4040. productVariantId: Scalars['ID'];
  4041. quantity: Scalars['Int'];
  4042. };
  4043. export type TestShippingMethodQuote = {
  4044. __typename?: 'TestShippingMethodQuote';
  4045. price: Scalars['Int'];
  4046. priceWithTax: Scalars['Int'];
  4047. metadata?: Maybe<Scalars['JSON']>;
  4048. };
  4049. export type TestShippingMethodResult = {
  4050. __typename?: 'TestShippingMethodResult';
  4051. eligible: Scalars['Boolean'];
  4052. quote?: Maybe<TestShippingMethodQuote>;
  4053. };
  4054. export type TextCustomFieldConfig = CustomField & {
  4055. __typename?: 'TextCustomFieldConfig';
  4056. name: Scalars['String'];
  4057. type: Scalars['String'];
  4058. list: Scalars['Boolean'];
  4059. label?: Maybe<Array<LocalizedString>>;
  4060. description?: Maybe<Array<LocalizedString>>;
  4061. readonly?: Maybe<Scalars['Boolean']>;
  4062. internal?: Maybe<Scalars['Boolean']>;
  4063. };
  4064. export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
  4065. export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
  4066. export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
  4067. export type UpdateActiveAdministratorInput = {
  4068. firstName?: Maybe<Scalars['String']>;
  4069. lastName?: Maybe<Scalars['String']>;
  4070. emailAddress?: Maybe<Scalars['String']>;
  4071. password?: Maybe<Scalars['String']>;
  4072. customFields?: Maybe<Scalars['JSON']>;
  4073. };
  4074. export type UpdateAddressInput = {
  4075. id: Scalars['ID'];
  4076. fullName?: Maybe<Scalars['String']>;
  4077. company?: Maybe<Scalars['String']>;
  4078. streetLine1?: Maybe<Scalars['String']>;
  4079. streetLine2?: Maybe<Scalars['String']>;
  4080. city?: Maybe<Scalars['String']>;
  4081. province?: Maybe<Scalars['String']>;
  4082. postalCode?: Maybe<Scalars['String']>;
  4083. countryCode?: Maybe<Scalars['String']>;
  4084. phoneNumber?: Maybe<Scalars['String']>;
  4085. defaultShippingAddress?: Maybe<Scalars['Boolean']>;
  4086. defaultBillingAddress?: Maybe<Scalars['Boolean']>;
  4087. customFields?: Maybe<Scalars['JSON']>;
  4088. };
  4089. export type UpdateAdministratorInput = {
  4090. id: Scalars['ID'];
  4091. firstName?: Maybe<Scalars['String']>;
  4092. lastName?: Maybe<Scalars['String']>;
  4093. emailAddress?: Maybe<Scalars['String']>;
  4094. password?: Maybe<Scalars['String']>;
  4095. roleIds?: Maybe<Array<Scalars['ID']>>;
  4096. customFields?: Maybe<Scalars['JSON']>;
  4097. };
  4098. export type UpdateAssetInput = {
  4099. id: Scalars['ID'];
  4100. name?: Maybe<Scalars['String']>;
  4101. focalPoint?: Maybe<CoordinateInput>;
  4102. tags?: Maybe<Array<Scalars['String']>>;
  4103. customFields?: Maybe<Scalars['JSON']>;
  4104. };
  4105. export type UpdateChannelInput = {
  4106. id: Scalars['ID'];
  4107. code?: Maybe<Scalars['String']>;
  4108. token?: Maybe<Scalars['String']>;
  4109. defaultLanguageCode?: Maybe<LanguageCode>;
  4110. pricesIncludeTax?: Maybe<Scalars['Boolean']>;
  4111. currencyCode?: Maybe<CurrencyCode>;
  4112. defaultTaxZoneId?: Maybe<Scalars['ID']>;
  4113. defaultShippingZoneId?: Maybe<Scalars['ID']>;
  4114. customFields?: Maybe<Scalars['JSON']>;
  4115. };
  4116. export type UpdateChannelResult = Channel | LanguageNotAvailableError;
  4117. export type UpdateCollectionInput = {
  4118. id: Scalars['ID'];
  4119. isPrivate?: Maybe<Scalars['Boolean']>;
  4120. featuredAssetId?: Maybe<Scalars['ID']>;
  4121. parentId?: Maybe<Scalars['ID']>;
  4122. assetIds?: Maybe<Array<Scalars['ID']>>;
  4123. filters?: Maybe<Array<ConfigurableOperationInput>>;
  4124. translations?: Maybe<Array<UpdateCollectionTranslationInput>>;
  4125. customFields?: Maybe<Scalars['JSON']>;
  4126. };
  4127. export type UpdateCollectionTranslationInput = {
  4128. id?: Maybe<Scalars['ID']>;
  4129. languageCode: LanguageCode;
  4130. name?: Maybe<Scalars['String']>;
  4131. slug?: Maybe<Scalars['String']>;
  4132. description?: Maybe<Scalars['String']>;
  4133. customFields?: Maybe<Scalars['JSON']>;
  4134. };
  4135. export type UpdateCountryInput = {
  4136. id: Scalars['ID'];
  4137. code?: Maybe<Scalars['String']>;
  4138. translations?: Maybe<Array<CountryTranslationInput>>;
  4139. enabled?: Maybe<Scalars['Boolean']>;
  4140. };
  4141. export type UpdateCustomerGroupInput = {
  4142. id: Scalars['ID'];
  4143. name?: Maybe<Scalars['String']>;
  4144. };
  4145. export type UpdateCustomerInput = {
  4146. id: Scalars['ID'];
  4147. title?: Maybe<Scalars['String']>;
  4148. firstName?: Maybe<Scalars['String']>;
  4149. lastName?: Maybe<Scalars['String']>;
  4150. phoneNumber?: Maybe<Scalars['String']>;
  4151. emailAddress?: Maybe<Scalars['String']>;
  4152. customFields?: Maybe<Scalars['JSON']>;
  4153. };
  4154. export type UpdateCustomerNoteInput = {
  4155. noteId: Scalars['ID'];
  4156. note: Scalars['String'];
  4157. };
  4158. export type UpdateCustomerResult = Customer | EmailAddressConflictError;
  4159. export type UpdateFacetInput = {
  4160. id: Scalars['ID'];
  4161. isPrivate?: Maybe<Scalars['Boolean']>;
  4162. code?: Maybe<Scalars['String']>;
  4163. translations?: Maybe<Array<FacetTranslationInput>>;
  4164. customFields?: Maybe<Scalars['JSON']>;
  4165. };
  4166. export type UpdateFacetValueInput = {
  4167. id: Scalars['ID'];
  4168. code?: Maybe<Scalars['String']>;
  4169. translations?: Maybe<Array<FacetValueTranslationInput>>;
  4170. customFields?: Maybe<Scalars['JSON']>;
  4171. };
  4172. export type UpdateGlobalSettingsInput = {
  4173. availableLanguages?: Maybe<Array<LanguageCode>>;
  4174. trackInventory?: Maybe<Scalars['Boolean']>;
  4175. outOfStockThreshold?: Maybe<Scalars['Int']>;
  4176. customFields?: Maybe<Scalars['JSON']>;
  4177. };
  4178. export type UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError;
  4179. export type UpdateOrderAddressInput = {
  4180. fullName?: Maybe<Scalars['String']>;
  4181. company?: Maybe<Scalars['String']>;
  4182. streetLine1?: Maybe<Scalars['String']>;
  4183. streetLine2?: Maybe<Scalars['String']>;
  4184. city?: Maybe<Scalars['String']>;
  4185. province?: Maybe<Scalars['String']>;
  4186. postalCode?: Maybe<Scalars['String']>;
  4187. countryCode?: Maybe<Scalars['String']>;
  4188. phoneNumber?: Maybe<Scalars['String']>;
  4189. };
  4190. export type UpdateOrderInput = {
  4191. id: Scalars['ID'];
  4192. customFields?: Maybe<Scalars['JSON']>;
  4193. };
  4194. export type UpdateOrderNoteInput = {
  4195. noteId: Scalars['ID'];
  4196. note?: Maybe<Scalars['String']>;
  4197. isPublic?: Maybe<Scalars['Boolean']>;
  4198. };
  4199. export type UpdatePaymentMethodInput = {
  4200. id: Scalars['ID'];
  4201. name?: Maybe<Scalars['String']>;
  4202. code?: Maybe<Scalars['String']>;
  4203. description?: Maybe<Scalars['String']>;
  4204. enabled?: Maybe<Scalars['Boolean']>;
  4205. checker?: Maybe<ConfigurableOperationInput>;
  4206. handler?: Maybe<ConfigurableOperationInput>;
  4207. };
  4208. export type UpdateProductInput = {
  4209. id: Scalars['ID'];
  4210. enabled?: Maybe<Scalars['Boolean']>;
  4211. featuredAssetId?: Maybe<Scalars['ID']>;
  4212. assetIds?: Maybe<Array<Scalars['ID']>>;
  4213. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  4214. translations?: Maybe<Array<ProductTranslationInput>>;
  4215. customFields?: Maybe<Scalars['JSON']>;
  4216. };
  4217. export type UpdateProductOptionGroupInput = {
  4218. id: Scalars['ID'];
  4219. code?: Maybe<Scalars['String']>;
  4220. translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
  4221. customFields?: Maybe<Scalars['JSON']>;
  4222. };
  4223. export type UpdateProductOptionInput = {
  4224. id: Scalars['ID'];
  4225. code?: Maybe<Scalars['String']>;
  4226. translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
  4227. customFields?: Maybe<Scalars['JSON']>;
  4228. };
  4229. export type UpdateProductVariantInput = {
  4230. id: Scalars['ID'];
  4231. enabled?: Maybe<Scalars['Boolean']>;
  4232. translations?: Maybe<Array<ProductVariantTranslationInput>>;
  4233. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  4234. sku?: Maybe<Scalars['String']>;
  4235. taxCategoryId?: Maybe<Scalars['ID']>;
  4236. price?: Maybe<Scalars['Int']>;
  4237. featuredAssetId?: Maybe<Scalars['ID']>;
  4238. assetIds?: Maybe<Array<Scalars['ID']>>;
  4239. stockOnHand?: Maybe<Scalars['Int']>;
  4240. outOfStockThreshold?: Maybe<Scalars['Int']>;
  4241. useGlobalOutOfStockThreshold?: Maybe<Scalars['Boolean']>;
  4242. trackInventory?: Maybe<GlobalFlag>;
  4243. customFields?: Maybe<Scalars['JSON']>;
  4244. };
  4245. export type UpdatePromotionInput = {
  4246. id: Scalars['ID'];
  4247. name?: Maybe<Scalars['String']>;
  4248. enabled?: Maybe<Scalars['Boolean']>;
  4249. startsAt?: Maybe<Scalars['DateTime']>;
  4250. endsAt?: Maybe<Scalars['DateTime']>;
  4251. couponCode?: Maybe<Scalars['String']>;
  4252. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  4253. conditions?: Maybe<Array<ConfigurableOperationInput>>;
  4254. actions?: Maybe<Array<ConfigurableOperationInput>>;
  4255. };
  4256. export type UpdatePromotionResult = Promotion | MissingConditionsError;
  4257. export type UpdateRoleInput = {
  4258. id: Scalars['ID'];
  4259. code?: Maybe<Scalars['String']>;
  4260. description?: Maybe<Scalars['String']>;
  4261. permissions?: Maybe<Array<Permission>>;
  4262. channelIds?: Maybe<Array<Scalars['ID']>>;
  4263. };
  4264. export type UpdateShippingMethodInput = {
  4265. id: Scalars['ID'];
  4266. code?: Maybe<Scalars['String']>;
  4267. fulfillmentHandler?: Maybe<Scalars['String']>;
  4268. checker?: Maybe<ConfigurableOperationInput>;
  4269. calculator?: Maybe<ConfigurableOperationInput>;
  4270. translations: Array<ShippingMethodTranslationInput>;
  4271. customFields?: Maybe<Scalars['JSON']>;
  4272. };
  4273. export type UpdateTagInput = {
  4274. id: Scalars['ID'];
  4275. value?: Maybe<Scalars['String']>;
  4276. };
  4277. export type UpdateTaxCategoryInput = {
  4278. id: Scalars['ID'];
  4279. name?: Maybe<Scalars['String']>;
  4280. isDefault?: Maybe<Scalars['Boolean']>;
  4281. };
  4282. export type UpdateTaxRateInput = {
  4283. id: Scalars['ID'];
  4284. name?: Maybe<Scalars['String']>;
  4285. value?: Maybe<Scalars['Float']>;
  4286. enabled?: Maybe<Scalars['Boolean']>;
  4287. categoryId?: Maybe<Scalars['ID']>;
  4288. zoneId?: Maybe<Scalars['ID']>;
  4289. customerGroupId?: Maybe<Scalars['ID']>;
  4290. };
  4291. export type UpdateZoneInput = {
  4292. id: Scalars['ID'];
  4293. name?: Maybe<Scalars['String']>;
  4294. };
  4295. export type User = Node & {
  4296. __typename?: 'User';
  4297. id: Scalars['ID'];
  4298. createdAt: Scalars['DateTime'];
  4299. updatedAt: Scalars['DateTime'];
  4300. identifier: Scalars['String'];
  4301. verified: Scalars['Boolean'];
  4302. roles: Array<Role>;
  4303. lastLogin?: Maybe<Scalars['DateTime']>;
  4304. authenticationMethods: Array<AuthenticationMethod>;
  4305. customFields?: Maybe<Scalars['JSON']>;
  4306. };
  4307. export type Zone = Node & {
  4308. __typename?: 'Zone';
  4309. id: Scalars['ID'];
  4310. createdAt: Scalars['DateTime'];
  4311. updatedAt: Scalars['DateTime'];
  4312. name: Scalars['String'];
  4313. members: Array<Country>;
  4314. };