OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets a list of approval records details that the current authenticated user can 4 # approve. 5 # 6 # Equivalent to GET /store/{storeId}/approval_status 7 # 8 # Arguments 9 # approvalStatusId: Query by approval request approval status id. 10 # approverId: Query by approver id. Only returns approval 11 # requests that can be approved by the current user. 12 # endSubmitTime: Query by approval request end time. 13 # entityId: Query by approval request entity id, such as order 14 # id. 15 # orderBy: Order by. 16 # pageNumber: Page number, starting at 1. Valid values include 17 # positive integers of 1 and above. The 'pageSize' must be specified for paging to 18 # work. 19 # pageSize: Page size. Used to limit the amount of data returned 20 # by a query. Valid values include positive integers of 1 and above. The 21 # 'pageNumber' must be specified for paging to work. 22 # q: The query name. 23 # responseFormat: The response format. Valid values are json and 24 # xml. If the request contains an input body, it must use the format specified in 25 # responseFormat. If the responseFormat is not specified, the accept HTTP header 26 # determines the format of the response. If the accept HTTP header is not 27 # specified then default response format is json. 28 # startSubmitTime: Query by approval request start time. 29 # status: Query by approval request status. 0 for pending, 1 for 30 # approved, 2 for rejected. 31 # storeId: The store identifier. 32 # submitterFirstName: Query by approval request submitter's first 33 # name. 34 # submitterLastName: Query by approval request submitter's last 35 # name. 36 # submitterMiddleName: Query by approval request submitter's 37 # middle name. 38 ( 39 : BigInt, 40 : BigInt, 41 : String, 42 : BigInt, 43 : OrderBy, 44 : Int, 45 : Int, 46 : Q4!, 47 : ResponseFormat, 48 : String, 49 : Status, 50 : String!, 51 : String, 52 : String, 53 : String 54 ): approvalStatusSummary 477 55 # Gets a Check Out Profile for the logged in user using the Member service. The 56 # shopper must log in before invoking this method. 57 # 58 # Equivalent to GET /store/{storeId}/person/checkoutProfile/{checkoutProfileId} 59 # 60 # Arguments 61 # checkoutProfileId: The checkout profile identifier. 62 # responseFormat: The response format. Valid values are json and 63 # xml. If the request contains an input body, it must use the format specified in 64 # responseFormat. If the responseFormat is not specified, the accept HTTP header 65 # determines the format of the response. If the accept HTTP header is not 66 # specified then default response format is json. 67 # storeId: The store identifier. 68 ( 69 : String!, 70 : ResponseFormat, 71 : String! 72 ): PersonCheckoutProfile 477 73 # Gets the Check Out Profiles for the logged in user using the Member service. The 74 # shopper must log in before invoking this method. 75 # 76 # Equivalent to GET /store/{storeId}/person/@self/checkoutProfile 77 # 78 # Arguments 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 : ResponseFormat, 87 : String! 88 ): PersonCheckoutProfile 477 89 # Gets a person contact by address ID. 90 # 91 # Equivalent to GET /store/{storeId}/person/@self/contact/byAddressId/{addressId} 92 # 93 # Arguments 94 # addressId: The address identifier. 95 # responseFormat: The response format. Valid values are json and 96 # xml. If the request contains an input body, it must use the format specified in 97 # responseFormat. If the responseFormat is not specified, the accept HTTP header 98 # determines the format of the response. If the accept HTTP header is not 99 # specified then default response format is json. 100 # storeId: The store identifier. 101 ( 102 : String!, 103 : ResponseFormat, 104 : String! 105 ): PersonSingleContact 477 106 # Gets a person contact by nickname. 107 # 108 # Equivalent to GET /store/{storeId}/person/@self/contact/{nickName} 109 # 110 # Arguments 111 # nickName: The contact name saved in addressBook by registered 112 # shopper. 113 # responseFormat: The response format. Valid values are json and 114 # xml. If the request contains an input body, it must use the format specified in 115 # responseFormat. If the responseFormat is not specified, the accept HTTP header 116 # determines the format of the response. If the accept HTTP header is not 117 # specified then default response format is json. 118 # storeId: The store identifier. 119 ( 120 : String!, 121 : ResponseFormat, 122 : String! 123 ): PersonSingleContact 477 124 # Gets the contacts in a person's address book. If the addressType optional query 125 # parameter is passed in, the returned contacts are filtered by addressType. 126 # 127 # Equivalent to GET /store/{storeId}/person/@self/contact 128 # 129 # Arguments 130 # addressType: The addressType to filter contacts by. All 131 # contacts will be returned if a valid value is not supplied for this parameter. 132 # responseFormat: The response format. Valid values are json and 133 # xml. If the request contains an input body, it must use the format specified in 134 # responseFormat. If the responseFormat is not specified, the accept HTTP header 135 # determines the format of the response. If the accept HTTP header is not 136 # specified then default response format is json. 137 # storeId: The store identifier. 138 ( 139 : AddressType, 140 : ResponseFormat, 141 : String! 142 ): JSON 477 143 # Find an approval status record by its id. 144 # 145 # Equivalent to GET /store/{storeId}/approval_status/{approvalStatusId} 146 # 147 # Arguments 148 # approvalStatusId: The approval status ID. 149 # storeId: The store identifier. 150 ( 151 : String!, 152 : String! 153 ): approvalStatusStoreSummary 477 154 # Finds approval member groups types for an organization based on properties 155 # filter. 156 # 157 # Equivalent to GET /store/{storeId}/member_group 158 # 159 # Arguments 160 # orderBy: Order by. 161 # pageNumber: Page number, starting at 1. Valid values include 162 # positive integers of 1 and above. The pageSize must be specified for paging to 163 # work. 164 # pageSize: Page size. Used to limit the amount of data returned 165 # by a query. Valid values include positive integers of 1 and above. The 166 # pageNumber must be specified for paging to work 167 # propertiesFilter: Properties value based on which approval 168 # member groups will be filtered. 169 # q: The query name. 170 # storeId: The store identifier. 171 ( 172 : String, 173 : BigInt, 174 : BigInt, 175 : String!, 176 : Q2!, 177 : String! 178 ): memberGroupListSummary 477 179 # Finds a member group by its ID. 180 # 181 # Equivalent to GET /store/{storeId}/member_group/{memberGroupId} 182 # 183 # Arguments 184 # memberGroupId: The member group ID. 185 # storeId: The store identifier. 186 ( 187 : String!, 188 : String! 189 ): memberGroupListSummary 477 190 # Finds a member group current shopper explicitly belongs. 191 # 192 # Equivalent to GET /store/{storeId}/member_group/member/{memberId} 193 # 194 # Arguments 195 # memberId: The memberID. 196 # storeId: The store identifier. 197 ( 198 : String!, 199 : String! 200 ): memberGroupListSummary 477 201 # Allows administrators to find organization information by organization 202 # identifier. 203 # 204 # Equivalent to GET /store/{storeId}/organization/{organizationId} 205 # 206 # Arguments 207 # organizationId: The organization identifier. 208 # profileName: Profile name. Profiles determine the subset of 209 # data returned by a query. Default profile name = IBM_Organization_Summary. 210 # storeId: The store identifier. 211 ( 212 : String!, 213 : ProfileName2, 214 : String! 215 ): parentAssignedRolesDetails 477 216 # This allows an administrator to find organizations based on query name. See each 217 # query for details on input and output. 218 # 219 # Equivalent to GET /store/{storeId}/organization 220 # 221 # Arguments 222 # accountId: The trading account ID. 223 # maxResults: The maximum number of results to be returned. 224 # orgId: The organization identifier. 225 # orgName: The organization name. 226 # parentOrgName: The parent organization name. 227 # profileName: Profile name. Profiles determine the subset of 228 # data returned by a query. 229 # q: The query name. - organizationHierarchy: Retrieves the
230 # organization hierarchy.organizationsICanAdmin: This allows an 231 # administrator to find organizations that he/she can 232 # administer.rolesICanAssignInOrg: This allows an administrator to find 233 # roles that he/she can assign in organizations. 234 # responseFormat: The response format. If the request has an 235 # input body, that body must also use the format specified in "responseFormat". 236 # Valid values include "json" and "xml" without the quotes. If the responseFormat 237 # isn't specified, the "accept" HTTP header shall be used to determine the format 238 # of the response. If the "accept" HTTP header isn't specified as well, the 239 # default response format shall be in json. 240 # startIndex: The starting index of the result. 241 # storeId: The store identifier. 242 ( 243 : String, 244 : String, 245 : String!, 246 : String, 247 : String, 248 : ProfileName, 249 : Q!, 250 : ResponseFormat, 251 : String, 252 : String! 253 ): organizationListDetails 477 254 # Get user's entitled organizations. 255 # 256 # Equivalent to GET /store/{storeId}/organization/@self/entitled_orgs 257 # 258 # Arguments 259 # accountCheck: [Not documented] 260 # explicitEntitlement: [Not documented] 261 # responseFormat: The response format. Valid values are json and 262 # xml. If the request contains an input body, it must use the format specified in 263 # responseFormat. If the responseFormat is not specified, the accept HTTP header 264 # determines the format of the response. If the accept HTTP header is not 265 # specified then default response format is json. 266 # storeId: The store identifier. 267 ( 268 : String, 269 : String, 270 : ResponseFormat, 271 : String! 272 ): organizationListSummary 477 273 # Allows administrators to find users based on a query name. See each query for 274 # details on input and output. 275 # 276 # Equivalent to GET /store/{storeId}/person 277 # 278 # Arguments 279 # accountStatus: The account status. 280 # address1: Address line 1 of the customer to search for. 281 # address1SearchType: The search type. The valid values are 1 282 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 283 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 284 # and exact match), 6(case insensitive and exact match),8(not equals) 285 # city: The city name of the customer to search for. 286 # citySearchType: The search type. The valid values are 1 (case 287 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 288 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 289 # match), 6(case insensitive and exact match),8(not equals) 290 # country: The country or region name of the customer to search 291 # for. 292 # countrySearchType: The search type. The valid values are 1 293 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 294 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 295 # and exact match), 6(case insensitive and exact match),8(not equals) 296 # email1: The primary e-mail address of the customer to search 297 # for. 298 # email1SearchType: The search type. The valid values are 1 (case 299 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 300 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 301 # match), 6(case insensitive and exact match),8(not equals) 302 # email2: The secondary e-mail address of the customer to search 303 # for. 304 # email2SearchType: The search type. The valid values are 1 (case 305 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 306 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 307 # match), 6(case insensitive and exact match),8(not equals) 308 # fax1: The primary fax number of the customer to search for. 309 # fax1SearchType: The search type. The valid values are 1 (case 310 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 311 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 312 # match), 6(case insensitive and exact match),8(not equals) 313 # fax2: The secondary fax number of the customer to search for. 314 # fax2SearchType: The search type. The valid values are 1 (case 315 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 316 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 317 # match), 6(case insensitive and exact match),8(not equals) 318 # field1: Customizable field1 to search for. 319 # field1SearchType: The search type. The valid values are 1 (case 320 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 321 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 322 # match), 6(case insensitive and exact match),8(not equals) 323 # field2: Customizable field2 to search for. 324 # field2SearchType: The search type. The valid values are 1 (case 325 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 326 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 327 # match), 6(case insensitive and exact match),8(not equals) 328 # firstName: First name of the customer to search for. 329 # firstNameSearchType: The search type. The valid values are 1 330 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 331 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 332 # and exact match), 6(case insensitive and exact match),8(not equals) 333 # lastName: Last name of the customer to search for. 334 # lastNameSearchType: The search type. The valid values are 1 335 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 336 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 337 # and exact match), 6(case insensitive and exact match),8(not equals) 338 # logonId: Logon Id of the customer to search for. 339 # logonIdSearchType: The search type. The valid values are 1 340 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 341 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 342 # and exact match), 6(case insensitive and exact match),8(not equals) 343 # maxResults: Page size. Used to limit the amount of data 344 # returned by a query. Valid values include positive integers of 1 and above. 345 # middleName: Last name of the customer to search for. 346 # middleNameSearchType: The search type. The valid values are 1 347 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 348 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 349 # and exact match), 6(case insensitive and exact match),8(not equals) 350 # orderByFieldName: The order by field name. 351 # orderByTableName: The order by table name. 352 # parentOrgId: The parent organization ID. 353 # parentOrgName: Parent organization name to search buyers. Only 354 # used in B2B store. 355 # parentOrgNameSearchType: The search type. The valid values are 356 # 1 (case sensitive and starts with), 2(case sensitive and contains), 3(case 357 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 358 # and exact match), 6(case insensitive and exact match),8(not equals) 359 # phone1: The primary phone number of the customer to search for. 360 # phone1SearchType: The search type. The valid values are 1 (case 361 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 362 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 363 # match), 6(case insensitive and exact match),8(not equals) 364 # phone2: The secondary phone number of the customer to search 365 # for. 366 # phone2SearchType: The search type. The valid values are 1 (case 367 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 368 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 369 # match), 6(case insensitive and exact match),8(not equals) 370 # profileName: Profile name. Profiles determine the subset of 371 # data to be returned by a query. Default profile name = IBM_User_List_Summary. 372 # q: The query name. 373 # roleId: The role ID. 374 # startIndex: The starting index of the result. 375 # state: The state or province name of the customer to search 376 # for. 377 # stateSearchType: The search type. The valid values are 1 (case 378 # sensitive and starts with), 2(case sensitive and contains), 3(case insensitive 379 # and starts with),4(case insensitive and contains), 5(case sensitive and exact 380 # match), 6(case insensitive and exact match),8(not equals) 381 # storeId: The store identifier. 382 # zipcode: ZIP or postal code of the customer to search for. 383 # zipcodeSearchType: The search type. The valid values are 1 384 # (case sensitive and starts with), 2(case sensitive and contains), 3(case 385 # insensitive and starts with),4(case insensitive and contains), 5(case sensitive 386 # and exact match), 6(case insensitive and exact match),8(not equals) 387 ( 388 : String, 389 : String, 390 : Address1SearchType, 391 : String, 392 : CitySearchType, 393 : String, 394 : CountrySearchType, 395 : String, 396 : Email1SearchType, 397 : String, 398 : Email2SearchType, 399 : String, 400 : Fax1SearchType, 401 : String, 402 : Fax2SearchType, 403 : String, 404 : Field1SearchType, 405 : String, 406 : Field2SearchType, 407 : String, 408 : FirstNameSearchType, 409 : String, 410 : LastNameSearchType, 411 : String, 412 : LogonIdSearchType, 413 : String, 414 : String, 415 : MiddleNameSearchType, 416 : String, 417 : String, 418 : String, 419 : String, 420 : ParentOrgNameSearchType, 421 : String, 422 : Phone1SearchType, 423 : String, 424 : Phone2SearchType, 425 : ProfileName3, 426 : Q3!, 427 : String, 428 : String, 429 : String, 430 : StateSearchType, 431 : String!, 432 : String, 433 : ZipcodeSearchType 434 ): userListDetails 477 435 # Allows administrators to find user information by user identifier. 436 # 437 # Equivalent to GET /store/{storeId}/person/{userId} 438 # 439 # Arguments 440 # profileName: Profile name. Profiles determine the subset of 441 # data returned by a query. The default profile name is IBM_User_Display_Details. 442 # storeId: The store identifier. 443 # userId: The user identifier. 444 ( 445 : ProfileName4, 446 : String!, 447 : String! 448 ): PersonAdministratorsToFindUserInformationByUserIdentifier 477 449 # Finds personal opt-out. When the store level personal opt-out does not exist, 450 # the site level personal opt-out is returned. 451 # 452 # Equivalent to GET /store/{storeId}/person/@self/optOut 453 # 454 # Arguments 455 # profileName: Profile name. Profiles determine the subset of 456 # data returned by a query. Default profile name = IBM_optOut_email. 457 # storeId: The store identifier. 458 ( 459 : ProfileName5, 460 : String! 461 ): emailUserReceiveData 477 462 # Gets the account data for a registered user. 463 # 464 # Equivalent to GET /store/{storeId}/person/@self 465 # 466 # Arguments 467 # responseFormat: The response format. Valid values are json and 468 # xml. If the request contains an input body, it must use the format specified in 469 # responseFormat. If the responseFormat is not specified, the accept HTTP header 470 # determines the format of the response. If the accept HTTP header is not 471 # specified then default response format is json. 472 # storeId: The store identifier. 473 ( 474 : ResponseFormat, 475 : String! 476 ): PersonPerson 478 479 }
link Required by
This element is not required by anyone