| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812 |
- // 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;
- /** 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;
- /** 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 `Upload` scalar type represents a file upload. */
- Upload: any;
- };
- 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 speicified, an error will result. */
- collection?: Maybe<Collection>;
- collectionFilters: Array<ConfigurableOperationDefinition>;
- 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>;
- order?: Maybe<Order>;
- orders: OrderList;
- paymentMethods: PaymentMethodList;
- paymentMethod?: Maybe<PaymentMethod>;
- paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
- paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
- productOptionGroups: Array<ProductOptionGroup>;
- productOptionGroup?: Maybe<ProductOptionGroup>;
- search: SearchResponse;
- /** List Products */
- products: ProductList;
- /** Get a Product either by id or slug. If neither id nor slug is speicified, an error will result. */
- product?: Maybe<Product>;
- /** List ProductVariants */
- 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 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 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>;
- };
- 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 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 olfer than the given date. Returns the number of jobs deleted. */
- removeSettledJobs: Scalars['Int'];
- cancelJob: Job;
- settlePayment: SettlePaymentResult;
- 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 is 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;
- /** 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;
- reindex: Job;
- /** 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 MutationSettlePaymentArgs = {
- 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 MutationCreateProductOptionGroupArgs = {
- input: CreateProductOptionGroupInput;
- };
- export type MutationUpdateProductOptionGroupArgs = {
- input: UpdateProductOptionGroupInput;
- };
- export type MutationCreateProductOptionArgs = {
- input: CreateProductOptionInput;
- };
- export type MutationUpdateProductOptionArgs = {
- input: UpdateProductOptionInput;
- };
- 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 CreateAdministratorInput = {
- firstName: Scalars['String'];
- lastName: Scalars['String'];
- emailAddress: Scalars['String'];
- password: Scalars['String'];
- roleIds: Array<Scalars['ID']>;
- 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 UpdateActiveAdministratorInput = {
- firstName?: Maybe<Scalars['String']>;
- lastName?: Maybe<Scalars['String']>;
- emailAddress?: Maybe<Scalars['String']>;
- password?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- 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 AdministratorList = PaginatedList & {
- __typename?: 'AdministratorList';
- items: Array<Administrator>;
- totalItems: Scalars['Int'];
- };
- 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 MimeTypeError = ErrorResult & {
- __typename?: 'MimeTypeError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- fileName: Scalars['String'];
- mimeType: Scalars['String'];
- };
- export type CreateAssetResult = Asset | MimeTypeError;
- export type AssetListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<AssetSortParameter>;
- filter?: Maybe<AssetFilterParameter>;
- tags?: Maybe<Array<Scalars['String']>>;
- tagsOperator?: Maybe<LogicalOperator>;
- };
- export type CreateAssetInput = {
- file: Scalars['Upload'];
- tags?: Maybe<Array<Scalars['String']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CoordinateInput = {
- x: Scalars['Float'];
- y: Scalars['Float'];
- };
- 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 UpdateAssetInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- focalPoint?: Maybe<CoordinateInput>;
- tags?: Maybe<Array<Scalars['String']>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type AssignAssetsToChannelInput = {
- assetIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
- export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
- 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 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']>;
- };
- /** 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 CreateChannelResult = Channel | LanguageNotAvailableError;
- export type UpdateChannelResult = Channel | LanguageNotAvailableError;
- 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 MoveCollectionInput = {
- collectionId: Scalars['ID'];
- parentId: Scalars['ID'];
- index: Scalars['Int'];
- };
- export type CreateCollectionTranslationInput = {
- languageCode: LanguageCode;
- name: Scalars['String'];
- slug: Scalars['String'];
- description: Scalars['String'];
- 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 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 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 CountryTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- };
- export type CreateCountryInput = {
- code: Scalars['String'];
- translations: Array<CountryTranslationInput>;
- enabled: Scalars['Boolean'];
- };
- export type UpdateCountryInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<CountryTranslationInput>>;
- enabled?: Maybe<Scalars['Boolean']>;
- };
- 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 CustomerGroupList = PaginatedList & {
- __typename?: 'CustomerGroupList';
- items: Array<CustomerGroup>;
- totalItems: Scalars['Int'];
- };
- export type CreateCustomerGroupInput = {
- name: Scalars['String'];
- customerIds?: Maybe<Array<Scalars['ID']>>;
- };
- export type UpdateCustomerGroupInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- };
- 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 AddNoteToCustomerInput = {
- id: Scalars['ID'];
- note: Scalars['String'];
- isPublic: Scalars['Boolean'];
- };
- export type UpdateCustomerNoteInput = {
- noteId: Scalars['ID'];
- note: Scalars['String'];
- };
- export type CreateCustomerResult = Customer | EmailAddressConflictError;
- export type UpdateCustomerResult = Customer | EmailAddressConflictError;
- 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 FacetTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateFacetInput = {
- code: Scalars['String'];
- isPrivate: Scalars['Boolean'];
- translations: Array<FacetTranslationInput>;
- values?: Maybe<Array<CreateFacetValueWithFacetInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateFacetInput = {
- id: Scalars['ID'];
- isPrivate?: Maybe<Scalars['Boolean']>;
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<FacetTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FacetValueTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateFacetValueWithFacetInput = {
- code: Scalars['String'];
- translations: Array<FacetValueTranslationInput>;
- };
- export type CreateFacetValueInput = {
- facetId: Scalars['ID'];
- code: Scalars['String'];
- translations: Array<FacetValueTranslationInput>;
- 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']>;
- };
- /**
- * 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 UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError;
- 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 OrderProcessState = {
- __typename?: 'OrderProcessState';
- name: Scalars['String'];
- to: Array<Scalars['String']>;
- };
- export type PermissionDefinition = {
- __typename?: 'PermissionDefinition';
- name: Scalars['String'];
- description: Scalars['String'];
- assignable: Scalars['Boolean'];
- };
- export type ServerConfig = {
- __typename?: 'ServerConfig';
- orderProcess: Array<OrderProcessState>;
- permittedAssetTypes: Array<Scalars['String']>;
- permissions: Array<PermissionDefinition>;
- customFieldConfig: CustomFields;
- };
- 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 ImportInfo = {
- __typename?: 'ImportInfo';
- errors?: Maybe<Array<Scalars['String']>>;
- processed: Scalars['Int'];
- imported: Scalars['Int'];
- };
- /**
- * @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'
- }
- export type JobList = PaginatedList & {
- __typename?: 'JobList';
- items: Array<Job>;
- totalItems: Scalars['Int'];
- };
- 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'];
- };
- export type JobQueue = {
- __typename?: 'JobQueue';
- name: Scalars['String'];
- running: Scalars['Boolean'];
- };
- 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>;
- /**
- * Order-level adjustments to the order total, such as discounts from promotions
- * @deprecated Use `discounts` instead
- */
- adjustments: Array<Adjustment>;
- discounts: Array<Adjustment>;
- /** 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 Fulfillment = Node & {
- __typename?: 'Fulfillment';
- nextStates: Array<Scalars['String']>;
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- orderItems: Array<OrderItem>;
- state: Scalars['String'];
- method: Scalars['String'];
- trackingCode?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- 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 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'];
- };
- export type UpdateOrderInput = {
- id: Scalars['ID'];
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type FulfillOrderInput = {
- lines: Array<OrderLineInput>;
- handler: ConfigurableOperationInput;
- };
- 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>>;
- reason?: Maybe<Scalars['String']>;
- };
- export type RefundOrderInput = {
- lines: Array<OrderLineInput>;
- shipping: Scalars['Int'];
- adjustment: Scalars['Int'];
- paymentId: Scalars['ID'];
- reason?: Maybe<Scalars['String']>;
- };
- export type OrderLineInput = {
- orderLineId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type SettleRefundInput = {
- id: Scalars['ID'];
- transactionId: Scalars['String'];
- };
- export type AddNoteToOrderInput = {
- id: Scalars['ID'];
- note: Scalars['String'];
- isPublic: Scalars['Boolean'];
- };
- export type UpdateOrderNoteInput = {
- noteId: Scalars['ID'];
- note?: Maybe<Scalars['String']>;
- isPublic?: Maybe<Scalars['Boolean']>;
- };
- export type AdministratorPaymentInput = {
- paymentMethod?: Maybe<Scalars['String']>;
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type AdministratorRefundInput = {
- paymentId: Scalars['ID'];
- reason?: Maybe<Scalars['String']>;
- };
- export type ModifyOrderOptions = {
- freezePromotions?: Maybe<Scalars['Boolean']>;
- recalculateShipping?: Maybe<Scalars['Boolean']>;
- };
- 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 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>;
- };
- export type AddItemInput = {
- productVariantId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type AdjustOrderLineInput = {
- orderLineId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- 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 ManualPaymentInput = {
- orderId: Scalars['ID'];
- method: Scalars['String'];
- transactionId?: Maybe<Scalars['String']>;
- metadata?: Maybe<Scalars['JSON']>;
- };
- /** Returned if the Payment settlement fails */
- export type SettlePaymentError = ErrorResult & {
- __typename?: 'SettlePaymentError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- paymentErrorMessage: Scalars['String'];
- };
- /** Returned if no OrderLines have been specified for the operation */
- export type EmptyOrderLineSelectionError = ErrorResult & {
- __typename?: 'EmptyOrderLineSelectionError';
- 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'];
- };
- /** Returned if the specified FulfillmentHandler code is not valid */
- export type InvalidFulfillmentHandlerError = ErrorResult & {
- __typename?: 'InvalidFulfillmentHandlerError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** 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'];
- };
- /**
- * 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'];
- };
- /** Returned if an operation has specified OrderLines from multiple Orders */
- export type MultipleOrderError = ErrorResult & {
- __typename?: 'MultipleOrderError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** 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'];
- };
- /** 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 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 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'];
- };
- /** 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'];
- };
- /** 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'];
- };
- /** 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'];
- };
- /** 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'];
- };
- /** 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'];
- };
- /** 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'];
- };
- /** Returned when a call to modifyOrder fails to specify any changes */
- export type NoChangesSpecifiedError = ErrorResult & {
- __typename?: 'NoChangesSpecifiedError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /**
- * 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'];
- };
- /**
- * 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 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 TransitionOrderToStateResult = Order | OrderStateTransitionError;
- export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError;
- export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError;
- export type CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError;
- export type RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError;
- export type SettleRefundResult = Refund | RefundStateTransitionError;
- export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
- export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
- export type ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError;
- export type AddManualPaymentToOrderResult = Order | ManualPaymentStateError;
- export type PaymentMethodList = PaginatedList & {
- __typename?: 'PaymentMethodList';
- items: Array<PaymentMethod>;
- totalItems: Scalars['Int'];
- };
- export type CreatePaymentMethodInput = {
- name: Scalars['String'];
- code: Scalars['String'];
- description?: Maybe<Scalars['String']>;
- enabled: Scalars['Boolean'];
- checker?: Maybe<ConfigurableOperationInput>;
- handler: ConfigurableOperationInput;
- };
- 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>;
- };
- 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;
- };
- 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>;
- variants: Array<ProductVariant>;
- optionGroups: Array<ProductOptionGroup>;
- facetValues: Array<FacetValue>;
- translations: Array<ProductTranslation>;
- collections: Array<Collection>;
- 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;
- /** @deprecated price now always excludes tax */
- priceIncludesTax: Scalars['Boolean'];
- 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 ProductOptionGroupTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductOptionGroupInput = {
- code: Scalars['String'];
- translations: Array<ProductOptionGroupTranslationInput>;
- options: Array<CreateGroupOptionInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type UpdateProductOptionGroupInput = {
- id: Scalars['ID'];
- code?: Maybe<Scalars['String']>;
- translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type ProductOptionTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateGroupOptionInput = {
- code: Scalars['String'];
- translations: Array<ProductOptionGroupTranslationInput>;
- };
- export type CreateProductOptionInput = {
- productOptionGroupId: Scalars['ID'];
- code: Scalars['String'];
- translations: 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 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'];
- /** @deprecated Use `productAsset.preview` instead */
- productPreview: Scalars['String'];
- productAsset?: Maybe<SearchResultAsset>;
- productVariantId: Scalars['ID'];
- productVariantName: Scalars['String'];
- /** @deprecated Use `productVariantAsset.preview` instead */
- productVariantPreview: 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 relevence score for the result. Differs between database implementations */
- score: Scalars['Float'];
- };
- export type StockMovementListOptions = {
- type?: Maybe<StockMovementType>;
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- };
- 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 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 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 ProductVariantTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateProductVariantOptionInput = {
- optionGroupId: Scalars['ID'];
- code: Scalars['String'];
- translations: Array<ProductOptionTranslationInput>;
- };
- 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 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 AssignProductsToChannelInput = {
- productIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- priceFactor?: Maybe<Scalars['Float']>;
- };
- export type RemoveProductsFromChannelInput = {
- productIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type AssignProductVariantsToChannelInput = {
- productVariantIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- priceFactor?: Maybe<Scalars['Float']>;
- };
- export type RemoveProductVariantsFromChannelInput = {
- productVariantIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type ProductOptionInUseError = ErrorResult & {
- __typename?: 'ProductOptionInUseError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- optionGroupCode: Scalars['String'];
- productVariantCount: Scalars['Int'];
- };
- export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
- 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>;
- };
- 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>>;
- };
- export type AssignPromotionsToChannelInput = {
- promotionIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- export type RemovePromotionsFromChannelInput = {
- promotionIds: Array<Scalars['ID']>;
- channelId: Scalars['ID'];
- };
- /** 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 CreatePromotionResult = Promotion | MissingConditionsError;
- export type UpdatePromotionResult = Promotion | MissingConditionsError;
- export type CreateRoleInput = {
- code: Scalars['String'];
- description: Scalars['String'];
- permissions: Array<Permission>;
- channelIds?: Maybe<Array<Scalars['ID']>>;
- };
- 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 ShippingMethodTranslationInput = {
- id?: Maybe<Scalars['ID']>;
- languageCode: LanguageCode;
- name?: Maybe<Scalars['String']>;
- description?: Maybe<Scalars['String']>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- export type CreateShippingMethodInput = {
- code: Scalars['String'];
- fulfillmentHandler: Scalars['String'];
- checker: ConfigurableOperationInput;
- calculator: ConfigurableOperationInput;
- translations: Array<ShippingMethodTranslationInput>;
- customFields?: Maybe<Scalars['JSON']>;
- };
- 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 TestShippingMethodInput = {
- checker: ConfigurableOperationInput;
- calculator: ConfigurableOperationInput;
- shippingAddress: CreateAddressInput;
- lines: Array<TestShippingMethodOrderLineInput>;
- };
- export type TestEligibleShippingMethodsInput = {
- shippingAddress: CreateAddressInput;
- lines: Array<TestShippingMethodOrderLineInput>;
- };
- export type TestShippingMethodOrderLineInput = {
- productVariantId: Scalars['ID'];
- quantity: Scalars['Int'];
- };
- export type TestShippingMethodResult = {
- __typename?: 'TestShippingMethodResult';
- eligible: Scalars['Boolean'];
- quote?: Maybe<TestShippingMethodQuote>;
- };
- export type TestShippingMethodQuote = {
- __typename?: 'TestShippingMethodQuote';
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- metadata?: Maybe<Scalars['JSON']>;
- };
- export enum StockMovementType {
- ADJUSTMENT = 'ADJUSTMENT',
- ALLOCATION = 'ALLOCATION',
- RELEASE = 'RELEASE',
- SALE = 'SALE',
- CANCELLATION = 'CANCELLATION',
- RETURN = 'RETURN'
- }
- export type StockMovement = {
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- };
- 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 Allocation = Node & StockMovement & {
- __typename?: 'Allocation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- productVariant: ProductVariant;
- type: StockMovementType;
- quantity: Scalars['Int'];
- orderLine: OrderLine;
- };
- 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 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 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 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 StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release;
- export type StockMovementList = {
- __typename?: 'StockMovementList';
- items: Array<StockMovementItem>;
- totalItems: Scalars['Int'];
- };
- export type CreateTagInput = {
- value: Scalars['String'];
- };
- export type UpdateTagInput = {
- id: Scalars['ID'];
- value?: Maybe<Scalars['String']>;
- };
- export type CreateTaxCategoryInput = {
- name: Scalars['String'];
- isDefault?: Maybe<Scalars['Boolean']>;
- };
- export type UpdateTaxCategoryInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- isDefault?: Maybe<Scalars['Boolean']>;
- };
- export type CreateTaxRateInput = {
- name: Scalars['String'];
- enabled: Scalars['Boolean'];
- value: Scalars['Float'];
- categoryId: Scalars['ID'];
- zoneId: Scalars['ID'];
- customerGroupId?: Maybe<Scalars['ID']>;
- };
- 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']>;
- };
- export type CreateZoneInput = {
- name: Scalars['String'];
- memberIds?: Maybe<Array<Scalars['ID']>>;
- };
- export type UpdateZoneInput = {
- id: Scalars['ID'];
- name?: Maybe<Scalars['String']>;
- };
- 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 Coordinate = {
- __typename?: 'Coordinate';
- x: Scalars['Float'];
- y: Scalars['Float'];
- };
- export type AssetList = PaginatedList & {
- __typename?: 'AssetList';
- items: Array<Asset>;
- totalItems: Scalars['Int'];
- };
- export enum AssetType {
- IMAGE = 'IMAGE',
- VIDEO = 'VIDEO',
- BINARY = 'BINARY'
- }
- 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 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']>;
- };
- export type CollectionBreadcrumb = {
- __typename?: 'CollectionBreadcrumb';
- id: Scalars['ID'];
- name: Scalars['String'];
- slug: Scalars['String'];
- };
- 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 CollectionList = PaginatedList & {
- __typename?: 'CollectionList';
- items: Array<Collection>;
- totalItems: Scalars['Int'];
- };
- export type ProductVariantList = PaginatedList & {
- __typename?: 'ProductVariantList';
- items: Array<ProductVariant>;
- totalItems: Scalars['Int'];
- };
- export enum GlobalFlag {
- TRUE = 'TRUE',
- FALSE = 'FALSE',
- INHERIT = 'INHERIT'
- }
- export enum AdjustmentType {
- PROMOTION = 'PROMOTION',
- DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION'
- }
- export enum DeletionResult {
- /** The entity was successfully deleted */
- DELETED = 'DELETED',
- /** Deletion did not take place, reason given in message */
- NOT_DELETED = 'NOT_DELETED'
- }
- /**
- * @description
- * Permissions for administrators and customers. Used to control access to
- * GraphQL resolvers via the {@link Allow} decorator.
- *
- * @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 create Catalog */
- CreateCatalog = 'CreateCatalog',
- /** Grants permission to read Catalog */
- ReadCatalog = 'ReadCatalog',
- /** Grants permission to update Catalog */
- UpdateCatalog = 'UpdateCatalog',
- /** Grants permission to delete Catalog */
- DeleteCatalog = 'DeleteCatalog',
- /** 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 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 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 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 Settings */
- CreateSettings = 'CreateSettings',
- /** Grants permission to read Settings */
- ReadSettings = 'ReadSettings',
- /** Grants permission to update Settings */
- UpdateSettings = 'UpdateSettings',
- /** Grants permission to delete Settings */
- DeleteSettings = 'DeleteSettings'
- }
- export enum SortOrder {
- ASC = 'ASC',
- DESC = 'DESC'
- }
- 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',
- 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'
- }
- export enum LogicalOperator {
- AND = 'AND',
- OR = 'OR'
- }
- /** Retured 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'];
- };
- /** 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 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'];
- };
- /** Retured when attemting 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'];
- };
- /** Retured when the maximum order size limit has been reached. */
- export type OrderLimitError = ErrorResult & {
- __typename?: 'OrderLimitError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- maxItems: Scalars['Int'];
- };
- /** Retured when attemting to set a negative OrderLine quantity. */
- export type NegativeQuantityError = ErrorResult & {
- __typename?: 'NegativeQuantityError';
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- /** 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;
- };
- export type PaginatedList = {
- items: Array<Node>;
- totalItems: Scalars['Int'];
- };
- export type Node = {
- id: Scalars['ID'];
- };
- export type ErrorResult = {
- errorCode: ErrorCode;
- message: Scalars['String'];
- };
- export type Adjustment = {
- __typename?: 'Adjustment';
- adjustmentSource: Scalars['String'];
- type: AdjustmentType;
- description: Scalars['String'];
- amount: Scalars['Int'];
- };
- export type TaxLine = {
- __typename?: 'TaxLine';
- description: Scalars['String'];
- taxRate: Scalars['Float'];
- };
- 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 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 DeletionResponse = {
- __typename?: 'DeletionResponse';
- result: DeletionResult;
- message?: Maybe<Scalars['String']>;
- };
- export type ConfigArgInput = {
- name: Scalars['String'];
- /** A JSON stringified representation of the actual value */
- value: Scalars['String'];
- };
- export type ConfigurableOperationInput = {
- code: Scalars['String'];
- arguments: Array<ConfigArgInput>;
- };
- 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']>;
- };
- export type BooleanOperators = {
- eq?: Maybe<Scalars['Boolean']>;
- };
- export type NumberRange = {
- start: Scalars['Float'];
- end: Scalars['Float'];
- };
- 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 DateRange = {
- start: Scalars['DateTime'];
- end: Scalars['DateTime'];
- };
- export type DateOperators = {
- eq?: Maybe<Scalars['DateTime']>;
- before?: Maybe<Scalars['DateTime']>;
- after?: Maybe<Scalars['DateTime']>;
- between?: Maybe<DateRange>;
- };
- export type SearchInput = {
- term?: Maybe<Scalars['String']>;
- facetValueIds?: Maybe<Array<Scalars['ID']>>;
- facetValueOperator?: Maybe<LogicalOperator>;
- 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 SearchResultSortParameter = {
- name?: Maybe<SortOrder>;
- price?: Maybe<SortOrder>;
- };
- 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 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 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']>;
- };
- /** 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 ShippingMethodQuote = {
- __typename?: 'ShippingMethodQuote';
- id: Scalars['ID'];
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- name: Scalars['String'];
- description: Scalars['String'];
- /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
- metadata?: Maybe<Scalars['JSON']>;
- };
- export type PaymentMethodQuote = {
- __typename?: 'PaymentMethodQuote';
- id: Scalars['ID'];
- code: Scalars['String'];
- isEligible: Scalars['Boolean'];
- eligibilityMessage?: Maybe<Scalars['String']>;
- };
- 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>;
- };
- export type CountryTranslation = {
- __typename?: 'CountryTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type CountryList = PaginatedList & {
- __typename?: 'CountryList';
- items: Array<Country>;
- totalItems: Scalars['Int'];
- };
- /**
- * @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 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']>;
- };
- 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']>;
- pattern?: Maybe<Scalars['String']>;
- options?: Maybe<Array<StringFieldOption>>;
- };
- export type StringFieldOption = {
- __typename?: 'StringFieldOption';
- value: Scalars['String'];
- label?: Maybe<Array<LocalizedString>>;
- };
- 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']>;
- pattern?: Maybe<Scalars['String']>;
- };
- 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']>;
- min?: Maybe<Scalars['Int']>;
- max?: Maybe<Scalars['Int']>;
- step?: Maybe<Scalars['Int']>;
- };
- 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']>;
- min?: Maybe<Scalars['Float']>;
- max?: Maybe<Scalars['Float']>;
- step?: Maybe<Scalars['Float']>;
- };
- 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']>;
- };
- /**
- * 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']>;
- min?: Maybe<Scalars['String']>;
- max?: Maybe<Scalars['String']>;
- step?: Maybe<Scalars['Int']>;
- };
- 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']>;
- entity: Scalars['String'];
- scalarFields: Array<Scalars['String']>;
- };
- export type LocalizedString = {
- __typename?: 'LocalizedString';
- languageCode: LanguageCode;
- value: Scalars['String'];
- };
- export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig;
- export type CustomerGroup = Node & {
- __typename?: 'CustomerGroup';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- customers: CustomerList;
- };
- export type CustomerGroupCustomersArgs = {
- options?: Maybe<CustomerListOptions>;
- };
- export type CustomerList = PaginatedList & {
- __typename?: 'CustomerList';
- items: Array<Customer>;
- totalItems: Scalars['Int'];
- };
- 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']>;
- };
- export type FacetValueTranslation = {
- __typename?: 'FacetValueTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type FacetTranslation = {
- __typename?: 'FacetTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type FacetList = PaginatedList & {
- __typename?: 'FacetList';
- items: Array<Facet>;
- totalItems: Scalars['Int'];
- };
- 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'
- }
- export type HistoryEntryList = PaginatedList & {
- __typename?: 'HistoryEntryList';
- items: Array<HistoryEntry>;
- totalItems: Scalars['Int'];
- };
- /**
- * @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'
- }
- /**
- * 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 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 OrderList = PaginatedList & {
- __typename?: 'OrderList';
- items: Array<Order>;
- totalItems: Scalars['Int'];
- };
- export type ShippingLine = {
- __typename?: 'ShippingLine';
- shippingMethod: ShippingMethod;
- price: Scalars['Int'];
- priceWithTax: Scalars['Int'];
- discountedPrice: Scalars['Int'];
- discountedPriceWithTax: Scalars['Int'];
- discounts: Array<Adjustment>;
- };
- 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 (proportially-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'];
- /** @deprecated `unitPrice` is now always without tax */
- unitPriceIncludesTax: Scalars['Boolean'];
- taxRate: Scalars['Float'];
- adjustments: Array<Adjustment>;
- taxLines: Array<TaxLine>;
- fulfillment?: Maybe<Fulfillment>;
- refundId?: Maybe<Scalars['ID']>;
- };
- 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 (proportially-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>;
- /** @deprecated Use `linePriceWithTax` instead */
- totalPrice: Scalars['Int'];
- taxRate: Scalars['Float'];
- /** The total price of the line excluding tax and discounts. */
- linePrice: Scalars['Int'];
- /** The total price of the line including tax bit 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 (proportially-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'];
- /** @deprecated Use `discounts` instead */
- adjustments: Array<Adjustment>;
- discounts: Array<Adjustment>;
- taxLines: Array<TaxLine>;
- order: Order;
- customFields?: Maybe<Scalars['JSON']>;
- };
- 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 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 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 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 ProductOptionTranslation = {
- __typename?: 'ProductOptionTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- export type SearchReindexResponse = {
- __typename?: 'SearchReindexResponse';
- success: Scalars['Boolean'];
- };
- export type SearchResponse = {
- __typename?: 'SearchResponse';
- items: Array<SearchResult>;
- totalItems: Scalars['Int'];
- facetValues: Array<FacetValueResult>;
- };
- /**
- * 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 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;
- /** The price value where the result has a single price */
- export type SinglePrice = {
- __typename?: 'SinglePrice';
- value: Scalars['Int'];
- };
- /** The price range where the result has more than one price */
- export type PriceRange = {
- __typename?: 'PriceRange';
- min: Scalars['Int'];
- max: Scalars['Int'];
- };
- 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 ProductList = PaginatedList & {
- __typename?: 'ProductList';
- items: Array<Product>;
- totalItems: Scalars['Int'];
- };
- export type ProductVariantTranslation = {
- __typename?: 'ProductVariantTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- };
- 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>;
- };
- export type PromotionList = PaginatedList & {
- __typename?: 'PromotionList';
- items: Array<Promotion>;
- totalItems: Scalars['Int'];
- };
- 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 RoleList = PaginatedList & {
- __typename?: 'RoleList';
- items: Array<Role>;
- totalItems: Scalars['Int'];
- };
- export type ShippingMethod = Node & {
- __typename?: 'ShippingMethod';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- 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 ShippingMethodTranslation = {
- __typename?: 'ShippingMethodTranslation';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- languageCode: LanguageCode;
- name: Scalars['String'];
- description: Scalars['String'];
- };
- export type ShippingMethodList = PaginatedList & {
- __typename?: 'ShippingMethodList';
- items: Array<ShippingMethod>;
- totalItems: Scalars['Int'];
- };
- export type Tag = Node & {
- __typename?: 'Tag';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- value: Scalars['String'];
- };
- export type TagList = PaginatedList & {
- __typename?: 'TagList';
- items: Array<Tag>;
- totalItems: Scalars['Int'];
- };
- export type TaxCategory = Node & {
- __typename?: 'TaxCategory';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- isDefault: Scalars['Boolean'];
- };
- 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>;
- };
- export type TaxRateList = PaginatedList & {
- __typename?: 'TaxRateList';
- items: Array<TaxRate>;
- totalItems: Scalars['Int'];
- };
- 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 AuthenticationMethod = Node & {
- __typename?: 'AuthenticationMethod';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- strategy: Scalars['String'];
- };
- export type Zone = Node & {
- __typename?: 'Zone';
- id: Scalars['ID'];
- createdAt: Scalars['DateTime'];
- updatedAt: Scalars['DateTime'];
- name: Scalars['String'];
- members: Array<Country>;
- };
- export type AdministratorListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<AdministratorSortParameter>;
- filter?: Maybe<AdministratorFilterParameter>;
- };
- export type CollectionListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<CollectionSortParameter>;
- filter?: Maybe<CollectionFilterParameter>;
- };
- export type CountryListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<CountrySortParameter>;
- filter?: Maybe<CountryFilterParameter>;
- };
- export type CustomerGroupListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<CustomerGroupSortParameter>;
- filter?: Maybe<CustomerGroupFilterParameter>;
- };
- export type CustomerListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<CustomerSortParameter>;
- filter?: Maybe<CustomerFilterParameter>;
- };
- export type FacetListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<FacetSortParameter>;
- filter?: Maybe<FacetFilterParameter>;
- };
- export type JobListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<JobSortParameter>;
- filter?: Maybe<JobFilterParameter>;
- };
- export type OrderListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<OrderSortParameter>;
- filter?: Maybe<OrderFilterParameter>;
- };
- export type PaymentMethodListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<PaymentMethodSortParameter>;
- filter?: Maybe<PaymentMethodFilterParameter>;
- };
- export type ProductListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<ProductSortParameter>;
- filter?: Maybe<ProductFilterParameter>;
- };
- export type ProductVariantListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<ProductVariantSortParameter>;
- filter?: Maybe<ProductVariantFilterParameter>;
- };
- export type PromotionListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<PromotionSortParameter>;
- filter?: Maybe<PromotionFilterParameter>;
- };
- export type RoleListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<RoleSortParameter>;
- filter?: Maybe<RoleFilterParameter>;
- };
- export type ShippingMethodListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<ShippingMethodSortParameter>;
- filter?: Maybe<ShippingMethodFilterParameter>;
- };
- export type TagListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<TagSortParameter>;
- filter?: Maybe<TagFilterParameter>;
- };
- export type TaxRateListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<TaxRateSortParameter>;
- filter?: Maybe<TaxRateFilterParameter>;
- };
- export type HistoryEntryListOptions = {
- skip?: Maybe<Scalars['Int']>;
- take?: Maybe<Scalars['Int']>;
- sort?: Maybe<HistoryEntrySortParameter>;
- filter?: Maybe<HistoryEntryFilterParameter>;
- };
- export type AdministratorFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- firstName?: Maybe<StringOperators>;
- lastName?: Maybe<StringOperators>;
- emailAddress?: Maybe<StringOperators>;
- };
- export type AdministratorSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- firstName?: Maybe<SortOrder>;
- lastName?: Maybe<SortOrder>;
- emailAddress?: Maybe<SortOrder>;
- };
- export type AssetFilterParameter = {
- 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 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 type CollectionFilterParameter = {
- isPrivate?: Maybe<BooleanOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- slug?: Maybe<StringOperators>;
- position?: Maybe<NumberOperators>;
- description?: Maybe<StringOperators>;
- };
- 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 CountryFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- };
- export type CountrySortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- };
- export type CustomerGroupFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- };
- export type CustomerGroupSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- };
- export type CustomerFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- title?: Maybe<StringOperators>;
- firstName?: Maybe<StringOperators>;
- lastName?: Maybe<StringOperators>;
- phoneNumber?: Maybe<StringOperators>;
- emailAddress?: Maybe<StringOperators>;
- };
- 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>;
- };
- export type FacetFilterParameter = {
- isPrivate?: Maybe<BooleanOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- };
- export type FacetSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- };
- export type JobFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- startedAt?: Maybe<DateOperators>;
- settledAt?: Maybe<DateOperators>;
- queueName?: Maybe<StringOperators>;
- state?: Maybe<StringOperators>;
- progress?: Maybe<NumberOperators>;
- isSettled?: Maybe<BooleanOperators>;
- duration?: Maybe<NumberOperators>;
- };
- export type JobSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- startedAt?: Maybe<SortOrder>;
- settledAt?: Maybe<SortOrder>;
- queueName?: Maybe<SortOrder>;
- progress?: Maybe<SortOrder>;
- duration?: Maybe<SortOrder>;
- };
- export type OrderFilterParameter = {
- 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 OrderSortParameter = {
- 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>;
- };
- export type PaymentMethodFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- code?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- };
- export type PaymentMethodSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type ProductFilterParameter = {
- enabled?: Maybe<BooleanOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- slug?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- };
- export type ProductSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- slug?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type ProductVariantFilterParameter = {
- enabled?: Maybe<BooleanOperators>;
- trackInventory?: Maybe<StringOperators>;
- stockOnHand?: Maybe<NumberOperators>;
- stockAllocated?: Maybe<NumberOperators>;
- outOfStockThreshold?: Maybe<NumberOperators>;
- useGlobalOutOfStockThreshold?: Maybe<BooleanOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- languageCode?: Maybe<StringOperators>;
- sku?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- price?: Maybe<NumberOperators>;
- currencyCode?: Maybe<StringOperators>;
- priceIncludesTax?: Maybe<BooleanOperators>;
- priceWithTax?: Maybe<NumberOperators>;
- stockLevel?: Maybe<StringOperators>;
- };
- 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 PromotionFilterParameter = {
- 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 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>;
- };
- export type RoleFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- code?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- };
- export type RoleSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- code?: Maybe<SortOrder>;
- description?: Maybe<SortOrder>;
- };
- export type ShippingMethodFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- code?: Maybe<StringOperators>;
- name?: Maybe<StringOperators>;
- description?: Maybe<StringOperators>;
- fulfillmentHandlerCode?: Maybe<StringOperators>;
- };
- 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 TagFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- value?: Maybe<StringOperators>;
- };
- export type TagSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- value?: Maybe<SortOrder>;
- };
- export type TaxRateFilterParameter = {
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- name?: Maybe<StringOperators>;
- enabled?: Maybe<BooleanOperators>;
- value?: Maybe<NumberOperators>;
- };
- export type TaxRateSortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- name?: Maybe<SortOrder>;
- value?: Maybe<SortOrder>;
- };
- export type HistoryEntryFilterParameter = {
- isPublic?: Maybe<BooleanOperators>;
- createdAt?: Maybe<DateOperators>;
- updatedAt?: Maybe<DateOperators>;
- type?: Maybe<StringOperators>;
- };
- export type HistoryEntrySortParameter = {
- id?: Maybe<SortOrder>;
- createdAt?: Maybe<SortOrder>;
- updatedAt?: Maybe<SortOrder>;
- };
- export type AuthenticationInput = {
- native?: Maybe<NativeAuthInput>;
- };
- export type NativeAuthInput = {
- username: Scalars['String'];
- password: Scalars['String'];
- };
- export type CustomFields = {
- __typename?: 'CustomFields';
- Address: Array<CustomFieldConfig>;
- Administrator: Array<CustomFieldConfig>;
- Asset: Array<CustomFieldConfig>;
- Channel: Array<CustomFieldConfig>;
- Collection: Array<CustomFieldConfig>;
- Customer: Array<CustomFieldConfig>;
- Facet: Array<CustomFieldConfig>;
- FacetValue: Array<CustomFieldConfig>;
- Fulfillment: Array<CustomFieldConfig>;
- GlobalSettings: Array<CustomFieldConfig>;
- Order: Array<CustomFieldConfig>;
- OrderLine: Array<CustomFieldConfig>;
- Product: Array<CustomFieldConfig>;
- ProductOption: Array<CustomFieldConfig>;
- ProductOptionGroup: Array<CustomFieldConfig>;
- ProductVariant: Array<CustomFieldConfig>;
- User: Array<CustomFieldConfig>;
- ShippingMethod: Array<CustomFieldConfig>;
- };
|