OBJECT
Mutation
link GraphQL Schema definition
1 type Mutation { 2 # Generate an access token with given user parameters and permissions, and valid for given time (30 days by default) 3 # 4 # Required permission: admin 5 # 6 # Requires field selected: userErrors 7 # 8 # Arguments 9 # input: (self-explanatory) 10 (: AccessTokenCreateInput!): AccessTokenCreatePayload! 11 12 # Update access token - extend validity or modify permissions 13 # 14 # Required permission: admin 15 # 16 # Requires field selected: userErrors 17 # 18 # Arguments 19 # accessToken: (self-explanatory) 20 # input: (self-explanatory) 21 (: AccessTokenInput!, : AccessTokenUpdateInput!): AccessTokenUpdatePayload! 22 23 # Disable given token by changing expiration date 24 # 25 # Required permission: admin 26 # 27 # Requires field selected: userErrors 28 # 29 # Arguments 30 # accessToken: (self-explanatory) 31 (: AccessTokenInput!): AccessTokenRevokePayload! 32 33 # Finds deprecated permissions in all access tokens and replaces them with currently used counterparts. 34 # It runs in a "dry run" mode by default, to see and check what exactly is going to be updated. 35 # 36 # Required permission: admin 37 # 38 # Requires field selected: userErrors 39 # 40 # Arguments 41 # dryRun: (self-explanatory) 42 (: Boolean! = true): DeprecatedPermissionMigratePayload! 43 44 # Assigns dynamic and mapped attributes to an object. 45 # 46 # Required permission: Attribute:write 47 # 48 # Requires field selected: userErrors 49 # 50 # Arguments 51 # input: (self-explanatory) 52 (: AttributesAssignGenericInput!): AttributesAssignPayload! 53 54 # Unassigns dynamic and mapped attributes from an object. 55 # 56 # Required permission: Attribute:write 57 # 58 # Requires field selected: userErrors 59 # 60 # Arguments 61 # input: (self-explanatory) 62 (: AttributesUnassignGenericInput!): AttributesUnassignPayload! 63 64 # Create a mapped attribute 65 # 66 # Required permission: Attribute:write 67 # 68 # Requires field selected: userErrors 69 # 70 # Arguments 71 # input: (self-explanatory) 72 (: AttributeCreateInput!): AttributeCreatePayload! 73 74 # Update a mapped attribute 75 # 76 # Required permission: Attribute:write 77 # 78 # Requires field selected: userErrors 79 # 80 # Arguments 81 # id: (self-explanatory) 82 # input: (self-explanatory) 83 (: Int!, : AttributeUpdateInput!): AttributeUpdatePayload! 84 85 # Create a brand 86 # 87 # Required permission: Brand:write 88 # 89 # Requires field selected: userErrors 90 # 91 # Arguments 92 # input: (self-explanatory) 93 (: BrandCreateInput!): BrandCreatePayload! 94 95 # Update a brand 96 # 97 # Required permission: Brand:write 98 # 99 # Requires field selected: userErrors 100 # 101 # Arguments 102 # id: (self-explanatory) 103 # externalId: (self-explanatory) 104 # input: (self-explanatory) 105 (: Int, : String, : BrandUpdateInput!): BrandUpdatePayload! 106 107 # Creates a new collection 108 # 109 # Required permission: Collection:write 110 # 111 # Requires field selected: userErrors 112 # 113 # Arguments 114 # input: (self-explanatory) 115 (: CollectionCreateInput!): CollectionCreatePayload! 116 117 # Update a collection 118 # 119 # Required permission: Collection:write 120 # 121 # Requires field selected: userErrors 122 # 123 # Arguments 124 # id: (self-explanatory) 125 # externalId: (self-explanatory) 126 # input: (self-explanatory) 127 (: Int, : String, : CollectionUpdateInput!): CollectionUpdatePayload! 128 129 # Create a new display 130 # 131 # Required permission: Display:write 132 # 133 # Requires field selected: userErrors 134 # 135 # Arguments 136 # input: (self-explanatory) 137 (: DisplayCreateInput!): DisplayCreatePayload! 138 139 # Update an existing display 140 # 141 # Required permission: Display:write 142 # 143 # Requires field selected: userErrors 144 # 145 # Arguments 146 # id: (self-explanatory) 147 # input: (self-explanatory) 148 (: Int!, : DisplayUpdateInput!): DisplayUpdatePayload! 149 150 # Create a media upload policy 151 # 152 # Required permission: ProductMedia:write 153 # 154 # Requires field selected: userErrors 155 # 156 # Arguments 157 # input: (self-explanatory) 158 (: MediaUploadCreateInput!): MediaUploadCreatePayload! 159 160 # Complete media upload by assigning media to: 161 # 162 # - Product (required permission: 'Product:write') 163 # 164 # - ProductVariant (required permission: 'ProductVariant:write') 165 # 166 # 167 # Required permission: ProductMedia:write 168 # 169 # Requires field selected: userErrors 170 # 171 # Arguments 172 # input: (self-explanatory) 173 (: MediaUploadCompleteInput!): MediaUploadCompletePayload! 174 175 # Update product media 176 # 177 # Required permission: ProductMedia:write 178 # 179 # Requires field selected: userErrors 180 # 181 # Arguments 182 # id: (self-explanatory) 183 # input: (self-explanatory) 184 (: Int!, : ProductMediaUpdateInput!): ProductMediaUpdatePayload! 185 186 # Delete a product media 187 # 188 # Required permission: ProductMedia:write 189 # 190 # Requires field selected: userErrors 191 # 192 # Arguments 193 # id: (self-explanatory) 194 (: Int!): ProductMediaDeletePayload! 195 196 # Create a new folder 197 # 198 # Required permission: Folder:write 199 # 200 # Requires field selected: userErrors 201 # 202 # Arguments 203 # input: (self-explanatory) 204 (: FolderCreateInput): FolderCreatePayload! 205 206 # Update an existing folder 207 # 208 # Required permission: Folder:write 209 # 210 # Requires field selected: userErrors 211 # 212 # Arguments 213 # id: (self-explanatory) 214 # externalId: (self-explanatory) 215 # input: (self-explanatory) 216 (: Int, : String, : FolderUpdateInput): FolderUpdatePayload! 217 218 # Create a Price Alteration 219 # 220 # Required permission: Price:write 221 # 222 # Requires field selected: userErrors 223 # 224 # Arguments 225 # input: (self-explanatory) 226 (: PriceAlterationCreateInput!): PriceAlterationPayload! 227 228 # Update a Price Alteration 229 # 230 # Required permission: Price:write 231 # 232 # Requires field selected: userErrors 233 # 234 # Arguments 235 # id: (self-explanatory) 236 # input: (self-explanatory) 237 (: Int!, : PriceAlterationUpdateInput!): PriceAlterationPayload! 238 239 # Create a product 240 # 241 # Required permission: Product:write 242 # 243 # Requires field selected: userErrors 244 # 245 # Arguments 246 # input: (self-explanatory) 247 (: ProductCreateInput!): ProductCreatePayload! 248 249 # Update a product 250 # 251 # Required permission: Product:write 252 # 253 # Requires field selected: userErrors 254 # 255 # Arguments 256 # id: (self-explanatory) 257 # externalId: (self-explanatory) 258 # input: (self-explanatory) 259 (: Int, : String, : ProductUpdateInput!): ProductUpdatePayload! 260 261 # Create a product variant 262 # 263 # Required permission: ProductVariant:write 264 # 265 # Requires field selected: userErrors 266 # 267 # Arguments 268 # input: (self-explanatory) 269 (: ProductVariantCreateInput!): ProductVariantCreatePayload! 270 271 # Update a product variant 272 # 273 # Required permission: ProductVariant:write 274 # 275 # Requires field selected: userErrors 276 # 277 # Arguments 278 # id: (self-explanatory) 279 # externalId: (self-explanatory) 280 # input: (self-explanatory) 281 (: Int, : String, : ProductVariantUpdateInput!): ProductVariantUpdatePayload! 282 283 # Delete a product variant 284 # 285 # Required permission: ProductVariant:write 286 # 287 # Requires field selected: userErrors 288 # 289 # Arguments 290 # id: (self-explanatory) 291 # externalId: (self-explanatory) 292 (: Int, : String): ProductVariantDeletePayload! 293 294 # Add, update or delete a translations for given object and language 295 # 296 # Required permission: Translation:write 297 # 298 # Requires field selected: userErrors 299 # 300 # Arguments 301 # input: (self-explanatory) 302 (: TranslationsSetInput!): TranslationsSetPayload! 303 304 # Set prices on products for given pricelist. 305 # Individual variant prices can also be set from the product price level. 306 # You can set up to 100 product prices in one call. 307 # 308 # Required permission: Price:write 309 # 310 # Requires field selected: userErrors 311 # 312 # Arguments 313 # input: (self-explanatory) 314 (: ProductPricesSetInput!): PricesSetPayload! 315 316 # Set altered prices on products for given pricelist. 317 # Same rules as for setPrices 318 # 319 # Required permission: Price:write 320 # 321 # Requires field selected: userErrors 322 # 323 # Arguments 324 # input: (self-explanatory) 325 (: ProductAlteredPricesSetInput!): AlteredPricesSetPayload! 326 327 # Relate a display to another display 328 # 329 # Required permission: Display:write 330 # 331 # Requires field selected: userErrors 332 # 333 # Arguments 334 # input: (self-explanatory) 335 (: DisplayRelationAddInput!): DisplayRelationAddPayload! 336 337 # Remove a display relation 338 # 339 # Required permission: Display:write 340 # 341 # Requires field selected: userErrors 342 # 343 # Arguments 344 # input: (self-explanatory) 345 (: DisplayRelationRemoveInput!): DisplayRelationRemovePayload! 346 347 # Create a pricelist 348 # 349 # Required permission: Pricelist:write 350 # 351 # Requires field selected: userErrors 352 # 353 # Arguments 354 # input: (self-explanatory) 355 (: PricelistCreateInput!): PricelistCreatePayload! 356 357 # Update a pricelist 358 # 359 # Required permission: Pricelist:write 360 # 361 # Requires field selected: userErrors 362 # 363 # Arguments 364 # id: (self-explanatory) 365 # externalId: (self-explanatory) 366 # input: (self-explanatory) 367 (: Int, : String, : PricelistUpdateInput!): PricelistUpdatePayload! 368 369 # Delete a pricelist 370 # 371 # Required permission: Pricelist:write 372 # 373 # Requires field selected: userErrors 374 # 375 # Arguments 376 # id: (self-explanatory) 377 # externalId: (self-explanatory) 378 (: Int, : String): PricelistDeletePayload! 379 380 # Create a product variant size 381 # 382 # Required permission: ProductVariant:write 383 # 384 # Requires field selected: userErrors 385 # 386 # Arguments 387 # input: (self-explanatory) 388 (: ProductSizeCreateInput!): ProductSizeCreatePayload! 389 390 # Update a product variant size 391 # 392 # Required permission: ProductVariant:write 393 # 394 # Requires field selected: userErrors 395 # 396 # Arguments 397 # id: (self-explanatory) 398 # input: (self-explanatory) 399 (: Int!, : ProductSizeUpdateInput!): ProductSizeUpdatePayload! 400 401 # Create a delivery window 402 # 403 # Required permission: DeliveryWindow:write 404 # 405 # Requires field selected: userErrors 406 # 407 # Arguments 408 # input: (self-explanatory) 409 (: DeliveryWindowCreateInput!): DeliveryWindowCreatePayload! 410 411 # Update a delivery window 412 # 413 # Required permission: DeliveryWindow:write 414 # 415 # Requires field selected: userErrors 416 # 417 # Arguments 418 # id: (self-explanatory) 419 # externalId: (self-explanatory) 420 # input: (self-explanatory) 421 (: Int, : String, : DeliveryWindowUpdateInput!): DeliveryWindowUpdatePayload! 422 423 # Sets how variants should be available in given delivery window. If provided variant already is assigned to that delivery 424 # window then it will be updated with provided parameters. 425 # 426 # Required permission: DeliveryWindow:write 427 # 428 # Requires field selected: userErrors 429 # 430 # Arguments 431 # input: (self-explanatory) 432 (: DeliveryWindowVariantsSetInput!): DeliveryWindowVariantsSetPayload! 433 434 # Unsets variants from delivery window 435 # 436 # Required permission: DeliveryWindow:write 437 # 438 # Requires field selected: userErrors 439 # 440 # Arguments 441 # input: (self-explanatory) 442 (: DeliveryWindowVariantsUnsetInput!): DeliveryWindowVariantsUnsetPayload! 443 444 # Create a delivery window group 445 # 446 # Required permission: DeliveryWindow:write 447 # 448 # Requires field selected: userErrors 449 # 450 # Arguments 451 # input: (self-explanatory) 452 (: DeliveryWindowGroupCreateInput!): DeliveryWindowGroupCreatePayload! 453 454 # Update a delivery window group 455 # 456 # Required permission: DeliveryWindow:write 457 # 458 # Requires field selected: userErrors 459 # 460 # Arguments 461 # id: (self-explanatory) 462 # externalId: (self-explanatory) 463 # input: (self-explanatory) 464 (: Int, : String, : DeliveryWindowGroupUpdateInput!): DeliveryWindowGroupUpdatePayload! 465 466 # Delete a delivery window group 467 # 468 # Required permission: DeliveryWindow:write 469 # 470 # Requires field selected: userErrors 471 # 472 # Arguments 473 # id: (self-explanatory) 474 # externalId: (self-explanatory) 475 (: Int, : String): DeliveryWindowGroupDeletePayload! 476 477 # Set order in delivery window tree 478 # Only the provide items will be sorted in order. 479 # The rest of the items will not retain their previous order and will be ordered by ID 480 # 481 # Required permission: DeliveryWindow:write 482 # 483 # Requires field selected: userErrors 484 # 485 # Arguments 486 # input: (self-explanatory) 487 (: DeliveryWindowTreeOrderSetInput!): DeliveryWindowTreeOrderSetPayload! 488 489 # Create a shipping 490 # 491 # Required permission: ShippingOption:write 492 # 493 # Requires field selected: userErrors 494 # 495 # Arguments 496 # input: (self-explanatory) 497 (: ShippingOptionCreateInput!): ShippingOptionCreatePayload! 498 499 # Update a shipping option 500 # 501 # Required permission: ShippingOption:write 502 # 503 # Requires field selected: userErrors 504 # 505 # Arguments 506 # id: (self-explanatory) 507 # input: (self-explanatory) 508 (: Int!, : ShippingOptionUpdateInput!): ShippingOptionUpdatePayload! 509 510 # Delete a shipping option 511 # 512 # Required permission: ShippingOption:write 513 # 514 # Requires field selected: userErrors 515 # 516 # Arguments 517 # id: (self-explanatory) 518 (: Int!): ShippingOptionDeletePayload! 519 520 # Change stock for many items 521 # 522 # Required permission: StockChange:write 523 # 524 # Requires field selected: userErrors 525 # 526 # Arguments 527 # input: (self-explanatory) 528 (: StockChangeInput!): StockChangePayload! 529 530 # Set stock levels: unlike the `changeStock` mutation, this one accepts absolute stock values, 531 # either FTA (free to allocate), or physical. If FTA values are provided, they should not include 532 # possible `stockOffset` from `ProductVariant`, nor `threshold` from `Warehouse`, just the physical 533 # stock minus the allocated quantity. 534 # 535 # Required permission: StockChange:write 536 # 537 # Requires field selected: userErrors 538 # 539 # Arguments 540 # input: (self-explanatory) 541 (: StockSetInput!): StockSetPayload! 542 543 # Create a subscription 544 # 545 # Required permission: Subscription:write 546 # 547 # Requires field selected: userErrors 548 # 549 # Arguments 550 # input: (self-explanatory) 551 (: SubscriptionCreateInput!): SubscriptionUpdatePayload! 552 553 # Update a subscription 554 # 555 # Required permission: Subscription:write 556 # 557 # Requires field selected: userErrors 558 # 559 # Arguments 560 # id: (self-explanatory) 561 # input: (self-explanatory) 562 (: Int!, : SubscriptionUpdateInput!): SubscriptionUpdatePayload! 563 564 # Create a subscription plan 565 # 566 # Required permission: SubscriptionPlan:write 567 # 568 # Requires field selected: userErrors 569 # 570 # Arguments 571 # input: (self-explanatory) 572 (: SubscriptionPlanCreateInput!): SubscriptionPlanCreatePayload! 573 574 # Update a subscription plan 575 # 576 # Required permission: SubscriptionPlan:write 577 # 578 # Requires field selected: userErrors 579 # 580 # Arguments 581 # id: (self-explanatory) 582 # input: (self-explanatory) 583 (: Int!, : SubscriptionPlanUpdateInput!): SubscriptionPlanUpdatePayload! 584 585 # Update a subscription contract 586 # 587 # Required permission: Subscription:write 588 # 589 # Requires field selected: userErrors 590 # 591 # Arguments 592 # id: (self-explanatory) 593 # input: (self-explanatory) 594 (: Int!, : SubscriptionContractUpdateInput!): SubscriptionContractUpdatePayload! 595 596 # Set variants to a subscription plan. 597 # You can set up to 100 variants in one call. 598 # 599 # Required permission: SubscriptionPlan:write 600 # 601 # Requires field selected: userErrors 602 # 603 # Arguments 604 # input: (self-explanatory) 605 (: SubscriptionPlanVariantsSetInput!): SubscriptionPlanVariantsSetPayload! 606 607 # Unset variants from a subscription plan. 608 # You can unset up to 100 variants in one call. 609 # 610 # Required permission: SubscriptionPlan:write 611 # 612 # Requires field selected: userErrors 613 # 614 # Arguments 615 # input: (self-explanatory) 616 (: SubscriptionPlanVariantsUnsetInput!): SubscriptionPlanVariantsUnsetPayload! 617 618 # Create a size chart 619 # 620 # Required permission: SizeChart:write 621 # 622 # Requires field selected: userErrors 623 # 624 # Arguments 625 # input: (self-explanatory) 626 (: SizeChartCreateInput!): SizeChartCreatePayload! 627 628 # Update a size chart. Covers adding, removing and rearranging sizes. For renaming sizes use `updateSizeChartLabels` 629 # 630 # Required permission: SizeChart:write 631 # 632 # Requires field selected: userErrors 633 # 634 # Arguments 635 # id: (self-explanatory) 636 # externalId: (self-explanatory) 637 # input: (self-explanatory) 638 (: Int, : String, : SizeChartUpdateInput!): SizeChartUpdatePayload! 639 640 # Update size labels 641 # 642 # Required permission: SizeChart:write 643 # 644 # Requires field selected: userErrors 645 # 646 # Arguments 647 # id: (self-explanatory) 648 # externalId: (self-explanatory) 649 # input: (self-explanatory) 650 (: Int, : String, : SizeChartLabelsUpdateInput!): SizeChartUpdatePayload! 651 652 # Merge two size charts into one 653 # 654 # Required permission: SizeChart:write 655 # 656 # Requires field selected: userErrors 657 # 658 # Arguments 659 # input: (self-explanatory) 660 (: SizeChartMergeInput!): SizeChartUpdatePayload! 661 662 # Delete a size chart 663 # 664 # Required permission: SizeChart:write 665 # 666 # Requires field selected: userErrors 667 # 668 # Arguments 669 # id: (self-explanatory) 670 # externalId: (self-explanatory) 671 (: Int, : String): SizeChartDeletePayload! 672 673 # Create a bundle 674 # 675 # Required permission: Bundle:write 676 # 677 # Requires field selected: userErrors 678 # 679 # Arguments 680 # input: (self-explanatory) 681 (: BundleCreateInput!): BundleCreatePayload! 682 683 # Update a bundle 684 # 685 # Required permission: Bundle:write 686 # 687 # Requires field selected: userErrors 688 # 689 # Arguments 690 # id: (self-explanatory) 691 # input: (self-explanatory) 692 (: Int!, : BundleUpdateInput!): BundleUpdatePayload! 693 694 # Create a measurement chart 695 # 696 # Required permission: MeasurementChart:write 697 # 698 # Requires field selected: userErrors 699 # 700 # Arguments 701 # input: (self-explanatory) 702 (: MeasurementChartCreateInput!): MeasurementChartCreatePayload! 703 704 # Update a measurement chart 705 # 706 # Required permission: MeasurementChart:write 707 # 708 # Requires field selected: userErrors 709 # 710 # Arguments 711 # id: (self-explanatory) 712 # input: (self-explanatory) 713 (: Int!, : MeasurementChartUpdateInput!): MeasurementChartUpdatePayload! 714 715 # Delete a measurement chart 716 # 717 # Required permission: MeasurementChart:write 718 # 719 # Requires field selected: userErrors 720 # 721 # Arguments 722 # id: (self-explanatory) 723 (: Int!): MeasurementChartDeletePayload! 724 725 # Create a customer 726 # 727 # Required permission: Customer:write 728 # 729 # Requires field selected: userErrors 730 # 731 # Arguments 732 # input: (self-explanatory) 733 (: CustomerCreateInput!): CustomerCreatePayload! 734 735 # Update a customer 736 # 737 # Required permission: Customer:write 738 # 739 # Requires field selected: userErrors 740 # 741 # Arguments 742 # id: (self-explanatory) 743 # externalId: (self-explanatory) 744 # input: (self-explanatory) 745 (: Int, : String, : CustomerUpdateInput!): CustomerUpdatePayload! 746 747 # Delete a customer 748 # 749 # Required permission: Customer:write 750 # 751 # Requires field selected: userErrors 752 # 753 # Arguments 754 # id: (self-explanatory) 755 # externalId: (self-explanatory) 756 (: Int, : String): CustomerDeletePayload! 757 758 # Create an account 759 # 760 # Required permission: Account:write 761 # 762 # Requires field selected: userErrors 763 # 764 # Arguments 765 # input: (self-explanatory) 766 (: AccountCreateInput!): AccountCreatePayload! 767 768 # Update an account 769 # 770 # Required permission: Account:write 771 # 772 # Requires field selected: userErrors 773 # 774 # Arguments 775 # id: (self-explanatory) 776 # externalId: (self-explanatory) 777 # input: (self-explanatory) 778 (: Int, : String, : AccountUpdateInput!): AccountUpdatePayload! 779 780 # Delete an account 781 # 782 # Required permission: Account:write 783 # 784 # Requires field selected: userErrors 785 # 786 # Arguments 787 # id: (self-explanatory) 788 # externalId: (self-explanatory) 789 (: Int, : String): AccountDeletePayload! 790 791 # Create an address book entry for an account 792 # 793 # Required permission: Account:write 794 # 795 # Arguments 796 # input: (self-explanatory) 797 (: AddressBookEntryCreateInput!): AddressBookEntryCreatePayload! 798 799 # Update an address book entry for an account 800 # 801 # Required permission: Account:write 802 # 803 # Arguments 804 # id: (self-explanatory) 805 # externalId: (self-explanatory) 806 # input: (self-explanatory) 807 (: Int, : String, : AddressBookEntryUpdateInput!): AddressBookEntryUpdatePayload! 808 809 # Delete an address book from an account 810 # 811 # Required permission: Account:write 812 # 813 # Requires field selected: userErrors 814 # 815 # Arguments 816 # id: (self-explanatory) 817 # externalId: (self-explanatory) 818 (: Int, : String): AddressBookEntryDeletePayload! 819 820 # Create a buyer for an account 821 # 822 # Required permission: Buyer:write 823 # 824 # Requires field selected: userErrors 825 # 826 # Arguments 827 # input: (self-explanatory) 828 (: BuyerCreateInput!): BuyerCreatePayload! 829 830 # Update a buyer for an account 831 # 832 # Required permission: Buyer:write 833 # 834 # Requires field selected: userErrors 835 # 836 # Arguments 837 # id: (self-explanatory) 838 # externalId: (self-explanatory) 839 # input: (self-explanatory) 840 (: Int, : String, : BuyerUpdateInput!): BuyerUpdatePayload! 841 842 # Delete a buyer from an account 843 # 844 # Required permission: Buyer:write 845 # 846 # Requires field selected: userErrors 847 # 848 # Arguments 849 # id: (self-explanatory) 850 # externalId: (self-explanatory) 851 (: Int, : String): BuyerDeletePayload! 852 853 # Create a campaign 854 # 855 # Required permission: Campaign:write 856 # 857 # Requires field selected: userErrors 858 # 859 # Arguments 860 # input: (self-explanatory) 861 (: CampaignCreateInput!): CampaignCreatePayload! 862 863 # Update a campaign 864 # 865 # Required permission: Campaign:write 866 # 867 # Requires field selected: userErrors 868 # 869 # Arguments 870 # id: (self-explanatory) 871 # input: (self-explanatory) 872 (: Int!, : CampaignUpdateInput!): CampaignUpdatePayload! 873 874 # Delete a campaign 875 # 876 # Required permission: Campaign:write 877 # 878 # Requires field selected: userErrors 879 # 880 # Arguments 881 # id: (self-explanatory) 882 (: Int!): CampaignDeletePayload! 883 884 # Set campaign variants 885 # 886 # Required permission: Campaign:write 887 # 888 # Requires field selected: userErrors 889 # 890 # Arguments 891 # input: (self-explanatory) 892 (: CampaignVariantsSetInput!): CampaignVariantsSetPayload! 893 894 # Unset campaign variants 895 # 896 # Required permission: Campaign:write 897 # 898 # Requires field selected: userErrors 899 # 900 # Arguments 901 # input: (self-explanatory) 902 (: CampaignVariantsUnsetInput!): CampaignVariantsUnsetPayload! 903 904 # Create a market 905 # 906 # Required permission: Market:write 907 # 908 # Requires field selected: userErrors 909 # 910 # Arguments 911 # input: (self-explanatory) 912 (: MarketCreateInput!): MarketCreatePayload! 913 914 # Update a market 915 # 916 # Required permission: Market:write 917 # 918 # Requires field selected: userErrors 919 # 920 # Arguments 921 # id: (self-explanatory) 922 # externalId: (self-explanatory) 923 # input: (self-explanatory) 924 (: Int, : String, : MarketUpdateInput!): MarketUpdatePayload! 925 926 # Delete a market 927 # 928 # Required permission: Market:write 929 # 930 # Requires field selected: userErrors 931 # 932 # Arguments 933 # id: (self-explanatory) 934 # externalId: (self-explanatory) 935 (: Int, : String): MarketDeletePayload! 936 937 # Assign displays to a market 938 # 939 # Required permission: Display:write 940 # 941 # Arguments 942 # input: (self-explanatory) 943 (: MarketDisplaysSetInput!): MarketDisplaysSetPayload! 944 945 # Unassign displays from a market 946 # 947 # Required permission: Display:write 948 # 949 # Arguments 950 # input: (self-explanatory) 951 (: MarketDisplaysUnsetInput!): MarketDisplaysUnsetPayload! 952 953 # Create a category 954 # 955 # Required permission: Category:write 956 # 957 # Requires field selected: userErrors 958 # 959 # Arguments 960 # input: (self-explanatory) 961 (: CategoryCreateInput!): CategoryCreatePayload! 962 963 # Update a category 964 # 965 # Required permission: Category:write 966 # 967 # Requires field selected: userErrors 968 # 969 # Arguments 970 # id: (self-explanatory) 971 # input: (self-explanatory) 972 (: Int!, : CategoryUpdateInput!): CategoryUpdatePayload! 973 974 # Delete a category 975 # 976 # Required permission: Category:write 977 # 978 # Requires field selected: userErrors 979 # 980 # Arguments 981 # id: (self-explanatory) 982 # input: (self-explanatory) 983 (: Int!, : CategoryDeleteInput! = {deleteChildrenStrategy: RESTRICT_IF_PRESENT}): CategoryDeletePayload! 984 985 # Set category displays 986 # 987 # Required permission: Category:write 988 # 989 # Requires field selected: userErrors 990 # 991 # Arguments 992 # input: (self-explanatory) 993 (: CategoryDisplaysSetInput!): CategoryDisplaysSetPayload! 994 995 # Unset category displays 996 # 997 # Required permission: Category:write 998 # 999 # Requires field selected: userErrors 1000 # 1001 # Arguments 1002 # input: (self-explanatory) 1003 (: CategoryDisplaysUnsetInput!): CategoryDisplaysUnsetPayload! 1004 1005 # Sort displays of a category 1006 # 1007 # Required permission: Category:write 1008 # 1009 # Requires field selected: userErrors 1010 # 1011 # Arguments 1012 # input: (self-explanatory) 1013 (: CategoryDisplaysSortInput!): CategoryDisplaysSortPayload! 1014 1015 # Create a voucher 1016 # 1017 # Required permission: Voucher:write 1018 # 1019 # Requires field selected: userErrors 1020 # 1021 # Arguments 1022 # input: (self-explanatory) 1023 (: VoucherCreateInput!): VoucherCreatePayload! 1024 1025 # Update a voucher 1026 # 1027 # Required permission: Voucher:write 1028 # 1029 # Requires field selected: userErrors 1030 # 1031 # Arguments 1032 # id: (self-explanatory) 1033 # externalId: (self-explanatory) 1034 # input: (self-explanatory) 1035 (: Int, : String, : VoucherUpdateInput!): VoucherUpdatePayload! 1036 1037 # Delete a voucher 1038 # 1039 # Required permission: Voucher:write 1040 # 1041 # Requires field selected: userErrors 1042 # 1043 # Arguments 1044 # id: (self-explanatory) 1045 # externalId: (self-explanatory) 1046 (: Int, : String): VoucherDeletePayload! 1047 1048 # Add an action to a voucher 1049 # 1050 # Required permission: Voucher:write 1051 # 1052 # Requires field selected: userErrors 1053 # 1054 # Arguments 1055 # input: (self-explanatory) 1056 (: VoucherActionCreateInput!): VoucherActionCreatePayload! 1057 1058 # Update an action of voucher 1059 # 1060 # Required permission: Voucher:write 1061 # 1062 # Requires field selected: userErrors 1063 # 1064 # Arguments 1065 # id: (self-explanatory) 1066 # input: (self-explanatory) 1067 (: Int!, : VoucherActionUpdateInput!): VoucherActionUpdatePayload! 1068 1069 # Delete an action from voucher 1070 # 1071 # Required permission: Voucher:write 1072 # 1073 # Requires field selected: userErrors 1074 # 1075 # Arguments 1076 # id: (self-explanatory) 1077 (: Int!): VoucherActionDeletePayload! 1078 1079 # Update a DTC order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1080 # 1081 # Required permission: Order:write 1082 # 1083 # Requires field selected: userErrors 1084 # 1085 # Arguments 1086 # order: (self-explanatory) 1087 # input: (self-explanatory) 1088 (: OrderInput!, : DirectToConsumerOrderUpdateInput!): DirectToConsumerOrderUpdatePayload! 1089 1090 # Resume a DTC order 1091 # 1092 # Required permission: Order:write 1093 # 1094 # Requires field selected: userErrors 1095 # 1096 # Arguments 1097 # order: (self-explanatory) 1098 # input: (self-explanatory) 1099 (: OrderInput!, : DirectToConsumerOrderResumeInput!): DirectToConsumerOrderUpdatePayload! 1100 1101 # Update a wholesale order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1102 # 1103 # Required permission: Order:write 1104 # 1105 # Requires field selected: userErrors 1106 # 1107 # Arguments 1108 # order: (self-explanatory) 1109 # input: (self-explanatory) 1110 (: OrderInput!, : WholesaleOrderUpdateInput!): WholesaleOrderUpdatePayload! 1111 1112 # Cancel a DTC order 1113 # 1114 # Required permission: Order:write 1115 # 1116 # Requires field selected: userErrors 1117 # 1118 # Arguments 1119 # order: (self-explanatory) 1120 # input: (self-explanatory) 1121 (: OrderInput!, : DirectToConsumerOrderCancelInput!): DirectToConsumerOrderCancelPayload! 1122 1123 # Cancel a Wholesale order 1124 # 1125 # Required permission: Order:write 1126 # 1127 # Requires field selected: userErrors 1128 # 1129 # Arguments 1130 # order: (self-explanatory) 1131 # input: (self-explanatory) 1132 (: OrderInput!, : WholesaleOrderCancelInput!): WholesaleOrderCancelPayload! 1133 1134 # Confirm an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1135 # 1136 # Required permission: Order:write 1137 # 1138 # Requires field selected: userErrors 1139 # 1140 # Arguments 1141 # input: (self-explanatory) 1142 (: OrderConfirmInput!): OrderConfirmPayload! 1143 1144 # Add a note to an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1145 # 1146 # Required permission: OrderHistory:write 1147 # 1148 # Requires field selected: userErrors 1149 # 1150 # Arguments 1151 # input: (self-explanatory) 1152 (: OrderNoteAddInput): OrderNoteAddPayload! 1153 1154 # Add an external link attachment to a wholesale order 1155 # 1156 # Required permission: OrderHistory:write 1157 # 1158 # Requires field selected: userErrors 1159 # 1160 # Arguments 1161 # input: (self-explanatory) 1162 (: OrderLinkAttachmentInput): OrderLinkAttachmentAddPayload! 1163 1164 # Lock/unlock an order. 1165 # If a user does not have permission to lock/unlock the order and tries to modify a locked order, it will be forbidden. 1166 # This includes creating a shipment and order allocation. 1167 # 1168 # Required permission: Order.isLocked:write 1169 # 1170 # Requires field selected: userErrors 1171 # 1172 # Arguments 1173 # input: (self-explanatory) 1174 (: OrdersLockInput!): OrdersLockPayload! 1175 1176 # Allocate stock for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1177 # 1178 # Required permission: Order:write 1179 # 1180 # Requires field selected: userErrors 1181 # 1182 # Arguments 1183 # input: (self-explanatory) 1184 (: OrderAllocateInput!): OrderAllocatePayload! 1185 1186 # Unallocate stock for an order that isn't locked (unless the user has 'Order.isLocked:write' permission). 1187 # A whole order is affected by default, but it's also possible to select, which lines or warehouses 1188 # should be affected by this call. 1189 # 1190 # Required permission: Order:write 1191 # 1192 # Requires field selected: userErrors 1193 # 1194 # Arguments 1195 # input: (self-explanatory) 1196 (: OrderUnallocateInput!): OrderUnallocatePayload! 1197 1198 # Capture an order 1199 # 1200 # Required permission: Order:write 1201 # 1202 # Requires field selected: userErrors 1203 # 1204 # Arguments 1205 # order: (self-explanatory) 1206 (: OrderInput!): OrderCapturePayload! 1207 1208 # Create a shipment for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1209 # 1210 # Required permission: Shipment:write 1211 # 1212 # Requires field selected: userErrors 1213 # 1214 # Arguments 1215 # input: (self-explanatory) 1216 (: ShipmentCreateInput!): ShipmentCreatePayload! 1217 1218 # Update a shipment 1219 # 1220 # Required permission: Shipment:write 1221 # 1222 # Requires field selected: userErrors 1223 # 1224 # Arguments 1225 # id: (self-explanatory) 1226 # externalId: (self-explanatory) 1227 # input: (self-explanatory) 1228 (: Int, : String, : ShipmentUpdateInput!): ShipmentUpdatePayload! 1229 1230 # Complete a shipment 1231 # 1232 # Required permission: Shipment:write 1233 # 1234 # Requires field selected: userErrors 1235 # 1236 # Arguments 1237 # id: (self-explanatory) 1238 # externalId: (self-explanatory) 1239 # input: (self-explanatory) 1240 (: Int, : String, : ShipmentCompleteInput): ShipmentCompletePayload 1241 1242 # Delete a shipment from an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1243 # 1244 # Required permission: Shipment:write 1245 # 1246 # Requires field selected: userErrors 1247 # 1248 # Arguments 1249 # id: (self-explanatory) 1250 # externalId: (self-explanatory) 1251 (: Int, : String): ShipmentDeletePayload! 1252 1253 # Capture a shipment. 1254 # Even if the mutation returns empty userErrors, a capture itself can be failed because a failed attempt is also saved 1255 # into a payment history entry and the mutation shows it in paymentHistoryEntry. 1256 # The best way to check whether the capture succeeded is to check shipment.isCaptured. 1257 # 1258 # If the order was captured before and there is some amount not assigned to any shipment, it will be set to 1259 # the shipment. If the total shipment amount is assigned that way, no real capture will be made. In this case, 1260 # paymentHistoryEntry cannot be created and it will be null, but the shipment field will be non-empty. 1261 # 1262 # Required permission: Payment.capture:write 1263 # 1264 # Requires field selected: userErrors 1265 # 1266 # Arguments 1267 # id: (self-explanatory) 1268 # externalId: (self-explanatory) 1269 (: Int, : String): ShipmentCapturePayload! 1270 1271 # Release remaining order authorization after all shipments are captured in order to release customer's funds that will 1272 # not be captured. Amount that will be released is authorization amount - total captured amount across all shipments. 1273 # 1274 # Required permission: Payment.cancel:write 1275 # 1276 # Requires field selected: userErrors 1277 # 1278 # Arguments 1279 # order: (self-explanatory) 1280 (: OrderInput): ReleaseRemainingOrderAuthorizationPayload! 1281 1282 # Create a return 1283 # 1284 # Required permission: Return:write 1285 # 1286 # Requires field selected: userErrors 1287 # 1288 # Arguments 1289 # input: (self-explanatory) 1290 (: ReturnCreateInput!): ReturnCreatePayload! 1291 1292 # Complete a return 1293 # 1294 # Required permission: Return:write 1295 # 1296 # Requires field selected: userErrors 1297 # 1298 # Arguments 1299 # id: (self-explanatory) 1300 # externalId: (self-explanatory) 1301 # input: (self-explanatory) 1302 (: Int, : String, : ReturnCompleteInput! = {sendEmail: false}): ReturnCompletePayload! 1303 1304 # Uncomplete a return 1305 # 1306 # Required permission: Return:write 1307 # 1308 # Requires field selected: userErrors 1309 # 1310 # Arguments 1311 # id: (self-explanatory) 1312 # externalId: (self-explanatory) 1313 (: Int, : String): ReturnUncompletePayload! 1314 1315 # Delete a return 1316 # 1317 # Required permission: Return:write 1318 # 1319 # Requires field selected: userErrors 1320 # 1321 # Arguments 1322 # id: (self-explanatory) 1323 # externalId: (self-explanatory) 1324 (: Int, : String): ReturnDeletePayload! 1325 1326 # Create a warehouse 1327 # 1328 # Required permission: Warehouse:write 1329 # 1330 # Requires field selected: userErrors 1331 # 1332 # Arguments 1333 # input: (self-explanatory) 1334 (: WarehouseCreateInput!): WarehouseCreatePayload! 1335 1336 # Update a warehouse 1337 # 1338 # Required permission: Warehouse:write 1339 # 1340 # Requires field selected: userErrors 1341 # 1342 # Arguments 1343 # id: (self-explanatory) 1344 # externalId: (self-explanatory) 1345 # input: (self-explanatory) 1346 (: Int!, : String, : WarehouseUpdateInput!): WarehouseUpdatePayload! 1347 1348 # Add payment information to an invoice 1349 # 1350 # Required permission: Invoice:write 1351 # 1352 # Requires field selected: userErrors 1353 # 1354 # Arguments 1355 # input: (self-explanatory) 1356 (: RegisterInvoicePaymentInput!): InvoicePaymentRegisterPayload! 1357 1358 # Only to mark as fully paid 1359 # 1360 # Required permission: Invoice:write 1361 # 1362 # Requires field selected: userErrors 1363 # 1364 # Arguments 1365 # input: (self-explanatory) 1366 (: MarkInvoiceAsPaidInput!): MarkInvoiceAsPaidPayload! 1367 1368 # Add item to the wishlist 1369 # 1370 # Required permission: Wishlist:write 1371 # 1372 # Requires field selected: userErrors 1373 # 1374 # Arguments 1375 # input: (self-explanatory) 1376 (: WishlistItemAddInput!): WishlistItemAddPayload! 1377 1378 # Remove item from the wishlist 1379 # 1380 # Required permission: Wishlist:write 1381 # 1382 # Requires field selected: userErrors 1383 # 1384 # Arguments 1385 # input: (self-explanatory) 1386 (: WishlistItemRemoveInput!): WishlistItemRemovePayload! 1387 1388 # Set ID conversion rules 1389 # 1390 # Required permission: IdConversion:write 1391 # 1392 # Requires field selected: userErrors 1393 # 1394 # Arguments 1395 # input: (self-explanatory) 1396 (: [IdConversionSetInput!]!): IdConversionsSetPayload! 1397 1398 # Unset ID conversion rules 1399 # 1400 # Required permission: IdConversion:write 1401 # 1402 # Requires field selected: userErrors 1403 # 1404 # Arguments 1405 # input: (self-explanatory) 1406 (: [IdConversionUnsetInput!]!): IdConversionsUnsetPayload! 1407 1408 # Add subvouchers to a voucher, a lightweight way to have 1409 # multiple individually tracked codes for a single voucher configuration 1410 # 1411 # Required permission: Voucher:write 1412 # 1413 # Requires field selected: userErrors 1414 # 1415 # Arguments 1416 # input: (self-explanatory) 1417 (: SubvouchersCreateInput!): SubvouchersPayload! 1418 1419 # Update a single subvoucher 1420 # 1421 # Required permission: Voucher:write 1422 # 1423 # Requires field selected: userErrors 1424 # 1425 # Arguments 1426 # id: (self-explanatory) 1427 # input: (self-explanatory) 1428 (: Int!, : SubvoucherUpdateInput!): SubvoucherPayload! 1429 1430 # Completely remove a subvoucher 1431 # 1432 # Required permission: Voucher:write 1433 # 1434 # Requires field selected: userErrors 1435 # 1436 # Arguments 1437 # id: (self-explanatory) 1438 (: Int!): SubvoucherRemovePayload! 1439 1440 # Add a size localization, which will define, how sizes in specified size charts are presented in given stores and 1441 # countries 1442 # 1443 # Required permission: SizeChart:write 1444 # 1445 # Requires field selected: userErrors 1446 # 1447 # Arguments 1448 # input: (self-explanatory) 1449 (: SizeLocalizationCreateInput!): SizeLocalizationCreatePayload! 1450 1451 # Update a size localization 1452 # 1453 # Required permission: SizeChart:write 1454 # 1455 # Requires field selected: userErrors 1456 # 1457 # Arguments 1458 # sizeLocalization: (self-explanatory) 1459 # input: (self-explanatory) 1460 ( 1461 : SizeLocalizationInput!, 1462 : SizeLocalizationUpdateInput! 1463 ): SizeLocalizationUpdatePayload! 1464 1465 # Set localized names for sizes in a given size localization 1466 # 1467 # Required permission: SizeChart:write 1468 # 1469 # Requires field selected: userErrors 1470 # 1471 # Arguments 1472 # sizeLocalization: (self-explanatory) 1473 # input: (self-explanatory) 1474 (: SizeLocalizationInput!, : [LocalizedSizesSetInput!]!): LocalizedSizesSetPayload! 1475 1476 # Create purchase order 1477 # 1478 # Required permission: PurchaseOrder:write 1479 # 1480 # Requires field selected: userErrors 1481 # 1482 # Arguments 1483 # input: (self-explanatory) 1484 (: PurchaseOrderCreateInput!): PurchaseOrderCreatePayload! 1485 1486 # Update a purchase order 1487 # 1488 # Required permission: PurchaseOrder:write 1489 # 1490 # Requires field selected: userErrors 1491 # 1492 # Arguments 1493 # id: (self-explanatory) 1494 # input: (self-explanatory) 1495 (: Int!, : PurchaseOrderUpdateInput!): PurchaseOrderUpdatePayload! 1496 1497 # Confirm a purchase order 1498 # 1499 # Required permission: PurchaseOrder:write 1500 # 1501 # Requires field selected: userErrors 1502 # 1503 # Arguments 1504 # id: (self-explanatory) 1505 (: Int!): PurchaseOrderConfirmPayload! 1506 1507 # Create purchase order delivery 1508 # 1509 # Required permission: PurchaseOrderDelivery:write 1510 # 1511 # Requires field selected: userErrors 1512 # 1513 # Arguments 1514 # input: (self-explanatory) 1515 (: PurchaseOrderDeliveryCreateInput!): PurchaseOrderDeliveryCreatePayload! 1516 1517 # Accept purchase order delivery 1518 # 1519 # Required permission: PurchaseOrderDelivery:write 1520 # 1521 # Requires field selected: userErrors 1522 # 1523 # Arguments 1524 # id: (self-explanatory) 1525 # input: (self-explanatory) 1526 (: Int!, : PurchaseOrderDeliveryAcceptInput!): PurchaseOrderDeliveryAcceptPayload! 1527 1528 # Create new Supplier 1529 # 1530 # Required permission: Supplier:write 1531 # 1532 # Requires field selected: userErrors 1533 # 1534 # Arguments 1535 # input: (self-explanatory) 1536 (: SupplierCreateInput!): SupplierCreatePayload! 1537 1538 # Update Supplier 1539 # 1540 # Required permission: Supplier:write 1541 # 1542 # Requires field selected: userErrors 1543 # 1544 # Arguments 1545 # supplier: (self-explanatory) 1546 # input: (self-explanatory) 1547 (: SupplierInput!, : SupplierUpdateInput!): SupplierUpdatePayload! 1548 1549 # Add product variants handled by Supplier 1550 # 1551 # Required permission: Supplier:write 1552 # 1553 # Requires field selected: userErrors 1554 # 1555 # Arguments 1556 # input: (self-explanatory) 1557 (: SupplierProductVariantsSetInput!): SupplierProductVariantsSetPayload! 1558 1559 # Remove product variants handled by Supplier 1560 # 1561 # Required permission: Supplier:write 1562 # 1563 # Requires field selected: userErrors 1564 # 1565 # Arguments 1566 # input: (self-explanatory) 1567 (: SupplierProductVariantsUnsetInput!): SupplierProductVariantsUnsetPayload! 1568 1569 # Subscribe to receive events of specified object and change types 1570 # 1571 # Required permission: Event:write 1572 # 1573 # Requires field selected: userErrors 1574 # 1575 # Arguments 1576 # input: (self-explanatory) 1577 (: [EventListenerSetInput!]!): EventListenerSetPayload! 1578 1579 # Unsubscribe from given object and change types. 1580 # It will result in deleting all queued events of these types. 1581 # 1582 # Required permission: Event:write 1583 # 1584 # Requires field selected: userErrors 1585 # 1586 # Arguments 1587 # input: (self-explanatory) 1588 (: [EventListenerUnsetInput!]!): EventListenerUnsetPayload! 1589 1590 # Confirm the given events. 1591 # It means they were processed on your side and they are no longer needed. 1592 # It is an essential mechanism to clean the events queue. 1593 # Limit is 200 events per call. 1594 # 1595 # Required permission: Event:write 1596 # 1597 # Requires field selected: userErrors 1598 # 1599 # Arguments 1600 # input: (self-explanatory) 1601 (: EventsConfirmInput!): EventsConfirmPayload! 1602 1603 # Required permission: MediaBatch:write 1604 # 1605 # Arguments 1606 # input: (self-explanatory) 1607 (: MediaBatchCreateInput!): MediaBatchCreatePayload! 1608 1609 }
link Required by
This element is not required by anyone