OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Gets promotions list by product ID.
4#
5# Equivalent to GET /store/{storeId}/associated_promotion
6#
7# Arguments
8# currency: The currency code to use for example, currency=USD.
9# If no currency code is specified, the store default currency is used.
10# profileName: Profile name. Profiles determine the subset of
11# data returned by a query.
12# q: The query name.
13# qCalculationUsageId: The calculation usage ID.
14# qCategoryId: [Not documented]
15# qCode: The calculation code name.
16# qDisplayLevel: [Not documented]
17# qEnableStorePath: Whether the data bean searches for
18# calculation code based on store path. The default value is true.
19# qIncludeCategoryPromotions: Whether to exclude category
20# promotions. The default value is false.
21# qIncludeChildItems: Whether to include the child items. The
22# default value is false.
23# qIncludeNonManagementCenterPromotions: Whether all the
24# promotions in the store have been created in Management Center. The default
25# value is false.
26# qIncludeParentCategories: Whether to retrieve the calculation
27# codes attached to the parent category of the specified catalog group. The
28# default value is false.
29# qIncludeParentProduct: Whether to retrieve the calculation
30# codes attached to the parent product of the specified catalog entry. The default
31# value is false.
32# qIncludePromotionCode: Whether to exclude the calculation codes
33# that require a promotion code. The default value is true.
34# qIncludeUnentitledPromotionsByMemberGroup: Whether to include
35# promotions that are targeted to a member group if the user does not belong to
36# the member group. The default value is false.
37# qProductId: The product ID.
38# qShipModeId: The ship mode ID.
39# qStoreId: [Not documented]
40# qUserId: The user ID.
41# responseFormat: The response format. Valid values are json and
42# xml. If the request contains an input body, it must use the format specified in
43# responseFormat. If the responseFormat is not specified, the accept HTTP header
44# determines the format of the response. If the accept HTTP header is not
45# specified then default response format is json.
46# storeId: The store identifier.
47associatedPromotionFindPromotionsByProductWAssociatedPromotionSummaryProfileName(
48currency: String,
49profileName: String,
50q: Q,
51qCalculationUsageId: String,
52qCategoryId: Int,
53qCode: String,
54qDisplayLevel: Int,
55qEnableStorePath: String,
56qIncludeCategoryPromotions: String,
57qIncludeChildItems: String,
58qIncludeNonManagementCenterPromotions: String,
59qIncludeParentCategories: String,
60qIncludeParentProduct: String,
61qIncludePromotionCode: String,
62qIncludeUnentitledPromotionsByMemberGroup: String,
63qProductId: String,
64qShipModeId: String,
65qStoreId: Int,
66qUserId: String,
67responseFormat: ResponseFormat,
68storeId: String!
69): associatedPromotionsListSummary
153
70# Gets available coupons for the current shopper.
71#
72# Equivalent to GET /store/{storeId}/coupon/@self
73#
74# Arguments
75# currency: The currency code to use for example, currency=USD.
76# If no currency code is specified, the store default currency is used.
77# pageNumber: Page number. Valid values are positive integers
78# starting at 1. Use pageNumber with pageSize.
79# pageSize: Page size. Used to limit the amount of data returned
80# by a query. Valid values are integers starting with 1. Use pageSize with
81# pageNumber.
82# responseFormat: The response format. Valid values are json and
83# xml. If the request contains an input body, it must use the format specified in
84# responseFormat. If the responseFormat is not specified, the accept HTTP header
85# determines the format of the response. If the accept HTTP header is not
86# specified then default response format is json.
87# storeId: The store identifier.
88couponGetCoupon(
89currency: String,
90pageNumber: Int,
91pageSize: Int,
92responseFormat: ResponseFormat,
93storeId: String!
94): CouponCoupon
153
95# Gets promotions by ID.
96#
97# Equivalent to GET /store/{storeId}/promotion/{promotionId}
98#
99# Arguments
100# currency: The currency code to use for example, currency=USD.
101# If no currency code is specified, the store default currency is used.
102# langId: Language identifier. If not specified, the "locale"
103# parameter is used. If "locale" is not specified, then the store default language
104# is used.
105# promotionId: The promotion identifier.
106# responseFormat: The response format. Valid values are json and
107# xml. If the request contains an input body, it must use the format specified in
108# responseFormat. If the responseFormat is not specified, the accept HTTP header
109# determines the format of the response. If the accept HTTP header is not
110# specified then default response format is json.
111# storeId: The store identifier.
112promotionGetPromotionByID(
113currency: String,
114langId: String,
115promotionId: Int!,
116responseFormat: ResponseFormat,
117storeId: String!
118): PromotionPromotion
153
119# Gets the promotion list by query type and parameters.
120#
121# Equivalent to GET /store/{storeId}/promotion
122#
123# Arguments
124# currency: The currency code to use for example, currency=USD.
125# If no currency code is specified, the store default currency is used.
126# langId: Language identifier. If not specified, the "locale"
127# parameter is used. If "locale" is not specified, then the store default language
128# is used.
129# pageNumber: Page number. Valid values are positive integers
130# starting at 1. Use pageNumber with pageSize.
131# pageSize: Page size. Used to limit the amount of data returned
132# by a query. Valid values are integers starting with 1. Use pageSize with
133# pageNumber.
134# q: The query name.
135# qName: The name of the promotion to find when finding
136# promotions by name.
137# responseFormat: The response format. Valid values are json and
138# xml. If the request contains an input body, it must use the format specified in
139# responseFormat. If the responseFormat is not specified, the accept HTTP header
140# determines the format of the response. If the accept HTTP header is not
141# specified then default response format is json.
142# storeId: The store identifier.
143promotionGetPromotionsByQuery(
144currency: String,
145langId: String,
146pageNumber: Int,
147pageSize: Int,
148q: Q2!,
149qName: String,
150responseFormat: ResponseFormat,
151storeId: String!
152): PromotionPromotion
154
155}

link Required by

This element is not required by anyone