OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Checks if the customer identified by userId or personalizationId is part of 4 # given customer segment. 5 # 6 # Equivalent to GET /store/{storeId}/segment/{segmentId}/isMember 7 # 8 # Arguments 9 # personalizationId: The user's personalization id. Note : this 10 # parameter is ignored if the userId parameter is specified. 11 # responseFormat: The response format. Valid values are json and 12 # xml. If the request contains an input body, it must use the format specified in 13 # responseFormat. If the responseFormat is not specified, the accept HTTP header 14 # determines the format of the response. If the accept HTTP header is not 15 # specified then default response format is json. 16 # segmentId: Segment identifier. 17 # storeId: The store identifier. 18 # userId: User unique identifier. 19 ( 20 : String, 21 : ResponseFormat, 22 : String!, 23 : String!, 24 : Int 25 ): segmentMemberCheck 278 26 # Gets all search terms that have search rules. 27 # 28 # Equivalent to GET /store/{storeId}/espot 29 # 30 # Arguments 31 # q: The query name. 32 # responseFormat: The response format. Valid values are json and 33 # xml. If the request contains an input body, it must use the format specified in 34 # responseFormat. If the responseFormat is not specified, the accept HTTP header 35 # determines the format of the response. If the accept HTTP header is not 36 # specified then default response format is json. 37 # storeId: The store identifier. 38 ( 39 : Q2!, 40 : String, 41 : String! 42 ): ESpotDataSearchContainer 278 43 # Gets an e-Marketing Spot by name. 44 # 45 # Equivalent to GET /store/{storeId}/espot/{name} 46 # 47 # Arguments 48 # catalogId: The catalog identifier. If none is specified, the 49 # store default catalog is used. 50 # currency: The currency code to use for example, currency=USD. 51 # If no currency code is specified, the store default currency is used. 52 # name: E-Spot name. 53 # responseFormat: The response format. Valid values are json and 54 # xml. If the request contains an input body, it must use the format specified in 55 # responseFormat. If the responseFormat is not specified, the accept HTTP header 56 # determines the format of the response. If the accept HTTP header is not 57 # specified then default response format is json. 58 # storeId: The store identifier. 59 ( 60 : String, 61 : String, 62 : String, 63 : ResponseFormat, 64 : String! 65 ): ESpotDataContainer 278 66 # "Deprecated: Gets an e-Marketing Spot for a specific product. Alternatively, 67 # this can be implemented using the findByName method with the following URL: 68 # store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay." 69 # 70 # Equivalent to GET /store/{storeId}/espot/{name}/product/{productId} 71 # 72 # Arguments 73 # catalogId: The catalog identifier. If none is specified, the 74 # store default catalog is used. 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 # name: E-Spot name. 78 # productId: The product identifier. 79 # responseFormat: The response format. Valid values are json and 80 # xml. If the request contains an input body, it must use the format specified in 81 # responseFormat. If the responseFormat is not specified, the accept HTTP header 82 # determines the format of the response. If the accept HTTP header is not 83 # specified then default response format is json. 84 # storeId: The store identifier. 85 ( 86 : String, 87 : String, 88 : String!, 89 : String!, 90 : ResponseFormat, 91 : String! 92 ): ESpotDataContainer 278 93 # Gets e-Marketing Spot data. 94 # 95 # Equivalent to GET /store/{storeId}/espot/{name}/type/{type} 96 # 97 # Arguments 98 # catalogId: The catalog identifier. If none is specified, the 99 # store default catalog is used. 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 # name: E-Spot name. 103 # responseFormat: The response format. Valid values are json and 104 # xml. If the request contains an input body, it must use the format specified in 105 # responseFormat. If the responseFormat is not specified, the accept HTTP header 106 # determines the format of the response. If the accept HTTP header is not 107 # specified then default response format is json. 108 # storeId: The store identifier. 109 # type: E-Marketing Spot type for example, SEARCH. 110 ( 111 : String, 112 : String, 113 : String, 114 : ResponseFormat, 115 : String!, 116 : String! 117 ): EspotEspot 278 118 # Gets user behavior rules. 119 # 120 # Equivalent to GET /store/{storeId}/event/behavior_rules 121 # 122 # Arguments 123 # responseFormat: The response format. Valid values are json and 124 # xml. If the request contains an input body, it must use the format specified in 125 # responseFormat. If the responseFormat is not specified, the accept HTTP header 126 # determines the format of the response. If the accept HTTP header is not 127 # specified then default response format is json. 128 # storeId: The store identifier. 129 ( 130 : String, 131 : String! 132 ): BehaviorRulesBehaviorRules 278 133 # Get the marketing tracking data for a user for the store. 134 # 135 # Equivalent to GET /store/{storeId}/user_behavior 136 # 137 # Arguments 138 # storeId: The store identifier. 139 # userId: The user ID 140 (: StoreId!, : String): userBehaviorListAdminSummary 278 141 # Gets customer segment by segmentId. 142 # 143 # Equivalent to GET /store/{storeId}/segment/{segmentId} 144 # 145 # Arguments 146 # responseFormat: The response format. Valid values are json and 147 # xml. If the request contains an input body, it must use the format specified in 148 # responseFormat. If the responseFormat is not specified, the accept HTTP header 149 # determines the format of the response. If the accept HTTP header is not 150 # specified then default response format is json. 151 # segmentId: The segment identifier. 152 # storeId: The store identifier. 153 ( 154 : ResponseFormat, 155 : String!, 156 : String! 157 ): SegmentSegments 278 158 # Gets all customer segments by a specified storeId or get segment by userId or 159 # personalizationId or byName. 160 # 161 # Equivalent to GET /store/{storeId}/segment 162 # 163 # Arguments 164 # pageNumber: Page number. Valid values are positive integers 165 # starting at 1. Use pageNumber with pageSize. 166 # pageSize: Page size. Used to limit the amount of data returned 167 # by a query. Valid values are integers starting with 1. Use pageSize with 168 # pageNumber. 169 # q: The query name. 170 # qName: The user's name. Required if the query is set to byName. 171 # qPersonalizationId: The user's personalization identifier. 172 # Required if the query is set to byPersonalizationId. 173 # qUserId: The user identifier. Required if the query is set to 174 # byUserId. 175 # responseFormat: The response format. Valid values are json and 176 # xml. If the request contains an input body, it must use the format specified in 177 # responseFormat. If the responseFormat is not specified, the accept HTTP header 178 # determines the format of the response. If the accept HTTP header is not 179 # specified then default response format is json. 180 # storeId: The store identifier. 181 ( 182 : Int, 183 : Int, 184 : Q3!, 185 : String, 186 : String, 187 : Int, 188 : ResponseFormat, 189 : String! 190 ): SegmentSegments 278 191 # "Deprecated: Gets an e-Marketing Spot at a specific category level. For example, 192 # Furniture. Alternatively, this can be implemented using the findByName method 193 # with the following URL: 194 # store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay." 195 # 196 # Equivalent to GET /store/{storeId}/espot/{name}/category/{categoryId} 197 # 198 # Arguments 199 # catalogId: The catalog identifier. If none is specified, the 200 # store default catalog shall be used. 201 # categoryId: The category identifier. 202 # currency: The currency code to use. Example usage : 203 # currency=USD. If no currency code is specified, the store default currency shall 204 # be used. 205 # name: E-Spot name. 206 # responseFormat: The response format. If the request has an 207 # input body, that body must also use the format specified in "responseFormat". 208 # Valid values include "json" and "xml" without the quotes. If the responseFormat 209 # isn't specified, the "accept" HTTP header shall be used to determine the format 210 # of the response. If the "accept" HTTP header isn't specified as well, the 211 # default response format shall be in json. 212 # storeId: The store identifier. 213 ( 214 : String, 215 : String!, 216 : String, 217 : String!, 218 : ResponseFormat, 219 : String! 220 ): ESpotDataContainer 278 221 # Gets an e-Marketing Spot in a store using its unique identifier. 222 # 223 # Equivalent to GET /store/{storeId}/spot/{spotId} 224 # 225 # Arguments 226 # pageNumber: Page number. Valid values are positive integers 227 # starting at 1. Use pageNumber with pageSize. 228 # pageSize: Page size. Used to limit the amount of data returned 229 # by a query. Valid values are integers starting with 1. Use pageSize with 230 # pageNumber. 231 # responseFormat: The response format. Valid values are json and 232 # xml. If the request contains an input body, it must use the format specified in 233 # responseFormat. If the responseFormat is not specified, the accept HTTP header 234 # determines the format of the response. If the accept HTTP header is not 235 # specified then default response format is json. 236 # spotId: E-Spot identifier. 237 # storeId: The store identifier. 238 ( 239 : Int, 240 : Int, 241 : ResponseFormat, 242 : Int!, 243 : String! 244 ): SpotSpot 278 245 # Gets e-Marketing Spots in a store. 246 # 247 # Equivalent to GET /store/{storeId}/spot 248 # 249 # Arguments 250 # catalogId: The catalog identifier. If none is specified, the 251 # store default catalog is used. 252 # pageNumber: Page number. Valid values are positive integers 253 # starting at 1. Use pageNumber with pageSize. 254 # pageSize: Page size. Used to limit the amount of data returned 255 # by a query. Valid values are integers starting with 1. Use pageSize with 256 # pageNumber. 257 # q: The query name. 258 # qName: Name of the e-spot used to find all spots with at least 259 # a partial match in the name or description. Required for search by name. 260 # qType: Type of the e-spot. For instance : qType=MARKETING or 261 # STOREFEATURE Required for search by type. 262 # responseFormat: The response format. Valid values are json and 263 # xml. If the request contains an input body, it must use the format specified in 264 # responseFormat. If the responseFormat is not specified, the accept HTTP header 265 # determines the format of the response. If the accept HTTP header is not 266 # specified then default response format is json. 267 # storeId: The store identifier. 268 ( 269 : String, 270 : String, 271 : String, 272 : Q!, 273 : String, 274 : String, 275 : ResponseFormat, 276 : String! 277 ): SpotSpot 279 280 }
link Required by
This element is not required by anyone