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

link Required by

This element is not required by anyone