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 # Add, update or delete a translations for given object and language 284 # 285 # Required permission: Translation:write 286 # 287 # Requires field selected: userErrors 288 # 289 # Arguments 290 # input: (self-explanatory) 291 (: TranslationsSetInput!): TranslationsSetPayload! 292 293 # Set prices on products for given pricelist. 294 # Individual variant prices can also be set from the product price level. 295 # You can set up to 100 product prices in one call. 296 # 297 # Required permission: Price:write 298 # 299 # Requires field selected: userErrors 300 # 301 # Arguments 302 # input: (self-explanatory) 303 (: ProductPricesSetInput!): PricesSetPayload! 304 305 # Set altered prices on products for given pricelist. 306 # Same rules as for setPrices 307 # 308 # Required permission: Price:write 309 # 310 # Requires field selected: userErrors 311 # 312 # Arguments 313 # input: (self-explanatory) 314 (: ProductAlteredPricesSetInput!): AlteredPricesSetPayload! 315 316 # Relate a display to another display 317 # 318 # Required permission: Display:write 319 # 320 # Requires field selected: userErrors 321 # 322 # Arguments 323 # input: (self-explanatory) 324 (: DisplayRelationAddInput!): DisplayRelationAddPayload! 325 326 # Remove a display relation 327 # 328 # Required permission: Display:write 329 # 330 # Requires field selected: userErrors 331 # 332 # Arguments 333 # input: (self-explanatory) 334 (: DisplayRelationRemoveInput!): DisplayRelationRemovePayload! 335 336 # Create a pricelist 337 # 338 # Required permission: Pricelist:write 339 # 340 # Requires field selected: userErrors 341 # 342 # Arguments 343 # input: (self-explanatory) 344 (: PricelistCreateInput!): PricelistCreatePayload! 345 346 # Update a pricelist 347 # 348 # Required permission: Pricelist:write 349 # 350 # Requires field selected: userErrors 351 # 352 # Arguments 353 # id: (self-explanatory) 354 # externalId: (self-explanatory) 355 # input: (self-explanatory) 356 (: Int, : String, : PricelistUpdateInput!): PricelistUpdatePayload! 357 358 # Delete a pricelist 359 # 360 # Required permission: Pricelist:write 361 # 362 # Requires field selected: userErrors 363 # 364 # Arguments 365 # id: (self-explanatory) 366 # externalId: (self-explanatory) 367 (: Int, : String): PricelistDeletePayload! 368 369 # Create a product variant size 370 # 371 # Required permission: ProductVariant:write 372 # 373 # Requires field selected: userErrors 374 # 375 # Arguments 376 # input: (self-explanatory) 377 (: ProductSizeCreateInput!): ProductSizeCreatePayload! 378 379 # Update a product variant size 380 # 381 # Required permission: ProductVariant:write 382 # 383 # Requires field selected: userErrors 384 # 385 # Arguments 386 # id: (self-explanatory) 387 # input: (self-explanatory) 388 (: Int!, : ProductSizeUpdateInput!): ProductSizeUpdatePayload! 389 390 # Create a delivery window 391 # 392 # Required permission: DeliveryWindow:write 393 # 394 # Requires field selected: userErrors 395 # 396 # Arguments 397 # input: (self-explanatory) 398 (: DeliveryWindowCreateInput!): DeliveryWindowCreatePayload! 399 400 # Update a delivery window 401 # 402 # Required permission: DeliveryWindow:write 403 # 404 # Requires field selected: userErrors 405 # 406 # Arguments 407 # id: (self-explanatory) 408 # externalId: (self-explanatory) 409 # input: (self-explanatory) 410 (: Int, : String, : DeliveryWindowUpdateInput!): DeliveryWindowUpdatePayload! 411 412 # Sets how variants should be available in given delivery window. If provided variant already is assigned to that delivery 413 # window then it will be updated with provided parameters. 414 # 415 # Required permission: DeliveryWindow:write 416 # 417 # Requires field selected: userErrors 418 # 419 # Arguments 420 # input: (self-explanatory) 421 (: DeliveryWindowVariantsSetInput!): DeliveryWindowVariantsSetPayload! 422 423 # Unsets variants from delivery window 424 # 425 # Required permission: DeliveryWindow:write 426 # 427 # Requires field selected: userErrors 428 # 429 # Arguments 430 # input: (self-explanatory) 431 (: DeliveryWindowVariantsUnsetInput!): DeliveryWindowVariantsUnsetPayload! 432 433 # Create a delivery window group 434 # 435 # Required permission: DeliveryWindow:write 436 # 437 # Requires field selected: userErrors 438 # 439 # Arguments 440 # input: (self-explanatory) 441 (: DeliveryWindowGroupCreateInput!): DeliveryWindowGroupCreatePayload! 442 443 # Update a delivery window group 444 # 445 # Required permission: DeliveryWindow:write 446 # 447 # Requires field selected: userErrors 448 # 449 # Arguments 450 # id: (self-explanatory) 451 # externalId: (self-explanatory) 452 # input: (self-explanatory) 453 (: Int, : String, : DeliveryWindowGroupUpdateInput!): DeliveryWindowGroupUpdatePayload! 454 455 # Delete a delivery window group 456 # 457 # Required permission: DeliveryWindow:write 458 # 459 # Requires field selected: userErrors 460 # 461 # Arguments 462 # id: (self-explanatory) 463 # externalId: (self-explanatory) 464 (: Int, : String): DeliveryWindowGroupDeletePayload! 465 466 # Set order in delivery window tree 467 # Only the provide items will be sorted in order. 468 # The rest of the items will not retain their previous order and will be ordered by ID 469 # 470 # Required permission: DeliveryWindow:write 471 # 472 # Requires field selected: userErrors 473 # 474 # Arguments 475 # input: (self-explanatory) 476 (: DeliveryWindowTreeOrderSetInput!): DeliveryWindowTreeOrderSetPayload! 477 478 # Create a shipping 479 # 480 # Required permission: ShippingOption:write 481 # 482 # Requires field selected: userErrors 483 # 484 # Arguments 485 # input: (self-explanatory) 486 (: ShippingOptionCreateInput!): ShippingOptionCreatePayload! 487 488 # Update a shipping option 489 # 490 # Required permission: ShippingOption:write 491 # 492 # Requires field selected: userErrors 493 # 494 # Arguments 495 # id: (self-explanatory) 496 # input: (self-explanatory) 497 (: Int!, : ShippingOptionUpdateInput!): ShippingOptionUpdatePayload! 498 499 # Delete a shipping option 500 # 501 # Required permission: ShippingOption:write 502 # 503 # Requires field selected: userErrors 504 # 505 # Arguments 506 # id: (self-explanatory) 507 (: Int!): ShippingOptionDeletePayload! 508 509 # Change stock for many items 510 # 511 # Required permission: StockChange:write 512 # 513 # Requires field selected: userErrors 514 # 515 # Arguments 516 # input: (self-explanatory) 517 (: StockChangeInput!): StockChangePayload! 518 519 # Set stock levels: unlike the `changeStock` mutation, this one accepts absolute stock values, 520 # either FTA (free to allocate), or physical. If FTA values are provided, they should not include 521 # possible `stockOffset` from `ProductVariant`, nor `threshold` from `Warehouse`, just the physical 522 # stock minus the allocated quantity. 523 # 524 # Required permission: StockChange:write 525 # 526 # Requires field selected: userErrors 527 # 528 # Arguments 529 # input: (self-explanatory) 530 (: StockSetInput!): StockSetPayload! 531 532 # Create a subscription 533 # 534 # Required permission: Subscription:write 535 # 536 # Requires field selected: userErrors 537 # 538 # Arguments 539 # input: (self-explanatory) 540 (: SubscriptionCreateInput!): SubscriptionUpdatePayload! 541 542 # Update a subscription 543 # 544 # Required permission: Subscription:write 545 # 546 # Requires field selected: userErrors 547 # 548 # Arguments 549 # id: (self-explanatory) 550 # input: (self-explanatory) 551 (: Int!, : SubscriptionUpdateInput!): SubscriptionUpdatePayload! 552 553 # Create a subscription plan 554 # 555 # Required permission: SubscriptionPlan:write 556 # 557 # Requires field selected: userErrors 558 # 559 # Arguments 560 # input: (self-explanatory) 561 (: SubscriptionPlanCreateInput!): SubscriptionPlanCreatePayload! 562 563 # Update a subscription plan 564 # 565 # Required permission: SubscriptionPlan:write 566 # 567 # Requires field selected: userErrors 568 # 569 # Arguments 570 # id: (self-explanatory) 571 # input: (self-explanatory) 572 (: Int!, : SubscriptionPlanUpdateInput!): SubscriptionPlanUpdatePayload! 573 574 # Update a subscription contract 575 # 576 # Required permission: Subscription:write 577 # 578 # Requires field selected: userErrors 579 # 580 # Arguments 581 # id: (self-explanatory) 582 # input: (self-explanatory) 583 (: Int!, : SubscriptionContractUpdateInput!): SubscriptionContractUpdatePayload! 584 585 # Set variants to a subscription plan. 586 # You can set up to 100 variants in one call. 587 # 588 # Required permission: SubscriptionPlan:write 589 # 590 # Requires field selected: userErrors 591 # 592 # Arguments 593 # input: (self-explanatory) 594 (: SubscriptionPlanVariantsSetInput!): SubscriptionPlanVariantsSetPayload! 595 596 # Unset variants from a subscription plan. 597 # You can unset 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 (: SubscriptionPlanVariantsUnsetInput!): SubscriptionPlanVariantsUnsetPayload! 606 607 # Create a size chart 608 # 609 # Required permission: SizeChart:write 610 # 611 # Requires field selected: userErrors 612 # 613 # Arguments 614 # input: (self-explanatory) 615 (: SizeChartCreateInput!): SizeChartCreatePayload! 616 617 # Update a size chart. Covers adding, removing and rearranging sizes. For renaming sizes use `updateSizeChartLabels` 618 # 619 # Required permission: SizeChart:write 620 # 621 # Requires field selected: userErrors 622 # 623 # Arguments 624 # id: (self-explanatory) 625 # externalId: (self-explanatory) 626 # input: (self-explanatory) 627 (: Int, : String, : SizeChartUpdateInput!): SizeChartUpdatePayload! 628 629 # Update size labels 630 # 631 # Required permission: SizeChart:write 632 # 633 # Requires field selected: userErrors 634 # 635 # Arguments 636 # id: (self-explanatory) 637 # externalId: (self-explanatory) 638 # input: (self-explanatory) 639 (: Int, : String, : SizeChartLabelsUpdateInput!): SizeChartUpdatePayload! 640 641 # Merge two size charts into one 642 # 643 # Required permission: SizeChart:write 644 # 645 # Requires field selected: userErrors 646 # 647 # Arguments 648 # input: (self-explanatory) 649 (: SizeChartMergeInput!): SizeChartUpdatePayload! 650 651 # Delete a size chart 652 # 653 # Required permission: SizeChart:write 654 # 655 # Requires field selected: userErrors 656 # 657 # Arguments 658 # id: (self-explanatory) 659 # externalId: (self-explanatory) 660 (: Int, : String): SizeChartDeletePayload! 661 662 # Create a bundle 663 # 664 # Required permission: Bundle:write 665 # 666 # Requires field selected: userErrors 667 # 668 # Arguments 669 # input: (self-explanatory) 670 (: BundleCreateInput!): BundleCreatePayload! 671 672 # Update a bundle 673 # 674 # Required permission: Bundle:write 675 # 676 # Requires field selected: userErrors 677 # 678 # Arguments 679 # id: (self-explanatory) 680 # input: (self-explanatory) 681 (: Int!, : BundleUpdateInput!): BundleUpdatePayload! 682 683 # Create a measurement chart 684 # 685 # Required permission: MeasurementChart:write 686 # 687 # Requires field selected: userErrors 688 # 689 # Arguments 690 # input: (self-explanatory) 691 (: MeasurementChartCreateInput!): MeasurementChartCreatePayload! 692 693 # Update a measurement chart 694 # 695 # Required permission: MeasurementChart:write 696 # 697 # Requires field selected: userErrors 698 # 699 # Arguments 700 # id: (self-explanatory) 701 # input: (self-explanatory) 702 (: Int!, : MeasurementChartUpdateInput!): MeasurementChartUpdatePayload! 703 704 # Delete a measurement chart 705 # 706 # Required permission: MeasurementChart:write 707 # 708 # Requires field selected: userErrors 709 # 710 # Arguments 711 # id: (self-explanatory) 712 (: Int!): MeasurementChartDeletePayload! 713 714 # Create a customer 715 # 716 # Required permission: Customer:write 717 # 718 # Requires field selected: userErrors 719 # 720 # Arguments 721 # input: (self-explanatory) 722 (: CustomerCreateInput!): CustomerCreatePayload! 723 724 # Update a customer 725 # 726 # Required permission: Customer:write 727 # 728 # Requires field selected: userErrors 729 # 730 # Arguments 731 # id: (self-explanatory) 732 # externalId: (self-explanatory) 733 # input: (self-explanatory) 734 (: Int, : String, : CustomerUpdateInput!): CustomerUpdatePayload! 735 736 # Delete a customer 737 # 738 # Required permission: Customer:write 739 # 740 # Requires field selected: userErrors 741 # 742 # Arguments 743 # id: (self-explanatory) 744 # externalId: (self-explanatory) 745 (: Int, : String): CustomerDeletePayload! 746 747 # Create an account 748 # 749 # Required permission: Account:write 750 # 751 # Requires field selected: userErrors 752 # 753 # Arguments 754 # input: (self-explanatory) 755 (: AccountCreateInput!): AccountCreatePayload! 756 757 # Update an account 758 # 759 # Required permission: Account:write 760 # 761 # Requires field selected: userErrors 762 # 763 # Arguments 764 # id: (self-explanatory) 765 # externalId: (self-explanatory) 766 # input: (self-explanatory) 767 (: Int, : String, : AccountUpdateInput!): AccountUpdatePayload! 768 769 # Delete an account 770 # 771 # Required permission: Account:write 772 # 773 # Requires field selected: userErrors 774 # 775 # Arguments 776 # id: (self-explanatory) 777 # externalId: (self-explanatory) 778 (: Int, : String): AccountDeletePayload! 779 780 # Create an address book entry for an account 781 # 782 # Required permission: Account:write 783 # 784 # Arguments 785 # input: (self-explanatory) 786 (: AddressBookEntryCreateInput!): AddressBookEntryCreatePayload! 787 788 # Update an address book entry for an account 789 # 790 # Required permission: Account:write 791 # 792 # Arguments 793 # id: (self-explanatory) 794 # externalId: (self-explanatory) 795 # input: (self-explanatory) 796 (: Int, : String, : AddressBookEntryUpdateInput!): AddressBookEntryUpdatePayload! 797 798 # Delete an address book from an account 799 # 800 # Required permission: Account:write 801 # 802 # Requires field selected: userErrors 803 # 804 # Arguments 805 # id: (self-explanatory) 806 # externalId: (self-explanatory) 807 (: Int, : String): AddressBookEntryDeletePayload! 808 809 # Create a buyer for an account 810 # 811 # Required permission: Buyer:write 812 # 813 # Requires field selected: userErrors 814 # 815 # Arguments 816 # input: (self-explanatory) 817 (: BuyerCreateInput!): BuyerCreatePayload! 818 819 # Update a buyer for an account 820 # 821 # Required permission: Buyer:write 822 # 823 # Requires field selected: userErrors 824 # 825 # Arguments 826 # id: (self-explanatory) 827 # externalId: (self-explanatory) 828 # input: (self-explanatory) 829 (: Int, : String, : BuyerUpdateInput!): BuyerUpdatePayload! 830 831 # Delete a buyer from an account 832 # 833 # Required permission: Buyer:write 834 # 835 # Requires field selected: userErrors 836 # 837 # Arguments 838 # id: (self-explanatory) 839 # externalId: (self-explanatory) 840 (: Int, : String): BuyerDeletePayload! 841 842 # Create a campaign 843 # 844 # Required permission: Campaign:write 845 # 846 # Requires field selected: userErrors 847 # 848 # Arguments 849 # input: (self-explanatory) 850 (: CampaignCreateInput!): CampaignCreatePayload! 851 852 # Update a campaign 853 # 854 # Required permission: Campaign:write 855 # 856 # Requires field selected: userErrors 857 # 858 # Arguments 859 # id: (self-explanatory) 860 # input: (self-explanatory) 861 (: Int!, : CampaignUpdateInput!): CampaignUpdatePayload! 862 863 # Delete a campaign 864 # 865 # Required permission: Campaign:write 866 # 867 # Requires field selected: userErrors 868 # 869 # Arguments 870 # id: (self-explanatory) 871 (: Int!): CampaignDeletePayload! 872 873 # Set campaign variants 874 # 875 # Required permission: Campaign:write 876 # 877 # Requires field selected: userErrors 878 # 879 # Arguments 880 # input: (self-explanatory) 881 (: CampaignVariantsSetInput!): CampaignVariantsSetPayload! 882 883 # Unset campaign variants 884 # 885 # Required permission: Campaign:write 886 # 887 # Requires field selected: userErrors 888 # 889 # Arguments 890 # input: (self-explanatory) 891 (: CampaignVariantsUnsetInput!): CampaignVariantsUnsetPayload! 892 893 # Create a market 894 # 895 # Required permission: Market:write 896 # 897 # Requires field selected: userErrors 898 # 899 # Arguments 900 # input: (self-explanatory) 901 (: MarketCreateInput!): MarketCreatePayload! 902 903 # Update a market 904 # 905 # Required permission: Market:write 906 # 907 # Requires field selected: userErrors 908 # 909 # Arguments 910 # id: (self-explanatory) 911 # externalId: (self-explanatory) 912 # input: (self-explanatory) 913 (: Int, : String, : MarketUpdateInput!): MarketUpdatePayload! 914 915 # Delete a market 916 # 917 # Required permission: Market:write 918 # 919 # Requires field selected: userErrors 920 # 921 # Arguments 922 # id: (self-explanatory) 923 # externalId: (self-explanatory) 924 (: Int, : String): MarketDeletePayload! 925 926 # Assign displays to a market 927 # 928 # Required permission: Display:write 929 # 930 # Arguments 931 # input: (self-explanatory) 932 (: MarketDisplaysSetInput!): MarketDisplaysSetPayload! 933 934 # Unassign displays from a market 935 # 936 # Required permission: Display:write 937 # 938 # Arguments 939 # input: (self-explanatory) 940 (: MarketDisplaysUnsetInput!): MarketDisplaysUnsetPayload! 941 942 # Create a category 943 # 944 # Required permission: Category:write 945 # 946 # Requires field selected: userErrors 947 # 948 # Arguments 949 # input: (self-explanatory) 950 (: CategoryCreateInput!): CategoryCreatePayload! 951 952 # Update a category 953 # 954 # Required permission: Category:write 955 # 956 # Requires field selected: userErrors 957 # 958 # Arguments 959 # id: (self-explanatory) 960 # input: (self-explanatory) 961 (: Int!, : CategoryUpdateInput!): CategoryUpdatePayload! 962 963 # Delete 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!, : CategoryDeleteInput! = {deleteChildrenStrategy: RESTRICT_IF_PRESENT}): CategoryDeletePayload! 973 974 # Set category displays 975 # 976 # Required permission: Category:write 977 # 978 # Requires field selected: userErrors 979 # 980 # Arguments 981 # input: (self-explanatory) 982 (: CategoryDisplaysSetInput!): CategoryDisplaysSetPayload! 983 984 # Unset category displays 985 # 986 # Required permission: Category:write 987 # 988 # Requires field selected: userErrors 989 # 990 # Arguments 991 # input: (self-explanatory) 992 (: CategoryDisplaysUnsetInput!): CategoryDisplaysUnsetPayload! 993 994 # Sort displays of a category 995 # 996 # Required permission: Category:write 997 # 998 # Requires field selected: userErrors 999 # 1000 # Arguments 1001 # input: (self-explanatory) 1002 (: CategoryDisplaysSortInput!): CategoryDisplaysSortPayload! 1003 1004 # Create a voucher 1005 # 1006 # Required permission: Voucher:write 1007 # 1008 # Requires field selected: userErrors 1009 # 1010 # Arguments 1011 # input: (self-explanatory) 1012 (: VoucherCreateInput!): VoucherCreatePayload! 1013 1014 # Update a voucher 1015 # 1016 # Required permission: Voucher:write 1017 # 1018 # Requires field selected: userErrors 1019 # 1020 # Arguments 1021 # id: (self-explanatory) 1022 # externalId: (self-explanatory) 1023 # input: (self-explanatory) 1024 (: Int, : String, : VoucherUpdateInput!): VoucherUpdatePayload! 1025 1026 # Delete a voucher 1027 # 1028 # Required permission: Voucher:write 1029 # 1030 # Requires field selected: userErrors 1031 # 1032 # Arguments 1033 # id: (self-explanatory) 1034 # externalId: (self-explanatory) 1035 (: Int, : String): VoucherDeletePayload! 1036 1037 # Add an action to a voucher 1038 # 1039 # Required permission: Voucher:write 1040 # 1041 # Requires field selected: userErrors 1042 # 1043 # Arguments 1044 # input: (self-explanatory) 1045 (: VoucherActionCreateInput!): VoucherActionCreatePayload! 1046 1047 # Update an action of voucher 1048 # 1049 # Required permission: Voucher:write 1050 # 1051 # Requires field selected: userErrors 1052 # 1053 # Arguments 1054 # id: (self-explanatory) 1055 # input: (self-explanatory) 1056 (: Int!, : VoucherActionUpdateInput!): VoucherActionUpdatePayload! 1057 1058 # Delete an action from voucher 1059 # 1060 # Required permission: Voucher:write 1061 # 1062 # Requires field selected: userErrors 1063 # 1064 # Arguments 1065 # id: (self-explanatory) 1066 (: Int!): VoucherActionDeletePayload! 1067 1068 # Update a DTC order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1069 # 1070 # Required permission: Order:write 1071 # 1072 # Requires field selected: userErrors 1073 # 1074 # Arguments 1075 # order: (self-explanatory) 1076 # input: (self-explanatory) 1077 (: OrderInput!, : DirectToConsumerOrderUpdateInput!): DirectToConsumerOrderUpdatePayload! 1078 1079 # Resume a DTC order 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!, : DirectToConsumerOrderResumeInput!): DirectToConsumerOrderUpdatePayload! 1089 1090 # Update a wholesale order that isn't locked (unless the user has 'Order.isLocked:write' permission) 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!, : WholesaleOrderUpdateInput!): WholesaleOrderUpdatePayload! 1100 1101 # Cancel a DTC order 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!, : DirectToConsumerOrderCancelInput!): DirectToConsumerOrderCancelPayload! 1111 1112 # Cancel a Wholesale 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!, : WholesaleOrderCancelInput!): WholesaleOrderCancelPayload! 1122 1123 # Confirm an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1124 # 1125 # Required permission: Order:write 1126 # 1127 # Requires field selected: userErrors 1128 # 1129 # Arguments 1130 # input: (self-explanatory) 1131 (: OrderConfirmInput!): OrderConfirmPayload! 1132 1133 # Add a note to an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1134 # 1135 # Required permission: OrderHistory:write 1136 # 1137 # Requires field selected: userErrors 1138 # 1139 # Arguments 1140 # input: (self-explanatory) 1141 (: OrderNoteAddInput): OrderNoteAddPayload! 1142 1143 # Add an external link attachment to a wholesale order 1144 # 1145 # Required permission: OrderHistory:write 1146 # 1147 # Requires field selected: userErrors 1148 # 1149 # Arguments 1150 # input: (self-explanatory) 1151 (: OrderLinkAttachmentInput): OrderLinkAttachmentAddPayload! 1152 1153 # Lock/unlock an order. 1154 # If a user does not have permission to lock/unlock the order and tries to modify a locked order, it will be forbidden. 1155 # This includes creating a shipment and order allocation. 1156 # 1157 # Required permission: Order.isLocked:write 1158 # 1159 # Requires field selected: userErrors 1160 # 1161 # Arguments 1162 # input: (self-explanatory) 1163 (: OrdersLockInput!): OrdersLockPayload! 1164 1165 # Allocate stock for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1166 # 1167 # Required permission: Order:write 1168 # 1169 # Requires field selected: userErrors 1170 # 1171 # Arguments 1172 # input: (self-explanatory) 1173 (: OrderAllocateInput!): OrderAllocatePayload! 1174 1175 # Unallocate stock for an order that isn't locked (unless the user has 'Order.isLocked:write' permission). 1176 # A whole order is affected by default, but it's also possible to select, which lines or warehouses 1177 # should be affected by this call. 1178 # 1179 # Required permission: Order:write 1180 # 1181 # Requires field selected: userErrors 1182 # 1183 # Arguments 1184 # input: (self-explanatory) 1185 (: OrderUnallocateInput!): OrderUnallocatePayload! 1186 1187 # Capture an order 1188 # 1189 # Required permission: Order:write 1190 # 1191 # Requires field selected: userErrors 1192 # 1193 # Arguments 1194 # order: (self-explanatory) 1195 (: OrderInput!): OrderCapturePayload! 1196 1197 # Create a shipment for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1198 # 1199 # Required permission: Shipment:write 1200 # 1201 # Requires field selected: userErrors 1202 # 1203 # Arguments 1204 # input: (self-explanatory) 1205 (: ShipmentCreateInput!): ShipmentCreatePayload! 1206 1207 # Update a shipment 1208 # 1209 # Required permission: Shipment:write 1210 # 1211 # Requires field selected: userErrors 1212 # 1213 # Arguments 1214 # id: (self-explanatory) 1215 # externalId: (self-explanatory) 1216 # input: (self-explanatory) 1217 (: Int, : String, : ShipmentUpdateInput!): ShipmentUpdatePayload! 1218 1219 # Complete a shipment 1220 # 1221 # Required permission: Shipment:write 1222 # 1223 # Requires field selected: userErrors 1224 # 1225 # Arguments 1226 # id: (self-explanatory) 1227 # externalId: (self-explanatory) 1228 # input: (self-explanatory) 1229 (: Int, : String, : ShipmentCompleteInput): ShipmentCompletePayload 1230 1231 # Delete a shipment from an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1232 # 1233 # Required permission: Shipment:write 1234 # 1235 # Requires field selected: userErrors 1236 # 1237 # Arguments 1238 # id: (self-explanatory) 1239 # externalId: (self-explanatory) 1240 (: Int, : String): ShipmentDeletePayload! 1241 1242 # Capture a shipment. 1243 # Even if the mutation returns empty userErrors, a capture itself can be failed because a failed attempt is also saved 1244 # into a payment history entry and the mutation shows it in paymentHistoryEntry. 1245 # The best way to check whether the capture succeeded is to check shipment.isCaptured. 1246 # 1247 # If the order was captured before and there is some amount not assigned to any shipment, it will be set to 1248 # the shipment. If the total shipment amount is assigned that way, no real capture will be made. In this case, 1249 # paymentHistoryEntry cannot be created and it will be null, but the shipment field will be non-empty. 1250 # 1251 # Required permission: Payment.capture:write 1252 # 1253 # Requires field selected: userErrors 1254 # 1255 # Arguments 1256 # id: (self-explanatory) 1257 # externalId: (self-explanatory) 1258 (: Int, : String): ShipmentCapturePayload! 1259 1260 # Release remaining order authorization after all shipments are captured in order to release customer's funds that will 1261 # not be captured. Amount that will be released is authorization amount - total captured amount across all shipments. 1262 # 1263 # Required permission: Payment.cancel:write 1264 # 1265 # Requires field selected: userErrors 1266 # 1267 # Arguments 1268 # order: (self-explanatory) 1269 (: OrderInput): ReleaseRemainingOrderAuthorizationPayload! 1270 1271 # Create a return 1272 # 1273 # Required permission: Return:write 1274 # 1275 # Requires field selected: userErrors 1276 # 1277 # Arguments 1278 # input: (self-explanatory) 1279 (: ReturnCreateInput!): ReturnCreatePayload! 1280 1281 # Complete a return 1282 # 1283 # Required permission: Return:write 1284 # 1285 # Requires field selected: userErrors 1286 # 1287 # Arguments 1288 # id: (self-explanatory) 1289 # externalId: (self-explanatory) 1290 # input: (self-explanatory) 1291 (: Int, : String, : ReturnCompleteInput! = {sendEmail: false}): ReturnCompletePayload! 1292 1293 # Uncomplete a return 1294 # 1295 # Required permission: Return:write 1296 # 1297 # Requires field selected: userErrors 1298 # 1299 # Arguments 1300 # id: (self-explanatory) 1301 # externalId: (self-explanatory) 1302 (: Int, : String): ReturnUncompletePayload! 1303 1304 # Delete 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): ReturnDeletePayload! 1314 1315 # Create a warehouse 1316 # 1317 # Required permission: Warehouse:write 1318 # 1319 # Requires field selected: userErrors 1320 # 1321 # Arguments 1322 # input: (self-explanatory) 1323 (: WarehouseCreateInput!): WarehouseCreatePayload! 1324 1325 # Update a warehouse 1326 # 1327 # Required permission: Warehouse:write 1328 # 1329 # Requires field selected: userErrors 1330 # 1331 # Arguments 1332 # id: (self-explanatory) 1333 # externalId: (self-explanatory) 1334 # input: (self-explanatory) 1335 (: Int!, : String, : WarehouseUpdateInput!): WarehouseUpdatePayload! 1336 1337 # Add payment information to an invoice 1338 # 1339 # Required permission: Invoice:write 1340 # 1341 # Requires field selected: userErrors 1342 # 1343 # Arguments 1344 # input: (self-explanatory) 1345 (: RegisterInvoicePaymentInput!): InvoicePaymentRegisterPayload! 1346 1347 # Only to mark as fully paid 1348 # 1349 # Required permission: Invoice:write 1350 # 1351 # Requires field selected: userErrors 1352 # 1353 # Arguments 1354 # input: (self-explanatory) 1355 (: MarkInvoiceAsPaidInput!): MarkInvoiceAsPaidPayload! 1356 1357 # Add item to the wishlist 1358 # 1359 # Required permission: Wishlist:write 1360 # 1361 # Requires field selected: userErrors 1362 # 1363 # Arguments 1364 # input: (self-explanatory) 1365 (: WishlistItemAddInput!): WishlistItemAddPayload! 1366 1367 # Remove item from the wishlist 1368 # 1369 # Required permission: Wishlist:write 1370 # 1371 # Requires field selected: userErrors 1372 # 1373 # Arguments 1374 # input: (self-explanatory) 1375 (: WishlistItemRemoveInput!): WishlistItemRemovePayload! 1376 1377 # Set ID conversion rules 1378 # 1379 # Required permission: IdConversion:write 1380 # 1381 # Requires field selected: userErrors 1382 # 1383 # Arguments 1384 # input: (self-explanatory) 1385 (: [IdConversionSetInput!]!): IdConversionsSetPayload! 1386 1387 # Unset ID conversion rules 1388 # 1389 # Required permission: IdConversion:write 1390 # 1391 # Requires field selected: userErrors 1392 # 1393 # Arguments 1394 # input: (self-explanatory) 1395 (: [IdConversionUnsetInput!]!): IdConversionsUnsetPayload! 1396 1397 # Add subvouchers to a voucher, a lightweight way to have 1398 # multiple individually tracked codes for a single voucher configuration 1399 # 1400 # Required permission: Voucher:write 1401 # 1402 # Requires field selected: userErrors 1403 # 1404 # Arguments 1405 # input: (self-explanatory) 1406 (: SubvouchersCreateInput!): SubvouchersPayload! 1407 1408 # Update a single subvoucher 1409 # 1410 # Required permission: Voucher:write 1411 # 1412 # Requires field selected: userErrors 1413 # 1414 # Arguments 1415 # id: (self-explanatory) 1416 # input: (self-explanatory) 1417 (: Int!, : SubvoucherUpdateInput!): SubvoucherPayload! 1418 1419 # Completely remove a subvoucher 1420 # 1421 # Required permission: Voucher:write 1422 # 1423 # Requires field selected: userErrors 1424 # 1425 # Arguments 1426 # id: (self-explanatory) 1427 (: Int!): SubvoucherRemovePayload! 1428 1429 # Add a size localization, which will define, how sizes in specified size charts are presented in given stores and 1430 # countries 1431 # 1432 # Required permission: SizeChart:write 1433 # 1434 # Requires field selected: userErrors 1435 # 1436 # Arguments 1437 # input: (self-explanatory) 1438 (: SizeLocalizationCreateInput!): SizeLocalizationCreatePayload! 1439 1440 # Update a size localization 1441 # 1442 # Required permission: SizeChart:write 1443 # 1444 # Requires field selected: userErrors 1445 # 1446 # Arguments 1447 # sizeLocalization: (self-explanatory) 1448 # input: (self-explanatory) 1449 ( 1450 : SizeLocalizationInput!, 1451 : SizeLocalizationUpdateInput! 1452 ): SizeLocalizationUpdatePayload! 1453 1454 # Set localized names for sizes in a given size localization 1455 # 1456 # Required permission: SizeChart:write 1457 # 1458 # Requires field selected: userErrors 1459 # 1460 # Arguments 1461 # sizeLocalization: (self-explanatory) 1462 # input: (self-explanatory) 1463 (: SizeLocalizationInput!, : [LocalizedSizesSetInput!]!): LocalizedSizesSetPayload! 1464 1465 # Create purchase order 1466 # 1467 # Required permission: PurchaseOrder:write 1468 # 1469 # Requires field selected: userErrors 1470 # 1471 # Arguments 1472 # input: (self-explanatory) 1473 (: PurchaseOrderCreateInput!): PurchaseOrderCreatePayload! 1474 1475 # Update a purchase order 1476 # 1477 # Required permission: PurchaseOrder:write 1478 # 1479 # Requires field selected: userErrors 1480 # 1481 # Arguments 1482 # id: (self-explanatory) 1483 # input: (self-explanatory) 1484 (: Int!, : PurchaseOrderUpdateInput!): PurchaseOrderUpdatePayload! 1485 1486 # Confirm a purchase order 1487 # 1488 # Required permission: PurchaseOrder:write 1489 # 1490 # Requires field selected: userErrors 1491 # 1492 # Arguments 1493 # id: (self-explanatory) 1494 (: Int!): PurchaseOrderConfirmPayload! 1495 1496 # Create purchase order delivery 1497 # 1498 # Required permission: PurchaseOrderDelivery:write 1499 # 1500 # Requires field selected: userErrors 1501 # 1502 # Arguments 1503 # input: (self-explanatory) 1504 (: PurchaseOrderDeliveryCreateInput!): PurchaseOrderDeliveryCreatePayload! 1505 1506 # Accept purchase order delivery 1507 # 1508 # Required permission: PurchaseOrderDelivery:write 1509 # 1510 # Requires field selected: userErrors 1511 # 1512 # Arguments 1513 # id: (self-explanatory) 1514 # input: (self-explanatory) 1515 (: Int!, : PurchaseOrderDeliveryAcceptInput!): PurchaseOrderDeliveryAcceptPayload! 1516 1517 # Subscribe to receive events of specified object and change types 1518 # 1519 # Required permission: Event:write 1520 # 1521 # Requires field selected: userErrors 1522 # 1523 # Arguments 1524 # input: (self-explanatory) 1525 (: [EventListenerSetInput!]!): EventListenerSetPayload! 1526 1527 # Unsubscribe from given object and change types. 1528 # It will result in deleting all queued events of these types. 1529 # 1530 # Required permission: Event:write 1531 # 1532 # Requires field selected: userErrors 1533 # 1534 # Arguments 1535 # input: (self-explanatory) 1536 (: [EventListenerUnsetInput!]!): EventListenerUnsetPayload! 1537 1538 # Confirm the given events. 1539 # It means they were processed on your side and they are no longer needed. 1540 # It is an essential mechanism to clean the events queue. 1541 # Limit is 200 events per call. 1542 # 1543 # Required permission: Event:write 1544 # 1545 # Requires field selected: userErrors 1546 # 1547 # Arguments 1548 # input: (self-explanatory) 1549 (: EventsConfirmInput!): EventsConfirmPayload! 1550 1551 # Required permission: MediaBatch:write 1552 # 1553 # Arguments 1554 # input: (self-explanatory) 1555 (: MediaBatchCreateInput!): MediaBatchCreatePayload! 1556 1557 }
link Required by
This element is not required by anyone