OBJECT
Mutation
link GraphQL Schema definition
1 type Mutation { 2 3 # Approve or reject an approval record. 4 # 5 # Equivalent to POST /store/{storeId}/approval_status/{approvalStatusId} 6 # 7 # Arguments 8 # action: The action name. 9 # approvalStatusId: The approval status ID. 10 # requestBody: Description of the post input body to update an 11 # approval status record. 12 # responseFormat: The response format. Valid values are json and 13 # xml. If the request contains an input body, it must use the format specified in 14 # responseFormat. If the responseFormat is not specified, the accept HTTP header 15 # determines the format of the response. If the accept HTTP header is not 16 # specified then default response format is json. 17 # storeId: The store identifier. 18 ( 19 : Action4, 20 : String!, 21 : approvalStatusParameterDescInput!, 22 : ResponseFormat, 23 : String! 24 ): updateApprovalStatusResponse 426 25 # Creates Check Out Profile for the logged in user using the Member service. The 26 # shopper must log in before invoking this method. 27 # 28 # Equivalent to POST /store/{storeId}/person/@self/checkoutProfile 29 # 30 # Arguments 31 # requestBody: [Not documented] 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 : PersonCheckoutProfileUpdateByIdInput, 40 : ResponseFormat, 41 : String! 42 ): ComIbmCommerceRestMemberHandlerPersonCheckoutProfileHandlerCheckoutProfileIdContainer 426 43 # Deletes a Check Out Profile for the logged in user using the Member service. The 44 # shopper must log in before invoking this method. 45 # 46 # Equivalent to DELETE /store/{storeId}/person/checkoutProfile/{checkoutProfileId} 47 # 48 # Arguments 49 # checkoutProfileId: The checkout profile identifier. 50 # responseFormat: The response format. Valid values are json and 51 # xml. If the request contains an input body, it must use the format specified in 52 # responseFormat. If the responseFormat is not specified, the accept HTTP header 53 # determines the format of the response. If the accept HTTP header is not 54 # specified then default response format is json. 55 # storeId: The store identifier. 56 ( 57 : String!, 58 : ResponseFormat, 59 : String! 60 ): String 426 61 # Updates the CheckOutProfile for the logged in user using the Member service. The 62 # shopper must log in before invoking this method. 63 # 64 # Equivalent to PUT /store/{storeId}/person/@self/checkoutProfile 65 # 66 # Arguments 67 # requestBody: [Not documented] 68 # responseFormat: The response format. Valid values are json and 69 # xml. If the request contains an input body, it must use the format specified in 70 # responseFormat. If the responseFormat is not specified, the accept HTTP header 71 # determines the format of the response. If the accept HTTP header is not 72 # specified then default response format is json. 73 # storeId: The store identifier. 74 ( 75 : PersonCheckoutProfileUpdateInput, 76 : ResponseFormat, 77 : String! 78 ): personProfileContainer 426 79 # Updates the CheckOutProfile for the logged in user using the Member service. The 80 # shopper must log in before invoking this method. 81 # 82 # Equivalent to PUT /store/{storeId}/person/checkoutProfile/{checkoutProfileId} 83 # 84 # Arguments 85 # checkoutProfileId: The checkout profile identifier. 86 # requestBody: [Not documented] 87 # responseFormat: The response format. Valid values are json and 88 # xml. If the request contains an input body, it must use the format specified in 89 # responseFormat. If the responseFormat is not specified, the accept HTTP header 90 # determines the format of the response. If the accept HTTP header is not 91 # specified then default response format is json. 92 # storeId: The store identifier. 93 ( 94 : String!, 95 : PersonCheckoutProfileUpdateByIdInput, 96 : ResponseFormat, 97 : String! 98 ): ComIbmCommerceRestMemberHandlerPersonCheckoutProfileHandlerCheckoutProfileIdContainer 426 99 # Creates a new contact in a person's address book. 100 # 101 # Equivalent to POST /store/{storeId}/person/@self/contact 102 # 103 # Arguments 104 # requestBody: [Not documented] 105 # responseFormat: The response format. Valid values are json and 106 # xml. If the request contains an input body, it must use the format specified in 107 # responseFormat. If the responseFormat is not specified, the accept HTTP header 108 # determines the format of the response. If the accept HTTP header is not 109 # specified then default response format is json. 110 # storeId: The store identifier. 111 ( 112 : JSON, 113 : ResponseFormat, 114 : String! 115 ): personUserIdentifier 426 116 # Deletes the contact in the address book identified by nickname. 117 # 118 # Equivalent to DELETE /store/{storeId}/person/@self/contact/{nickName} 119 # 120 # Arguments 121 # nickName: The contact name saved in addressBook by registered 122 # shopper. 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 : ResponseFormat, 132 : String! 133 ): JSON 426 134 # Updates the contact in the address book identified by nickname. 135 # 136 # Equivalent to PUT /store/{storeId}/person/@self/contact/{nickName} 137 # 138 # Arguments 139 # nickName: The contact name saved in addressBook by registered 140 # shopper. 141 # requestBody: [Not documented] 142 # responseFormat: The response format. Valid values are json and 143 # xml. If the request contains an input body, it must use the format specified in 144 # responseFormat. If the responseFormat is not specified, the accept HTTP header 145 # determines the format of the response. If the accept HTTP header is not 146 # specified then default response format is json. 147 # storeId: The store identifier. 148 ( 149 : String!, 150 : JSON, 151 : ResponseFormat, 152 : String! 153 ): PersonSingleContact 426 154 # Registers a new Buyer Organization as well as the initial Buyer Administrator 155 # for the new organization. 156 # 157 # Equivalent to POST /store/{storeId}/organization/buyer 158 # 159 # Arguments 160 # requestBody: Request of BuyerRegistrationAddCmd. 161 # responseFormat: The response format. Valid values are json and 162 # xml. If the request contains an input body, it must use the format specified in 163 # responseFormat. If the responseFormat is not specified, the accept HTTP header 164 # determines the format of the response. If the accept HTTP header is not 165 # specified then default response format is json. 166 # storeId: The store identifier. 167 ( 168 : buyerRegistrationInput!, 169 : ResponseFormat, 170 : String! 171 ): orgEntityBuyerIdentifier 426 172 # Allows an administrator to register an organization. 173 # 174 # Equivalent to POST /store/{storeId}/organization 175 # 176 # Arguments 177 # requestBody: Request of OrgEntityAddCmd. 178 # storeId: The store identifier. 179 ( 180 : orgEntityAddRequestInput, 181 : String! 182 ): organizationIdentity 426 183 # Performs an action on an organization. See each action for details on input and 184 # output. Actions include: updating an approval group, and assigning or 185 # unassigning one or more roles from an organization 186 # 187 # Equivalent to POST /store/{storeId}/organization/{organizationId} 188 # 189 # Arguments 190 # action: The action of the rest service. 191 # organizationId: The organization identifier. 192 # requestBody: Information about an organization entity identity. 193 # storeId: The store identifier. 194 ( 195 : Action!, 196 : String!, 197 : updateApprovalGroupsInput, 198 : String! 199 ): updateApprovalGroupsResponse 426 200 # This allows an administrator to update information of an organization. 201 # 202 # Equivalent to PUT /store/{storeId}/organization/{organizationId} 203 # 204 # Arguments 205 # organizationId: The organization identifier. 206 # requestBody: Request of OrgEntityUpdateCmd. 207 # storeId: The store identifier. 208 ( 209 : String!, 210 : organizationEntityUpdateRequestInput, 211 : String! 212 ): organizationIdentity 426 213 # Changes language and currency preference in profile and in context. 214 # 215 # Equivalent to PUT /store/{storeId}/person/@self/languageCurrency 216 # 217 # Arguments 218 # responseFormat: The response format. Valid values are json and 219 # xml. If the request contains an input body, it must use the format specified in 220 # responseFormat. If the responseFormat is not specified, the accept HTTP header 221 # determines the format of the response. If the accept HTTP header is not 222 # specified then default response format is json. 223 # storeId: The store identifier. 224 ( 225 : ResponseFormat, 226 : String! 227 ): PersonUpdateCurrencyAndLanguagePreferenceCmd 426 228 # Deletes one or more values of a context attribute for a registered user by 229 # removing associated entry in the MBRATTRVAL table. 230 # 231 # Equivalent to DELETE 232 # /store/{storeId}/person/@self/contextattributes/{attributeName}/{value} 233 # 234 # Arguments 235 # attributeName: Name of the context attribute as listed in 236 # MBRATTR. 237 # responseFormat: The response format. Valid values are json and 238 # xml. If the request contains an input body, it must use the format specified in 239 # responseFormat. If the responseFormat is not specified, the accept HTTP header 240 # determines the format of the response. If the accept HTTP header is not 241 # specified then default response format is json. 242 # storeId: The store identifier. 243 # value: Value of the context attribute you want to delete as 244 # listed in MBRATTRVAL. 245 ( 246 : String!, 247 : ResponseFormat, 248 : String!, 249 : String! 250 ): deleteContextAttribute 426 251 # Allows administrators to delete user 252 # 253 # Equivalent to DELETE /store/{storeId}/person/{userId} 254 # 255 # Arguments 256 # storeId: The store identifier. 257 # userId: The user identifier. 258 ( 259 : String!, 260 : String! 261 ): PersonAdministratorToPerfromActionOnUserDelete 426 262 # Performs an action on a user by an administrator. See each action for details on 263 # input and output. 264 # 265 # Equivalent to POST /store/{storeId}/person/{userId} 266 # 267 # Arguments 268 # action: The action of the rest service. The assignRole action 269 # allows an administrator to assign role(s) to a registered user, while 270 # unassignRole allos an administrator to unassign role(s) from a registered user. 271 # storeId: The store identifier. 272 # userId: The user identifier. 273 ( 274 : Action2!, 275 : String!, 276 : String! 277 ): PersonPerformActionByAdministrator 426 278 # Registers a user. When the mode is set to admin, the registration is done by an 279 # administrator. 280 # 281 # Equivalent to POST /store/{storeId}/person 282 # 283 # Arguments 284 # mode: The mode of the rest service. 285 # requestBody: Request of UserRegistrationAdminAdd. 286 # responseFormat: The response format. Valid values are json and 287 # xml. If the request contains an input body, it must use the format specified in 288 # responseFormat. If the responseFormat is not specified, the accept HTTP header 289 # determines the format of the response. If the accept HTTP header is not 290 # specified then default response format is json. 291 # storeId: The store identifier. 292 ( 293 : Mode2, 294 : userRegistrationAdminInput, 295 : ResponseFormat, 296 : String! 297 ): userRegistrationAdminAddResponse 426 298 # Allows a CSR or CSS to reset the password for a registered user. It also allows 299 # resetting password when the CSR / CSS has established a session to act on behalf 300 # of a user. 301 # 302 # Equivalent to POST /store/{storeId}/person/updateMemberPassword 303 # 304 # Arguments 305 # mode: The mode in which resetPassword is run. ResetPassword can 306 # be executed in an administrator session or in an on-behalf session for a user. 307 # Default value is 'resetPasswordAdmin' if no valid value was supplied. 308 # requestBody: Request of ResetPasswordAdministratorCmd. 309 # storeId: The store identifier. 310 ( 311 : Mode, 312 : resetPasswordAdministratorRequestInput, 313 : String! 314 ): JSON 426 315 # Updates the user to include, exclude, or unassign the user from a member group. 316 # 317 # Equivalent to POST /store/{storeId}/person/updateMemberUser/{userId} 318 # 319 # Arguments 320 # requestBody: Body of MemberGroupMemberUpdateCmd. 321 # storeId: The store identifier. 322 # userId: The user identifier. 323 ( 324 : updateMemberUserInput, 325 : String!, 326 : String! 327 ): updateMemberUserResponse 426 328 # Allows administrators to update account data for a registered user. 329 # 330 # Equivalent to PUT /store/{storeId}/person/{userId} 331 # 332 # Arguments 333 # requestBody: Request of UserRegistrationAdminUpdateCmd. 334 # storeId: The store identifier. 335 # userId: The user identifier. 336 ( 337 : userRegistrationAdminUpdateRequestInput, 338 : String!, 339 : String! 340 ): PersonAdministratorToPerfromActionOnUser 426 341 # This API supports the following operations:
342 # 1. Update the registered user profile of the current user using 343 # UserRegistrationUpdateCmd. This is done when query parameter 'action' is set to 344 # 'updateUserRegistration'. Updating the user's password is deprecated; the 345 # ResetPassword operation should be used instead, as specified in 2a.
346 # 2. Resetting or updating the password for unauthenticated and authenticated 347 # users. This is done when resetPassword parameter is set to 'true':
348 # a. Reset password while authenticated requires the following input 349 # parameters:
Request body parameters:
resetPassword : true
logonId 350 # : logonId of the registered user
xcred_logonPasswordOld : Old password of 351 # the registered user
logonPassword : New password of the user
352 # xcred_logonPasswordVerify : The verified password of the user, which must be 353 # identical to logonPassword
354 # b. Reset password while unauthenticated requires the following input parameters: 355 #
i) Using Validation Code:
Step 1: Specify logonId and 356 # challenge answer. A validation code is then emailed to the user to be used in 357 # Step 2.
Request body parameters:
resetPassword : true
logonId 358 # : The logon ID of the registered user
challengeAnswer : Answer to the 359 # challenge question.
360 # Step 2: Specify validation code received in the email from step 1 and a 361 # new password, to update the user's password.
Request body parameters:
362 # resetPassword : true
logonId : The logon ID of the registered 363 # user
xcred_validationCode : The validation code generated in the above 364 # step
logonPassword : New password of the user
365 # xcred_logonPasswordVerify : The verified password of the user, which must be 366 # identical to logonPassword
367 # ii) Using Temporary Password (deprecated):
Specify logonId and challenge 368 # answer. A temporary password is then emailed to the user.
Request body 369 # parameters:
resetPassword : true
logonId : The logon ID of the 370 # registered user
challengeAnswer : Answer to the challenge question
371 # 372 # Equivalent to PUT /store/{storeId}/person/@self 373 # 374 # Arguments 375 # action: The action of the rest service. 376 # requestBody: Request of UserRegistrationUpdateCmd. 377 # responseFormat: The response format. Valid values are json and 378 # xml. If the request contains an input body, it must use the format specified in 379 # responseFormat. If the responseFormat is not specified, the accept HTTP header 380 # determines the format of the response. If the accept HTTP header is not 381 # specified then default response format is json. 382 # storeId: The store identifier. 383 ( 384 : Action3, 385 : userRegistrationUpdateRequestInput, 386 : ResponseFormat, 387 : String! 388 ): PersonAdministratorToPerfromActionOnUser 426 389 # Activate the user account. 390 # 391 # Equivalent to PUT /store/{storeId}/useractivate/emailactivate 392 # 393 # Arguments 394 # langId: The language ID. 395 # requestBody: Request body to activate the user account. 396 # responseFormat: The response format. Valid values are json and 397 # xml. If the request contains an input body, it must use the format specified in 398 # responseFormat. If the responseFormat is not specified, the accept HTTP header 399 # determines the format of the response. If the accept HTTP header is not 400 # specified then default response format is json. 401 # storeId: The store identifier. 402 ( 403 : String, 404 : activateUserRequestBodyInput!, 405 : ResponseFormat, 406 : String! 407 ): activateUserResponse 426 408 # Resend user account activation email. 409 # 410 # Equivalent to POST /store/{storeId}/useractivate/resendemail 411 # 412 # Arguments 413 # requestBody: Request body for resend user account activation 414 # email. 415 # responseFormat: The response format. Valid values are json and 416 # xml. If the request contains an input body, it must use the format specified in 417 # responseFormat. If the responseFormat is not specified, the accept HTTP header 418 # determines the format of the response. If the accept HTTP header is not 419 # specified then default response format is json. 420 # storeId: The store identifier. 421 ( 422 : resendActiveUserRequestBodyInput!, 423 : ResponseFormat, 424 : String! 425 ): JSON 427 428 }
link Required by
This element is not required by anyone