generated-types.ts 148 KB

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