OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Finds catalog entries by their parent part number. Invalid part number is
4# ignored.
5#
6# Equivalent to GET /store/{storeId}/catalog_entry
7#
8# Arguments
9# catalogId: The unique id of the catalog to search the catalog
10# entries under. If no catalog specified, store default catalog is used.
11# currency: The currency code to use. Example usage :
12# currency=USD. If no currency code is specified, the store default currency shall
13# be used.
14# langId: Language identifier. If not specified, the "locale"
15# parameter is used. If "locale" is not specified, then the store default language
16# is used.
17# pageNumber: Page number. Valid values are positive integers
18# starting at 1. Use pageNumber with pageSize.
19# pageSize: Page size. Used to limit the amount of data returned
20# by a query. Valid values are integers starting with 1. Use pageSize with
21# pageNumber.
22# partNumber: The part number of the parent catalog entry.
23# profileName: Profile name. Profiles determine the subset of
24# data returned by a query.
25# q: The query name.
26# storeId: The store identifier.
27catalogEntryByParentPartNumbers(
28catalogId: String,
29currency: Currency,
30langId: String,
31pageNumber: Int,
32pageSize: Int,
33partNumber: [String]!,
34profileName: ProfileName2,
35q: Q!,
36storeId: String!
37): CatalogEntryIBMAdminCatalogEntryDefiningAttributeDictionaryAttribute
180
38# Gets catalog entries by search term.
39#
40# Equivalent to GET /store/{storeId}/catalog_entry/bySearchTerm/{searchTerm}
41#
42# Arguments
43# catalogId: The unique id of the catalog to search the catalog
44# entries under. If no catalog specified, store default catalog is used.
45# excludeType: The catalog entry types that are not returned.
46# langId: Language identifier. If not specified, the "locale"
47# parameter is used. If "locale" is not specified, then the store default language
48# is used.
49# pageNumber: Page number. Valid values are positive integers
50# starting at 1. Use pageNumber with pageSize.
51# pageSize: Page size. Used to limit the amount of data returned
52# by a query. Valid values are integers starting with 1. Use pageSize with
53# pageNumber.
54# profileName: Profile name. Profiles determine the subset of
55# data returned by a query.
56# searchTerm: The term user is searching for.
57# storeId: The store identifier.
58# type: The catalog entry types to return.
59catalogEntryFindBySearchTerm(
60catalogId: String,
61excludeType: [ExcludeTypeListItem],
62langId: String,
63pageNumber: Int,
64pageSize: Int,
65profileName: ProfileName3,
66searchTerm: String!,
67storeId: String!,
68type: [TypeListItem]
69): CatalogEntryIBMAdminStandardOfferPrice
180
70# Gets catalogs by search term.
71#
72# Equivalent to GET /store/{storeId}/category/bySearchTerm/{searchTerm}
73#
74# Arguments
75# catalogId: The unique ID of the catalog to search the
76# categories under.
77# langId: Language identifier. If not specified, the "locale"
78# parameter is used. If "locale" is not specified, then the store default language
79# is used.
80# pageNumber: Page number. Valid values are positive integers
81# starting at 1. Use pageNumber with pageSize.
82# pageSize: Page size. Used to limit the amount of data returned
83# by a query. Valid values are integers starting with 1. Use pageSize with
84# pageNumber.
85# profileName: Profile name. Profiles determine the subset of
86# data returned by a query.
87# searchTerm: The term user is searching for.
88# storeId: The store identifier.
89categoryFindBySearchTerm(
90catalogId: String,
91langId: String,
92pageNumber: Int,
93pageSize: Int,
94profileName: ProfileName,
95searchTerm: String!,
96storeId: String!
97): CategoryIBMAdminDetailsBreadcrumb
180
98# Gets catalogs by search term.
99#
100# Equivalent to GET /store/{storeId}/categoryview/byId/{categoryId}
101#
102# Arguments
103# catalogId: The catalog identifier. If none is specified, the
104# store default catalog shall be used.
105# categoryId: Category ID.
106# currency: The currency code to use. Example usage
107# currency=USD. If no currency code is specified, the store default currency shall
108# be used.
109# responseFormat: The response format. If the request has an
110# input body, that body must also use the format specified in "responseFormat".
111# Valid values include “json” and “xml” without the quotes. If the responseFormat
112# isn’t specified, the “accept” HTTP header shall be used to determine the format
113# of the response. If the “accept” HTTP header isn’t specified as well, the
114# default response format shall be in json.
115# storeId: The store identifier.
116getStoreStoreIdCategoryviewByIdCategoryId(
117catalogId: String,
118categoryId: String!,
119currency: String,
120responseFormat: String,
121storeId: String!
122): CategoryviewCategoryDetails
180
123# Gets catalogs by search term.
124#
125# Equivalent to GET
126# /store/{storeId}/categoryview/byParentCategory/{parentCategoryId}
127#
128# Arguments
129# catalogId: The catalog identifier. If none is specified, the
130# store default catalog shall be used.
131# currency: The currency code to use. Example usage
132# currency=USD. If no currency code is specified, the store default currency shall
133# be used.
134# pageNumber: Page number, starting at 1. Valid values include
135# positive integers of 1 and above. The “pageSize” must be specified for paging to
136# work.
137# pageSize: Page size. Used to limit the amount of data returned
138# by a query. Valid values include positive integers of 1 and above. The
139# “pageNumber” must be specified for paging to work.
140# parentCategoryId: The parent category unique ID.
141# responseFormat: The response format. If the request has an
142# input body, that body must also use the format specified in "responseFormat".
143# Valid values include “json” and “xml” without the quotes. If the responseFormat
144# isn’t specified, the “accept” HTTP header shall be used to determine the format
145# of the response. If the “accept” HTTP header isn’t specified as well, the
146# default response format shall be in json.
147# storeId: The store identifier.
148getStoreStoreIdCategoryviewByParentCategoryParentCategoryId(
149catalogId: String,
150currency: String,
151pageNumber: Int,
152pageSize: Int,
153parentCategoryId: String!,
154responseFormat: String,
155storeId: String!
156): CategoryviewCategorySummary
180
157# Gets catalogs by search term.
158#
159# Equivalent to GET /store/{storeId}/categoryview/@top
160#
161# Arguments
162# catalogId: The catalog identifier. If none is specified, the
163# store default catalog shall be used.
164# currency: The currency code to use. Example usage
165# currency=USD. If no currency code is specified, the store default currency shall
166# be used.
167# responseFormat: The response format. If the request has an
168# input body, that body must also use the format specified in "responseFormat".
169# Valid values include “json” and “xml” without the quotes. If the responseFormat
170# isn’t specified, the “accept” HTTP header shall be used to determine the format
171# of the response. If the “accept” HTTP header isn’t specified as well, the
172# default response format shall be in json.
173# storeId: The store identifier.
174getStoreStoreIdCategoryviewTop(
175catalogId: String,
176currency: String,
177responseFormat: String,
178storeId: String!
179): CategoryviewCategoryDetails
181
182}

link Required by

This element is not required by anyone