OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Equivalent to GET /admin/index/dataImport/status 4 # 5 # Arguments 6 # detailInfo: [Not documented] 7 # jobStatusId: [Not documented] 8 # responseFormat: [Not documented] 9 ( 10 : String, 11 : String, 12 : String 13 ): DataImportStatusResponse 374 14 # Get the list of available resources on the server. 15 # 16 # Equivalent to GET /api 17 # 18 # Arguments 19 # responseFormat: The response format. If the request has an 20 # input body, that body must also use the format specified in "responseFormat". 21 # Valid values include �json� and �xml� without the quotes. If the responseFormat 22 # isn�t specified, the �accept� HTTP header shall be used to determine the format 23 # of the response. If the �accept� HTTP header isn�t specified as well, the 24 # default response format shall be in json. 25 (: String!): Api 374 26 # Get the aggregated list of available resources on multiple server. 27 # 28 # Equivalent to GET /api/aggregated 29 # 30 # Arguments 31 # responseFormat: The response format. If the request has an 32 # input body, that body must also use the format specified in "responseFormat". 33 # Valid values include �json� and �xml� without the quotes. If the responseFormat 34 # isn�t specified, the �accept� HTTP header shall be used to determine the format 35 # of the response. If the �accept� HTTP header isn�t specified as well, the 36 # default response format shall be in json. 37 (: String!): ComIbmCommerceRestApiHandlerApiHandlerResourceLinkList 374 38 # Generate the default API resource bundle used for translation. 39 # 40 # Equivalent to GET /api/bundle/{resourceName} 41 # 42 # Arguments 43 # resourceName: The name of the resource. 44 (: String!): JSON 374 45 # Describe the APIs available on a resource by name. 46 # 47 # Equivalent to GET /api/resource/{resourceName} 48 # 49 # Arguments 50 # resourceName: The name of the resource. 51 # responseFormat: The response format. If the request has an 52 # input body, that body must also use the format specified in "responseFormat". 53 # Valid values include �json� and �xml� without the quotes. If the responseFormat 54 # isn�t specified, the �accept� HTTP header shall be used to determine the format 55 # of the response. If the �accept� HTTP header isn�t specified as well, the 56 # default response format shall be in json. 57 ( 58 : String!, 59 : String 60 ): JSON 374 61 # Checks the health status of ts. 62 # 63 # Equivalent to GET /health/ping 64 : JSON 374 65 # By default, this API check if this user is allowed to access this view. 66 # 67 # Equivalent to GET /store/{storeId}/access_control/byUserIdAndViewId 68 # 69 # Arguments 70 # profileName: Profile name. Profiles determine the subset of 71 # data to be returned by a query. 72 # responseFormat: The response format. If the request has an 73 # input body, that body must also use the format specified in "responseFormat". 74 # Valid values include �json� and �xml� without the quotes. If the responseFormat 75 # isn�t specified, the �accept� HTTP header shall be used to determine the format 76 # of the response. If the �accept� HTTP header isn�t specified as well, the 77 # default response format shall be in json 78 # storeId: The store identifier. 79 # viewId: The view identifier. 80 ( 81 : String, 82 : String, 83 : String!, 84 : String! 85 ): AccesscontrolByUserIdAndViewId 374 86 # Gets the activity list by query type and parameters. 87 # 88 # Equivalent to GET /store/{storeId}/activity 89 # 90 # Arguments 91 # emailPromotionId: [Not documented] 92 # q: The query name. 93 # storeId: The store identifier. 94 ( 95 : String, 96 : String!, 97 : String! 98 ): Activity 374 99 # Resolve email activity urls 100 # 101 # Equivalent to GET /store/{storeId}/activity/urls 102 # 103 # Arguments 104 # clickedEventUrl: [Not documented] 105 # emailPromotionId: [Not documented] 106 # optOutForwardUrl: [Not documented] 107 # storeId: The store identifier. 108 # urlHeader: [Not documented] 109 # userId: [Not documented] 110 ( 111 : String, 112 : String, 113 : String, 114 : String!, 115 : String, 116 : String 117 ): Activityurls 374 118 # Finds an aggregate by a query. 119 # 120 # Equivalent to GET /store/{storeId}/aggregate 121 # 122 # Arguments 123 # q: The query name. The possible values are: 124 # contentPageAggregateByPageId, contentPageAggregateByPageName, 125 # categoryPageAggregateByCategoryId. 126 # storeId: The store identifier. 127 (: String!, : String!): JSON 374 128 # Response the content url resolved values 129 # 130 # Equivalent to GET /store/{storeId}/contentUrl 131 # 132 # Arguments 133 # includeHostName: The includeHostName. 134 # preview: The preview. 135 # responseFormat: The response format. If the request has an 136 # input body, that body must also use the format specified in "responseFormat". 137 # Valid values include �json� and �xml� without the quotes. If the responseFormat 138 # isn�t specified, the �accept� HTTP header shall be used to determine the format 139 # of the response. If the �accept� HTTP header isn�t specified as well, the 140 # default response format shall be in json. 141 # storeId: The store identifier. 142 # storeStaticAssets: The storeStaticAssets. 143 # unresolvedURL: The unresolvedURL. 144 # useCustomerTenantWCH: The useCustomerTenantWCH. 145 ( 146 : String!, 147 : String!, 148 : String, 149 : String!, 150 : String!, 151 : String!, 152 : String! 153 ): ContentUrlResponse 374 154 # Finds the contracts the current user is eligible to. 155 # 156 # Equivalent to GET /store/{storeId}/contract 157 # 158 # Arguments 159 # q: the query name. 160 # storeId: The store identifier. 161 (: Q2!, : String!): ContractsResponse 374 162 # Finds the contracts the current user is eligible to. 163 # 164 # Equivalent to GET /store/{storeId}/contract/{contractId} 165 # 166 # Arguments 167 # contractId: The contract identifier. 168 # currency: The currency code to use. 169 # profileName: Profile name. Profiles determine the subset of 170 # data to be returned by a query. 171 # storeId: The store identifier. 172 ( 173 : String!, 174 : String, 175 : String, 176 : String! 177 ): ContractResponse 374 178 # Finds all features supported. 179 # 180 # Equivalent to GET /store/{storeId}/feature 181 # 182 # Arguments 183 # storeId: The store identifier. 184 (: String!): ComIbmCommerceRestConfigFeatureHandlerFeatureResponse 374 185 # Finds a file upload job by its ID. 186 # 187 # Equivalent to GET /store/{storeId}/file_upload_job 188 # 189 # Arguments 190 # forUser: User name to act on behalf of. 191 # forUserId: User identifier to act on behalf of. 192 # langId: Language identifier. If not specified, the �locale� 193 # parameter will be used. If �locale� isn�t specified, then the store default 194 # language shall be used. 195 # locale: The locale to use.If the �langId� parameter is 196 # specified, the �locale� parameter will be ignored. If no locale is specified, 197 # the store default locale will be used. 198 # numberOfDays: Returns the file upload jobs loaded later than 199 # the specified number days from current date 200 # q: The query name. 201 # responseFormat: The response format. If the request has an 202 # input body, that body must also use the format specified in "responseFormat". 203 # Valid values include �json� and �xml� without the quotes. If the responseFormat 204 # isn�t specified, the �accept� HTTP header shall be used to determine the format 205 # of the response. If the �accept� HTTP header isn�t specified as well, the 206 # default response format shall be in json. 207 # storeId: The store identifier. 208 # uploadType: Returns the file upload jobs of the specified 209 # upload type, for example, RequisitionListUpload 210 # workspaceName: Name of the workspace to use for the request. 211 # workspaceTask: Identifier of the workspace task to use for the 212 # request. 213 # workspaceTaskGroup: Identifier of the workspace task group to 214 # use for the request 215 ( 216 : String, 217 : String, 218 : String, 219 : String, 220 : String!, 221 : String!, 222 : String, 223 : String!, 224 : String!, 225 : String, 226 : String, 227 : String 228 ): FileUploadJobIBMStoreSummary 374 229 # Finds a file upload job by its ID. 230 # 231 # Equivalent to GET /store/{storeId}/file_upload_job/{fileUploadJobId} 232 # 233 # Arguments 234 # fileUploadJobId: The file upload job ID. 235 # forUser: User name to act on behalf of. 236 # forUserId: User identifier to act on behalf of. 237 # langId: Language identifier. If not specified, the �locale� 238 # parameter will be used. If �locale� isn�t specified, then the store default 239 # language shall be used. 240 # locale: The locale to use.If the �langId� parameter is 241 # specified, the �locale� parameter will be ignored. If no locale is specified, 242 # the store default locale will be used. 243 # responseFormat: The response format. If the request has an 244 # input body, that body must also use the format specified in "responseFormat". 245 # Valid values include �json� and �xml� without the quotes. If the responseFormat 246 # isn�t specified, the �accept� HTTP header shall be used to determine the format 247 # of the response. If the �accept� HTTP header isn�t specified as well, the 248 # default response format shall be in json 249 # storeId: The store identifier. 250 # workspaceName: Name of the workspace to use for the request. 251 # workspaceTask: Identifier of the workspace task to use for the 252 # request. 253 # workspaceTaskGroup: Identifier of the workspace task group to 254 # use for the request. 255 ( 256 : String!, 257 : String, 258 : String, 259 : String, 260 : String, 261 : String, 262 : String!, 263 : String, 264 : String, 265 : String 266 ): FileUploadJobIBMStoreSummary 374 267 # findJobById. 268 # 269 # Equivalent to GET /store/{storeId}/job/{jobId} 270 # 271 # Arguments 272 # jobId: jobId. 273 # storeId: storeId. 274 (: String!, : String!): ComIbmCommerceSchedulerBeansJobDataBeanIBMAdminSummary 374 275 # findJobStatuses. 276 # 277 # Equivalent to GET /store/{storeId}/job_status 278 # 279 # Arguments 280 # jobId: jobId 281 # storeId: The store identifier. 282 (: String, : String!): ComIbmCommerceSchedulerBeansJobStatusListDataBeanIBMAdminSummary 374 283 # Get the merchant information 284 # 285 # Equivalent to GET /store/{storeId}/merchant 286 # 287 # Arguments 288 # paymentConfigGroup: The payment configuration group 289 # paymentSystem: The payment system which is used for ApplePay 290 # responseFormat: The response format. If the request has an 291 # input body, that body must also use the format specified in "responseFormat". 292 # Valid values include �json� and �xml� without the quotes. If the responseFormat 293 # isn�t specified, the �accept� HTTP header shall be used to determine the format 294 # of the response. If the �accept� HTTP header isn�t specified as well, the 295 # default response format shall be in json. 296 # storeId: The store identifier. 297 ( 298 : String!, 299 : String!, 300 : String, 301 : String! 302 ): JSON 374 303 # Gets reomte store configs. 304 # 305 # Equivalent to GET /store/{storeId}/remoteConfig 306 # 307 # Arguments 308 # responseFormat: The response format. If the request has an 309 # input body, that body must also use the format specified in "responseFormat". 310 # Valid values include �json� and �xml� without the quotes. If the responseFormat 311 # isn�t specified, the �accept� HTTP header shall be used to determine the format 312 # of the response. If the �accept� HTTP header isn�t specified as well, the 313 # default response format shall be in json. 314 # storeId: The store identifier. 315 ( 316 : String, 317 : String! 318 ): ComIbmCommerceRestStoreHandlerStoreHandlerRemoteConfig 374 319 # Finds requisition lists that can be used by the current user. 320 # 321 # Equivalent to GET /store/{storeId}/requisition_list 322 # 323 # Arguments 324 # orderBy: Order by. 325 # pageNumber: Page number, starting at 1. Valid values include 326 # positive integers of 1 and above. The �pageSize� must be specified for paging to 327 # work. 328 # pageSize: Page size. Used to limit the amount of data returned 329 # by a query. Valid values include positive integers of 1 and above. The 330 # �pageNumber� must be specified for paging to work. 331 # q: the query name. 332 # storeId: The store identifier. 333 ( 334 : String, 335 : Int, 336 : Int, 337 : Q!, 338 : String! 339 ): ComIbmCommerceOrderBeansRequisitionListDataBeanIBMStoreSummary 374 340 # Finds a requisition list by its ID. 341 # 342 # Equivalent to GET /store/{storeId}/requisition_list/{requisitionListId} 343 # 344 # Arguments 345 # requisitionListId: The requisition list ID. 346 # storeId: The store identifier. 347 ( 348 : String!, 349 : String! 350 ): ComIbmCommerceOrderBeansRequisitionListDataBeanIBMStoreSummary 374 351 # Finds the display customization TC of the account associated with the current 352 # user. 353 # 354 # Equivalent to GET /store/{storeId}/term_condition 355 # 356 # Arguments 357 # q: The query name. Possible value is displayCustomizationTC. 358 # storeId: The store identifier. 359 ( 360 : String!, 361 : String! 362 ): ComIbmCommerceToolsContractBeansDisplayCustomizationTCDataBeanIBMStoreDetails 374 363 # Finds a term condition by its ID. 364 # 365 # Equivalent to GET /store/{storeId}/term_condition/{termConditionId} 366 # 367 # Arguments 368 # storeId: The store identifier. 369 # termConditionId: The term condition ID. 370 ( 371 : String!, 372 : String! 373 ): ComIbmCommerceContractBeansExtendedTermConditionDataBeanIBMStoreDetails 375 376 }
link Required by
This element is not required by anyone