OBJECT
Mutation
link GraphQL Schema definition
1 type Mutation { 2 3 # Applies coupons to the shopping cart. 4 # 5 # Equivalent to POST /store/{storeId}/cart/@self/assigned_coupon 6 # 7 # Arguments 8 # requestBody: Body of a request to apply a coupon to a shopping 9 # cart. 10 # responseFormat: The response format. If the request has an 11 # input body, that body must also use the format specified in "responseFormat". 12 # Valid values include "json" and "xml" without the quotes. If the responseFormat 13 # isn't specified, the "accept" HTTP header shall be used to determine the format 14 # of the response. If the "accept" HTTP header isn't specified as well, the 15 # default response format shall be in json. 16 # storeId: The store identifier. 17 ( 18 : applyCouponBodyInput!, 19 : ResponseFormat, 20 : String! 21 ): applyCouponResponse 616 22 # Adds one or more order items to the shopping cart. 23 # 24 # Equivalent to POST /store/{storeId}/cart 25 # 26 # Arguments 27 # requestBody: Description of the addOrderItem input body. 28 # responseFormat: The response format. Valid values are json and 29 # xml. If the request contains an input body, it must use the format specified in 30 # responseFormat. If the responseFormat is not specified, the accept HTTP header 31 # determines the format of the response. If the accept HTTP header is not 32 # specified then default response format is json. 33 # storeId: The store identifier. 34 ( 35 : orderItemDescInput, 36 : ResponseFormat, 37 : String! 38 ): orderWithOrderItemContainer 616 39 # Applies the quick checkout profile to the shopping cart. 40 # 41 # Equivalent to PUT /store/{storeId}/cart/@self/applyCheckoutProfile 42 # 43 # Arguments 44 # requestBody: Structure containing an order identifier. 45 # responseFormat: The response format. Valid values are json and 46 # xml. If the request contains an input body, it must use the format specified in 47 # responseFormat. If the responseFormat is not specified, the accept HTTP header 48 # determines the format of the response. If the accept HTTP header is not 49 # specified then default response format is json. 50 # storeId: The store identifier. 51 ( 52 : cartOrderIdContainerRequestInput, 53 : ResponseFormat, 54 : String! 55 ): cartOrderIdContainerResponse 616 56 # Calculates the price of the order. 57 # 58 # Equivalent to POST /store/{storeId}/cart/calculate 59 # 60 # Arguments 61 # requestBody: Body of request input for calculateOrder. 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 : culateOrderRequestInput, 70 : ResponseFormat, 71 : String! 72 ): cartCalculateOrderResponse 616 73 # Calculates the price of the order. 74 # 75 # Equivalent to POST /store/{storeId}/cart/{orderId}/calculate 76 # 77 # Arguments 78 # orderId: The order ID. 79 # requestBody: Body of request input for calculateOrder. 80 # responseFormat: The response format. Valid values are json and 81 # xml. If the request contains an input body, it must use the format specified in 82 # responseFormat. If the responseFormat is not specified, the accept HTTP header 83 # determines the format of the response. If the accept HTTP header is not 84 # specified then default response format is json. 85 # storeId: The store identifier. 86 ( 87 : String!, 88 : culateOrderRequestInput, 89 : ResponseFormat, 90 : String! 91 ): CartCalculate 616 92 # Cancels the specified order. 93 # 94 # Equivalent to DELETE /store/{storeId}/cart/{orderId}/cancel_order 95 # 96 # Arguments 97 # forcedCancel: This parameter is used to cancel an order that 98 # has deposited payment. 99 # orderId: The order ID. 100 # responseFormat: The response format. Valid values are json and 101 # xml. If the request contains an input body, it must use the format specified in 102 # responseFormat. If the responseFormat is not specified, the accept HTTP header 103 # determines the format of the response. If the accept HTTP header is not 104 # specified then default response format is json. 105 # storeId: The store identifier. 106 ( 107 : ForcedCancel, 108 : String!, 109 : ResponseFormat, 110 : String! 111 ): cartCancelOrder 616 112 # Deletes all order items from the shopping cart. 113 # 114 # Equivalent to DELETE /store/{storeId}/cart/@self 115 # 116 # Arguments 117 # responseFormat: The response format. Valid values are json and 118 # xml. If the request contains an input body, it must use the format specified in 119 # responseFormat. If the responseFormat is not specified, the accept HTTP header 120 # determines the format of the response. If the accept HTTP header is not 121 # specified then default response format is json. 122 # storeId: The store identifier. 123 ( 124 : ResponseFormat, 125 : String! 126 ): String 616 127 # Checks out the shopping cart. 128 # 129 # Equivalent to POST /store/{storeId}/cart/@self/checkout 130 # 131 # Arguments 132 # requestBody: Request body input for shopping cart submission 133 # for checkout. 134 # responseFormat: The response format. Valid values are json and 135 # xml. If the request contains an input body, it must use the format specified in 136 # responseFormat. If the responseFormat is not specified, the accept HTTP header 137 # determines the format of the response. If the accept HTTP header is not 138 # specified then default response format is json. 139 # storeId: The store identifier. 140 ( 141 : cartCheckoutRequestInput, 142 : ResponseFormat, 143 : String! 144 ): cartOrderIdContainer 616 145 # Copies the order into a new order. 146 # 147 # Equivalent to POST /store/{storeId}/cart/copy_order 148 # 149 # Arguments 150 # requestBody: [Not documented] 151 # responseFormat: The response format. Valid values are json and 152 # xml. If the request contains an input body, it must use the format specified in 153 # responseFormat. If the responseFormat is not specified, the accept HTTP header 154 # determines the format of the response. If the accept HTTP header is not 155 # specified then default response format is json. 156 # storeId: The store identifier. 157 ( 158 : copyOrderRequestInput, 159 : ResponseFormat, 160 : String! 161 ): copyOrderRequest 616 162 # Creates an order. 163 # 164 # Equivalent to POST /store/{storeId}/cart/create_order 165 # 166 # Arguments 167 # description: The description for the order. 168 # isSharedOrder: The order type flag for identifying order is 169 # shared or private. 170 # requestBody: [Not documented] 171 # responseFormat: The response format. Valid values are json and 172 # xml. If the request contains an input body, it must use the format specified in 173 # responseFormat. If the responseFormat is not specified, the accept HTTP header 174 # determines the format of the response. If the accept HTTP header is not 175 # specified then default response format is json. 176 # storeId: The store identifier. 177 ( 178 : String!, 179 : Boolean, 180 : createOrderRequestInput, 181 : ResponseFormat, 182 : String! 183 ): CartCreateorder 616 184 # Allows the CSR to cancel the specified order. 185 # 186 # Equivalent to DELETE /store/{storeId}/cart/{orderId}/csrcancel_order 187 # 188 # Arguments 189 # forcedCancel: This parameter is used to cancel an order that 190 # has deposited payment. 191 # orderId: The order ID. 192 # responseFormat: The response format. Valid values are json and 193 # xml. If the request contains an input body, it must use the format specified in 194 # responseFormat. If the responseFormat is not specified, the accept HTTP header 195 # determines the format of the response. If the accept HTTP header is not 196 # specified then default response format is json. 197 # storeId: The store identifier. 198 ( 199 : ForcedCancel, 200 : String!, 201 : ResponseFormat, 202 : String! 203 ): CartCancelCSROrder 616 204 # Allows the CSR to cancel the specific order on behalf of a shopper. 205 # 206 # Equivalent to DELETE /store/{storeId}/cart/{orderId}/csrcancel_order_onbehalf 207 # 208 # Arguments 209 # forcedCancel: This parameter is used to cancel an order that 210 # has deposited payment. 211 # orderId: The order ID. 212 # responseFormat: The response format. Valid values are json and 213 # xml. If the request contains an input body, it must use the format specified in 214 # responseFormat. If the responseFormat is not specified, the accept HTTP header 215 # determines the format of the response. If the accept HTTP header is not 216 # specified then default response format is json. 217 # storeId: The store identifier. 218 ( 219 : ForcedCancel, 220 : String!, 221 : ResponseFormat, 222 : String! 223 ): String 616 224 # Deletes the specified order item from the order. 225 # 226 # Equivalent to PUT /store/{storeId}/cart/@self/delete_order_item 227 # 228 # Arguments 229 # requestBody: [Not documented] 230 # responseFormat: The response format. Valid values are json and 231 # xml. If the request contains an input body, it must use the format specified in 232 # responseFormat. If the responseFormat is not specified, the accept HTTP header 233 # determines the format of the response. If the accept HTTP header is not 234 # specified then default response format is json. 235 # storeId: The store identifier. 236 ( 237 : deleteOrderItemRequestInput, 238 : ResponseFormat, 239 : String! 240 ): cartOrderIdContainerdelete 616 241 # Allows the CSR to lock the shopping cart. 242 # 243 # Equivalent to POST /store/{storeId}/cart/{cartId}/lock 244 # 245 # Arguments 246 # cartId: Order identifier. 247 # responseFormat: The response format. Valid values are json and 248 # xml. If the request contains an input body, it must use the format specified in 249 # responseFormat. If the responseFormat is not specified, the accept HTTP header 250 # determines the format of the response. If the accept HTTP header is not 251 # specified then default response format is json. 252 # storeId: The store identifier. 253 ( 254 : String!, 255 : ResponseFormat, 256 : String! 257 ): cartOrderIdContainerlock 616 258 # Allows the buyer administrator or CSR to lock the shopping cart. The 259 # administrator must have already established a session to act on behalf of a 260 # user. 261 # 262 # Equivalent to POST /store/{storeId}/cart/{cartId}/lockOnBehalf 263 # 264 # Arguments 265 # cartId: Order identifier. 266 # forUser: User name to act on behalf of. 267 # forUserId: User identifier to act on behalf of. 268 # responseFormat: The response format. Valid values are json and 269 # xml. If the request contains an input body, it must use the format specified in 270 # responseFormat. If the responseFormat is not specified, the accept HTTP header 271 # determines the format of the response. If the accept HTTP header is not 272 # specified then default response format is json. 273 # storeId: The store identifier. 274 ( 275 : String!, 276 : String, 277 : String, 278 : ResponseFormat, 279 : String! 280 ): cartOrderIdContainerlock 616 281 # Moves order items from one order to another. 282 # 283 # Equivalent to PUT /store/{storeId}/cart/move_order_item 284 # 285 # Arguments 286 # requestBody: [Not documented] 287 # responseFormat: The response format. Valid values are json and 288 # xml. If the request contains an input body, it must use the format specified in 289 # responseFormat. If the responseFormat is not specified, the accept HTTP header 290 # determines the format of the response. If the accept HTTP header is not 291 # specified then default response format is json. 292 # storeId: The store identifier. 293 ( 294 : orderItemMoveRequestInput, 295 : ResponseFormat, 296 : String! 297 ): orderItemMoveRequest 616 298 # Renews inventory status, price and address ID for order items. Remove order 299 # items that are out of stock. 300 # 301 # Equivalent to POST /store/{storeId}/cart/@self/renew_order_items 302 # 303 # Arguments 304 # responseFormat: [Not documented] 305 # storeId: [Not documented] 306 ( 307 : String, 308 : String! 309 ): CartRenewOrderItems 616 310 # Prepares the shopping cart for checkout. This method must be called before the 311 # checkout service. 312 # 313 # Equivalent to PUT /store/{storeId}/cart/@self/precheckout 314 # 315 # Arguments 316 # requestBody: Structure containing an order identifier. 317 # responseFormat: The response format. Valid values are json and 318 # xml. If the request contains an input body, it must use the format specified in 319 # responseFormat. If the responseFormat is not specified, the accept HTTP header 320 # determines the format of the response. If the accept HTTP header is not 321 # specified then default response format is json. 322 # storeId: The store identifier. 323 ( 324 : cartOrderIdContainerRequestInput, 325 : ResponseFormat, 326 : String! 327 ): cartOrderIdContainer 616 328 # Creates a scheduled order. The order is related to a scheduled job. 329 # 330 # Equivalent to POST /store/{storeId}/cart/{orderId}/schedule_order 331 # 332 # Arguments 333 # orderId: The order ID. 334 # requestBody: [Not documented] 335 # responseFormat: The response format. Valid values are json and 336 # xml. If the request contains an input body, it must use the format specified in 337 # responseFormat. If the responseFormat is not specified, the accept HTTP header 338 # determines the format of the response. If the accept HTTP header is not 339 # specified then default response format is json. 340 # storeId: The store identifier. 341 ( 342 : String!, 343 : orderScheduleRequestInput, 344 : ResponseFormat, 345 : String! 346 ): orderScheduleResponse 616 347 # Sets the specified order as the pending order. 348 # 349 # Equivalent to POST /store/{storeId}/cart/{orderId}/set_pending_order 350 # 351 # Arguments 352 # orderId: The order ID. 353 # requestBody: [Not documented] 354 # responseFormat: The response format. Valid values are json and 355 # xml. If the request contains an input body, it must use the format specified in 356 # responseFormat. If the responseFormat is not specified, the accept HTTP header 357 # determines the format of the response. If the accept HTTP header is not 358 # specified then default response format is json. 359 # storeId: The store identifier. 360 ( 361 : String!, 362 : pendingOrderRequestInput, 363 : ResponseFormat, 364 : String! 365 ): cartSetPendingOrderResponse 616 366 # Unlocks the shopping cart by a CSR. 367 # 368 # Equivalent to POST /store/{storeId}/cart/{cartId}/unlock 369 # 370 # Arguments 371 # cartId: Order identifier. 372 # responseFormat: The response format. Valid values are json and 373 # xml. If the request contains an input body, it must use the format specified in 374 # responseFormat. If the responseFormat is not specified, the accept HTTP header 375 # determines the format of the response. If the accept HTTP header is not 376 # specified then default response format is json. 377 # storeId: The store identifier. 378 ( 379 : String!, 380 : ResponseFormat, 381 : String! 382 ): cartOrderIdContainer 616 383 # Allows the buyer administrator or CSR to unlock the shopping cart. The 384 # administrator must have already established a session to act on behalf of a 385 # user. 386 # 387 # Equivalent to POST /store/{storeId}/cart/{cartId}/unlockOnBehalf 388 # 389 # Arguments 390 # cartId: Order identifier. 391 # forUser: User name to act on behalf of. 392 # forUserId: User identifier to act on behalf of. 393 # responseFormat: The response format. Valid values are json and 394 # xml. If the request contains an input body, it must use the format specified in 395 # responseFormat. If the responseFormat is not specified, the accept HTTP header 396 # determines the format of the response. If the accept HTTP header is not 397 # specified then default response format is json. 398 # storeId: The store identifier. 399 ( 400 : String!, 401 : String, 402 : String, 403 : ResponseFormat, 404 : String! 405 ): cartOrderIdContainerunlockonbehalf 616 406 # Updates one or more order items in the shopping cart. 407 # 408 # Equivalent to PUT /store/{storeId}/cart/@self/update_order_item 409 # 410 # Arguments 411 # requestBody: Description of the updateOrderItem input body. 412 # responseFormat: The response format. Valid values are json and 413 # xml. If the request contains an input body, it must use the format specified in 414 # responseFormat. If the responseFormat is not specified, the accept HTTP header 415 # determines the format of the response. If the accept HTTP header is not 416 # specified then default response format is json. 417 # storeId: The store identifier. 418 ( 419 : updateOrderItemBodyDescriptionInput, 420 : ResponseFormat, 421 : String! 422 ): orderWithOrderItemContainer 616 423 # Updates the reward option. 424 # 425 # Equivalent to PUT /store/{storeId}/cart/@self/update_reward_option 426 # 427 # Arguments 428 # requestBody: [Not documented] 429 # responseFormat: The response format. Valid values are json and 430 # xml. If the request contains an input body, it must use the format specified in 431 # responseFormat. If the responseFormat is not specified, the accept HTTP header 432 # determines the format of the response. If the accept HTTP header is not 433 # specified then default response format is json. 434 # storeId: The store identifier. 435 ( 436 : rewardChoiceUpdateRequestInput, 437 : ResponseFormat, 438 : String! 439 ): rewardChoiceUpdateRequest 616 440 # Removes coupons from the shopping cart. 441 # 442 # Equivalent to DELETE /store/{storeId}/cart/@self/assigned_coupon/{couponId} 443 # 444 # Arguments 445 # couponId: Coupon identifier.. 446 # responseFormat: The response format. Valid values are json and 447 # xml. If the request contains an input body, it must use the format specified in 448 # responseFormat. If the responseFormat is not specified, the accept HTTP header 449 # determines the format of the response. If the accept HTTP header is not 450 # specified then default response format is json. 451 # storeId: The store identifier. 452 ( 453 : String!, 454 : ResponseFormat, 455 : String! 456 ): assignedRemoveCouponResponse 616 457 # Removes promotion codes from the shopping cart. 458 # 459 # Equivalent to DELETE 460 # /store/{storeId}/cart/@self/assigned_promotion_code/{promoCode} 461 # 462 # Arguments 463 # promoCode: The promotion code. 464 # responseFormat: The response format. Valid values are json and 465 # xml. If the request contains an input body, it must use the format specified in 466 # responseFormat. If the responseFormat is not specified, the accept HTTP header 467 # determines the format of the response. If the accept HTTP header is not 468 # specified then default response format is json. 469 # storeId: The store identifier. 470 ( 471 : String!, 472 : ResponseFormat, 473 : String! 474 ): removePromotionCodeResponse 616 475 # Adds payment instructions to the shopping cart. 476 # 477 # Equivalent to POST /store/{storeId}/cart/@self/payment_instruction 478 # 479 # Arguments 480 # requestBody: [Not documented] 481 # responseFormat: The response format. Valid values are json and 482 # xml. If the request contains an input body, it must use the format specified in 483 # responseFormat. If the responseFormat is not specified, the accept HTTP header 484 # determines the format of the response. If the accept HTTP header is not 485 # specified then default response format is json. 486 # storeId: The store identifier. 487 ( 488 : CartPaymentInstructionInput, 489 : ResponseFormat, 490 : String! 491 ): paymentInstructionList 616 492 # Deletes all payment instructions from the shopping cart. 493 # 494 # Equivalent to DELETE /store/{storeId}/cart/@self/payment_instruction 495 # 496 # Arguments 497 # responseFormat: The response format. Valid values are json and 498 # xml. If the request contains an input body, it must use the format specified in 499 # responseFormat. If the responseFormat is not specified, the accept HTTP header 500 # determines the format of the response. If the accept HTTP header is not 501 # specified then default response format is json. 502 # storeId: The store identifier. 503 ( 504 : ResponseFormat, 505 : String! 506 ): PaymentInstrcutionDeleteall 616 507 # Deletes payment instructions from the shopping cart. 508 # 509 # Equivalent to DELETE 510 # /store/{storeId}/cart/@self/payment_instruction/{paymentInstruction_id} 511 # 512 # Arguments 513 # paymentInstructionId: Payment instruction identifier to delete. 514 # responseFormat: The response format. Valid values are json and 515 # xml. If the request contains an input body, it must use the format specified in 516 # responseFormat. If the responseFormat is not specified, the accept HTTP header 517 # determines the format of the response. If the accept HTTP header is not 518 # specified then default response format is json. 519 # storeId: The store identifier. 520 ( 521 : String!, 522 : ResponseFormat, 523 : String! 524 ): CartDeletePaymentInstruction 616 525 # Processes punch-out call back requests. 526 # 527 # Equivalent to POST /store/{storeId}/cart/@self/payment_instruction/callback 528 # 529 # Arguments 530 # responseFormat: The response format. Valid values are json and 531 # xml. If the request contains an input body, it must use the format specified in 532 # responseFormat. If the responseFormat is not specified, the accept HTTP header 533 # determines the format of the response. If the accept HTTP header is not 534 # specified then default response format is json. 535 # storeId: The store identifier. 536 ( 537 : ResponseFormat, 538 : String! 539 ): String 616 540 # Processes the punch-out payment requests. 541 # 542 # Equivalent to POST /store/{storeId}/cart/@self/payment_instruction/repay 543 # 544 # Arguments 545 # orderId: The order identifier. 546 # piId: The payment instruction identifier. 547 # responseFormat: The response format. Valid values are json and 548 # xml. If the request contains an input body, it must use the format specified in 549 # responseFormat. If the responseFormat is not specified, the accept HTTP header 550 # determines the format of the response. If the accept HTTP header is not 551 # specified then default response format is json. 552 # storeId: The store identifier. 553 ( 554 : String!, 555 : String!, 556 : ResponseFormat, 557 : String! 558 ): String 616 559 # Updates a payment instruction in the shopping cart. 560 # 561 # Equivalent to PUT /store/{storeId}/cart/@self/payment_instruction 562 # 563 # Arguments 564 # requestBody: [Not documented] 565 # responseFormat: The response format. Valid values are json and 566 # xml. If the request contains an input body, it must use the format specified in 567 # responseFormat. If the responseFormat is not specified, the accept HTTP header 568 # determines the format of the response. If the accept HTTP header is not 569 # specified then default response format is json. 570 # storeId: The store identifier. 571 ( 572 : CartPaymentInstructionInput, 573 : ResponseFormat, 574 : String! 575 ): paymentInstructionList 616 576 # Applies promotion codes to the shopping cart. 577 # 578 # Equivalent to POST /store/{storeId}/cart/@self/assigned_promotion_code 579 # 580 # Arguments 581 # requestBody: Body of a request to apply a promotion code to a 582 # shopping cart. 583 # responseFormat: The response format. If the request has an 584 # input body, that body must also use the format specified in "responseFormat". 585 # Valid values include "json" and "xml" without the quotes. If the responseFormat 586 # isn't specified, the "accept" HTTP header shall be used to determine the format 587 # of the response. If the "accept" HTTP header isn't specified as well, the 588 # default response format shall be in json. 589 # storeId: The store identifier. 590 ( 591 : applyPromotionCodeBodyInput!, 592 : ResponseFormat, 593 : String! 594 ): applyPromotionCodeResponse 616 595 # Updates shipping information for the shopping cart. 596 # 597 # Equivalent to PUT /store/{storeId}/cart/@self/shipping_info 598 # 599 # Arguments 600 # forUser: User name to act on behalf of. 601 # forUserId: User identifier to act on behalf of. 602 # requestBody: Order update shipping information. 603 # responseFormat: The response format. Valid values are json and 604 # xml. If the request contains an input body, it must use the format specified in 605 # responseFormat. If the responseFormat is not specified, the accept HTTP header 606 # determines the format of the response. If the accept HTTP header is not 607 # specified then default response format is json. 608 # storeId: The store identifier. 609 ( 610 : String, 611 : String, 612 : shippingInfoDescInput, 613 : ResponseFormat, 614 : String! 615 ): CartCartUpdateItemShippinginfo 617 618 }
link Required by
This element is not required by anyone