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