generated-types.ts 142 KB

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