generated-types.ts 142 KB

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