OBJECT

Query

The main queries are here, click to expand

link GraphQL Schema definition

1type Query {
2# Get single account data.
3#
4# Required permission: Account:read
5#
6# Store restrictions apply.
7#
8# Arguments
9# id: (self-explanatory)
10account(id: Int!): Account
11
12# Get collection of accounts.
13#
14# Required permission: Account:read
15#
16# Limit must be in range 1 - 200
17#
18# Store restrictions apply.
19#
20# Arguments
21# where: (self-explanatory)
22# sort: (self-explanatory)
23# limit: (self-explanatory)
24# page: (self-explanatory)
25accounts(where: AccountFilter, sort: [AccountSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Account!]!
26
27# Get accounts connection
28#
29# Required permission: Account:read
30#
31# Limit must be in range 1 - 200
32#
33# Store restrictions apply.
34#
35# Arguments
36# where: (self-explanatory)
37# sort: (self-explanatory)
38# first: (self-explanatory)
39# after: (self-explanatory)
40# last: (self-explanatory)
41# before: (self-explanatory)
42accountConnection(
43where: AccountFilter,
44sort: [AccountSort!] = [id_ASC],
45first: Int,
46after: String,
47last: Int,
48before: String
49): AccountConnection!
50
51# Get single admin user
52#
53# Required permission: AdminUser:read
54#
55# Arguments
56# id: (self-explanatory)
57adminUser(id: Int): AdminUser
58
59# Get collection of admin users
60#
61# Required permission: AdminUser:read
62#
63# Limit must be in range 1 - 200
64#
65# Arguments
66# where: (self-explanatory)
67# sort: (self-explanatory)
68# limit: (self-explanatory)
69# page: (self-explanatory)
70adminUsers(
71where: AdminUserFilter,
72sort: [AdminUserSort!] = [id_ASC],
73limit: Int = 20,
74page: Int = 1
75): [AdminUser!]!
76
77# Get single affiliate data
78#
79# Required permission: Affiliate:read
80#
81# Store restrictions apply.
82#
83# Arguments
84# id: (self-explanatory)
85affiliate(id: Int!): Affiliate
86
87# Get collection of affiliates
88#
89# Required permission: Affiliate:read
90#
91# Limit must be in range 1 - 200
92#
93# Store restrictions apply.
94#
95# Arguments
96# where: (self-explanatory)
97# sort: (self-explanatory)
98# limit: (self-explanatory)
99# page: (self-explanatory)
100affiliates(
101where: AffiliateFilter,
102sort: [AffiliateSort!] = [id_ASC],
103limit: Int = 20,
104page: Int = 1
105): [Affiliate!]!
106
107# Get collection of allocation rules
108#
109# Required permission: AllocationRule:read
110#
111# Limit must be in range 1 - 200
112#
113# Arguments
114# where: (self-explanatory)
115# sort: (self-explanatory)
116# limit: (self-explanatory)
117# page: (self-explanatory)
118allocationRules(
119where: AllocationRuleFilter = {isActive: true},
120sort: [AllocationRuleSort!] = [id_ASC],
121limit: Int = 20,
122page: Int
123): [AllocationRule!]!
124
125# Get all defined attribute types
126#
127# Required permission: Attribute:read
128#
129# All elements are always returned
130attributeTypes: [AttributeType!]!
131
132# Get collection of brands
133#
134# Required permission: Brand:read
135#
136# Limit must be in range 1 - 200
137#
138# Store restrictions apply.
139#
140# Arguments
141# where: (self-explanatory)
142# sort: (self-explanatory)
143# limit: (self-explanatory)
144# page: (self-explanatory)
145brands(where: BrandFilter, sort: [BrandSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Brand!]!
146
147# Get collection of brick and mortars
148#
149# Required permission: BrickAndMortar:read
150#
151# Limit must be in range 1 - 200
152#
153# Arguments
154# where: (self-explanatory)
155# sort: (self-explanatory)
156# limit: (self-explanatory)
157# page: (self-explanatory)
158brickAndMortars(
159where: BrickAndMortarFilter,
160sort: [BrickAndMortarSort!] = [id_ASC],
161limit: Int = 20,
162page: Int = 1
163): [BrickAndMortar!]!
164
165# Get single bundle data
166#
167# Required permission: Bundle:read
168#
169# Arguments
170# id: (self-explanatory)
171bundle(id: Int!): Bundle
172
173# Get collection of bundles in the Relay connection form
174#
175# Required permission: Bundle:read
176#
177# Limit must be in range 1 - 200
178#
179# Arguments
180# where: (self-explanatory)
181# sort: (self-explanatory)
182# first: (self-explanatory)
183# after: (self-explanatory)
184# last: (self-explanatory)
185# before: (self-explanatory)
186bundleConnection(
187where: BundleFilter,
188sort: [BundleSort!] = [id_ASC],
189first: Int,
190after: String,
191last: Int,
192before: String
193): BundleConnection!
194
195# Required permission: TaxRule:read
196#
197# Requires field selected: userErrors
198#
199# Arguments
200# input: (self-explanatory)
201calculateTaxes(input: OrderTaxesInput!): OrderTaxesPayload!
202
203# Get campaigns
204#
205# Required permission: Campaign:read
206#
207# Limit must be in range 1 - 200
208#
209# Store restrictions apply.
210#
211# Arguments
212# where: (self-explanatory)
213# sort: (self-explanatory)
214# limit: (self-explanatory)
215# page: (self-explanatory)
216campaigns(where: CampaignFilter, sort: [CampaignSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Campaign!]!
217
218# Get collection of campaigns in the Relay connection form
219#
220# Required permission: Campaign:read
221#
222# Limit must be in range 1 - 200
223#
224# Store restrictions apply.
225#
226# Arguments
227# where: (self-explanatory)
228# sort: (self-explanatory)
229# first: (self-explanatory)
230# after: (self-explanatory)
231# last: (self-explanatory)
232# before: (self-explanatory)
233campaignConnection(
234where: CampaignFilter,
235sort: [CampaignSort!] = [id_DESC],
236first: Int,
237after: String,
238last: Int,
239before: String
240): CampaignConnection!
241
242# Get categories
243#
244# Required permission: Category:read
245#
246# Limit must be in range 1 - 200
247#
248# Store restrictions apply.
249#
250# Arguments
251# where: (self-explanatory)
252# sort: (self-explanatory)
253# limit: (self-explanatory)
254# page: (self-explanatory)
255categories(
256where: CategoryFilter,
257sort: [CategorySort!] = [customOrder_ASC],
258limit: Int = 20,
259page: Int = 1
260): [Category!]!
261
262# Get single collection data
263#
264# Required permission: Collection:read
265#
266# Arguments
267# id: (self-explanatory)
268collection(id: Int!): Collection
269
270# Get list of collections by any criteria
271#
272# Required permission: Collection:read
273#
274# Limit must be in range 1 - 200
275#
276# Arguments
277# where: (self-explanatory)
278# sort: (self-explanatory)
279# limit: (self-explanatory)
280# page: (self-explanatory)
281collections(
282where: CollectionFilter,
283sort: [CollectionSort!] = [id_ASC],
284limit: Int = 20,
285page: Int = 1
286): [Collection!]!
287
288# Get list of collections in the Relay connection form
289#
290# Required permission: Collection:read
291#
292# Limit must be in range 1 - 200
293#
294# Arguments
295# where: (self-explanatory)
296# sort: (self-explanatory)
297# first: (self-explanatory)
298# after: (self-explanatory)
299# last: (self-explanatory)
300# before: (self-explanatory)
301collectionConnection(
302where: CollectionFilter,
303sort: [CollectionSort!] = [id_ASC],
304first: Int,
305after: String,
306last: Int,
307before: String
308): CollectionConnection!
309
310# Get continents to group countries
311#
312# Required permission: Country:read
313#
314# Limit is optional
315#
316# Arguments
317# where: (self-explanatory)
318# sort: (self-explanatory)
319# limit: (self-explanatory)
320# page: (self-explanatory)
321continents(
322where: ContinentFilter,
323sort: [ContinentSort!] = [name_ASC],
324limit: Int,
325page: Int
326): [Continent!]!
327
328# Get collection of countries by any criteria
329#
330# Required permission: Country:read
331#
332# Limit is optional
333#
334# Arguments
335# where: (self-explanatory)
336# sort: (self-explanatory)
337# limit: (self-explanatory)
338# page: (self-explanatory)
339countries(where: CountryFilter, sort: [CountrySort!] = [name_ASC], limit: Int, page: Int): [Country!]!
340
341# Get collection of currencies by any criteria
342#
343# Required permission: Currency:read
344#
345# Limit is optional
346#
347# Arguments
348# where: (self-explanatory)
349# sort: (self-explanatory)
350# limit: (self-explanatory)
351# page: (self-explanatory)
352currencies(
353where: CurrencyFilter,
354sort: [CurrencySort!] = [id_ASC],
355limit: Int,
356page: Int
357): [Currency!]!
358
359# Get single customer data
360#
361# Required permission: Purchaser:read
362#
363# Store restrictions apply.
364#
365# Arguments
366# id: (self-explanatory)
367customer(id: Int!): Customer
368
369# Get collection of customers by any criteria
370#
371# Required permission: Purchaser:read
372#
373# Limit must be in range 1 - 200
374#
375# Store restrictions apply.
376#
377# Arguments
378# where: (self-explanatory)
379# sort: (self-explanatory)
380# limit: (self-explanatory)
381# page: (self-explanatory)
382customers(
383where: PurchaserFilter,
384sort: [PurchaserSort!] = [id_ASC],
385limit: Int = 20,
386page: Int = 1
387): [Customer!]!
388
389# Get collection of customers in the Relay connection form
390#
391# Required permission: Purchaser:read
392#
393# Limit must be in range 1 - 200
394#
395# Store restrictions apply.
396#
397# Arguments
398# where: (self-explanatory)
399# sort: (self-explanatory)
400# first: (self-explanatory)
401# after: (self-explanatory)
402# last: (self-explanatory)
403# before: (self-explanatory)
404customerConnection(
405where: PurchaserFilter,
406sort: [PurchaserSort!] = [id_ASC],
407first: Int,
408after: String,
409last: Int,
410before: String
411): CustomerConnection!
412
413# Get delivery windows by any criteria
414#
415# Required permission: DeliveryWindow:read
416#
417# Limit must be in range 1 - 200
418#
419# Store restrictions apply.
420#
421# Arguments
422# where: (self-explanatory)
423# sort: (self-explanatory)
424# limit: (self-explanatory)
425# page: (self-explanatory)
426deliveryWindows(
427where: DeliveryWindowFilter,
428sort: [DeliveryWindowSort!] = [id_ASC],
429limit: Int = 20,
430page: Int = 1
431): [DeliveryWindow!]!
432
433# Get single discount data
434#
435# Required permission: Discount:read
436#
437# Store restrictions apply.
438#
439# Arguments
440# id: (self-explanatory)
441discount(id: Int!): Discount
442
443# Get collection of discounts
444#
445# Required permission: Discount:read
446#
447# Limit must be in range 1 - 200
448#
449# Store restrictions apply.
450#
451# Arguments
452# where: (self-explanatory)
453# sort: (self-explanatory)
454# limit: (self-explanatory)
455# page: (self-explanatory)
456discounts(where: DiscountFilter, sort: [DiscountSort!] = [priority_ASC, id_ASC], limit: Int = 20, page: Int = 1): [Discount!]!
457
458# Get single display data
459#
460# Required permission: Display:read
461#
462# Store restrictions apply.
463#
464# Arguments
465# id: (self-explanatory)
466display(id: Int!): Display
467
468# Get collection of displays by any criteria
469#
470# Required permission: Display:read
471#
472# Limit must be in range 1 - 200
473#
474# Store restrictions apply.
475#
476# Arguments
477# where: (self-explanatory)
478# sort: (self-explanatory)
479# limit: (self-explanatory)
480# page: (self-explanatory)
481displays(where: DisplayFilter, sort: [DisplaySort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Display!]!
482
483# Get collection of display items by any criteria
484#
485# Required permission: Display:read
486#
487# Limit must be in range 1 - 200
488#
489# Store restrictions apply.
490#
491# Arguments
492# where: (self-explanatory)
493# sort: (self-explanatory)
494# limit: (self-explanatory)
495# page: (self-explanatory)
496displayItems(
497where: DisplayItemFilter,
498sort: [DisplayItemSort!] = [customOrder_ASC],
499limit: Int = 20,
500page: Int = 1
501): [DisplayItem!]!
502
503# Get collection of displays in the Relay connection form
504#
505# Required permission: Display:read
506#
507# Limit must be in range 1 - 200
508#
509# Store restrictions apply.
510#
511# Arguments
512# where: (self-explanatory)
513# sort: (self-explanatory)
514# first: (self-explanatory)
515# after: (self-explanatory)
516# last: (self-explanatory)
517# before: (self-explanatory)
518displayConnection(
519where: DisplayFilter,
520sort: [DisplaySort!] = [id_ASC],
521first: Int,
522after: String,
523last: Int,
524before: String
525): DisplayConnection!
526
527# Get a list of document templates
528#
529# Required permission: DocumentTemplate:read
530#
531# Limit must be in range 1 - 200
532#
533# Store restrictions apply.
534#
535# Arguments
536# where: (self-explanatory)
537# sort: (self-explanatory)
538# limit: (self-explanatory)
539# page: (self-explanatory)
540documentTemplates(
541where: DocumentTemplateFilter,
542sort: [DocumentTemplateSort!] = [id_DESC],
543limit: Int = 20,
544page: Int = 1
545): [DocumentTemplate!]!
546
547# Get folders
548#
549# Required permission: Folder:read
550#
551# Limit must be in range 1 - 200
552#
553# Arguments
554# where: (self-explanatory)
555# sort: (self-explanatory)
556# limit: (self-explanatory)
557# page: (self-explanatory)
558folders(where: FolderFilter, sort: [FolderSort!] = [customOrder_ASC], limit: Int = 20, page: Int = 1): [Folder!]!
559
560# Get Gift Certificate Generators
561#
562# Required permission: GiftCertificateGenerator:read
563#
564# Limit must be in range 1 - 200
565#
566# Store restrictions apply.
567#
568# Arguments
569# where: (self-explanatory)
570# sort: (self-explanatory)
571# limit: (self-explanatory)
572# page: (self-explanatory)
573giftCertificateGenerators(
574where: GiftCertificateGeneratorFilter,
575sort: [GiftCertificateGeneratorSort!] = [id_ASC],
576limit: Int = 20,
577page: Int = 1
578): [GiftCertificateGenerator!]!
579
580# Get all users for which tokens were generated
581#
582# Required permission: admin
583#
584# Limit must be in range 1 - 200
585#
586# Arguments
587# where: (self-explanatory)
588# sort: (self-explanatory)
589# limit: (self-explanatory)
590# page: (self-explanatory)
591graphQLAccess(
592where: GraphQLAccessFilter,
593sort: [GraphQLAccessSort!] = [id_DESC],
594limit: Int = 20,
595page: Int = 1
596): [GraphQLAccess!]!
597
598# Get single invoice data
599#
600# Required permission: Invoice:read
601#
602# Store restrictions apply.
603#
604# Arguments
605# id: (self-explanatory)
606invoice(id: Int!): Invoice
607
608# Get all invoices
609#
610# Required permission: Invoice:read
611#
612# Limit must be in range 1 - 200
613#
614# Store restrictions apply.
615#
616# Arguments
617# where: (self-explanatory)
618# sort: (self-explanatory)
619# limit: (self-explanatory)
620# page: (self-explanatory)
621invoices(where: InvoiceFilter, sort: [InvoiceSort!] = [number_DESC, id_ASC], limit: Int = 20, page: Int = 1): [Invoice!]!
622
623# Get collection of invoices in the Relay connection form
624#
625# Required permission: Invoice:read
626#
627# Limit must be in range 1 - 200
628#
629# Store restrictions apply.
630#
631# Arguments
632# where: (self-explanatory)
633# sort: (self-explanatory)
634# first: (self-explanatory)
635# after: (self-explanatory)
636# last: (self-explanatory)
637# before: (self-explanatory)
638invoiceConnection(
639where: InvoiceFilter,
640sort: [InvoiceSort!] = [number_DESC, id_ASC],
641first: Int,
642after: String,
643last: Int,
644before: String
645): InvoiceConnection!
646
647# Get all known languages
648#
649# Required permission: Language:read
650#
651# Limit is optional
652#
653# Arguments
654# where: (self-explanatory)
655# sort: (self-explanatory)
656# limit: (self-explanatory)
657# page: (self-explanatory)
658languages(where: LanguageFilter, sort: [LanguageSort!] = [code_ASC, id_ASC], limit: Int, page: Int): [Language!]!
659
660# List localizable (translatable) fields for each object type.
661# Includes dynamic attributes along their objects, and mapped ones under
662# MappedAttribute type.
663#
664# Required permission: Localization:read
665#
666# All elements are always returned
667#
668# Arguments
669# where: (self-explanatory)
670localizableFields(where: LocalizableObjectFilter): [LocalizableObjectFields!]!
671
672# Get a list of mapped (non-dynamic) attributes
673#
674# Required permission: Attribute:read
675#
676# Limit must be in range 1 - 200
677#
678# Arguments
679# where: (self-explanatory)
680# sort: (self-explanatory)
681# limit: (self-explanatory)
682# page: (self-explanatory)
683mappedAttributes(
684where: MappedAttributeFilter,
685sort: [MappedAttributeSort!] = [id_ASC],
686limit: Int = 20,
687page: Int = 1
688): [MappedAttribute!]!
689
690# Get single market data
691#
692# Required permission: Market:read
693#
694# Store restrictions apply.
695#
696# Arguments
697# id: (self-explanatory)
698market(id: Int!): Market
699
700# Get all markets
701#
702# Required permission: Market:read
703#
704# Limit is optional
705#
706# Store restrictions apply.
707#
708# Arguments
709# where: (self-explanatory)
710# sort: (self-explanatory)
711# limit: (self-explanatory)
712# page: (self-explanatory)
713markets(where: MarketFilter, sort: [MarketSort!] = [id_ASC], limit: Int, page: Int): [Market!]!
714
715# Get single measurementChart
716#
717# Required permission: MeasurementChart:read
718#
719# Arguments
720# id: (self-explanatory)
721measurementChart(id: Int!): MeasurementChart
722
723# Get all measurementCharts
724#
725# Required permission: MeasurementChart:read
726#
727# Limit is optional
728#
729# Arguments
730# where: (self-explanatory)
731# sort: (self-explanatory)
732# limit: (self-explanatory)
733# page: (self-explanatory)
734measurementCharts(
735where: MeasurementChartFilter,
736sort: [MeasurementChartSort!] = [id_ASC],
737limit: Int,
738page: Int
739): [MeasurementChart!]!
740
741# Get all media sizes available for ProductMedia
742#
743# Required permission: none
744#
745# All elements are always returned
746mediaSizes: [MediaSize!]!
747
748# Get all newsletter subscriptions
749#
750# Required permission: NewsletterSubscription:read
751#
752# Limit must be in range 1 - 200
753#
754# Store restrictions apply.
755#
756# Arguments
757# where: (self-explanatory)
758# sort: (self-explanatory)
759# limit: (self-explanatory)
760# page: (self-explanatory)
761newsletterSubscriptions(
762where: NewsletterSubscriptionFilter,
763sort: [NewsletterSubscriptionSort!] = [id_ASC],
764limit: Int = 20,
765page: Int = 1
766): [NewsletterSubscription!]!
767
768# Get single order data
769#
770# Required permission: Order:read
771#
772# Store restrictions apply.
773#
774# Arguments
775# id: (self-explanatory)
776# number: (self-explanatory)
777order(id: String, number: Int): Order
778
779# Get all orders
780#
781# Required permission: Order:read
782#
783# Limit must be in range 1 - 100
784#
785# Store restrictions apply.
786#
787# Arguments
788# where: (self-explanatory)
789# sort: (self-explanatory)
790# limit: (self-explanatory)
791# page: (self-explanatory)
792orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [Order!]!
793
794# Get collection of orders in the Relay connection form
795#
796# Required permission: Order:read
797#
798# Limit must be in range 1 - 100
799#
800# Store restrictions apply.
801#
802# Arguments
803# where: (self-explanatory)
804# sort: (self-explanatory)
805# first: (self-explanatory)
806# after: (self-explanatory)
807# last: (self-explanatory)
808# before: (self-explanatory)
809orderConnection(
810where: OrderFilter,
811sort: [OrderSort!] = [number_DESC],
812first: Int,
813after: String,
814last: Int,
815before: String
816): OrderConnection!
817
818# Get all permission names
819#
820# Required permission: admin
821#
822# All elements are always returned
823permissionNames: [String!]!
824
825# Get payment history
826#
827# Required permission: PaymentHistory:read
828#
829# Limit must be in range 1 - 200
830#
831# Arguments
832# where: (self-explanatory)
833# sort: (self-explanatory)
834# limit: (self-explanatory)
835# page: (self-explanatory)
836orderPaymentHistory(
837where: PaymentHistoryEntryFilter,
838sort: [PaymentHistoryEntrySort!] = [id_DESC],
839limit: Int = 20,
840page: Int = 1
841): [PaymentHistoryEntry!]!
842
843# Get payment terms
844#
845# Required permission: PaymentTerms:read
846#
847# Limit is optional
848#
849# Store restrictions apply.
850#
851# Arguments
852# where: (self-explanatory)
853# sort: (self-explanatory)
854# limit: (self-explanatory)
855# page: (self-explanatory)
856paymentTerms(
857where: PaymentTermsFilter,
858sort: [PaymentTermsSort!] = [id_ASC],
859limit: Int,
860page: Int
861): [PaymentTerms!]!
862
863# Get single pricelist data
864#
865# Required permission: Pricelist:read
866#
867# Store restrictions apply.
868#
869# Arguments
870# id: (self-explanatory)
871pricelist(id: Int!): Pricelist
872
873# Get collection of pricelists by any criteria
874#
875# Required permission: Pricelist:read
876#
877# Limit must be in range 1 - 200
878#
879# Store restrictions apply.
880#
881# Arguments
882# where: (self-explanatory)
883# sort: (self-explanatory)
884# limit: (self-explanatory)
885# page: (self-explanatory)
886pricelists(
887where: PricelistFilter,
888sort: [PricelistSort!] = [id_ASC],
889limit: Int = 20,
890page: Int = 1
891): [Pricelist!]!
892
893# Get single price alteration data
894#
895# Required permission: Price:read
896#
897# Store restrictions apply.
898#
899# Arguments
900# id: (self-explanatory)
901priceAlteration(id: Int!): PriceAlteration
902
903# Get price alterations
904#
905# Required permission: Price:read
906#
907# All elements are always returned
908#
909# Store restrictions apply.
910#
911# Arguments
912# where: (self-explanatory)
913# sort: (self-explanatory)
914priceAlterations(
915where: PriceAlterationFilter,
916sort: [PriceAlterationSort!]
917): [PriceAlteration!]!
918
919# Get single product data
920#
921# Required permission: Product:read
922#
923# Arguments
924# id: (self-explanatory)
925product(id: Int!): Product
926
927# Get collection of products by any criteria
928#
929# Required permission: Product:read
930#
931# Limit must be in range 1 - 200
932#
933# Arguments
934# where: (self-explanatory)
935# sort: (self-explanatory)
936# limit: (self-explanatory)
937# page: (self-explanatory)
938products(where: ProductFilter, sort: [ProductSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Product!]!
939
940# Get collection of products in the Relay connection form
941#
942# Required permission: Product:read
943#
944# Limit must be in range 1 - 200
945#
946# Arguments
947# where: (self-explanatory)
948# sort: (self-explanatory)
949# first: (self-explanatory)
950# after: (self-explanatory)
951# last: (self-explanatory)
952# before: (self-explanatory)
953productConnection(
954where: ProductFilter,
955sort: [ProductSort!] = [id_ASC],
956first: Int,
957after: String,
958last: Int,
959before: String
960): ProductConnection!
961
962# Get collection of product sizes by any criteria
963#
964# Required permission: ProductSize:read
965#
966# Limit must be in range 1 - 200
967#
968# Arguments
969# where: (self-explanatory)
970# sort: (self-explanatory)
971# limit: (self-explanatory)
972# page: (self-explanatory)
973productSizes(
974where: ProductSizeFilter,
975sort: [ProductSizeSort!] = [id_ASC],
976limit: Int = 20,
977page: Int = 1
978): [ProductSize!]!
979
980# Get collection of product sizes in the Relay connection form
981#
982# Required permission: ProductSize:read
983#
984# Limit must be in range 1 - 200
985#
986# Arguments
987# where: (self-explanatory)
988# sort: (self-explanatory)
989# first: (self-explanatory)
990# after: (self-explanatory)
991# last: (self-explanatory)
992# before: (self-explanatory)
993productSizeConnection(
994where: ProductSizeFilter,
995sort: [ProductSizeSort!] = [id_ASC],
996first: Int,
997after: String,
998last: Int,
999before: String
1000): ProductSizeConnection!
1001
1002# Get single product variant data
1003#
1004# Required permission: ProductVariant:read
1005#
1006# Arguments
1007# id: (self-explanatory)
1008productVariant(id: Int!): ProductVariant
1009
1010# Get collection of product variants by any criteria
1011#
1012# Required permission: ProductVariant:read
1013#
1014# Limit must be in range 1 - 200
1015#
1016# Arguments
1017# where: (self-explanatory)
1018# sort: (self-explanatory)
1019# limit: (self-explanatory)
1020# page: (self-explanatory)
1021productVariants(
1022where: ProductVariantFilter,
1023sort: [ProductVariantSort!] = [id_ASC],
1024limit: Int = 20,
1025page: Int = 1
1026): [ProductVariant!]!
1027
1028# Get collection of product variants in the Relay connection form
1029#
1030# Required permission: ProductVariant:read
1031#
1032# Limit must be in range 1 - 200
1033#
1034# Arguments
1035# where: (self-explanatory)
1036# sort: (self-explanatory)
1037# first: (self-explanatory)
1038# after: (self-explanatory)
1039# last: (self-explanatory)
1040# before: (self-explanatory)
1041productVariantConnection(
1042where: ProductVariantFilter,
1043sort: [ProductVariantSort!] = [id_ASC],
1044first: Int,
1045after: String,
1046last: Int,
1047before: String
1048): ProductVariantConnection!
1049
1050# Get collection of returns by any criteria
1051#
1052# Required permission: Return:read
1053#
1054# Limit must be in range 1 - 200
1055#
1056# Store restrictions apply.
1057#
1058# Arguments
1059# where: (self-explanatory)
1060# sort: (self-explanatory)
1061# limit: (self-explanatory)
1062# page: (self-explanatory)
1063returns(where: ReturnFilter, sort: [ReturnSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Return!]!
1064
1065# Get collection of returns in the Relay connection form
1066#
1067# Required permission: Return:read
1068#
1069# Limit must be in range 1 - 200
1070#
1071# Store restrictions apply.
1072#
1073# Arguments
1074# where: (self-explanatory)
1075# sort: (self-explanatory)
1076# first: (self-explanatory)
1077# after: (self-explanatory)
1078# last: (self-explanatory)
1079# before: (self-explanatory)
1080returnConnection(
1081where: ReturnFilter,
1082sort: [ReturnSort!] = [id_ASC],
1083first: Int,
1084after: String,
1085last: Int,
1086before: String
1087): ReturnConnection!
1088
1089# Get single sales representative
1090#
1091# Required permission: SalesRepresentative:read
1092#
1093# Arguments
1094# id: (self-explanatory)
1095salesRepresentative(id: Int!): SalesRepresentative
1096
1097# Get collection of sales representatives
1098#
1099# Required permission: SalesRepresentative:read
1100#
1101# Limit must be in range 1 - 200
1102#
1103# Arguments
1104# where: (self-explanatory)
1105# sort: (self-explanatory)
1106# limit: (self-explanatory)
1107# page: (self-explanatory)
1108salesRepresentatives(
1109where: SalesRepresentativeFilter,
1110sort: [SalesRepresentativeSort!] = [id_ASC],
1111limit: Int = 20,
1112page: Int = 1
1113): [SalesRepresentative!]!
1114
1115# Get single shipment data
1116#
1117# Required permission: Shipment:read
1118#
1119# Store restrictions apply.
1120#
1121# Arguments
1122# id: (self-explanatory)
1123shipment(id: Int!): Shipment
1124
1125# Get collection of shipments by any criteria
1126#
1127# Required permission: Shipment:read
1128#
1129# Limit must be in range 1 - 200
1130#
1131# Store restrictions apply.
1132#
1133# Arguments
1134# where: (self-explanatory)
1135# sort: (self-explanatory)
1136# limit: (self-explanatory)
1137# page: (self-explanatory)
1138shipments(where: ShipmentFilter, sort: [ShipmentSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Shipment!]!
1139
1140# Get collection of shipments in Relay connection form
1141#
1142# Required permission: Shipment:read
1143#
1144# Limit must be in range 1 - 200
1145#
1146# Store restrictions apply.
1147#
1148# Arguments
1149# where: (self-explanatory)
1150# sort: (self-explanatory)
1151# first: (self-explanatory)
1152# after: (self-explanatory)
1153# last: (self-explanatory)
1154# before: (self-explanatory)
1155shipmentConnection(
1156where: ShipmentFilter,
1157sort: [ShipmentSort!] = [id_DESC],
1158first: Int,
1159after: String,
1160last: Int,
1161before: String
1162): ShipmentConnection!
1163
1164# Get shipping options
1165#
1166# Required permission: ShippingOption:read
1167#
1168# Limit must be in range 1 - 200
1169#
1170# Store restrictions apply.
1171#
1172# Arguments
1173# where: (self-explanatory)
1174# sort: (self-explanatory)
1175# limit: (self-explanatory)
1176# page: (self-explanatory)
1177shippingOptions(
1178where: ShippingOptionFilter,
1179sort: [ShippingOptionSort!] = [name_ASC, id_ASC],
1180limit: Int = 20,
1181page: Int = 1
1182): [ShippingOption!]!
1183
1184# Get shipping terms
1185#
1186# Required permission: ShippingTerms:read
1187#
1188# Limit is optional
1189#
1190# Store restrictions apply.
1191#
1192# Arguments
1193# where: (self-explanatory)
1194# sort: (self-explanatory)
1195# limit: (self-explanatory)
1196# page: (self-explanatory)
1197shippingTerms(
1198where: ShippingTermsFilter,
1199sort: [ShippingTermsSort!] = [id_ASC],
1200limit: Int,
1201page: Int
1202): [ShippingTerms!]!
1203
1204# Get single size chart
1205#
1206# Required permission: SizeChart:read
1207#
1208# Arguments
1209# id: (self-explanatory)
1210sizeChart(id: Int!): SizeChart
1211
1212# Get collection of size charts by any criteria
1213#
1214# Required permission: SizeChart:read
1215#
1216# Limit is optional
1217#
1218# Arguments
1219# where: (self-explanatory)
1220# sort: (self-explanatory)
1221# limit: (self-explanatory)
1222# page: (self-explanatory)
1223sizeCharts(
1224where: SizeChartFilter,
1225sort: [SizeChartSort!] = [id_ASC],
1226limit: Int,
1227page: Int
1228): [SizeChart!]!
1229
1230# Get single store data
1231#
1232# Required permission: Store:read
1233#
1234# Store restrictions apply.
1235#
1236# Arguments
1237# id: (self-explanatory)
1238store(id: Int!): Store
1239
1240# Get collection of stores by any criteria
1241#
1242# Required permission: Store:read
1243#
1244# Limit is optional
1245#
1246# Store restrictions apply.
1247#
1248# Arguments
1249# where: (self-explanatory)
1250# sort: (self-explanatory)
1251# limit: (self-explanatory)
1252# page: (self-explanatory)
1253stores(where: StoreFilter, sort: [StoreSort!] = [id_ASC], limit: Int, page: Int): [Store!]!
1254
1255# Get collection of store plugins by any criteria
1256#
1257# Required permission: StorePlugin:read
1258#
1259# Limit is optional
1260#
1261# Store restrictions apply.
1262#
1263# Arguments
1264# where: (self-explanatory)
1265# sort: (self-explanatory)
1266# limit: (self-explanatory)
1267# page: (self-explanatory)
1268storePlugins(
1269where: StorePluginFilter,
1270sort: [StorePluginSort!] = [id_ASC],
1271limit: Int,
1272page: Int
1273): [StorePlugin!]!
1274
1275# Get collection of subscription plans by any criteria
1276#
1277# Required permission: SubscriptionPlan:read
1278#
1279# Limit must be in range 1 - 200
1280#
1281# Store restrictions apply.
1282#
1283# Arguments
1284# where: (self-explanatory)
1285# sort: (self-explanatory)
1286# limit: (self-explanatory)
1287# page: (self-explanatory)
1288subscriptionPlans(
1289where: SubscriptionPlanFilter,
1290sort: [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC],
1291limit: Int = 20,
1292page: Int = 1
1293): [SubscriptionPlan!]!
1294
1295# Get defined tax classes
1296#
1297# Required permission: TaxClass:read
1298#
1299# Limit is optional
1300#
1301# Arguments
1302# where: (self-explanatory)
1303# sort: (self-explanatory)
1304# limit: (self-explanatory)
1305# page: (self-explanatory)
1306taxClasses(
1307where: TaxClassFilter,
1308sort: [TaxClassSort!] = [id_ASC],
1309limit: Int,
1310page: Int
1311): [TaxClass!]!
1312
1313# Get defined tax groups
1314#
1315# Required permission: TaxRule:read
1316#
1317# Limit is optional
1318#
1319# Arguments
1320# where: (self-explanatory)
1321# sort: (self-explanatory)
1322# limit: (self-explanatory)
1323# page: (self-explanatory)
1324taxGroups(where: TaxGroupFilter, sort: [TaxGroupSort!] = [id_ASC], limit: Int, page: Int): [TaxGroup!]!
1325
1326# Get defined tax rules
1327#
1328# Required permission: TaxRule:read
1329#
1330# Limit must be in range 1 - 200
1331#
1332# Arguments
1333# where: (self-explanatory)
1334# sort: (self-explanatory)
1335# limit: (self-explanatory)
1336# page: (self-explanatory)
1337taxRules(where: TaxRuleFilter, sort: [TaxRuleSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [TaxRule!]!
1338
1339# Get data of currently authenticated user
1340#
1341# Required permission: none
1342viewer: GraphQLUser!
1343
1344# Get single warehouse
1345#
1346# Required permission: Warehouse:read
1347#
1348# Arguments
1349# id: (self-explanatory)
1350warehouse(id: Int!): Warehouse!
1351
1352# Get collection of warehouses
1353#
1354# Required permission: Warehouse:read
1355#
1356# Limit must be in range 1 - 200
1357#
1358# Arguments
1359# where: (self-explanatory)
1360# sort: (self-explanatory)
1361# limit: (self-explanatory)
1362# page: (self-explanatory)
1363warehouses(
1364where: WarehouseFilter,
1365sort: [WarehouseSort!] = [customSort_ASC, id_ASC],
1366limit: Int = 20,
1367page: Int = 1
1368): [Warehouse!]!
1369
1370# Get collection of warehouse deliveries in Relay connection form
1371#
1372# Required permission: WarehouseDelivery:read
1373#
1374# Limit must be in range 1 - 200
1375#
1376# Arguments
1377# where: (self-explanatory)
1378# sort: (self-explanatory)
1379# first: (self-explanatory)
1380# after: (self-explanatory)
1381# last: (self-explanatory)
1382# before: (self-explanatory)
1383warehouseDeliveryConnection(
1384where: WarehouseDeliveryFilter,
1385sort: [WarehouseDeliverySort!] = [id_DESC],
1386first: Int,
1387after: String,
1388last: Int,
1389before: String
1390): WarehouseDeliveryConnection!
1391
1392# Get collection of warehouse delivery lines
1393#
1394# Required permission: WarehouseDelivery:read
1395#
1396# Limit must be in range 1 - 200
1397#
1398# Arguments
1399# where: (self-explanatory)
1400# sort: (self-explanatory)
1401# limit: (self-explanatory)
1402# page: (self-explanatory)
1403warehouseDeliveryLines(
1404where: WarehouseDeliveryLineFilter,
1405sort: [WarehouseDeliveryLineSort!] = [id_ASC],
1406limit: Int = 20,
1407page: Int = 1
1408): [WarehouseDeliveryLine!]!
1409
1410# Get collection of warehouse delivery lines in Relay connection form
1411#
1412# Required permission: WarehouseDelivery:read
1413#
1414# Limit must be in range 1 - 200
1415#
1416# Arguments
1417# where: (self-explanatory)
1418# sort: (self-explanatory)
1419# first: (self-explanatory)
1420# after: (self-explanatory)
1421# last: (self-explanatory)
1422# before: (self-explanatory)
1423warehouseDeliveryLineConnection(
1424where: WarehouseDeliveryLineFilter,
1425sort: [WarehouseDeliveryLineSort!] = [id_ASC],
1426first: Int,
1427after: String,
1428last: Int,
1429before: String
1430): WarehouseDeliveryLineConnection!
1431
1432# Get a list of subscriptions
1433#
1434# Required permission: Subscription:read
1435#
1436# Limit must be in range 1 - 200
1437#
1438# Store restrictions apply.
1439#
1440# Arguments
1441# where: (self-explanatory)
1442# sort: (self-explanatory)
1443# limit: (self-explanatory)
1444# page: (self-explanatory)
1445subscriptions(
1446where: SubscriptionFilter,
1447sort: [SubscriptionSort!] = [id_DESC],
1448limit: Int = 20,
1449page: Int = 1
1450): [Subscription!]!
1451
1452# Get a list of subscription contracts
1453#
1454# Required permission: Subscription:read
1455#
1456# Limit must be in range 1 - 200
1457#
1458# Store restrictions apply.
1459#
1460# Arguments
1461# where: (self-explanatory)
1462# sort: (self-explanatory)
1463# limit: (self-explanatory)
1464# page: (self-explanatory)
1465subscriptionContracts(
1466where: SubscriptionContractFilter,
1467sort: [SubscriptionContractSort!] = [id_DESC],
1468limit: Int = 20,
1469page: Int = 1
1470): [SubscriptionContract!]!
1471
1472# Get the counter(s) for any object type
1473#
1474# Required permission: none
1475counters: Counters!
1476
1477# Get a list of purchase orders
1478#
1479# Required permission: PurchaseOrder:read
1480#
1481# Limit must be in range 1 - 200
1482#
1483# Arguments
1484# where: (self-explanatory)
1485# sort: (self-explanatory)
1486# limit: (self-explanatory)
1487# page: (self-explanatory)
1488purchaseOrders(
1489where: PurchaseOrderFilter,
1490sort: [PurchaseOrderSort!] = [id_DESC],
1491limit: Int = 20,
1492page: Int = 1
1493): [PurchaseOrder!]!
1494
1495# Get a list of purchase order deliveries
1496#
1497# Required permission: PurchaseOrderDelivery:read
1498#
1499# Limit must be in range 1 - 200
1500#
1501# Arguments
1502# where: (self-explanatory)
1503# sort: (self-explanatory)
1504# limit: (self-explanatory)
1505# page: (self-explanatory)
1506purchaseOrderDeliveries(
1507where: PurchaseOrderDeliveryFilter,
1508sort: [PurchaseOrderDeliverySort!] = [id_DESC],
1509limit: Int = 20,
1510page: Int = 1
1511): [PurchaseOrderDelivery!]!
1512
1513# Get single supplier data by ID
1514#
1515# Required permission: Supplier:read
1516#
1517# Arguments
1518# id: (self-explanatory)
1519supplier(id: Int!): Supplier
1520
1521# Get a list of suppliers
1522#
1523# Required permission: Supplier:read
1524#
1525# Limit must be in range 1 - 200
1526#
1527# Arguments
1528# where: (self-explanatory)
1529# sort: (self-explanatory)
1530# limit: (self-explanatory)
1531# page: (self-explanatory)
1532suppliers(where: SupplierFilter, sort: [SupplierSort!] = [name_ASC], limit: Int = 20, page: Int = 1): [Supplier!]!
1533
1534# Required permission: MediaBatch:read
1535#
1536# Arguments
1537# queueId: (self-explanatory)
1538mediaBatch(queueId: String!): MediaBatch
1539
1540}

link Required by

This element is not required by anyone