generated-types.ts 154 KB

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