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

link Required by

This element is not required by anyone