| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324 |
- // tslint:disable
- export type Maybe<T> = T;
- export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
- export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
- export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
- /** All built-in and custom scalars, mapped to their actual values */
- export type Scalars = {
- ID: string | number;
- String: string;
- Boolean: boolean;
- Int: number;
- Float: number;
- /** 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. */
- DateTime: any;
- /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
- JSON: any;
- /** The `Upload` scalar type represents a file upload. */
- Upload: any;
- };
- export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError;
- export type AddItemInput = {
- productVariantId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type AddManualPaymentToOrderResult = Order | ManualPaymentStateError;
- export type AddNoteToCustomerInput = {
- id: Scalars['ID'];
- note: Scalars['String'];
- isPublic: Scalars['Boolean'];
- };
- export type AddNoteToOrderInput = {
- id: Scalars['ID'];
- note: Scalars['String'];
- isPublic: Scalars['Boolean'];
- };
- export type Address = Node & {
- __typename?: 'Address';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- fullName?: Maybe<Scalars['String']>;
- company?: Maybe<Scalars['String']>;
- streetLine1: Scalars['String'];
- streetLine2?: Maybe<Scalars['String']>;
- city?: Maybe<Scalars['String']>;
- province?: Maybe<Scalars['String']>;
- postalCode?: Maybe<Scalars['String']>;
- country: Country;
- phoneNumber?: Maybe<Scalars['String']>;
- defaultShippingAddress?: Maybe<Scalars['Boolean']>;
- defaultBillingAddress?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type AdjustOrderLineInput = {
- orderLineId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type Adjustment = {
- __typename?: 'Adjustment';
- adjustmentSource: Scalars['String'];
- type: AdjustmentType;
- description: Scalars['String'];
- amount: Scalars['Int'];
- };
- export enum AdjustmentType {
- PROMOTION = 'PROMOTION',
- DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
- OTHER = 'OTHER'
- }
- export type Administrator = Node & {
- __typename?: 'Administrator';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- firstName: Scalars['String'];
- lastName: Scalars['String'];
- emailAddress: Scalars['String'];
- user: User;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type AdministratorFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- firstName?: Maybe<StringOperators>;
- lastName?: Maybe<StringOperators>;
- emailAddress?: Maybe<StringOperators>;
- };
- export type AdministratorList = PaginatedList & {
- __typename?: 'AdministratorList';
- items: Array<Administrator>;
- totalItems: Scalars['Int'];
- };
- export type AdministratorListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<AdministratorSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<AdministratorFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type AdministratorPaymentInput = {
- paymentMethod?: Maybe<Scalars['String']>;
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type AdministratorRefundInput = {
- paymentId: Scalars['ID'];
- reason?: Maybe<Scalars['String']>;
- };
- export type AdministratorSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- firstName?: Maybe<SortOrder>;
- lastName?: Maybe<SortOrder>;
- emailAddress?: Maybe<SortOrder>;
- };
- export type Allocation = Node & StockMovement & {
- __typename?: 'Allocation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderLine: OrderLine;
- };
- /** Returned if an attempting to refund an OrderItem which has already been refunded */
- export type AlreadyRefundedError = ErrorResult & {
- __typename?: 'AlreadyRefundedError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- refundId: Scalars['ID'];
- };
- export type Asset = Node & {
- __typename?: 'Asset';
- tags: Array<Tag>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- type: AssetType;
- fileSize: Scalars['Int'];
- mimeType: Scalars['String'];
- width: Scalars['Int'];
- height: Scalars['Int'];
- source: Scalars['String'];
- preview: Scalars['String'];
- focalPoint?: Maybe<Coordinate>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type AssetFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- type?: Maybe<StringOperators>;
- fileSize?: Maybe<NumberOperators>;
- mimeType?: Maybe<StringOperators>;
- width?: Maybe<NumberOperators>;
- height?: Maybe<NumberOperators>;
- source?: Maybe<StringOperators>;
- preview?: Maybe<StringOperators>;
- };
- export type AssetList = PaginatedList & {
- __typename?: 'AssetList';
- items: Array<Asset>;
- totalItems: Scalars['Int'];
- };
- export type AssetListOptions = {
- tags?: Maybe<Array<Scalars['String']>>;
- tagsOperator?: Maybe<LogicalOperator>;
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<AssetSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<AssetFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type AssetSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- fileSize?: Maybe<SortOrder>;
- mimeType?: Maybe<SortOrder>;
- width?: Maybe<SortOrder>;
- height?: Maybe<SortOrder>;
- source?: Maybe<SortOrder>;
- preview?: Maybe<SortOrder>;
- };
- export enum AssetType {
- IMAGE = 'IMAGE',
- VIDEO = 'VIDEO',
- BINARY = 'BINARY'
- }
- export type AssignAssetsToChannelInput = {
- assetIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type AssignProductVariantsToChannelInput = {
- productVariantIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- priceFactor?: Maybe<Scalars['Float']>;
- };
- export type AssignProductsToChannelInput = {
- productIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- priceFactor?: Maybe<Scalars['Float']>;
- };
- export type AssignPromotionsToChannelInput = {
- promotionIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type AuthenticationInput = {
- native?: Maybe<NativeAuthInput>;
- };
- export type AuthenticationMethod = Node & {
- __typename?: 'AuthenticationMethod';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- strategy: Scalars['String'];
- };
- export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
- export type BooleanCustomFieldConfig = CustomField & {
- __typename?: 'BooleanCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- /** Operators for filtering on a list of Boolean fields */
- export type BooleanListOperators = {
- inList: Scalars['Boolean'];
- };
- /** Operators for filtering on a Boolean field */
- export type BooleanOperators = {
- eq?: Maybe<Scalars['Boolean']>;
- };
- /** Returned if an attempting to cancel lines from an Order which is still active */
- export type CancelActiveOrderError = ErrorResult & {
- __typename?: 'CancelActiveOrderError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- orderState: Scalars['String'];
- };
- export type CancelOrderInput = {
- /** The id of the order to be cancelled */
- orderId: Scalars['ID'];
- /** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
- lines?: Maybe<Array<OrderLineInput>>;
- /** Specify whether the shipping charges should also be cancelled. Defaults to false */
- cancelShipping?: Maybe<Scalars['Boolean']>;
- reason?: Maybe<Scalars['String']>;
- };
- export type CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError;
- /** Returned if the Payment cancellation fails */
- export type CancelPaymentError = ErrorResult & {
- __typename?: 'CancelPaymentError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- paymentErrorMessage: Scalars['String'];
- };
- export type CancelPaymentResult = Payment | CancelPaymentError | PaymentStateTransitionError;
- export type Cancellation = Node & StockMovement & {
- __typename?: 'Cancellation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderLine: OrderLine;
- };
- export type Channel = Node & {
- __typename?: 'Channel';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- code: Scalars['String'];
- token: Scalars['String'];
- defaultTaxZone?: Maybe<Zone>;
- defaultShippingZone?: Maybe<Zone>;
- defaultLanguageCode: LanguageCode;
- currencyCode: CurrencyCode;
- pricesIncludeTax: Scalars['Boolean'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- /**
- * Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
- * of the GlobalSettings
- */
- export type ChannelDefaultLanguageError = ErrorResult & {
- __typename?: 'ChannelDefaultLanguageError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- language: Scalars['String'];
- channelCode: Scalars['String'];
- };
- export type Collection = Node & {
- __typename?: 'Collection';
- isPrivate: Scalars['Boolean'];
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode?: Maybe<LanguageCode>;
- name: Scalars['String'];
- slug: Scalars['String'];
- breadcrumbs: Array<CollectionBreadcrumb>;
- position: Scalars['Int'];
- description: Scalars['String'];
- featuredAsset?: Maybe<Asset>;
- assets: Array<Asset>;
- parent?: Maybe<Collection>;
- children?: Maybe<Array<Collection>>;
- filters: Array<ConfigurableOperation>;
- translations: Array<CollectionTranslation>;
- productVariants: ProductVariantList;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CollectionProductVariantsArgs = {
- options?: Maybe<ProductVariantListOptions>;
- };
- export type CollectionBreadcrumb = {
- __typename?: 'CollectionBreadcrumb';
- id: Scalars['ID'];
- name: Scalars['String'];
- slug: Scalars['String'];
- };
- export type CollectionFilterParameter = {
- isPrivate?: Maybe<BooleanOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- slug?: Maybe<StringOperators>;
- position?: Maybe<NumberOperators>;
- description?: Maybe<StringOperators>;
- };
- export type CollectionList = PaginatedList & {
- __typename?: 'CollectionList';
- items: Array<Collection>;
- totalItems: Scalars['Int'];
- };
- export type CollectionListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<CollectionSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<CollectionFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- /**
- * Which Collections are present in the products returned
- * by the search, and in what quantity.
- */
- export type CollectionResult = {
- __typename?: 'CollectionResult';
- collection: Collection;
- count: Scalars['Int'];
- };
- export type CollectionSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- slug?: Maybe<SortOrder>;
- position?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type CollectionTranslation = {
- __typename?: 'CollectionTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- slug: Scalars['String'];
- description: Scalars['String'];
- };
- export type ConfigArg = {
- __typename?: 'ConfigArg';
- name: Scalars['String'];
- value: Scalars['String'];
- };
- export type ConfigArgDefinition = {
- __typename?: 'ConfigArgDefinition';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- required: Scalars['Boolean'];
- defaultValue?: Maybe<Scalars['JSON']>;
- label?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type ConfigArgInput = {
- name: Scalars['String'];
- /** A JSON stringified representation of the actual value */
- value: Scalars['String'];
- };
- export type ConfigurableOperation = {
- __typename?: 'ConfigurableOperation';
- code: Scalars['String'];
- args: Array<ConfigArg>;
- };
- export type ConfigurableOperationDefinition = {
- __typename?: 'ConfigurableOperationDefinition';
- code: Scalars['String'];
- args: Array<ConfigArgDefinition>;
- description: Scalars['String'];
- };
- export type ConfigurableOperationInput = {
- code: Scalars['String'];
- arguments: Array<ConfigArgInput>;
- };
- export type Coordinate = {
- __typename?: 'Coordinate';
- x: Scalars['Float'];
- y: Scalars['Float'];
- };
- export type CoordinateInput = {
- x: Scalars['Float'];
- y: Scalars['Float'];
- };
- export type Country = Node & {
- __typename?: 'Country';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- code: Scalars['String'];
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- translations: Array<CountryTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CountryFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- };
- export type CountryList = PaginatedList & {
- __typename?: 'CountryList';
- items: Array<Country>;
- totalItems: Scalars['Int'];
- };
- export type CountryListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<CountrySortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<CountryFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type CountrySortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- };
- export type CountryTranslation = {
- __typename?: 'CountryTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type CountryTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- /** Returned if the provided coupon code is invalid */
- export type CouponCodeExpiredError = ErrorResult & {
- __typename?: 'CouponCodeExpiredError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- couponCode: Scalars['String'];
- };
- /** Returned if the provided coupon code is invalid */
- export type CouponCodeInvalidError = ErrorResult & {
- __typename?: 'CouponCodeInvalidError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- couponCode: Scalars['String'];
- };
- /** Returned if the provided coupon code is invalid */
- export type CouponCodeLimitError = ErrorResult & {
- __typename?: 'CouponCodeLimitError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- couponCode: Scalars['String'];
- limit: Scalars['Int'];
- };
- export type CreateAddressInput = {
- fullName?: Maybe<Scalars['String']>;
- company?: Maybe<Scalars['String']>;
- streetLine1: Scalars['String'];
- streetLine2?: Maybe<Scalars['String']>;
- city?: Maybe<Scalars['String']>;
- province?: Maybe<Scalars['String']>;
- postalCode?: Maybe<Scalars['String']>;
- countryCode: Scalars['String'];
- phoneNumber?: Maybe<Scalars['String']>;
- defaultShippingAddress?: Maybe<Scalars['Boolean']>;
- defaultBillingAddress?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateAdministratorInput = {
- firstName: Scalars['String'];
- lastName: Scalars['String'];
- emailAddress: Scalars['String'];
- password: Scalars['String'];
- roleIds: Array<Scalars['ID']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateAssetInput = {
- file: Scalars['Upload'];
- tags?: Maybe<Array<Scalars['String']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateAssetResult = Asset | MimeTypeError;
- export type CreateChannelInput = {
- code: Scalars['String'];
- token: Scalars['String'];
- defaultLanguageCode: LanguageCode;
- pricesIncludeTax: Scalars['Boolean'];
- currencyCode: CurrencyCode;
- defaultTaxZoneId: Scalars['ID'];
- defaultShippingZoneId: Scalars['ID'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateChannelResult = Channel | LanguageNotAvailableError;
- export type CreateCollectionInput = {
- isPrivate?: Maybe<Scalars['Boolean']>;
- featuredAssetId?: Maybe<Scalars['ID']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- parentId?: Maybe<Scalars['ID']>;
- filters: Array<ConfigurableOperationInput>;
- translations: Array<CreateCollectionTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateCollectionTranslationInput = {
- languageCode: LanguageCode;
- name: Scalars['String'];
- slug: Scalars['String'];
- description: Scalars['String'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateCountryInput = {
- code: Scalars['String'];
- translations: Array<CountryTranslationInput>;
- enabled: Scalars['Boolean'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateCustomerGroupInput = {
- name: Scalars['String'];
- customerIds?: Maybe<Array<Scalars['ID']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateCustomerInput = {
- title?: Maybe<Scalars['String']>;
- firstName: Scalars['String'];
- lastName: Scalars['String'];
- phoneNumber?: Maybe<Scalars['String']>;
- emailAddress: Scalars['String'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateCustomerResult = Customer | EmailAddressConflictError;
- export type CreateFacetInput = {
- code: Scalars['String'];
- isPrivate: Scalars['Boolean'];
- translations: Array<FacetTranslationInput>;
- values?: Maybe<Array<CreateFacetValueWithFacetInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateFacetValueInput = {
- facetId: Scalars['ID'];
- code: Scalars['String'];
- translations: Array<FacetValueTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateFacetValueWithFacetInput = {
- code: Scalars['String'];
- translations: Array<FacetValueTranslationInput>;
- };
- /** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
- export type CreateFulfillmentError = ErrorResult & {
- __typename?: 'CreateFulfillmentError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- fulfillmentHandlerError: Scalars['String'];
- };
- export type CreateGroupOptionInput = {
- code: Scalars['String'];
- translations: Array<ProductOptionGroupTranslationInput>;
- };
- export type CreatePaymentMethodInput = {
- name: Scalars['String'];
- code: Scalars['String'];
- description?: Maybe<Scalars['String']>;
- enabled: Scalars['Boolean'];
- checker?: Maybe<ConfigurableOperationInput>;
- handler: ConfigurableOperationInput;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductInput = {
- featuredAssetId?: Maybe<Scalars['ID']>;
- enabled?: Maybe<Scalars['Boolean']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- translations: Array<ProductTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductOptionGroupInput = {
- code: Scalars['String'];
- translations: Array<ProductOptionGroupTranslationInput>;
- options: Array<CreateGroupOptionInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductOptionInput = {
- productOptionGroupId: Scalars['ID'];
- code: Scalars['String'];
- translations: Array<ProductOptionGroupTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductVariantInput = {
- productId: Scalars['ID'];
- translations: Array<ProductVariantTranslationInput>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- sku: Scalars['String'];
- price?: Maybe<Scalars['Int']>;
- taxCategoryId?: Maybe<Scalars['ID']>;
- optionIds?: Maybe<Array<Scalars['ID']>>;
- featuredAssetId?: Maybe<Scalars['ID']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- stockOnHand?: Maybe<Scalars['Int']>;
- outOfStockThreshold?: Maybe<Scalars['Int']>;
- useGlobalOutOfStockThreshold?: Maybe<Scalars['Boolean']>;
- trackInventory?: Maybe<GlobalFlag>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductVariantOptionInput = {
- optionGroupId: Scalars['ID'];
- code: Scalars['String'];
- translations: Array<ProductOptionTranslationInput>;
- };
- export type CreatePromotionInput = {
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- startsAt?: Maybe<Scalars['DateTime']>;
- endsAt?: Maybe<Scalars['DateTime']>;
- couponCode?: Maybe<Scalars['String']>;
- perCustomerUsageLimit?: Maybe<Scalars['Int']>;
- conditions: Array<ConfigurableOperationInput>;
- actions: Array<ConfigurableOperationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreatePromotionResult = Promotion | MissingConditionsError;
- export type CreateRoleInput = {
- code: Scalars['String'];
- description: Scalars['String'];
- permissions: Array<Permission>;
- channelIds?: Maybe<Array<Scalars['ID']>>;
- };
- export type CreateShippingMethodInput = {
- code: Scalars['String'];
- fulfillmentHandler: Scalars['String'];
- checker: ConfigurableOperationInput;
- calculator: ConfigurableOperationInput;
- translations: Array<ShippingMethodTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateTagInput = {
- value: Scalars['String'];
- };
- export type CreateTaxCategoryInput = {
- name: Scalars['String'];
- isDefault?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateTaxRateInput = {
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- value: Scalars['Float'];
- categoryId: Scalars['ID'];
- zoneId: Scalars['ID'];
- customerGroupId?: Maybe<Scalars['ID']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateZoneInput = {
- name: Scalars['String'];
- memberIds?: Maybe<Array<Scalars['ID']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- /**
- * @description
- * ISO 4217 currency code
- *
- * @docsCategory common
- */
- export enum CurrencyCode {
- /** United Arab Emirates dirham */
- AED = 'AED',
- /** Afghan afghani */
- AFN = 'AFN',
- /** Albanian lek */
- ALL = 'ALL',
- /** Armenian dram */
- AMD = 'AMD',
- /** Netherlands Antillean guilder */
- ANG = 'ANG',
- /** Angolan kwanza */
- AOA = 'AOA',
- /** Argentine peso */
- ARS = 'ARS',
- /** Australian dollar */
- AUD = 'AUD',
- /** Aruban florin */
- AWG = 'AWG',
- /** Azerbaijani manat */
- AZN = 'AZN',
- /** Bosnia and Herzegovina convertible mark */
- BAM = 'BAM',
- /** Barbados dollar */
- BBD = 'BBD',
- /** Bangladeshi taka */
- BDT = 'BDT',
- /** Bulgarian lev */
- BGN = 'BGN',
- /** Bahraini dinar */
- BHD = 'BHD',
- /** Burundian franc */
- BIF = 'BIF',
- /** Bermudian dollar */
- BMD = 'BMD',
- /** Brunei dollar */
- BND = 'BND',
- /** Boliviano */
- BOB = 'BOB',
- /** Brazilian real */
- BRL = 'BRL',
- /** Bahamian dollar */
- BSD = 'BSD',
- /** Bhutanese ngultrum */
- BTN = 'BTN',
- /** Botswana pula */
- BWP = 'BWP',
- /** Belarusian ruble */
- BYN = 'BYN',
- /** Belize dollar */
- BZD = 'BZD',
- /** Canadian dollar */
- CAD = 'CAD',
- /** Congolese franc */
- CDF = 'CDF',
- /** Swiss franc */
- CHF = 'CHF',
- /** Chilean peso */
- CLP = 'CLP',
- /** Renminbi (Chinese) yuan */
- CNY = 'CNY',
- /** Colombian peso */
- COP = 'COP',
- /** Costa Rican colon */
- CRC = 'CRC',
- /** Cuban convertible peso */
- CUC = 'CUC',
- /** Cuban peso */
- CUP = 'CUP',
- /** Cape Verde escudo */
- CVE = 'CVE',
- /** Czech koruna */
- CZK = 'CZK',
- /** Djiboutian franc */
- DJF = 'DJF',
- /** Danish krone */
- DKK = 'DKK',
- /** Dominican peso */
- DOP = 'DOP',
- /** Algerian dinar */
- DZD = 'DZD',
- /** Egyptian pound */
- EGP = 'EGP',
- /** Eritrean nakfa */
- ERN = 'ERN',
- /** Ethiopian birr */
- ETB = 'ETB',
- /** Euro */
- EUR = 'EUR',
- /** Fiji dollar */
- FJD = 'FJD',
- /** Falkland Islands pound */
- FKP = 'FKP',
- /** Pound sterling */
- GBP = 'GBP',
- /** Georgian lari */
- GEL = 'GEL',
- /** Ghanaian cedi */
- GHS = 'GHS',
- /** Gibraltar pound */
- GIP = 'GIP',
- /** Gambian dalasi */
- GMD = 'GMD',
- /** Guinean franc */
- GNF = 'GNF',
- /** Guatemalan quetzal */
- GTQ = 'GTQ',
- /** Guyanese dollar */
- GYD = 'GYD',
- /** Hong Kong dollar */
- HKD = 'HKD',
- /** Honduran lempira */
- HNL = 'HNL',
- /** Croatian kuna */
- HRK = 'HRK',
- /** Haitian gourde */
- HTG = 'HTG',
- /** Hungarian forint */
- HUF = 'HUF',
- /** Indonesian rupiah */
- IDR = 'IDR',
- /** Israeli new shekel */
- ILS = 'ILS',
- /** Indian rupee */
- INR = 'INR',
- /** Iraqi dinar */
- IQD = 'IQD',
- /** Iranian rial */
- IRR = 'IRR',
- /** Icelandic króna */
- ISK = 'ISK',
- /** Jamaican dollar */
- JMD = 'JMD',
- /** Jordanian dinar */
- JOD = 'JOD',
- /** Japanese yen */
- JPY = 'JPY',
- /** Kenyan shilling */
- KES = 'KES',
- /** Kyrgyzstani som */
- KGS = 'KGS',
- /** Cambodian riel */
- KHR = 'KHR',
- /** Comoro franc */
- KMF = 'KMF',
- /** North Korean won */
- KPW = 'KPW',
- /** South Korean won */
- KRW = 'KRW',
- /** Kuwaiti dinar */
- KWD = 'KWD',
- /** Cayman Islands dollar */
- KYD = 'KYD',
- /** Kazakhstani tenge */
- KZT = 'KZT',
- /** Lao kip */
- LAK = 'LAK',
- /** Lebanese pound */
- LBP = 'LBP',
- /** Sri Lankan rupee */
- LKR = 'LKR',
- /** Liberian dollar */
- LRD = 'LRD',
- /** Lesotho loti */
- LSL = 'LSL',
- /** Libyan dinar */
- LYD = 'LYD',
- /** Moroccan dirham */
- MAD = 'MAD',
- /** Moldovan leu */
- MDL = 'MDL',
- /** Malagasy ariary */
- MGA = 'MGA',
- /** Macedonian denar */
- MKD = 'MKD',
- /** Myanmar kyat */
- MMK = 'MMK',
- /** Mongolian tögrög */
- MNT = 'MNT',
- /** Macanese pataca */
- MOP = 'MOP',
- /** Mauritanian ouguiya */
- MRU = 'MRU',
- /** Mauritian rupee */
- MUR = 'MUR',
- /** Maldivian rufiyaa */
- MVR = 'MVR',
- /** Malawian kwacha */
- MWK = 'MWK',
- /** Mexican peso */
- MXN = 'MXN',
- /** Malaysian ringgit */
- MYR = 'MYR',
- /** Mozambican metical */
- MZN = 'MZN',
- /** Namibian dollar */
- NAD = 'NAD',
- /** Nigerian naira */
- NGN = 'NGN',
- /** Nicaraguan córdoba */
- NIO = 'NIO',
- /** Norwegian krone */
- NOK = 'NOK',
- /** Nepalese rupee */
- NPR = 'NPR',
- /** New Zealand dollar */
- NZD = 'NZD',
- /** Omani rial */
- OMR = 'OMR',
- /** Panamanian balboa */
- PAB = 'PAB',
- /** Peruvian sol */
- PEN = 'PEN',
- /** Papua New Guinean kina */
- PGK = 'PGK',
- /** Philippine peso */
- PHP = 'PHP',
- /** Pakistani rupee */
- PKR = 'PKR',
- /** Polish złoty */
- PLN = 'PLN',
- /** Paraguayan guaraní */
- PYG = 'PYG',
- /** Qatari riyal */
- QAR = 'QAR',
- /** Romanian leu */
- RON = 'RON',
- /** Serbian dinar */
- RSD = 'RSD',
- /** Russian ruble */
- RUB = 'RUB',
- /** Rwandan franc */
- RWF = 'RWF',
- /** Saudi riyal */
- SAR = 'SAR',
- /** Solomon Islands dollar */
- SBD = 'SBD',
- /** Seychelles rupee */
- SCR = 'SCR',
- /** Sudanese pound */
- SDG = 'SDG',
- /** Swedish krona/kronor */
- SEK = 'SEK',
- /** Singapore dollar */
- SGD = 'SGD',
- /** Saint Helena pound */
- SHP = 'SHP',
- /** Sierra Leonean leone */
- SLL = 'SLL',
- /** Somali shilling */
- SOS = 'SOS',
- /** Surinamese dollar */
- SRD = 'SRD',
- /** South Sudanese pound */
- SSP = 'SSP',
- /** São Tomé and Príncipe dobra */
- STN = 'STN',
- /** Salvadoran colón */
- SVC = 'SVC',
- /** Syrian pound */
- SYP = 'SYP',
- /** Swazi lilangeni */
- SZL = 'SZL',
- /** Thai baht */
- THB = 'THB',
- /** Tajikistani somoni */
- TJS = 'TJS',
- /** Turkmenistan manat */
- TMT = 'TMT',
- /** Tunisian dinar */
- TND = 'TND',
- /** Tongan paʻanga */
- TOP = 'TOP',
- /** Turkish lira */
- TRY = 'TRY',
- /** Trinidad and Tobago dollar */
- TTD = 'TTD',
- /** New Taiwan dollar */
- TWD = 'TWD',
- /** Tanzanian shilling */
- TZS = 'TZS',
- /** Ukrainian hryvnia */
- UAH = 'UAH',
- /** Ugandan shilling */
- UGX = 'UGX',
- /** United States dollar */
- USD = 'USD',
- /** Uruguayan peso */
- UYU = 'UYU',
- /** Uzbekistan som */
- UZS = 'UZS',
- /** Venezuelan bolívar soberano */
- VES = 'VES',
- /** Vietnamese đồng */
- VND = 'VND',
- /** Vanuatu vatu */
- VUV = 'VUV',
- /** Samoan tala */
- WST = 'WST',
- /** CFA franc BEAC */
- XAF = 'XAF',
- /** East Caribbean dollar */
- XCD = 'XCD',
- /** CFA franc BCEAO */
- XOF = 'XOF',
- /** CFP franc (franc Pacifique) */
- XPF = 'XPF',
- /** Yemeni rial */
- YER = 'YER',
- /** South African rand */
- ZAR = 'ZAR',
- /** Zambian kwacha */
- ZMW = 'ZMW',
- /** Zimbabwean dollar */
- ZWL = 'ZWL'
- }
- export type CurrentUser = {
- __typename?: 'CurrentUser';
- id: Scalars['ID'];
- identifier: Scalars['String'];
- channels: Array<CurrentUserChannel>;
- };
- export type CurrentUserChannel = {
- __typename?: 'CurrentUserChannel';
- id: Scalars['ID'];
- token: Scalars['String'];
- code: Scalars['String'];
- permissions: Array<Permission>;
- };
- export type CustomField = {
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig | TextCustomFieldConfig;
- export type CustomFields = {
- __typename?: 'CustomFields';
- Address: Array<CustomFieldConfig>;
- Administrator: Array<CustomFieldConfig>;
- Asset: Array<CustomFieldConfig>;
- Channel: Array<CustomFieldConfig>;
- Collection: Array<CustomFieldConfig>;
- Country: Array<CustomFieldConfig>;
- Customer: Array<CustomFieldConfig>;
- CustomerGroup: Array<CustomFieldConfig>;
- Facet: Array<CustomFieldConfig>;
- FacetValue: Array<CustomFieldConfig>;
- Fulfillment: Array<CustomFieldConfig>;
- GlobalSettings: Array<CustomFieldConfig>;
- Order: Array<CustomFieldConfig>;
- OrderLine: Array<CustomFieldConfig>;
- PaymentMethod: Array<CustomFieldConfig>;
- Product: Array<CustomFieldConfig>;
- ProductOption: Array<CustomFieldConfig>;
- ProductOptionGroup: Array<CustomFieldConfig>;
- ProductVariant: Array<CustomFieldConfig>;
- Promotion: Array<CustomFieldConfig>;
- ShippingMethod: Array<CustomFieldConfig>;
- TaxCategory: Array<CustomFieldConfig>;
- TaxRate: Array<CustomFieldConfig>;
- User: Array<CustomFieldConfig>;
- Zone: Array<CustomFieldConfig>;
- };
- export type Customer = Node & {
- __typename?: 'Customer';
- groups: Array<CustomerGroup>;
- history: HistoryEntryList;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- title?: Maybe<Scalars['String']>;
- firstName: Scalars['String'];
- lastName: Scalars['String'];
- phoneNumber?: Maybe<Scalars['String']>;
- emailAddress: Scalars['String'];
- addresses?: Maybe<Array<Address>>;
- orders: OrderList;
- user?: Maybe<User>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CustomerHistoryArgs = {
- options?: Maybe<HistoryEntryListOptions>;
- };
- export type CustomerOrdersArgs = {
- options?: Maybe<OrderListOptions>;
- };
- export type CustomerFilterParameter = {
- postalCode?: Maybe<StringOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- title?: Maybe<StringOperators>;
- firstName?: Maybe<StringOperators>;
- lastName?: Maybe<StringOperators>;
- phoneNumber?: Maybe<StringOperators>;
- emailAddress?: Maybe<StringOperators>;
- };
- export type CustomerGroup = Node & {
- __typename?: 'CustomerGroup';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- customers: CustomerList;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CustomerGroupCustomersArgs = {
- options?: Maybe<CustomerListOptions>;
- };
- export type CustomerGroupFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- };
- export type CustomerGroupList = PaginatedList & {
- __typename?: 'CustomerGroupList';
- items: Array<CustomerGroup>;
- totalItems: Scalars['Int'];
- };
- export type CustomerGroupListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<CustomerGroupSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<CustomerGroupFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type CustomerGroupSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- };
- export type CustomerList = PaginatedList & {
- __typename?: 'CustomerList';
- items: Array<Customer>;
- totalItems: Scalars['Int'];
- };
- export type CustomerListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<CustomerSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<CustomerFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type CustomerSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- title?: Maybe<SortOrder>;
- firstName?: Maybe<SortOrder>;
- lastName?: Maybe<SortOrder>;
- phoneNumber?: Maybe<SortOrder>;
- emailAddress?: Maybe<SortOrder>;
- };
- /** Operators for filtering on a list of Date fields */
- export type DateListOperators = {
- inList: Scalars['DateTime'];
- };
- /** Operators for filtering on a DateTime field */
- export type DateOperators = {
- eq?: Maybe<Scalars['DateTime']>;
- before?: Maybe<Scalars['DateTime']>;
- after?: Maybe<Scalars['DateTime']>;
- between?: Maybe<DateRange>;
- };
- export type DateRange = {
- start: Scalars['DateTime'];
- end: Scalars['DateTime'];
- };
- /**
- * Expects the same validation formats as the `<input type="datetime-local">` HTML element.
- * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
- */
- export type DateTimeCustomFieldConfig = CustomField & {
- __typename?: 'DateTimeCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- min?: Maybe<Scalars['String']>;
- max?: Maybe<Scalars['String']>;
- step?: Maybe<Scalars['Int']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type DeleteAssetInput = {
- assetId: Scalars['ID'];
- force?: Maybe<Scalars['Boolean']>;
- deleteFromAllChannels?: Maybe<Scalars['Boolean']>;
- };
- export type DeleteAssetsInput = {
- assetIds: Array<Scalars['ID']>;
- force?: Maybe<Scalars['Boolean']>;
- deleteFromAllChannels?: Maybe<Scalars['Boolean']>;
- };
- export type DeletionResponse = {
- __typename?: 'DeletionResponse';
- result: DeletionResult;
- message?: Maybe<Scalars['String']>;
- };
- export enum DeletionResult {
- /** The entity was successfully deleted */
- DELETED = 'DELETED',
- /** Deletion did not take place, reason given in message */
- NOT_DELETED = 'NOT_DELETED'
- }
- export type Discount = {
- __typename?: 'Discount';
- adjustmentSource: Scalars['String'];
- type: AdjustmentType;
- description: Scalars['String'];
- amount: Scalars['Int'];
- amountWithTax: Scalars['Int'];
- };
- /** Returned when attempting to create a Customer with an email address already registered to an existing User. */
- export type EmailAddressConflictError = ErrorResult & {
- __typename?: 'EmailAddressConflictError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Returned if no OrderLines have been specified for the operation */
- export type EmptyOrderLineSelectionError = ErrorResult & {
- __typename?: 'EmptyOrderLineSelectionError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export enum ErrorCode {
- UNKNOWN_ERROR = 'UNKNOWN_ERROR',
- MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
- LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
- CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
- SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
- CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
- EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
- ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
- INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
- CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
- INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
- MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
- CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
- PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
- REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
- NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
- ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
- QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
- REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
- PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
- FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
- ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
- NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
- PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
- REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
- MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
- PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
- MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
- NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
- INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
- ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
- EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
- ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
- NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
- INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
- COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
- COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
- COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR'
- }
- export type ErrorResult = {
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Facet = Node & {
- __typename?: 'Facet';
- isPrivate: Scalars['Boolean'];
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- code: Scalars['String'];
- values: Array<FacetValue>;
- translations: Array<FacetTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FacetFilterParameter = {
- isPrivate?: Maybe<BooleanOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- };
- export type FacetList = PaginatedList & {
- __typename?: 'FacetList';
- items: Array<Facet>;
- totalItems: Scalars['Int'];
- };
- export type FacetListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<FacetSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<FacetFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type FacetSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- };
- export type FacetTranslation = {
- __typename?: 'FacetTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type FacetTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FacetValue = Node & {
- __typename?: 'FacetValue';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- facet: Facet;
- name: Scalars['String'];
- code: Scalars['String'];
- translations: Array<FacetValueTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- /**
- * Used to construct boolean expressions for filtering search results
- * by FacetValue ID. Examples:
- *
- * * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
- * * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
- * * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
- */
- export type FacetValueFilterInput = {
- and?: Maybe<Scalars['ID']>;
- or?: Maybe<Array<Scalars['ID']>>;
- };
- /**
- * Which FacetValues are present in the products returned
- * by the search, and in what quantity.
- */
- export type FacetValueResult = {
- __typename?: 'FacetValueResult';
- facetValue: FacetValue;
- count: Scalars['Int'];
- };
- export type FacetValueTranslation = {
- __typename?: 'FacetValueTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type FacetValueTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FloatCustomFieldConfig = CustomField & {
- __typename?: 'FloatCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- min?: Maybe<Scalars['Float']>;
- max?: Maybe<Scalars['Float']>;
- step?: Maybe<Scalars['Float']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type FulfillOrderInput = {
- lines: Array<OrderLineInput>;
- handler: ConfigurableOperationInput;
- };
- export type Fulfillment = Node & {
- __typename?: 'Fulfillment';
- nextStates: Array<Scalars['String']>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- orderItems: Array<OrderItem>;
- summary: Array<FulfillmentLineSummary>;
- state: Scalars['String'];
- method: Scalars['String'];
- trackingCode?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FulfillmentLineSummary = {
- __typename?: 'FulfillmentLineSummary';
- orderLine: OrderLine;
- quantity: Scalars['Int'];
- };
- /** Returned when there is an error in transitioning the Fulfillment state */
- export type FulfillmentStateTransitionError = ErrorResult & {
- __typename?: 'FulfillmentStateTransitionError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- transitionError: Scalars['String'];
- fromState: Scalars['String'];
- toState: Scalars['String'];
- };
- export enum GlobalFlag {
- TRUE = 'TRUE',
- FALSE = 'FALSE',
- INHERIT = 'INHERIT'
- }
- export type GlobalSettings = {
- __typename?: 'GlobalSettings';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- availableLanguages: Array<LanguageCode>;
- trackInventory: Scalars['Boolean'];
- outOfStockThreshold: Scalars['Int'];
- serverConfig: ServerConfig;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type HistoryEntry = Node & {
- __typename?: 'HistoryEntry';
- isPublic: Scalars['Boolean'];
- administrator?: Maybe<Administrator>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- type: HistoryEntryType;
- data: Scalars['JSON'];
- };
- export type HistoryEntryFilterParameter = {
- isPublic?: Maybe<BooleanOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- type?: Maybe<StringOperators>;
- };
- export type HistoryEntryList = PaginatedList & {
- __typename?: 'HistoryEntryList';
- items: Array<HistoryEntry>;
- totalItems: Scalars['Int'];
- };
- export type HistoryEntryListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<HistoryEntrySortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<HistoryEntryFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type HistoryEntrySortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- };
- export enum HistoryEntryType {
- CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
- CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
- CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
- CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
- CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
- CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
- CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
- CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
- CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
- CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
- CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
- CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
- CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
- CUSTOMER_NOTE = 'CUSTOMER_NOTE',
- ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION',
- ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
- ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
- ORDER_CANCELLATION = 'ORDER_CANCELLATION',
- ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
- ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
- ORDER_NOTE = 'ORDER_NOTE',
- ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
- ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
- ORDER_MODIFIED = 'ORDER_MODIFIED'
- }
- /** Operators for filtering on a list of ID fields */
- export type IdListOperators = {
- inList: Scalars['ID'];
- };
- /** Operators for filtering on an ID field */
- export type IdOperators = {
- eq?: Maybe<Scalars['String']>;
- notEq?: Maybe<Scalars['String']>;
- in?: Maybe<Array<Scalars['String']>>;
- notIn?: Maybe<Array<Scalars['String']>>;
- };
- export type ImportInfo = {
- __typename?: 'ImportInfo';
- errors?: Maybe<Array<Scalars['String']>>;
- processed: Scalars['Int'];
- imported: Scalars['Int'];
- };
- /** Returned when attempting to add more items to the Order than are available */
- export type InsufficientStockError = ErrorResult & {
- __typename?: 'InsufficientStockError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- quantityAvailable: Scalars['Int'];
- order: Order;
- };
- /**
- * Returned if attempting to create a Fulfillment when there is insufficient
- * stockOnHand of a ProductVariant to satisfy the requested quantity.
- */
- export type InsufficientStockOnHandError = ErrorResult & {
- __typename?: 'InsufficientStockOnHandError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- productVariantId: Scalars['ID'];
- productVariantName: Scalars['String'];
- stockOnHand: Scalars['Int'];
- };
- export type IntCustomFieldConfig = CustomField & {
- __typename?: 'IntCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- min?: Maybe<Scalars['Int']>;
- max?: Maybe<Scalars['Int']>;
- step?: Maybe<Scalars['Int']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- /** Returned if the user authentication credentials are not valid */
- export type InvalidCredentialsError = ErrorResult & {
- __typename?: 'InvalidCredentialsError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- authenticationError: Scalars['String'];
- };
- /** Returned if the specified FulfillmentHandler code is not valid */
- export type InvalidFulfillmentHandlerError = ErrorResult & {
- __typename?: 'InvalidFulfillmentHandlerError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Returned if the specified items are already part of a Fulfillment */
- export type ItemsAlreadyFulfilledError = ErrorResult & {
- __typename?: 'ItemsAlreadyFulfilledError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Job = Node & {
- __typename?: 'Job';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- startedAt?: Maybe<Scalars['DateTime']>;
- settledAt?: Maybe<Scalars['DateTime']>;
- queueName: Scalars['String'];
- state: JobState;
- progress: Scalars['Float'];
- data?: Maybe<Scalars['JSON']>;
- result?: Maybe<Scalars['JSON']>;
- error?: Maybe<Scalars['JSON']>;
- isSettled: Scalars['Boolean'];
- duration: Scalars['Int'];
- retries: Scalars['Int'];
- attempts: Scalars['Int'];
- };
- export type JobBufferSize = {
- __typename?: 'JobBufferSize';
- bufferId: Scalars['String'];
- size: Scalars['Int'];
- };
- export type JobFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- startedAt?: Maybe<DateOperators>;
- settledAt?: Maybe<DateOperators>;
- queueName?: Maybe<StringOperators>;
- state?: Maybe<StringOperators>;
- progress?: Maybe<NumberOperators>;
- isSettled?: Maybe<BooleanOperators>;
- duration?: Maybe<NumberOperators>;
- retries?: Maybe<NumberOperators>;
- attempts?: Maybe<NumberOperators>;
- };
- export type JobList = PaginatedList & {
- __typename?: 'JobList';
- items: Array<Job>;
- totalItems: Scalars['Int'];
- };
- export type JobListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<JobSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<JobFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type JobQueue = {
- __typename?: 'JobQueue';
- name: Scalars['String'];
- running: Scalars['Boolean'];
- };
- export type JobSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- startedAt?: Maybe<SortOrder>;
- settledAt?: Maybe<SortOrder>;
- queueName?: Maybe<SortOrder>;
- progress?: Maybe<SortOrder>;
- duration?: Maybe<SortOrder>;
- retries?: Maybe<SortOrder>;
- attempts?: Maybe<SortOrder>;
- };
- /**
- * @description
- * The state of a Job in the JobQueue
- *
- * @docsCategory common
- */
- export enum JobState {
- PENDING = 'PENDING',
- RUNNING = 'RUNNING',
- COMPLETED = 'COMPLETED',
- RETRYING = 'RETRYING',
- FAILED = 'FAILED',
- CANCELLED = 'CANCELLED'
- }
- /**
- * @description
- * Languages in the form of a ISO 639-1 language code with optional
- * region or script modifier (e.g. de_AT). The selection available is based
- * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
- * and includes the major spoken languages of the world and any widely-used variants.
- *
- * @docsCategory common
- */
- export enum LanguageCode {
- /** Afrikaans */
- af = 'af',
- /** Akan */
- ak = 'ak',
- /** Albanian */
- sq = 'sq',
- /** Amharic */
- am = 'am',
- /** Arabic */
- ar = 'ar',
- /** Armenian */
- hy = 'hy',
- /** Assamese */
- as = 'as',
- /** Azerbaijani */
- az = 'az',
- /** Bambara */
- bm = 'bm',
- /** Bangla */
- bn = 'bn',
- /** Basque */
- eu = 'eu',
- /** Belarusian */
- be = 'be',
- /** Bosnian */
- bs = 'bs',
- /** Breton */
- br = 'br',
- /** Bulgarian */
- bg = 'bg',
- /** Burmese */
- my = 'my',
- /** Catalan */
- ca = 'ca',
- /** Chechen */
- ce = 'ce',
- /** Chinese */
- zh = 'zh',
- /** Simplified Chinese */
- zh_Hans = 'zh_Hans',
- /** Traditional Chinese */
- zh_Hant = 'zh_Hant',
- /** Church Slavic */
- cu = 'cu',
- /** Cornish */
- kw = 'kw',
- /** Corsican */
- co = 'co',
- /** Croatian */
- hr = 'hr',
- /** Czech */
- cs = 'cs',
- /** Danish */
- da = 'da',
- /** Dutch */
- nl = 'nl',
- /** Flemish */
- nl_BE = 'nl_BE',
- /** Dzongkha */
- dz = 'dz',
- /** English */
- en = 'en',
- /** Australian English */
- en_AU = 'en_AU',
- /** Canadian English */
- en_CA = 'en_CA',
- /** British English */
- en_GB = 'en_GB',
- /** American English */
- en_US = 'en_US',
- /** Esperanto */
- eo = 'eo',
- /** Estonian */
- et = 'et',
- /** Ewe */
- ee = 'ee',
- /** Faroese */
- fo = 'fo',
- /** Finnish */
- fi = 'fi',
- /** French */
- fr = 'fr',
- /** Canadian French */
- fr_CA = 'fr_CA',
- /** Swiss French */
- fr_CH = 'fr_CH',
- /** Fulah */
- ff = 'ff',
- /** Galician */
- gl = 'gl',
- /** Ganda */
- lg = 'lg',
- /** Georgian */
- ka = 'ka',
- /** German */
- de = 'de',
- /** Austrian German */
- de_AT = 'de_AT',
- /** Swiss High German */
- de_CH = 'de_CH',
- /** Greek */
- el = 'el',
- /** Gujarati */
- gu = 'gu',
- /** Haitian Creole */
- ht = 'ht',
- /** Hausa */
- ha = 'ha',
- /** Hebrew */
- he = 'he',
- /** Hindi */
- hi = 'hi',
- /** Hungarian */
- hu = 'hu',
- /** Icelandic */
- is = 'is',
- /** Igbo */
- ig = 'ig',
- /** Indonesian */
- id = 'id',
- /** Interlingua */
- ia = 'ia',
- /** Irish */
- ga = 'ga',
- /** Italian */
- it = 'it',
- /** Japanese */
- ja = 'ja',
- /** Javanese */
- jv = 'jv',
- /** Kalaallisut */
- kl = 'kl',
- /** Kannada */
- kn = 'kn',
- /** Kashmiri */
- ks = 'ks',
- /** Kazakh */
- kk = 'kk',
- /** Khmer */
- km = 'km',
- /** Kikuyu */
- ki = 'ki',
- /** Kinyarwanda */
- rw = 'rw',
- /** Korean */
- ko = 'ko',
- /** Kurdish */
- ku = 'ku',
- /** Kyrgyz */
- ky = 'ky',
- /** Lao */
- lo = 'lo',
- /** Latin */
- la = 'la',
- /** Latvian */
- lv = 'lv',
- /** Lingala */
- ln = 'ln',
- /** Lithuanian */
- lt = 'lt',
- /** Luba-Katanga */
- lu = 'lu',
- /** Luxembourgish */
- lb = 'lb',
- /** Macedonian */
- mk = 'mk',
- /** Malagasy */
- mg = 'mg',
- /** Malay */
- ms = 'ms',
- /** Malayalam */
- ml = 'ml',
- /** Maltese */
- mt = 'mt',
- /** Manx */
- gv = 'gv',
- /** Maori */
- mi = 'mi',
- /** Marathi */
- mr = 'mr',
- /** Mongolian */
- mn = 'mn',
- /** Nepali */
- ne = 'ne',
- /** North Ndebele */
- nd = 'nd',
- /** Northern Sami */
- se = 'se',
- /** Norwegian Bokmål */
- nb = 'nb',
- /** Norwegian Nynorsk */
- nn = 'nn',
- /** Nyanja */
- ny = 'ny',
- /** Odia */
- or = 'or',
- /** Oromo */
- om = 'om',
- /** Ossetic */
- os = 'os',
- /** Pashto */
- ps = 'ps',
- /** Persian */
- fa = 'fa',
- /** Dari */
- fa_AF = 'fa_AF',
- /** Polish */
- pl = 'pl',
- /** Portuguese */
- pt = 'pt',
- /** Brazilian Portuguese */
- pt_BR = 'pt_BR',
- /** European Portuguese */
- pt_PT = 'pt_PT',
- /** Punjabi */
- pa = 'pa',
- /** Quechua */
- qu = 'qu',
- /** Romanian */
- ro = 'ro',
- /** Moldavian */
- ro_MD = 'ro_MD',
- /** Romansh */
- rm = 'rm',
- /** Rundi */
- rn = 'rn',
- /** Russian */
- ru = 'ru',
- /** Samoan */
- sm = 'sm',
- /** Sango */
- sg = 'sg',
- /** Sanskrit */
- sa = 'sa',
- /** Scottish Gaelic */
- gd = 'gd',
- /** Serbian */
- sr = 'sr',
- /** Shona */
- sn = 'sn',
- /** Sichuan Yi */
- ii = 'ii',
- /** Sindhi */
- sd = 'sd',
- /** Sinhala */
- si = 'si',
- /** Slovak */
- sk = 'sk',
- /** Slovenian */
- sl = 'sl',
- /** Somali */
- so = 'so',
- /** Southern Sotho */
- st = 'st',
- /** Spanish */
- es = 'es',
- /** European Spanish */
- es_ES = 'es_ES',
- /** Mexican Spanish */
- es_MX = 'es_MX',
- /** Sundanese */
- su = 'su',
- /** Swahili */
- sw = 'sw',
- /** Congo Swahili */
- sw_CD = 'sw_CD',
- /** Swedish */
- sv = 'sv',
- /** Tajik */
- tg = 'tg',
- /** Tamil */
- ta = 'ta',
- /** Tatar */
- tt = 'tt',
- /** Telugu */
- te = 'te',
- /** Thai */
- th = 'th',
- /** Tibetan */
- bo = 'bo',
- /** Tigrinya */
- ti = 'ti',
- /** Tongan */
- to = 'to',
- /** Turkish */
- tr = 'tr',
- /** Turkmen */
- tk = 'tk',
- /** Ukrainian */
- uk = 'uk',
- /** Urdu */
- ur = 'ur',
- /** Uyghur */
- ug = 'ug',
- /** Uzbek */
- uz = 'uz',
- /** Vietnamese */
- vi = 'vi',
- /** Volapük */
- vo = 'vo',
- /** Welsh */
- cy = 'cy',
- /** Western Frisian */
- fy = 'fy',
- /** Wolof */
- wo = 'wo',
- /** Xhosa */
- xh = 'xh',
- /** Yiddish */
- yi = 'yi',
- /** Yoruba */
- yo = 'yo',
- /** Zulu */
- zu = 'zu'
- }
- /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
- export type LanguageNotAvailableError = ErrorResult & {
- __typename?: 'LanguageNotAvailableError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- languageCode: Scalars['String'];
- };
- export type LocaleStringCustomFieldConfig = CustomField & {
- __typename?: 'LocaleStringCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- length?: Maybe<Scalars['Int']>;
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- pattern?: Maybe<Scalars['String']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type LocalizedString = {
- __typename?: 'LocalizedString';
- languageCode: LanguageCode;
- value: Scalars['String'];
- };
- export enum LogicalOperator {
- AND = 'AND',
- OR = 'OR'
- }
- export type ManualPaymentInput = {
- orderId: Scalars['ID'];
- method: Scalars['String'];
- transactionId?: Maybe<Scalars['String']>;
- metadata?: Maybe<Scalars['JSON']>;
- };
- /**
- * Returned when a call to addManualPaymentToOrder is made but the Order
- * is not in the required state.
- */
- export type ManualPaymentStateError = ErrorResult & {
- __typename?: 'ManualPaymentStateError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type MimeTypeError = ErrorResult & {
- __typename?: 'MimeTypeError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- fileName: Scalars['String'];
- mimeType: Scalars['String'];
- };
- /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
- export type MissingConditionsError = ErrorResult & {
- __typename?: 'MissingConditionsError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type ModifyOrderInput = {
- dryRun: Scalars['Boolean'];
- orderId: Scalars['ID'];
- addItems?: Maybe<Array<AddItemInput>>;
- adjustOrderLines?: Maybe<Array<AdjustOrderLineInput>>;
- surcharges?: Maybe<Array<SurchargeInput>>;
- updateShippingAddress?: Maybe<UpdateOrderAddressInput>;
- updateBillingAddress?: Maybe<UpdateOrderAddressInput>;
- note?: Maybe<Scalars['String']>;
- refund?: Maybe<AdministratorRefundInput>;
- options?: Maybe<ModifyOrderOptions>;
- couponCodes?: Maybe<Array<Scalars['String']>>;
- };
- export type ModifyOrderOptions = {
- freezePromotions?: Maybe<Scalars['Boolean']>;
- recalculateShipping?: Maybe<Scalars['Boolean']>;
- };
- export type ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError;
- export type MoveCollectionInput = {
- collectionId: Scalars['ID'];
- parentId: Scalars['ID'];
- index: Scalars['Int'];
- };
- /** Returned if an operation has specified OrderLines from multiple Orders */
- export type MultipleOrderError = ErrorResult & {
- __typename?: 'MultipleOrderError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Mutation = {
- __typename?: 'Mutation';
- /** Create a new Administrator */
- createAdministrator: Administrator;
- /** Update an existing Administrator */
- updateAdministrator: Administrator;
- /** Update the active (currently logged-in) Administrator */
- updateActiveAdministrator: Administrator;
- /** Delete an Administrator */
- deleteAdministrator: DeletionResponse;
- /** Assign a Role to an Administrator */
- assignRoleToAdministrator: Administrator;
- /** Create a new Asset */
- createAssets: Array<CreateAssetResult>;
- /** Update an existing Asset */
- updateAsset: Asset;
- /** Delete an Asset */
- deleteAsset: DeletionResponse;
- /** Delete multiple Assets */
- deleteAssets: DeletionResponse;
- /** Assign assets to channel */
- assignAssetsToChannel: Array<Asset>;
- /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
- login: NativeAuthenticationResult;
- /** Authenticates the user using a named authentication strategy */
- authenticate: AuthenticationResult;
- logout: Success;
- /** Create a new Channel */
- createChannel: CreateChannelResult;
- /** Update an existing Channel */
- updateChannel: UpdateChannelResult;
- /** Delete a Channel */
- deleteChannel: DeletionResponse;
- /** Create a new Collection */
- createCollection: Collection;
- /** Update an existing Collection */
- updateCollection: Collection;
- /** Delete a Collection and all of its descendants */
- deleteCollection: DeletionResponse;
- /** Move a Collection to a different parent or index */
- moveCollection: Collection;
- /** Create a new Country */
- createCountry: Country;
- /** Update an existing Country */
- updateCountry: Country;
- /** Delete a Country */
- deleteCountry: DeletionResponse;
- /** Create a new CustomerGroup */
- createCustomerGroup: CustomerGroup;
- /** Update an existing CustomerGroup */
- updateCustomerGroup: CustomerGroup;
- /** Delete a CustomerGroup */
- deleteCustomerGroup: DeletionResponse;
- /** Add Customers to a CustomerGroup */
- addCustomersToGroup: CustomerGroup;
- /** Remove Customers from a CustomerGroup */
- removeCustomersFromGroup: CustomerGroup;
- /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
- createCustomer: CreateCustomerResult;
- /** Update an existing Customer */
- updateCustomer: UpdateCustomerResult;
- /** Delete a Customer */
- deleteCustomer: DeletionResponse;
- /** Create a new Address and associate it with the Customer specified by customerId */
- createCustomerAddress: Address;
- /** Update an existing Address */
- updateCustomerAddress: Address;
- /** Update an existing Address */
- deleteCustomerAddress: Success;
- addNoteToCustomer: Customer;
- updateCustomerNote: HistoryEntry;
- deleteCustomerNote: DeletionResponse;
- /** Create a new Facet */
- createFacet: Facet;
- /** Update an existing Facet */
- updateFacet: Facet;
- /** Delete an existing Facet */
- deleteFacet: DeletionResponse;
- /** Create one or more FacetValues */
- createFacetValues: Array<FacetValue>;
- /** Update one or more FacetValues */
- updateFacetValues: Array<FacetValue>;
- /** Delete one or more FacetValues */
- deleteFacetValues: Array<DeletionResponse>;
- updateGlobalSettings: UpdateGlobalSettingsResult;
- importProducts?: Maybe<ImportInfo>;
- /** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
- removeSettledJobs: Scalars['Int'];
- cancelJob: Job;
- flushBufferedJobs: Success;
- settlePayment: SettlePaymentResult;
- cancelPayment: CancelPaymentResult;
- addFulfillmentToOrder: AddFulfillmentToOrderResult;
- cancelOrder: CancelOrderResult;
- refundOrder: RefundOrderResult;
- settleRefund: SettleRefundResult;
- addNoteToOrder: Order;
- updateOrderNote: HistoryEntry;
- deleteOrderNote: DeletionResponse;
- transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
- transitionFulfillmentToState: TransitionFulfillmentToStateResult;
- transitionPaymentToState: TransitionPaymentToStateResult;
- setOrderCustomFields?: Maybe<Order>;
- /**
- * Allows an Order to be modified after it has been completed by the Customer. The Order must first
- * be in the `Modifying` state.
- */
- modifyOrder: ModifyOrderResult;
- /**
- * Used to manually create a new Payment against an Order.
- * This can be used by an Administrator when an Order is in the ArrangingPayment state.
- *
- * It is also used when a completed Order
- * has been modified (using `modifyOrder`) and the price has increased. The extra payment
- * can then be manually arranged by the administrator, and the details used to create a new
- * Payment.
- */
- addManualPaymentToOrder: AddManualPaymentToOrderResult;
- /** Create existing PaymentMethod */
- createPaymentMethod: PaymentMethod;
- /** Update an existing PaymentMethod */
- updatePaymentMethod: PaymentMethod;
- /** Delete a PaymentMethod */
- deletePaymentMethod: DeletionResponse;
- /** Create a new ProductOptionGroup */
- createProductOptionGroup: ProductOptionGroup;
- /** Update an existing ProductOptionGroup */
- updateProductOptionGroup: ProductOptionGroup;
- /** Create a new ProductOption within a ProductOptionGroup */
- createProductOption: ProductOption;
- /** Create a new ProductOption within a ProductOptionGroup */
- updateProductOption: ProductOption;
- /** Delete a ProductOption */
- deleteProductOption: DeletionResponse;
- reindex: Job;
- runPendingSearchIndexUpdates: Success;
- /** Create a new Product */
- createProduct: Product;
- /** Update an existing Product */
- updateProduct: Product;
- /** Delete a Product */
- deleteProduct: DeletionResponse;
- /** Add an OptionGroup to a Product */
- addOptionGroupToProduct: Product;
- /** Remove an OptionGroup from a Product */
- removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
- /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
- createProductVariants: Array<Maybe<ProductVariant>>;
- /** Update existing ProductVariants */
- updateProductVariants: Array<Maybe<ProductVariant>>;
- /** Delete a ProductVariant */
- deleteProductVariant: DeletionResponse;
- /** Assigns all ProductVariants of Product to the specified Channel */
- assignProductsToChannel: Array<Product>;
- /** Removes all ProductVariants of Product from the specified Channel */
- removeProductsFromChannel: Array<Product>;
- /** Assigns ProductVariants to the specified Channel */
- assignProductVariantsToChannel: Array<ProductVariant>;
- /** Removes ProductVariants from the specified Channel */
- removeProductVariantsFromChannel: Array<ProductVariant>;
- createPromotion: CreatePromotionResult;
- updatePromotion: UpdatePromotionResult;
- deletePromotion: DeletionResponse;
- /** Assigns Promotions to the specified Channel */
- assignPromotionsToChannel: Array<Promotion>;
- /** Removes Promotions from the specified Channel */
- removePromotionsFromChannel: Array<Promotion>;
- /** Create a new Role */
- createRole: Role;
- /** Update an existing Role */
- updateRole: Role;
- /** Delete an existing Role */
- deleteRole: DeletionResponse;
- /** Create a new ShippingMethod */
- createShippingMethod: ShippingMethod;
- /** Update an existing ShippingMethod */
- updateShippingMethod: ShippingMethod;
- /** Delete a ShippingMethod */
- deleteShippingMethod: DeletionResponse;
- /** Create a new Tag */
- createTag: Tag;
- /** Update an existing Tag */
- updateTag: Tag;
- /** Delete an existing Tag */
- deleteTag: DeletionResponse;
- /** Create a new TaxCategory */
- createTaxCategory: TaxCategory;
- /** Update an existing TaxCategory */
- updateTaxCategory: TaxCategory;
- /** Deletes a TaxCategory */
- deleteTaxCategory: DeletionResponse;
- /** Create a new TaxRate */
- createTaxRate: TaxRate;
- /** Update an existing TaxRate */
- updateTaxRate: TaxRate;
- /** Delete a TaxRate */
- deleteTaxRate: DeletionResponse;
- /** Create a new Zone */
- createZone: Zone;
- /** Update an existing Zone */
- updateZone: Zone;
- /** Delete a Zone */
- deleteZone: DeletionResponse;
- /** Add members to a Zone */
- addMembersToZone: Zone;
- /** Remove members from a Zone */
- removeMembersFromZone: Zone;
- };
- export type MutationCreateAdministratorArgs = {
- input: CreateAdministratorInput;
- };
- export type MutationUpdateAdministratorArgs = {
- input: UpdateAdministratorInput;
- };
- export type MutationUpdateActiveAdministratorArgs = {
- input: UpdateActiveAdministratorInput;
- };
- export type MutationDeleteAdministratorArgs = {
- id: Scalars['ID'];
- };
- export type MutationAssignRoleToAdministratorArgs = {
- administratorId: Scalars['ID'];
- roleId: Scalars['ID'];
- };
- export type MutationCreateAssetsArgs = {
- input: Array<CreateAssetInput>;
- };
- export type MutationUpdateAssetArgs = {
- input: UpdateAssetInput;
- };
- export type MutationDeleteAssetArgs = {
- input: DeleteAssetInput;
- };
- export type MutationDeleteAssetsArgs = {
- input: DeleteAssetsInput;
- };
- export type MutationAssignAssetsToChannelArgs = {
- input: AssignAssetsToChannelInput;
- };
- export type MutationLoginArgs = {
- username: Scalars['String'];
- password: Scalars['String'];
- rememberMe?: Maybe<Scalars['Boolean']>;
- };
- export type MutationAuthenticateArgs = {
- input: AuthenticationInput;
- rememberMe?: Maybe<Scalars['Boolean']>;
- };
- export type MutationCreateChannelArgs = {
- input: CreateChannelInput;
- };
- export type MutationUpdateChannelArgs = {
- input: UpdateChannelInput;
- };
- export type MutationDeleteChannelArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateCollectionArgs = {
- input: CreateCollectionInput;
- };
- export type MutationUpdateCollectionArgs = {
- input: UpdateCollectionInput;
- };
- export type MutationDeleteCollectionArgs = {
- id: Scalars['ID'];
- };
- export type MutationMoveCollectionArgs = {
- input: MoveCollectionInput;
- };
- export type MutationCreateCountryArgs = {
- input: CreateCountryInput;
- };
- export type MutationUpdateCountryArgs = {
- input: UpdateCountryInput;
- };
- export type MutationDeleteCountryArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateCustomerGroupArgs = {
- input: CreateCustomerGroupInput;
- };
- export type MutationUpdateCustomerGroupArgs = {
- input: UpdateCustomerGroupInput;
- };
- export type MutationDeleteCustomerGroupArgs = {
- id: Scalars['ID'];
- };
- export type MutationAddCustomersToGroupArgs = {
- customerGroupId: Scalars['ID'];
- customerIds: Array<Scalars['ID']>;
- };
- export type MutationRemoveCustomersFromGroupArgs = {
- customerGroupId: Scalars['ID'];
- customerIds: Array<Scalars['ID']>;
- };
- export type MutationCreateCustomerArgs = {
- input: CreateCustomerInput;
- password?: Maybe<Scalars['String']>;
- };
- export type MutationUpdateCustomerArgs = {
- input: UpdateCustomerInput;
- };
- export type MutationDeleteCustomerArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateCustomerAddressArgs = {
- customerId: Scalars['ID'];
- input: CreateAddressInput;
- };
- export type MutationUpdateCustomerAddressArgs = {
- input: UpdateAddressInput;
- };
- export type MutationDeleteCustomerAddressArgs = {
- id: Scalars['ID'];
- };
- export type MutationAddNoteToCustomerArgs = {
- input: AddNoteToCustomerInput;
- };
- export type MutationUpdateCustomerNoteArgs = {
- input: UpdateCustomerNoteInput;
- };
- export type MutationDeleteCustomerNoteArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateFacetArgs = {
- input: CreateFacetInput;
- };
- export type MutationUpdateFacetArgs = {
- input: UpdateFacetInput;
- };
- export type MutationDeleteFacetArgs = {
- id: Scalars['ID'];
- force?: Maybe<Scalars['Boolean']>;
- };
- export type MutationCreateFacetValuesArgs = {
- input: Array<CreateFacetValueInput>;
- };
- export type MutationUpdateFacetValuesArgs = {
- input: Array<UpdateFacetValueInput>;
- };
- export type MutationDeleteFacetValuesArgs = {
- ids: Array<Scalars['ID']>;
- force?: Maybe<Scalars['Boolean']>;
- };
- export type MutationUpdateGlobalSettingsArgs = {
- input: UpdateGlobalSettingsInput;
- };
- export type MutationImportProductsArgs = {
- csvFile: Scalars['Upload'];
- };
- export type MutationRemoveSettledJobsArgs = {
- queueNames?: Maybe<Array<Scalars['String']>>;
- olderThan?: Maybe<Scalars['DateTime']>;
- };
- export type MutationCancelJobArgs = {
- jobId: Scalars['ID'];
- };
- export type MutationFlushBufferedJobsArgs = {
- bufferIds?: Maybe<Array<Scalars['String']>>;
- };
- export type MutationSettlePaymentArgs = {
- id: Scalars['ID'];
- };
- export type MutationCancelPaymentArgs = {
- id: Scalars['ID'];
- };
- export type MutationAddFulfillmentToOrderArgs = {
- input: FulfillOrderInput;
- };
- export type MutationCancelOrderArgs = {
- input: CancelOrderInput;
- };
- export type MutationRefundOrderArgs = {
- input: RefundOrderInput;
- };
- export type MutationSettleRefundArgs = {
- input: SettleRefundInput;
- };
- export type MutationAddNoteToOrderArgs = {
- input: AddNoteToOrderInput;
- };
- export type MutationUpdateOrderNoteArgs = {
- input: UpdateOrderNoteInput;
- };
- export type MutationDeleteOrderNoteArgs = {
- id: Scalars['ID'];
- };
- export type MutationTransitionOrderToStateArgs = {
- id: Scalars['ID'];
- state: Scalars['String'];
- };
- export type MutationTransitionFulfillmentToStateArgs = {
- id: Scalars['ID'];
- state: Scalars['String'];
- };
- export type MutationTransitionPaymentToStateArgs = {
- id: Scalars['ID'];
- state: Scalars['String'];
- };
- export type MutationSetOrderCustomFieldsArgs = {
- input: UpdateOrderInput;
- };
- export type MutationModifyOrderArgs = {
- input: ModifyOrderInput;
- };
- export type MutationAddManualPaymentToOrderArgs = {
- input: ManualPaymentInput;
- };
- export type MutationCreatePaymentMethodArgs = {
- input: CreatePaymentMethodInput;
- };
- export type MutationUpdatePaymentMethodArgs = {
- input: UpdatePaymentMethodInput;
- };
- export type MutationDeletePaymentMethodArgs = {
- id: Scalars['ID'];
- force?: Maybe<Scalars['Boolean']>;
- };
- export type MutationCreateProductOptionGroupArgs = {
- input: CreateProductOptionGroupInput;
- };
- export type MutationUpdateProductOptionGroupArgs = {
- input: UpdateProductOptionGroupInput;
- };
- export type MutationCreateProductOptionArgs = {
- input: CreateProductOptionInput;
- };
- export type MutationUpdateProductOptionArgs = {
- input: UpdateProductOptionInput;
- };
- export type MutationDeleteProductOptionArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateProductArgs = {
- input: CreateProductInput;
- };
- export type MutationUpdateProductArgs = {
- input: UpdateProductInput;
- };
- export type MutationDeleteProductArgs = {
- id: Scalars['ID'];
- };
- export type MutationAddOptionGroupToProductArgs = {
- productId: Scalars['ID'];
- optionGroupId: Scalars['ID'];
- };
- export type MutationRemoveOptionGroupFromProductArgs = {
- productId: Scalars['ID'];
- optionGroupId: Scalars['ID'];
- };
- export type MutationCreateProductVariantsArgs = {
- input: Array<CreateProductVariantInput>;
- };
- export type MutationUpdateProductVariantsArgs = {
- input: Array<UpdateProductVariantInput>;
- };
- export type MutationDeleteProductVariantArgs = {
- id: Scalars['ID'];
- };
- export type MutationAssignProductsToChannelArgs = {
- input: AssignProductsToChannelInput;
- };
- export type MutationRemoveProductsFromChannelArgs = {
- input: RemoveProductsFromChannelInput;
- };
- export type MutationAssignProductVariantsToChannelArgs = {
- input: AssignProductVariantsToChannelInput;
- };
- export type MutationRemoveProductVariantsFromChannelArgs = {
- input: RemoveProductVariantsFromChannelInput;
- };
- export type MutationCreatePromotionArgs = {
- input: CreatePromotionInput;
- };
- export type MutationUpdatePromotionArgs = {
- input: UpdatePromotionInput;
- };
- export type MutationDeletePromotionArgs = {
- id: Scalars['ID'];
- };
- export type MutationAssignPromotionsToChannelArgs = {
- input: AssignPromotionsToChannelInput;
- };
- export type MutationRemovePromotionsFromChannelArgs = {
- input: RemovePromotionsFromChannelInput;
- };
- export type MutationCreateRoleArgs = {
- input: CreateRoleInput;
- };
- export type MutationUpdateRoleArgs = {
- input: UpdateRoleInput;
- };
- export type MutationDeleteRoleArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateShippingMethodArgs = {
- input: CreateShippingMethodInput;
- };
- export type MutationUpdateShippingMethodArgs = {
- input: UpdateShippingMethodInput;
- };
- export type MutationDeleteShippingMethodArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateTagArgs = {
- input: CreateTagInput;
- };
- export type MutationUpdateTagArgs = {
- input: UpdateTagInput;
- };
- export type MutationDeleteTagArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateTaxCategoryArgs = {
- input: CreateTaxCategoryInput;
- };
- export type MutationUpdateTaxCategoryArgs = {
- input: UpdateTaxCategoryInput;
- };
- export type MutationDeleteTaxCategoryArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateTaxRateArgs = {
- input: CreateTaxRateInput;
- };
- export type MutationUpdateTaxRateArgs = {
- input: UpdateTaxRateInput;
- };
- export type MutationDeleteTaxRateArgs = {
- id: Scalars['ID'];
- };
- export type MutationCreateZoneArgs = {
- input: CreateZoneInput;
- };
- export type MutationUpdateZoneArgs = {
- input: UpdateZoneInput;
- };
- export type MutationDeleteZoneArgs = {
- id: Scalars['ID'];
- };
- export type MutationAddMembersToZoneArgs = {
- zoneId: Scalars['ID'];
- memberIds: Array<Scalars['ID']>;
- };
- export type MutationRemoveMembersFromZoneArgs = {
- zoneId: Scalars['ID'];
- memberIds: Array<Scalars['ID']>;
- };
- export type NativeAuthInput = {
- username: Scalars['String'];
- password: Scalars['String'];
- };
- /** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
- export type NativeAuthStrategyError = ErrorResult & {
- __typename?: 'NativeAuthStrategyError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
- /** Returned when attempting to set a negative OrderLine quantity. */
- export type NegativeQuantityError = ErrorResult & {
- __typename?: 'NegativeQuantityError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Returned when a call to modifyOrder fails to specify any changes */
- export type NoChangesSpecifiedError = ErrorResult & {
- __typename?: 'NoChangesSpecifiedError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Node = {
- id: Scalars['ID'];
- };
- /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
- export type NothingToRefundError = ErrorResult & {
- __typename?: 'NothingToRefundError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Operators for filtering on a list of Number fields */
- export type NumberListOperators = {
- inList: Scalars['Float'];
- };
- /** Operators for filtering on a Int or Float field */
- export type NumberOperators = {
- eq?: Maybe<Scalars['Float']>;
- lt?: Maybe<Scalars['Float']>;
- lte?: Maybe<Scalars['Float']>;
- gt?: Maybe<Scalars['Float']>;
- gte?: Maybe<Scalars['Float']>;
- between?: Maybe<NumberRange>;
- };
- export type NumberRange = {
- start: Scalars['Float'];
- end: Scalars['Float'];
- };
- export type Order = Node & {
- __typename?: 'Order';
- nextStates: Array<Scalars['String']>;
- modifications: Array<OrderModification>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- /**
- * The date & time that the Order was placed, i.e. the Customer
- * completed the checkout and the Order is no longer "active"
- */
- orderPlacedAt?: Maybe<Scalars['DateTime']>;
- /** A unique code for the Order */
- code: Scalars['String'];
- state: Scalars['String'];
- /** An order is active as long as the payment process has not been completed */
- active: Scalars['Boolean'];
- customer?: Maybe<Customer>;
- shippingAddress?: Maybe<OrderAddress>;
- billingAddress?: Maybe<OrderAddress>;
- lines: Array<OrderLine>;
- /**
- * Surcharges are arbitrary modifications to the Order total which are neither
- * ProductVariants nor discounts resulting from applied Promotions. For example,
- * one-off discounts based on customer interaction, or surcharges based on payment
- * methods.
- */
- surcharges: Array<Surcharge>;
- discounts: Array<Discount>;
- /** An array of all coupon codes applied to the Order */
- couponCodes: Array<Scalars['String']>;
- /** Promotions applied to the order. Only gets populated after the payment process has completed. */
- promotions: Array<Promotion>;
- payments?: Maybe<Array<Payment>>;
- fulfillments?: Maybe<Array<Fulfillment>>;
- totalQuantity: Scalars['Int'];
- /**
- * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
- * discounts which have been prorated (proportionally distributed) amongst the OrderItems.
- * To get a total of all OrderLines which does not account for prorated discounts, use the
- * sum of `OrderLine.discountedLinePrice` values.
- */
- subTotal: Scalars['Int'];
- /** Same as subTotal, but inclusive of tax */
- subTotalWithTax: Scalars['Int'];
- currencyCode: CurrencyCode;
- shippingLines: Array<ShippingLine>;
- shipping: Scalars['Int'];
- shippingWithTax: Scalars['Int'];
- /** Equal to subTotal plus shipping */
- total: Scalars['Int'];
- /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
- totalWithTax: Scalars['Int'];
- /** A summary of the taxes being applied to this Order */
- taxSummary: Array<OrderTaxSummary>;
- history: HistoryEntryList;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type OrderHistoryArgs = {
- options?: Maybe<HistoryEntryListOptions>;
- };
- export type OrderAddress = {
- __typename?: 'OrderAddress';
- fullName?: Maybe<Scalars['String']>;
- company?: Maybe<Scalars['String']>;
- streetLine1?: Maybe<Scalars['String']>;
- streetLine2?: Maybe<Scalars['String']>;
- city?: Maybe<Scalars['String']>;
- province?: Maybe<Scalars['String']>;
- postalCode?: Maybe<Scalars['String']>;
- country?: Maybe<Scalars['String']>;
- countryCode?: Maybe<Scalars['String']>;
- phoneNumber?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type OrderFilterParameter = {
- customerLastName?: Maybe<StringOperators>;
- transactionId?: Maybe<StringOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- orderPlacedAt?: Maybe<DateOperators>;
- code?: Maybe<StringOperators>;
- state?: Maybe<StringOperators>;
- active?: Maybe<BooleanOperators>;
- totalQuantity?: Maybe<NumberOperators>;
- subTotal?: Maybe<NumberOperators>;
- subTotalWithTax?: Maybe<NumberOperators>;
- currencyCode?: Maybe<StringOperators>;
- shipping?: Maybe<NumberOperators>;
- shippingWithTax?: Maybe<NumberOperators>;
- total?: Maybe<NumberOperators>;
- totalWithTax?: Maybe<NumberOperators>;
- };
- export type OrderItem = Node & {
- __typename?: 'OrderItem';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- cancelled: Scalars['Boolean'];
- /** The price of a single unit, excluding tax and discounts */
- unitPrice: Scalars['Int'];
- /** The price of a single unit, including tax but excluding discounts */
- unitPriceWithTax: Scalars['Int'];
- /**
- * The price of a single unit including discounts, excluding tax.
- *
- * If Order-level discounts have been applied, this will not be the
- * actual taxable unit price (see `proratedUnitPrice`), but is generally the
- * correct price to display to customers to avoid confusion
- * about the internal handling of distributed Order-level discounts.
- */
- discountedUnitPrice: Scalars['Int'];
- /** The price of a single unit including discounts and tax */
- discountedUnitPriceWithTax: Scalars['Int'];
- /**
- * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
- * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
- * and refund calculations.
- */
- proratedUnitPrice: Scalars['Int'];
- /** The proratedUnitPrice including tax */
- proratedUnitPriceWithTax: Scalars['Int'];
- unitTax: Scalars['Int'];
- taxRate: Scalars['Float'];
- adjustments: Array<Adjustment>;
- taxLines: Array<TaxLine>;
- fulfillment?: Maybe<Fulfillment>;
- refundId?: Maybe<Scalars['ID']>;
- };
- /** Returned when the maximum order size limit has been reached. */
- export type OrderLimitError = ErrorResult & {
- __typename?: 'OrderLimitError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- maxItems: Scalars['Int'];
- };
- export type OrderLine = Node & {
- __typename?: 'OrderLine';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- featuredAsset?: Maybe<Asset>;
- /** The price of a single unit, excluding tax and discounts */
- unitPrice: Scalars['Int'];
- /** The price of a single unit, including tax but excluding discounts */
- unitPriceWithTax: Scalars['Int'];
- /** Non-zero if the unitPrice has changed since it was initially added to Order */
- unitPriceChangeSinceAdded: Scalars['Int'];
- /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
- unitPriceWithTaxChangeSinceAdded: Scalars['Int'];
- /**
- * The price of a single unit including discounts, excluding tax.
- *
- * If Order-level discounts have been applied, this will not be the
- * actual taxable unit price (see `proratedUnitPrice`), but is generally the
- * correct price to display to customers to avoid confusion
- * about the internal handling of distributed Order-level discounts.
- */
- discountedUnitPrice: Scalars['Int'];
- /** The price of a single unit including discounts and tax */
- discountedUnitPriceWithTax: Scalars['Int'];
- /**
- * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
- * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
- * and refund calculations.
- */
- proratedUnitPrice: Scalars['Int'];
- /** The proratedUnitPrice including tax */
- proratedUnitPriceWithTax: Scalars['Int'];
- quantity: Scalars['Int'];
- items: Array<OrderItem>;
- taxRate: Scalars['Float'];
- /** The total price of the line excluding tax and discounts. */
- linePrice: Scalars['Int'];
- /** The total price of the line including tax but excluding discounts. */
- linePriceWithTax: Scalars['Int'];
- /** The price of the line including discounts, excluding tax */
- discountedLinePrice: Scalars['Int'];
- /** The price of the line including discounts and tax */
- discountedLinePriceWithTax: Scalars['Int'];
- /**
- * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
- * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
- * and refund calculations.
- */
- proratedLinePrice: Scalars['Int'];
- /** The proratedLinePrice including tax */
- proratedLinePriceWithTax: Scalars['Int'];
- /** The total tax on this line */
- lineTax: Scalars['Int'];
- discounts: Array<Discount>;
- taxLines: Array<TaxLine>;
- order: Order;
- fulfillments?: Maybe<Array<Fulfillment>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type OrderLineInput = {
- orderLineId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type OrderList = PaginatedList & {
- __typename?: 'OrderList';
- items: Array<Order>;
- totalItems: Scalars['Int'];
- };
- export type OrderListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<OrderSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<OrderFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type OrderModification = Node & {
- __typename?: 'OrderModification';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- priceChange: Scalars['Int'];
- note: Scalars['String'];
- orderItems?: Maybe<Array<OrderItem>>;
- surcharges?: Maybe<Array<Surcharge>>;
- payment?: Maybe<Payment>;
- refund?: Maybe<Refund>;
- isSettled: Scalars['Boolean'];
- };
- /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
- export type OrderModificationStateError = ErrorResult & {
- __typename?: 'OrderModificationStateError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type OrderProcessState = {
- __typename?: 'OrderProcessState';
- name: Scalars['String'];
- to: Array<Scalars['String']>;
- };
- export type OrderSortParameter = {
- customerLastName?: Maybe<SortOrder>;
- transactionId?: Maybe<SortOrder>;
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- orderPlacedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- state?: Maybe<SortOrder>;
- totalQuantity?: Maybe<SortOrder>;
- subTotal?: Maybe<SortOrder>;
- subTotalWithTax?: Maybe<SortOrder>;
- shipping?: Maybe<SortOrder>;
- shippingWithTax?: Maybe<SortOrder>;
- total?: Maybe<SortOrder>;
- totalWithTax?: Maybe<SortOrder>;
- };
- /** Returned if there is an error in transitioning the Order state */
- export type OrderStateTransitionError = ErrorResult & {
- __typename?: 'OrderStateTransitionError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- transitionError: Scalars['String'];
- fromState: Scalars['String'];
- toState: Scalars['String'];
- };
- /**
- * A summary of the taxes being applied to this order, grouped
- * by taxRate.
- */
- export type OrderTaxSummary = {
- __typename?: 'OrderTaxSummary';
- /** A description of this tax */
- description: Scalars['String'];
- /** The taxRate as a percentage */
- taxRate: Scalars['Float'];
- /** The total net price or OrderItems to which this taxRate applies */
- taxBase: Scalars['Int'];
- /** The total tax being applied to the Order at this taxRate */
- taxTotal: Scalars['Int'];
- };
- export type PaginatedList = {
- items: Array<Node>;
- totalItems: Scalars['Int'];
- };
- export type Payment = Node & {
- __typename?: 'Payment';
- nextStates: Array<Scalars['String']>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- method: Scalars['String'];
- amount: Scalars['Int'];
- state: Scalars['String'];
- transactionId?: Maybe<Scalars['String']>;
- errorMessage?: Maybe<Scalars['String']>;
- refunds: Array<Refund>;
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type PaymentMethod = Node & {
- __typename?: 'PaymentMethod';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- code: Scalars['String'];
- description: Scalars['String'];
- enabled: Scalars['Boolean'];
- checker?: Maybe<ConfigurableOperation>;
- handler: ConfigurableOperation;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type PaymentMethodFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- };
- export type PaymentMethodList = PaginatedList & {
- __typename?: 'PaymentMethodList';
- items: Array<PaymentMethod>;
- totalItems: Scalars['Int'];
- };
- export type PaymentMethodListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<PaymentMethodSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<PaymentMethodFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- /**
- * Returned when a call to modifyOrder fails to include a paymentMethod even
- * though the price has increased as a result of the changes.
- */
- export type PaymentMethodMissingError = ErrorResult & {
- __typename?: 'PaymentMethodMissingError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type PaymentMethodQuote = {
- __typename?: 'PaymentMethodQuote';
- id: Scalars['ID'];
- code: Scalars['String'];
- name: Scalars['String'];
- description: Scalars['String'];
- isEligible: Scalars['Boolean'];
- eligibilityMessage?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type PaymentMethodSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
- export type PaymentOrderMismatchError = ErrorResult & {
- __typename?: 'PaymentOrderMismatchError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Returned when there is an error in transitioning the Payment state */
- export type PaymentStateTransitionError = ErrorResult & {
- __typename?: 'PaymentStateTransitionError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- transitionError: Scalars['String'];
- fromState: Scalars['String'];
- toState: Scalars['String'];
- };
- /**
- * @description
- * Permissions for administrators and customers. Used to control access to
- * GraphQL resolvers via the {@link Allow} decorator.
- *
- * ## Understanding Permission.Owner
- *
- * `Permission.Owner` is a special permission which is used in some of the Vendure resolvers to indicate that that resolver should only
- * be accessible to the "owner" of that resource.
- *
- * For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
- * based on the activeUserId of the current session. As a result, the resolver code looks like this:
- *
- * @example
- * ```TypeScript
- * \@Query()
- * \@Allow(Permission.Owner)
- * async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
- * const userId = ctx.activeUserId;
- * if (userId) {
- * return this.customerService.findOneByUserId(ctx, userId);
- * }
- * }
- * ```
- *
- * Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
- * nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
- * of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
- *
- *
- * @docsCategory common
- */
- export enum Permission {
- /** Authenticated means simply that the user is logged in */
- Authenticated = 'Authenticated',
- /** SuperAdmin has unrestricted access to all operations */
- SuperAdmin = 'SuperAdmin',
- /** Owner means the user owns this entity, e.g. a Customer's own Order */
- Owner = 'Owner',
- /** Public means any unauthenticated user may perform the operation */
- Public = 'Public',
- /** Grants permission to update GlobalSettings */
- UpdateGlobalSettings = 'UpdateGlobalSettings',
- /** Grants permission to create Products, Facets, Assets, Collections */
- CreateCatalog = 'CreateCatalog',
- /** Grants permission to read Products, Facets, Assets, Collections */
- ReadCatalog = 'ReadCatalog',
- /** Grants permission to update Products, Facets, Assets, Collections */
- UpdateCatalog = 'UpdateCatalog',
- /** Grants permission to delete Products, Facets, Assets, Collections */
- DeleteCatalog = 'DeleteCatalog',
- /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
- CreateSettings = 'CreateSettings',
- /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
- ReadSettings = 'ReadSettings',
- /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
- UpdateSettings = 'UpdateSettings',
- /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
- DeleteSettings = 'DeleteSettings',
- /** Grants permission to create Administrator */
- CreateAdministrator = 'CreateAdministrator',
- /** Grants permission to read Administrator */
- ReadAdministrator = 'ReadAdministrator',
- /** Grants permission to update Administrator */
- UpdateAdministrator = 'UpdateAdministrator',
- /** Grants permission to delete Administrator */
- DeleteAdministrator = 'DeleteAdministrator',
- /** Grants permission to create Asset */
- CreateAsset = 'CreateAsset',
- /** Grants permission to read Asset */
- ReadAsset = 'ReadAsset',
- /** Grants permission to update Asset */
- UpdateAsset = 'UpdateAsset',
- /** Grants permission to delete Asset */
- DeleteAsset = 'DeleteAsset',
- /** Grants permission to create Channel */
- CreateChannel = 'CreateChannel',
- /** Grants permission to read Channel */
- ReadChannel = 'ReadChannel',
- /** Grants permission to update Channel */
- UpdateChannel = 'UpdateChannel',
- /** Grants permission to delete Channel */
- DeleteChannel = 'DeleteChannel',
- /** Grants permission to create Collection */
- CreateCollection = 'CreateCollection',
- /** Grants permission to read Collection */
- ReadCollection = 'ReadCollection',
- /** Grants permission to update Collection */
- UpdateCollection = 'UpdateCollection',
- /** Grants permission to delete Collection */
- DeleteCollection = 'DeleteCollection',
- /** Grants permission to create Country */
- CreateCountry = 'CreateCountry',
- /** Grants permission to read Country */
- ReadCountry = 'ReadCountry',
- /** Grants permission to update Country */
- UpdateCountry = 'UpdateCountry',
- /** Grants permission to delete Country */
- DeleteCountry = 'DeleteCountry',
- /** Grants permission to create Customer */
- CreateCustomer = 'CreateCustomer',
- /** Grants permission to read Customer */
- ReadCustomer = 'ReadCustomer',
- /** Grants permission to update Customer */
- UpdateCustomer = 'UpdateCustomer',
- /** Grants permission to delete Customer */
- DeleteCustomer = 'DeleteCustomer',
- /** Grants permission to create CustomerGroup */
- CreateCustomerGroup = 'CreateCustomerGroup',
- /** Grants permission to read CustomerGroup */
- ReadCustomerGroup = 'ReadCustomerGroup',
- /** Grants permission to update CustomerGroup */
- UpdateCustomerGroup = 'UpdateCustomerGroup',
- /** Grants permission to delete CustomerGroup */
- DeleteCustomerGroup = 'DeleteCustomerGroup',
- /** Grants permission to create Facet */
- CreateFacet = 'CreateFacet',
- /** Grants permission to read Facet */
- ReadFacet = 'ReadFacet',
- /** Grants permission to update Facet */
- UpdateFacet = 'UpdateFacet',
- /** Grants permission to delete Facet */
- DeleteFacet = 'DeleteFacet',
- /** Grants permission to create Order */
- CreateOrder = 'CreateOrder',
- /** Grants permission to read Order */
- ReadOrder = 'ReadOrder',
- /** Grants permission to update Order */
- UpdateOrder = 'UpdateOrder',
- /** Grants permission to delete Order */
- DeleteOrder = 'DeleteOrder',
- /** Grants permission to create PaymentMethod */
- CreatePaymentMethod = 'CreatePaymentMethod',
- /** Grants permission to read PaymentMethod */
- ReadPaymentMethod = 'ReadPaymentMethod',
- /** Grants permission to update PaymentMethod */
- UpdatePaymentMethod = 'UpdatePaymentMethod',
- /** Grants permission to delete PaymentMethod */
- DeletePaymentMethod = 'DeletePaymentMethod',
- /** Grants permission to create Product */
- CreateProduct = 'CreateProduct',
- /** Grants permission to read Product */
- ReadProduct = 'ReadProduct',
- /** Grants permission to update Product */
- UpdateProduct = 'UpdateProduct',
- /** Grants permission to delete Product */
- DeleteProduct = 'DeleteProduct',
- /** Grants permission to create Promotion */
- CreatePromotion = 'CreatePromotion',
- /** Grants permission to read Promotion */
- ReadPromotion = 'ReadPromotion',
- /** Grants permission to update Promotion */
- UpdatePromotion = 'UpdatePromotion',
- /** Grants permission to delete Promotion */
- DeletePromotion = 'DeletePromotion',
- /** Grants permission to create ShippingMethod */
- CreateShippingMethod = 'CreateShippingMethod',
- /** Grants permission to read ShippingMethod */
- ReadShippingMethod = 'ReadShippingMethod',
- /** Grants permission to update ShippingMethod */
- UpdateShippingMethod = 'UpdateShippingMethod',
- /** Grants permission to delete ShippingMethod */
- DeleteShippingMethod = 'DeleteShippingMethod',
- /** Grants permission to create Tag */
- CreateTag = 'CreateTag',
- /** Grants permission to read Tag */
- ReadTag = 'ReadTag',
- /** Grants permission to update Tag */
- UpdateTag = 'UpdateTag',
- /** Grants permission to delete Tag */
- DeleteTag = 'DeleteTag',
- /** Grants permission to create TaxCategory */
- CreateTaxCategory = 'CreateTaxCategory',
- /** Grants permission to read TaxCategory */
- ReadTaxCategory = 'ReadTaxCategory',
- /** Grants permission to update TaxCategory */
- UpdateTaxCategory = 'UpdateTaxCategory',
- /** Grants permission to delete TaxCategory */
- DeleteTaxCategory = 'DeleteTaxCategory',
- /** Grants permission to create TaxRate */
- CreateTaxRate = 'CreateTaxRate',
- /** Grants permission to read TaxRate */
- ReadTaxRate = 'ReadTaxRate',
- /** Grants permission to update TaxRate */
- UpdateTaxRate = 'UpdateTaxRate',
- /** Grants permission to delete TaxRate */
- DeleteTaxRate = 'DeleteTaxRate',
- /** Grants permission to create System */
- CreateSystem = 'CreateSystem',
- /** Grants permission to read System */
- ReadSystem = 'ReadSystem',
- /** Grants permission to update System */
- UpdateSystem = 'UpdateSystem',
- /** Grants permission to delete System */
- DeleteSystem = 'DeleteSystem',
- /** Grants permission to create Zone */
- CreateZone = 'CreateZone',
- /** Grants permission to read Zone */
- ReadZone = 'ReadZone',
- /** Grants permission to update Zone */
- UpdateZone = 'UpdateZone',
- /** Grants permission to delete Zone */
- DeleteZone = 'DeleteZone'
- }
- export type PermissionDefinition = {
- __typename?: 'PermissionDefinition';
- name: Scalars['String'];
- description: Scalars['String'];
- assignable: Scalars['Boolean'];
- };
- export type PreviewCollectionVariantsInput = {
- parentId?: Maybe<Scalars['ID']>;
- filters: Array<ConfigurableOperationInput>;
- };
- /** The price range where the result has more than one price */
- export type PriceRange = {
- __typename?: 'PriceRange';
- min: Scalars['Int'];
- max: Scalars['Int'];
- };
- export type Product = Node & {
- __typename?: 'Product';
- enabled: Scalars['Boolean'];
- channels: Array<Channel>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- slug: Scalars['String'];
- description: Scalars['String'];
- featuredAsset?: Maybe<Asset>;
- assets: Array<Asset>;
- /** Returns all ProductVariants */
- variants: Array<ProductVariant>;
- /** Returns a paginated, sortable, filterable list of ProductVariants */
- variantList: ProductVariantList;
- optionGroups: Array<ProductOptionGroup>;
- facetValues: Array<FacetValue>;
- translations: Array<ProductTranslation>;
- collections: Array<Collection>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductVariantListArgs = {
- options?: Maybe<ProductVariantListOptions>;
- };
- export type ProductFilterParameter = {
- enabled?: Maybe<BooleanOperators>;
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- slug?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- };
- export type ProductList = PaginatedList & {
- __typename?: 'ProductList';
- items: Array<Product>;
- totalItems: Scalars['Int'];
- };
- export type ProductListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<ProductSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<ProductFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type ProductOption = Node & {
- __typename?: 'ProductOption';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- code: Scalars['String'];
- name: Scalars['String'];
- groupId: Scalars['ID'];
- group: ProductOptionGroup;
- translations: Array<ProductOptionTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductOptionGroup = Node & {
- __typename?: 'ProductOptionGroup';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- code: Scalars['String'];
- name: Scalars['String'];
- options: Array<ProductOption>;
- translations: Array<ProductOptionGroupTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductOptionGroupTranslation = {
- __typename?: 'ProductOptionGroupTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type ProductOptionGroupTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductOptionInUseError = ErrorResult & {
- __typename?: 'ProductOptionInUseError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- optionGroupCode: Scalars['String'];
- productVariantCount: Scalars['Int'];
- };
- export type ProductOptionTranslation = {
- __typename?: 'ProductOptionTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type ProductOptionTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- slug?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type ProductTranslation = {
- __typename?: 'ProductTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- slug: Scalars['String'];
- description: Scalars['String'];
- };
- export type ProductTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- slug?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductVariant = Node & {
- __typename?: 'ProductVariant';
- enabled: Scalars['Boolean'];
- trackInventory: GlobalFlag;
- stockOnHand: Scalars['Int'];
- stockAllocated: Scalars['Int'];
- outOfStockThreshold: Scalars['Int'];
- useGlobalOutOfStockThreshold: Scalars['Boolean'];
- stockMovements: StockMovementList;
- channels: Array<Channel>;
- id: Scalars['ID'];
- product: Product;
- productId: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- sku: Scalars['String'];
- name: Scalars['String'];
- featuredAsset?: Maybe<Asset>;
- assets: Array<Asset>;
- price: Scalars['Int'];
- currencyCode: CurrencyCode;
- priceWithTax: Scalars['Int'];
- stockLevel: Scalars['String'];
- taxRateApplied: TaxRate;
- taxCategory: TaxCategory;
- options: Array<ProductOption>;
- facetValues: Array<FacetValue>;
- translations: Array<ProductVariantTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductVariantStockMovementsArgs = {
- options?: Maybe<StockMovementListOptions>;
- };
- export type ProductVariantFilterParameter = {
- enabled?: Maybe<BooleanOperators>;
- trackInventory?: Maybe<StringOperators>;
- stockOnHand?: Maybe<NumberOperators>;
- stockAllocated?: Maybe<NumberOperators>;
- outOfStockThreshold?: Maybe<NumberOperators>;
- useGlobalOutOfStockThreshold?: Maybe<BooleanOperators>;
- id?: Maybe<IdOperators>;
- productId?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- sku?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- price?: Maybe<NumberOperators>;
- currencyCode?: Maybe<StringOperators>;
- priceWithTax?: Maybe<NumberOperators>;
- stockLevel?: Maybe<StringOperators>;
- };
- export type ProductVariantList = PaginatedList & {
- __typename?: 'ProductVariantList';
- items: Array<ProductVariant>;
- totalItems: Scalars['Int'];
- };
- export type ProductVariantListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<ProductVariantSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<ProductVariantFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type ProductVariantSortParameter = {
- stockOnHand?: Maybe<SortOrder>;
- stockAllocated?: Maybe<SortOrder>;
- outOfStockThreshold?: Maybe<SortOrder>;
- id?: Maybe<SortOrder>;
- productId?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- sku?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- price?: Maybe<SortOrder>;
- priceWithTax?: Maybe<SortOrder>;
- stockLevel?: Maybe<SortOrder>;
- };
- export type ProductVariantTranslation = {
- __typename?: 'ProductVariantTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type ProductVariantTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type Promotion = Node & {
- __typename?: 'Promotion';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- startsAt?: Maybe<Scalars['DateTime']>;
- endsAt?: Maybe<Scalars['DateTime']>;
- couponCode?: Maybe<Scalars['String']>;
- perCustomerUsageLimit?: Maybe<Scalars['Int']>;
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- conditions: Array<ConfigurableOperation>;
- actions: Array<ConfigurableOperation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type PromotionFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- startsAt?: Maybe<DateOperators>;
- endsAt?: Maybe<DateOperators>;
- couponCode?: Maybe<StringOperators>;
- perCustomerUsageLimit?: Maybe<NumberOperators>;
- name?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- };
- export type PromotionList = PaginatedList & {
- __typename?: 'PromotionList';
- items: Array<Promotion>;
- totalItems: Scalars['Int'];
- };
- export type PromotionListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<PromotionSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<PromotionFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type PromotionSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- startsAt?: Maybe<SortOrder>;
- endsAt?: Maybe<SortOrder>;
- couponCode?: Maybe<SortOrder>;
- perCustomerUsageLimit?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- };
- /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
- export type QuantityTooGreatError = ErrorResult & {
- __typename?: 'QuantityTooGreatError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Query = {
- __typename?: 'Query';
- administrators: AdministratorList;
- administrator?: Maybe<Administrator>;
- activeAdministrator?: Maybe<Administrator>;
- /** Get a list of Assets */
- assets: AssetList;
- /** Get a single Asset by id */
- asset?: Maybe<Asset>;
- me?: Maybe<CurrentUser>;
- channels: Array<Channel>;
- channel?: Maybe<Channel>;
- activeChannel: Channel;
- collections: CollectionList;
- /** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
- collection?: Maybe<Collection>;
- collectionFilters: Array<ConfigurableOperationDefinition>;
- /** Used for real-time previews of the contents of a Collection */
- previewCollectionVariants: ProductVariantList;
- countries: CountryList;
- country?: Maybe<Country>;
- customerGroups: CustomerGroupList;
- customerGroup?: Maybe<CustomerGroup>;
- customers: CustomerList;
- customer?: Maybe<Customer>;
- facets: FacetList;
- facet?: Maybe<Facet>;
- globalSettings: GlobalSettings;
- job?: Maybe<Job>;
- jobs: JobList;
- jobsById: Array<Job>;
- jobQueues: Array<JobQueue>;
- jobBufferSize: Array<JobBufferSize>;
- order?: Maybe<Order>;
- orders: OrderList;
- paymentMethods: PaymentMethodList;
- paymentMethod?: Maybe<PaymentMethod>;
- paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
- paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
- productOptionGroups: Array<ProductOptionGroup>;
- productOptionGroup?: Maybe<ProductOptionGroup>;
- search: SearchResponse;
- pendingSearchIndexUpdates: Scalars['Int'];
- /** List Products */
- products: ProductList;
- /** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
- product?: Maybe<Product>;
- /** List ProductVariants either all or for the specific product. */
- productVariants: ProductVariantList;
- /** Get a ProductVariant by id */
- productVariant?: Maybe<ProductVariant>;
- promotion?: Maybe<Promotion>;
- promotions: PromotionList;
- promotionConditions: Array<ConfigurableOperationDefinition>;
- promotionActions: Array<ConfigurableOperationDefinition>;
- roles: RoleList;
- role?: Maybe<Role>;
- shippingMethods: ShippingMethodList;
- shippingMethod?: Maybe<ShippingMethod>;
- shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
- shippingCalculators: Array<ConfigurableOperationDefinition>;
- fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
- testShippingMethod: TestShippingMethodResult;
- testEligibleShippingMethods: Array<ShippingMethodQuote>;
- tag: Tag;
- tags: TagList;
- taxCategories: Array<TaxCategory>;
- taxCategory?: Maybe<TaxCategory>;
- taxRates: TaxRateList;
- taxRate?: Maybe<TaxRate>;
- zones: Array<Zone>;
- zone?: Maybe<Zone>;
- };
- export type QueryAdministratorsArgs = {
- options?: Maybe<AdministratorListOptions>;
- };
- export type QueryAdministratorArgs = {
- id: Scalars['ID'];
- };
- export type QueryAssetsArgs = {
- options?: Maybe<AssetListOptions>;
- };
- export type QueryAssetArgs = {
- id: Scalars['ID'];
- };
- export type QueryChannelArgs = {
- id: Scalars['ID'];
- };
- export type QueryCollectionsArgs = {
- options?: Maybe<CollectionListOptions>;
- };
- export type QueryCollectionArgs = {
- id?: Maybe<Scalars['ID']>;
- slug?: Maybe<Scalars['String']>;
- };
- export type QueryPreviewCollectionVariantsArgs = {
- input: PreviewCollectionVariantsInput;
- options?: Maybe<ProductVariantListOptions>;
- };
- export type QueryCountriesArgs = {
- options?: Maybe<CountryListOptions>;
- };
- export type QueryCountryArgs = {
- id: Scalars['ID'];
- };
- export type QueryCustomerGroupsArgs = {
- options?: Maybe<CustomerGroupListOptions>;
- };
- export type QueryCustomerGroupArgs = {
- id: Scalars['ID'];
- };
- export type QueryCustomersArgs = {
- options?: Maybe<CustomerListOptions>;
- };
- export type QueryCustomerArgs = {
- id: Scalars['ID'];
- };
- export type QueryFacetsArgs = {
- options?: Maybe<FacetListOptions>;
- };
- export type QueryFacetArgs = {
- id: Scalars['ID'];
- };
- export type QueryJobArgs = {
- jobId: Scalars['ID'];
- };
- export type QueryJobsArgs = {
- options?: Maybe<JobListOptions>;
- };
- export type QueryJobsByIdArgs = {
- jobIds: Array<Scalars['ID']>;
- };
- export type QueryJobBufferSizeArgs = {
- bufferIds?: Maybe<Array<Scalars['String']>>;
- };
- export type QueryOrderArgs = {
- id: Scalars['ID'];
- };
- export type QueryOrdersArgs = {
- options?: Maybe<OrderListOptions>;
- };
- export type QueryPaymentMethodsArgs = {
- options?: Maybe<PaymentMethodListOptions>;
- };
- export type QueryPaymentMethodArgs = {
- id: Scalars['ID'];
- };
- export type QueryProductOptionGroupsArgs = {
- filterTerm?: Maybe<Scalars['String']>;
- };
- export type QueryProductOptionGroupArgs = {
- id: Scalars['ID'];
- };
- export type QuerySearchArgs = {
- input: SearchInput;
- };
- export type QueryProductsArgs = {
- options?: Maybe<ProductListOptions>;
- };
- export type QueryProductArgs = {
- id?: Maybe<Scalars['ID']>;
- slug?: Maybe<Scalars['String']>;
- };
- export type QueryProductVariantsArgs = {
- options?: Maybe<ProductVariantListOptions>;
- productId?: Maybe<Scalars['ID']>;
- };
- export type QueryProductVariantArgs = {
- id: Scalars['ID'];
- };
- export type QueryPromotionArgs = {
- id: Scalars['ID'];
- };
- export type QueryPromotionsArgs = {
- options?: Maybe<PromotionListOptions>;
- };
- export type QueryRolesArgs = {
- options?: Maybe<RoleListOptions>;
- };
- export type QueryRoleArgs = {
- id: Scalars['ID'];
- };
- export type QueryShippingMethodsArgs = {
- options?: Maybe<ShippingMethodListOptions>;
- };
- export type QueryShippingMethodArgs = {
- id: Scalars['ID'];
- };
- export type QueryTestShippingMethodArgs = {
- input: TestShippingMethodInput;
- };
- export type QueryTestEligibleShippingMethodsArgs = {
- input: TestEligibleShippingMethodsInput;
- };
- export type QueryTagArgs = {
- id: Scalars['ID'];
- };
- export type QueryTagsArgs = {
- options?: Maybe<TagListOptions>;
- };
- export type QueryTaxCategoryArgs = {
- id: Scalars['ID'];
- };
- export type QueryTaxRatesArgs = {
- options?: Maybe<TaxRateListOptions>;
- };
- export type QueryTaxRateArgs = {
- id: Scalars['ID'];
- };
- export type QueryZoneArgs = {
- id: Scalars['ID'];
- };
- export type Refund = Node & {
- __typename?: 'Refund';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- items: Scalars['Int'];
- shipping: Scalars['Int'];
- adjustment: Scalars['Int'];
- total: Scalars['Int'];
- method?: Maybe<Scalars['String']>;
- state: Scalars['String'];
- transactionId?: Maybe<Scalars['String']>;
- reason?: Maybe<Scalars['String']>;
- orderItems: Array<OrderItem>;
- paymentId: Scalars['ID'];
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type RefundOrderInput = {
- lines: Array<OrderLineInput>;
- shipping: Scalars['Int'];
- adjustment: Scalars['Int'];
- paymentId: Scalars['ID'];
- reason?: Maybe<Scalars['String']>;
- };
- export type RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError;
- /** Returned if an attempting to refund an Order which is not in the expected state */
- export type RefundOrderStateError = ErrorResult & {
- __typename?: 'RefundOrderStateError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- orderState: Scalars['String'];
- };
- /**
- * Returned when a call to modifyOrder fails to include a refundPaymentId even
- * though the price has decreased as a result of the changes.
- */
- export type RefundPaymentIdMissingError = ErrorResult & {
- __typename?: 'RefundPaymentIdMissingError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** Returned when there is an error in transitioning the Refund state */
- export type RefundStateTransitionError = ErrorResult & {
- __typename?: 'RefundStateTransitionError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- transitionError: Scalars['String'];
- fromState: Scalars['String'];
- toState: Scalars['String'];
- };
- export type RelationCustomFieldConfig = CustomField & {
- __typename?: 'RelationCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- entity: Scalars['String'];
- scalarFields: Array<Scalars['String']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type Release = Node & StockMovement & {
- __typename?: 'Release';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderItem: OrderItem;
- };
- export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
- export type RemoveProductVariantsFromChannelInput = {
- productVariantIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type RemoveProductsFromChannelInput = {
- productIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type RemovePromotionsFromChannelInput = {
- promotionIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type Return = Node & StockMovement & {
- __typename?: 'Return';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderItem: OrderItem;
- };
- export type Role = Node & {
- __typename?: 'Role';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- code: Scalars['String'];
- description: Scalars['String'];
- permissions: Array<Permission>;
- channels: Array<Channel>;
- };
- export type RoleFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- code?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- };
- export type RoleList = PaginatedList & {
- __typename?: 'RoleList';
- items: Array<Role>;
- totalItems: Scalars['Int'];
- };
- export type RoleListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<RoleSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<RoleFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type RoleSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type Sale = Node & StockMovement & {
- __typename?: 'Sale';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderItem: OrderItem;
- };
- export type SearchInput = {
- term?: Maybe<Scalars['String']>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- facetValueOperator?: Maybe<LogicalOperator>;
- facetValueFilters?: Maybe<Array<FacetValueFilterInput>>;
- collectionId?: Maybe<Scalars['ID']>;
- collectionSlug?: Maybe<Scalars['String']>;
- groupByProduct?: Maybe<Scalars['Boolean']>;
- take?: Maybe<Scalars['Int']>;
- skip?: Maybe<Scalars['Int']>;
- sort?: Maybe<SearchResultSortParameter>;
- };
- export type SearchReindexResponse = {
- __typename?: 'SearchReindexResponse';
- success: Scalars['Boolean'];
- };
- export type SearchResponse = {
- __typename?: 'SearchResponse';
- items: Array<SearchResult>;
- totalItems: Scalars['Int'];
- facetValues: Array<FacetValueResult>;
- collections: Array<CollectionResult>;
- };
- export type SearchResult = {
- __typename?: 'SearchResult';
- enabled: Scalars['Boolean'];
- /** An array of ids of the Channels in which this result appears */
- channelIds: Array<Scalars['ID']>;
- sku: Scalars['String'];
- slug: Scalars['String'];
- productId: Scalars['ID'];
- productName: Scalars['String'];
- productAsset?: Maybe<SearchResultAsset>;
- productVariantId: Scalars['ID'];
- productVariantName: Scalars['String'];
- productVariantAsset?: Maybe<SearchResultAsset>;
- price: SearchResultPrice;
- priceWithTax: SearchResultPrice;
- currencyCode: CurrencyCode;
- description: Scalars['String'];
- facetIds: Array<Scalars['ID']>;
- facetValueIds: Array<Scalars['ID']>;
- /** An array of ids of the Collections in which this result appears */
- collectionIds: Array<Scalars['ID']>;
- /** A relevance score for the result. Differs between database implementations */
- score: Scalars['Float'];
- };
- export type SearchResultAsset = {
- __typename?: 'SearchResultAsset';
- id: Scalars['ID'];
- preview: Scalars['String'];
- focalPoint?: Maybe<Coordinate>;
- };
- /** The price of a search result product, either as a range or as a single price */
- export type SearchResultPrice = PriceRange | SinglePrice;
- export type SearchResultSortParameter = {
- name?: Maybe<SortOrder>;
- price?: Maybe<SortOrder>;
- };
- export type ServerConfig = {
- __typename?: 'ServerConfig';
- orderProcess: Array<OrderProcessState>;
- permittedAssetTypes: Array<Scalars['String']>;
- permissions: Array<PermissionDefinition>;
- customFieldConfig: CustomFields;
- };
- /** Returned if the Payment settlement fails */
- export type SettlePaymentError = ErrorResult & {
- __typename?: 'SettlePaymentError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- paymentErrorMessage: Scalars['String'];
- };
- export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError;
- export type SettleRefundInput = {
- id: Scalars['ID'];
- transactionId: Scalars['String'];
- };
- export type SettleRefundResult = Refund | RefundStateTransitionError;
- export type ShippingLine = {
- __typename?: 'ShippingLine';
- shippingMethod: ShippingMethod;
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- discountedPrice: Scalars['Int'];
- discountedPriceWithTax: Scalars['Int'];
- discounts: Array<Discount>;
- };
- export type ShippingMethod = Node & {
- __typename?: 'ShippingMethod';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- code: Scalars['String'];
- name: Scalars['String'];
- description: Scalars['String'];
- fulfillmentHandlerCode: Scalars['String'];
- checker: ConfigurableOperation;
- calculator: ConfigurableOperation;
- translations: Array<ShippingMethodTranslation>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ShippingMethodFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- fulfillmentHandlerCode?: Maybe<StringOperators>;
- };
- export type ShippingMethodList = PaginatedList & {
- __typename?: 'ShippingMethodList';
- items: Array<ShippingMethod>;
- totalItems: Scalars['Int'];
- };
- export type ShippingMethodListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<ShippingMethodSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<ShippingMethodFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type ShippingMethodQuote = {
- __typename?: 'ShippingMethodQuote';
- id: Scalars['ID'];
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- code: Scalars['String'];
- name: Scalars['String'];
- description: Scalars['String'];
- /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
- metadata?: Maybe<Scalars['JSON']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ShippingMethodSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- fulfillmentHandlerCode?: Maybe<SortOrder>;
- };
- export type ShippingMethodTranslation = {
- __typename?: 'ShippingMethodTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- description: Scalars['String'];
- };
- export type ShippingMethodTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- /** The price value where the result has a single price */
- export type SinglePrice = {
- __typename?: 'SinglePrice';
- value: Scalars['Int'];
- };
- export enum SortOrder {
- ASC = 'ASC',
- DESC = 'DESC'
- }
- export type StockAdjustment = Node & StockMovement & {
- __typename?: 'StockAdjustment';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- };
- export type StockMovement = {
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- };
- export type StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release;
- export type StockMovementList = {
- __typename?: 'StockMovementList';
- items: Array<StockMovementItem>;
- totalItems: Scalars['Int'];
- };
- export type StockMovementListOptions = {
- type?: Maybe<StockMovementType>;
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- };
- export enum StockMovementType {
- ADJUSTMENT = 'ADJUSTMENT',
- ALLOCATION = 'ALLOCATION',
- RELEASE = 'RELEASE',
- SALE = 'SALE',
- CANCELLATION = 'CANCELLATION',
- RETURN = 'RETURN'
- }
- export type StringCustomFieldConfig = CustomField & {
- __typename?: 'StringCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- length?: Maybe<Scalars['Int']>;
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- pattern?: Maybe<Scalars['String']>;
- options?: Maybe<Array<StringFieldOption>>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type StringFieldOption = {
- __typename?: 'StringFieldOption';
- value: Scalars['String'];
- label?: Maybe<Array<LocalizedString>>;
- };
- /** Operators for filtering on a list of String fields */
- export type StringListOperators = {
- inList: Scalars['String'];
- };
- /** Operators for filtering on a String field */
- export type StringOperators = {
- eq?: Maybe<Scalars['String']>;
- notEq?: Maybe<Scalars['String']>;
- contains?: Maybe<Scalars['String']>;
- notContains?: Maybe<Scalars['String']>;
- in?: Maybe<Array<Scalars['String']>>;
- notIn?: Maybe<Array<Scalars['String']>>;
- regex?: Maybe<Scalars['String']>;
- };
- /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
- export type Success = {
- __typename?: 'Success';
- success: Scalars['Boolean'];
- };
- export type Surcharge = Node & {
- __typename?: 'Surcharge';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- description: Scalars['String'];
- sku?: Maybe<Scalars['String']>;
- taxLines: Array<TaxLine>;
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- taxRate: Scalars['Float'];
- };
- export type SurchargeInput = {
- description: Scalars['String'];
- sku?: Maybe<Scalars['String']>;
- price: Scalars['Int'];
- priceIncludesTax: Scalars['Boolean'];
- taxRate?: Maybe<Scalars['Float']>;
- taxDescription?: Maybe<Scalars['String']>;
- };
- export type Tag = Node & {
- __typename?: 'Tag';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- value: Scalars['String'];
- };
- export type TagFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- value?: Maybe<StringOperators>;
- };
- export type TagList = PaginatedList & {
- __typename?: 'TagList';
- items: Array<Tag>;
- totalItems: Scalars['Int'];
- };
- export type TagListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<TagSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<TagFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type TagSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- value?: Maybe<SortOrder>;
- };
- export type TaxCategory = Node & {
- __typename?: 'TaxCategory';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- isDefault: Scalars['Boolean'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type TaxLine = {
- __typename?: 'TaxLine';
- description: Scalars['String'];
- taxRate: Scalars['Float'];
- };
- export type TaxRate = Node & {
- __typename?: 'TaxRate';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- value: Scalars['Float'];
- category: TaxCategory;
- zone: Zone;
- customerGroup?: Maybe<CustomerGroup>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type TaxRateFilterParameter = {
- id?: Maybe<IdOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- value?: Maybe<NumberOperators>;
- };
- export type TaxRateList = PaginatedList & {
- __typename?: 'TaxRateList';
- items: Array<TaxRate>;
- totalItems: Scalars['Int'];
- };
- export type TaxRateListOptions = {
- /** Skips the first n results, for use in pagination */
- skip?: Maybe<Scalars['Int']>;
- /** Takes n results, for use in pagination */
- take?: Maybe<Scalars['Int']>;
- /** Specifies which properties to sort the results by */
- sort?: Maybe<TaxRateSortParameter>;
- /** Allows the results to be filtered */
- filter?: Maybe<TaxRateFilterParameter>;
- /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
- filterOperator?: Maybe<LogicalOperator>;
- };
- export type TaxRateSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- value?: Maybe<SortOrder>;
- };
- export type TestEligibleShippingMethodsInput = {
- shippingAddress: CreateAddressInput;
- lines: Array<TestShippingMethodOrderLineInput>;
- };
- export type TestShippingMethodInput = {
- checker: ConfigurableOperationInput;
- calculator: ConfigurableOperationInput;
- shippingAddress: CreateAddressInput;
- lines: Array<TestShippingMethodOrderLineInput>;
- };
- export type TestShippingMethodOrderLineInput = {
- productVariantId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type TestShippingMethodQuote = {
- __typename?: 'TestShippingMethodQuote';
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type TestShippingMethodResult = {
- __typename?: 'TestShippingMethodResult';
- eligible: Scalars['Boolean'];
- quote?: Maybe<TestShippingMethodQuote>;
- };
- export type TextCustomFieldConfig = CustomField & {
- __typename?: 'TextCustomFieldConfig';
- name: Scalars['String'];
- type: Scalars['String'];
- list: Scalars['Boolean'];
- label?: Maybe<Array<LocalizedString>>;
- description?: Maybe<Array<LocalizedString>>;
- readonly?: Maybe<Scalars['Boolean']>;
- internal?: Maybe<Scalars['Boolean']>;
- nullable?: Maybe<Scalars['Boolean']>;
- ui?: Maybe<Scalars['JSON']>;
- };
- export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
- export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
- export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
- export type UpdateActiveAdministratorInput = {
- firstName?: Maybe<Scalars['String']>;
- lastName?: Maybe<Scalars['String']>;
- emailAddress?: Maybe<Scalars['String']>;
- password?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateAddressInput = {
- id: Scalars['ID'];
- fullName?: Maybe<Scalars['String']>;
- company?: Maybe<Scalars['String']>;
- streetLine1?: Maybe<Scalars['String']>;
- streetLine2?: Maybe<Scalars['String']>;
- city?: Maybe<Scalars['String']>;
- province?: Maybe<Scalars['String']>;
- postalCode?: Maybe<Scalars['String']>;
- countryCode?: Maybe<Scalars['String']>;
- phoneNumber?: Maybe<Scalars['String']>;
- defaultShippingAddress?: Maybe<Scalars['Boolean']>;
- defaultBillingAddress?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateAdministratorInput = {
- id: Scalars['ID'];
- firstName?: Maybe<Scalars['String']>;
- lastName?: Maybe<Scalars['String']>;
- emailAddress?: Maybe<Scalars['String']>;
- password?: Maybe<Scalars['String']>;
- roleIds?: Maybe<Array<Scalars['ID']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateAssetInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- focalPoint?: Maybe<CoordinateInput>;
- tags?: Maybe<Array<Scalars['String']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateChannelInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- token?: Maybe<Scalars['String']>;
- defaultLanguageCode?: Maybe<LanguageCode>;
- pricesIncludeTax?: Maybe<Scalars['Boolean']>;
- currencyCode?: Maybe<CurrencyCode>;
- defaultTaxZoneId?: Maybe<Scalars['ID']>;
- defaultShippingZoneId?: Maybe<Scalars['ID']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateChannelResult = Channel | LanguageNotAvailableError;
- export type UpdateCollectionInput = {
- id: Scalars['ID'];
- isPrivate?: Maybe<Scalars['Boolean']>;
- featuredAssetId?: Maybe<Scalars['ID']>;
- parentId?: Maybe<Scalars['ID']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- filters?: Maybe<Array<ConfigurableOperationInput>>;
- translations?: Maybe<Array<UpdateCollectionTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateCollectionTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- slug?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateCountryInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<CountryTranslationInput>>;
- enabled?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateCustomerGroupInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateCustomerInput = {
- id: Scalars['ID'];
- title?: Maybe<Scalars['String']>;
- firstName?: Maybe<Scalars['String']>;
- lastName?: Maybe<Scalars['String']>;
- phoneNumber?: Maybe<Scalars['String']>;
- emailAddress?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateCustomerNoteInput = {
- noteId: Scalars['ID'];
- note: Scalars['String'];
- };
- export type UpdateCustomerResult = Customer | EmailAddressConflictError;
- export type UpdateFacetInput = {
- id: Scalars['ID'];
- isPrivate?: Maybe<Scalars['Boolean']>;
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<FacetTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateFacetValueInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<FacetValueTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateGlobalSettingsInput = {
- availableLanguages?: Maybe<Array<LanguageCode>>;
- trackInventory?: Maybe<Scalars['Boolean']>;
- outOfStockThreshold?: Maybe<Scalars['Int']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError;
- export type UpdateOrderAddressInput = {
- fullName?: Maybe<Scalars['String']>;
- company?: Maybe<Scalars['String']>;
- streetLine1?: Maybe<Scalars['String']>;
- streetLine2?: Maybe<Scalars['String']>;
- city?: Maybe<Scalars['String']>;
- province?: Maybe<Scalars['String']>;
- postalCode?: Maybe<Scalars['String']>;
- countryCode?: Maybe<Scalars['String']>;
- phoneNumber?: Maybe<Scalars['String']>;
- };
- export type UpdateOrderInput = {
- id: Scalars['ID'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateOrderNoteInput = {
- noteId: Scalars['ID'];
- note?: Maybe<Scalars['String']>;
- isPublic?: Maybe<Scalars['Boolean']>;
- };
- export type UpdatePaymentMethodInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- code?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- enabled?: Maybe<Scalars['Boolean']>;
- checker?: Maybe<ConfigurableOperationInput>;
- handler?: Maybe<ConfigurableOperationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateProductInput = {
- id: Scalars['ID'];
- enabled?: Maybe<Scalars['Boolean']>;
- featuredAssetId?: Maybe<Scalars['ID']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- translations?: Maybe<Array<ProductTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateProductOptionGroupInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateProductOptionInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateProductVariantInput = {
- id: Scalars['ID'];
- enabled?: Maybe<Scalars['Boolean']>;
- translations?: Maybe<Array<ProductVariantTranslationInput>>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- sku?: Maybe<Scalars['String']>;
- taxCategoryId?: Maybe<Scalars['ID']>;
- price?: Maybe<Scalars['Int']>;
- featuredAssetId?: Maybe<Scalars['ID']>;
- assetIds?: Maybe<Array<Scalars['ID']>>;
- stockOnHand?: Maybe<Scalars['Int']>;
- outOfStockThreshold?: Maybe<Scalars['Int']>;
- useGlobalOutOfStockThreshold?: Maybe<Scalars['Boolean']>;
- trackInventory?: Maybe<GlobalFlag>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdatePromotionInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- enabled?: Maybe<Scalars['Boolean']>;
- startsAt?: Maybe<Scalars['DateTime']>;
- endsAt?: Maybe<Scalars['DateTime']>;
- couponCode?: Maybe<Scalars['String']>;
- perCustomerUsageLimit?: Maybe<Scalars['Int']>;
- conditions?: Maybe<Array<ConfigurableOperationInput>>;
- actions?: Maybe<Array<ConfigurableOperationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdatePromotionResult = Promotion | MissingConditionsError;
- export type UpdateRoleInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- permissions?: Maybe<Array<Permission>>;
- channelIds?: Maybe<Array<Scalars['ID']>>;
- };
- export type UpdateShippingMethodInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- fulfillmentHandler?: Maybe<Scalars['String']>;
- checker?: Maybe<ConfigurableOperationInput>;
- calculator?: Maybe<ConfigurableOperationInput>;
- translations: Array<ShippingMethodTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateTagInput = {
- id: Scalars['ID'];
- value?: Maybe<Scalars['String']>;
- };
- export type UpdateTaxCategoryInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- isDefault?: Maybe<Scalars['Boolean']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateTaxRateInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- value?: Maybe<Scalars['Float']>;
- enabled?: Maybe<Scalars['Boolean']>;
- categoryId?: Maybe<Scalars['ID']>;
- zoneId?: Maybe<Scalars['ID']>;
- customerGroupId?: Maybe<Scalars['ID']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateZoneInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type User = Node & {
- __typename?: 'User';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- identifier: Scalars['String'];
- verified: Scalars['Boolean'];
- roles: Array<Role>;
- lastLogin?: Maybe<Scalars['DateTime']>;
- authenticationMethods: Array<AuthenticationMethod>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type Zone = Node & {
- __typename?: 'Zone';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- members: Array<Country>;
- customFields?: Maybe<Scalars['JSON']>;
- };
|