OBJECT

Store

link GraphQL Schema definition

1type Store {
2id: Int!
3
4name: String!
5
6type: StoreType!
7
8# Required permission: Affiliate:read
9#
10# Limit must be in range 1 - 200
11#
12# Store restrictions apply.
13#
14# Arguments
15# where: (self-explanatory)
16# sort: (self-explanatory)
17# limit: (self-explanatory)
18# page: (self-explanatory)
19affiliates(
20where: AffiliateFilter,
21sort: [AffiliateSort!] = [id_ASC],
22limit: Int = 20,
23page: Int = 1
24): [Affiliate!]!
25
26# Required permission: AllocationRule:read
27allocationRule: AllocationRule
28
29# Required permission: Brand: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# limit: (self-explanatory)
39# page: (self-explanatory)
40brands(where: BrandFilter, sort: [BrandSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Brand!]!
41
42# Required permission: Campaign:read
43#
44# Limit must be in range 1 - 200
45#
46# Store restrictions apply.
47#
48# Arguments
49# where: (self-explanatory)
50# sort: (self-explanatory)
51# limit: (self-explanatory)
52# page: (self-explanatory)
53campaigns(where: CampaignFilter, sort: [CampaignSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Campaign!]!
54
55# Required permission: Category:read
56#
57# Limit must be in range 1 - 200
58#
59# Store restrictions apply.
60#
61# Arguments
62# where: (self-explanatory)
63# sort: (self-explanatory)
64# limit: (self-explanatory)
65# page: (self-explanatory)
66categories(
67where: CategoryFilter,
68sort: [CategorySort!] = [customOrder_ASC],
69limit: Int = 20,
70page: Int = 1
71): [Category!]!
72
73# Required permission: Market:read
74#
75# Store restrictions apply.
76defaultMarket: Market
77
78# Required permission: Pricelist:read
79#
80# Store restrictions apply.
81defaultPricelist: Pricelist
82
83# Required permission: TaxRule:read
84defaultTaxGroup: TaxGroup
85
86# Required permission: Market:read
87#
88# Limit is optional
89#
90# Store restrictions apply.
91#
92# Arguments
93# where: (self-explanatory)
94# sort: (self-explanatory)
95# limit: (self-explanatory)
96# page: (self-explanatory)
97markets(where: MarketFilter, sort: [MarketSort!] = [id_ASC], limit: Int, page: Int): [Market!]!
98
99# Required permission: Order:read
100#
101# Limit must be in range 1 - 100
102#
103# Store restrictions apply.
104#
105# Arguments
106# where: (self-explanatory)
107# sort: (self-explanatory)
108# limit: (self-explanatory)
109# page: (self-explanatory)
110orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [Order!]!
111
112# Required permission: StorePlugin:read
113#
114# All elements are always returned
115#
116# Store restrictions apply.
117plugins: [StorePlugin!]!
118
119# Required permission: Pricelist:read
120#
121# Limit must be in range 1 - 200
122#
123# Store restrictions apply.
124#
125# Arguments
126# where: (self-explanatory)
127# sort: (self-explanatory)
128# limit: (self-explanatory)
129# page: (self-explanatory)
130pricelists(
131where: PricelistFilter,
132sort: [PricelistSort!] = [id_ASC],
133limit: Int = 20,
134page: Int = 1
135): [Pricelist!]!
136
137# Required permission: ShippingOption:read
138#
139# All elements are always returned
140#
141# Store restrictions apply.
142shippingOptions: [ShippingOption!]!
143
144}