OBJECT
Query
link GraphQL Schema definition
1 type 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. 47 ( 48 String, : 49 String, : 50 Q, : 51 String, : 52 Int, : 53 String, : 54 Int, : 55 String, : 56 String, : 57 String, : 58 String, : 59 String, : 60 String, : 61 String, : 62 String, : 63 String, : 64 String, : 65 Int, : 66 String, : 67 ResponseFormat, : 68 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. 88 ( 89 String, : 90 Int, : 91 Int, : 92 ResponseFormat, : 93 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. 112 ( 113 String, : 114 String, : 115 Int!, : 116 ResponseFormat, : 117 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. 143 ( 144 String, : 145 String, : 146 Int, : 147 Int, : 148 Q2!, : 149 String, : 150 ResponseFormat, : 151 String! : 152 ): PromotionPromotion 154 155 }
link Required by
This element is not required by anyone