OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Gets configuration details by the specified identifier.
4#
5# Equivalent to GET /store/{storeId}/configuration/{configurationId}
6#
7# Arguments
8# configurationId: The configuration identifier. This is
9# mandatory parameter and cannot be null or empty.
10# storeId: The store identifier.
11configurationFindByConfigurationId(
12configurationId: String!,
13storeId: String!
14): ConfigurationConfiguration
237
15# Gets configuration details by one or more specified identifiers.
16#
17# Equivalent to GET /store/{storeId}/configuration
18#
19# Arguments
20# configurationId: The store identifier.
21# q: The query name.
22# storeId: The store identifier.
23configurationFindByQuery(
24configurationId: String!,
25q: Q8!,
26storeId: String!
27): ConfigurationConfiguration
237
28# Gets the flow info by flow ID.
29#
30# Equivalent to GET /store/{storeId}/flow/{flowId}
31#
32# Arguments
33# flowId: The flow ID.
34# storeId: The store identifier.
35flowFindByFlowId(flowId: String!, storeId: String!): FlowFlow
237
36# Gets integration configurations. Can only be called after logging in as an
37# integration user. As such, requests must be sent with an integration user cookie
38# or token. An integration user is a user in the RemoteConfigurationReader member
39# group.
40#
41# Equivalent to GET /integration_configuration
42#
43# Arguments
44# profileName: Profile name. Profiles determine the subset of
45# data returned by a query.
46# responseFormat: The response format. Valid values are json and
47# xml. If the request contains an input body, it must use the format specified in
48# responseFormat. If the responseFormat is not specified, the accept HTTP header
49# determines the format of the response. If the accept HTTP header is not
50# specified then default response format is json.
51integrationConfigurationGetConfiguration(
52profileName: String,
53responseFormat: ResponseFormat
54): integrationConfigurationDataBean
237
55# Gets integration session key configuration. Can only be called after logging in
56# as an integration user. As such, requests must be sent with an integration user
57# cookie or token. An integration user is a user in the RemoteConfigurationReader
58# member group.
59#
60# Equivalent to GET /integration_configuration/session_key
61#
62# Arguments
63# profileName: Profile name. Profiles determine the subset of
64# data returned by a query.
65# responseFormat: The response format. Valid values are json and
66# xml. If the request contains an input body, it must use the format specified in
67# responseFormat. If the responseFormat is not specified, the accept HTTP header
68# determines the format of the response. If the accept HTTP header is not
69# specified then default response format is json.
70integrationConfigurationGetEncryptedSessionKey(
71profileName: String,
72responseFormat: ResponseFormat
73): integrationconfigurationsessionkey
237
74# Gets the feature version data.
75#
76# Equivalent to GET /store/{storeId}/seo/redirectrule
77#
78# Arguments
79# origUrlKeywordId: The keyword ID.
80# q: The query name.
81# storeId: The store identifier.
82redirectRuleFindByOriginalUrlKeywordIds(
83origUrlKeywordId: [String]!,
84q: Q9!,
85storeId: String!
86): RedirectruleRedirectrule
237
87# Gets top-level resource URLs.
88#
89# Equivalent to GET /store/{storeId}
90#
91# Arguments
92# responseFormat: The response format. Valid values are json and
93# xml. If the request contains an input body, it must use the format specified in
94# responseFormat. If the responseFormat is not specified, the accept HTTP header
95# determines the format of the response. If the accept HTTP header is not
96# specified then default response format is json.
97# storeId: The store identifier.
98storeFetchStore(responseFormat: ResponseFormat, storeId: String!): storeInformation
237
99# Gets online store information by the specified query.
100#
101# Equivalent to GET /store/{storeId}/online_store
102#
103# Arguments
104# high: The high range.
105# low: The low range.
106# profileName: Profile name. Profiles determine the subset of
107# data to be returned by a query.
108# q: The query name.
109# storeId: The store identifier.
110storeFindByQueryOnlineStore(
111high: String,
112low: String,
113profileName: String,
114q: Q3!,
115storeId: String!
116): StoreStore
237
117# Gets tax information by the specified query.
118#
119# Equivalent to GET /store/{storeId}/taxInformation
120#
121# Arguments
122# high: The high range.
123# low: The low range.
124# profileName: Profile name. Profiles determine the subset of
125# data to be returned by a query.
126# q: The query name.
127# storeId: The store identifier.
128# storeIdentifier: The storeIdentifier.
129# usage: The usage.
130storeFindByQueryTaxInformation(
131high: String,
132low: String,
133profileName: ProfileName,
134q: Q!,
135storeId: String!,
136storeIdentifier: String,
137usage: String
138): calculationRuleCombineCmd
237
139# Gets store details by the specified store name and usage.
140#
141# Equivalent to GET /store/{storeId}/adminLookup
142#
143# Arguments
144# q: The query name.
145# responseFormat: The response format. Valid values are json and
146# xml. If the request contains an input body, it must use the format specified in
147# responseFormat. If the responseFormat is not specified, the accept HTTP header
148# determines the format of the response. If the accept HTTP header is not
149# specified then default response format is json.
150# storeId: The store identifier.
151# storeIdentifier: The store identifier
152# storeName: The store name.
153# usage: The usage.
154storeFindByStoreNameAndUsage(
155q: Q5!,
156responseFormat: ResponseFormat2!,
157storeId: String!,
158storeIdentifier: String!,
159storeName: String!,
160usage: String!
161): StoreStore
237
162# Gets information about a specific store ID. Can only be called after logging in
163# as an integration user. As such, requests must be sent with an integration user
164# cookie or token. An integration user is a user in the RemoteConfigurationReader
165# member group.
166#
167# Equivalent to GET /store/{storeId}/databean
168#
169# Arguments
170# jspStoreDir: [Not documented]
171# profileName: Profile name. Profiles determine the subset of
172# data returned by a query.
173# storeId: The store identifier.
174# storeRelationshipTypeName: [Not documented]
175storeFindDataBean(
176jspStoreDir: String,
177profileName: String,
178storeId: String!,
179storeRelationshipTypeName: String
180): StoreDatabeanResponse
237
181# Gets a list of enabled store features.
182#
183# Equivalent to GET /store/{storeId}/features
184#
185# Arguments
186# storeId: The store identifier.
187storeGetFeatureList(storeId: String!): StoreFeaturesList
237
188# Gets the feature version data.
189#
190# Equivalent to GET /store/{storeId}/seo/substitutionparameters
191#
192# Arguments
193# q: The query name.
194# storeId: The store identifier.
195substitutionParametersFindByAll(
196q: Q2!,
197storeId: String!
198): SubstitutionparametersSubstitutionparameters
237
199# Gets the feature version data.
200#
201# Equivalent to GET /store/{storeId}/seo/token
202#
203# Arguments
204# q: The query name.
205# storeId: The store identifier.
206# urlKeywordName: The input urlKeyword names.
207tokenFindByUrlKeywordNames(
208q: Q6!,
209storeId: String!,
210urlKeywordName: [String]!
211): TokenToken
237
212# Gets the feature version data.
213#
214# Equivalent to GET /store/{storeId}/seo/tokenusage
215#
216# Arguments
217# q: The query name.
218# storeId: The store identifier.
219tokenUsageFindByAll(q: Q4!, storeId: String!): TokenusageTokenusage
237
220# Gets the feature version data.
221#
222# Equivalent to GET /store/{storeId}/seo/urlkeyword
223#
224# Arguments
225# languageId: the return language of the query token.
226# q: The query name.
227# storeId: The store identifier.
228# tokenName: The input token name.
229# tokenValue: The input token value.
230uRLKeywordFindByTokenName(
231languageId: String!,
232q: Q7!,
233storeId: String!,
234tokenName: String!,
235tokenValue: String!
236): UrlkeywordUrlkeyword
238
239}

link Required by

This element is not required by anyone