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 shipping 434 # 435 # Required permission: ShippingOption:write 436 # 437 # Requires field selected: userErrors 438 # 439 # Arguments 440 # input: (self-explanatory) 441 (: ShippingOptionCreateInput!): ShippingOptionCreatePayload! 442 443 # Update a shipping option 444 # 445 # Required permission: ShippingOption:write 446 # 447 # Requires field selected: userErrors 448 # 449 # Arguments 450 # id: (self-explanatory) 451 # input: (self-explanatory) 452 (: Int!, : ShippingOptionUpdateInput!): ShippingOptionUpdatePayload! 453 454 # Delete a shipping option 455 # 456 # Required permission: ShippingOption:write 457 # 458 # Requires field selected: userErrors 459 # 460 # Arguments 461 # id: (self-explanatory) 462 (: Int!): ShippingOptionDeletePayload! 463 464 # Change stock for many items 465 # 466 # Required permission: StockChange:write 467 # 468 # Requires field selected: userErrors 469 # 470 # Arguments 471 # input: (self-explanatory) 472 (: StockChangeInput!): StockChangePayload! 473 474 # Set stock levels: unlike the `changeStock` mutation, this one accepts absolute stock values, 475 # either FTA (free to allocate), or physical. If FTA values are provided, they should not include 476 # possible `stockOffset` from `ProductVariant`, nor `threshold` from `Warehouse`, just the physical 477 # stock minus the allocated quantity. 478 # 479 # Required permission: StockChange:write 480 # 481 # Requires field selected: userErrors 482 # 483 # Arguments 484 # input: (self-explanatory) 485 (: StockSetInput!): StockSetPayload! 486 487 # Create a subscription 488 # 489 # Required permission: Subscription:write 490 # 491 # Requires field selected: userErrors 492 # 493 # Arguments 494 # input: (self-explanatory) 495 (: SubscriptionCreateInput!): SubscriptionUpdatePayload! 496 497 # Update a subscription 498 # 499 # Required permission: Subscription:write 500 # 501 # Requires field selected: userErrors 502 # 503 # Arguments 504 # id: (self-explanatory) 505 # input: (self-explanatory) 506 (: Int!, : SubscriptionUpdateInput!): SubscriptionUpdatePayload! 507 508 # Create a subscription plan 509 # 510 # Required permission: SubscriptionPlan:write 511 # 512 # Requires field selected: userErrors 513 # 514 # Arguments 515 # input: (self-explanatory) 516 (: SubscriptionPlanCreateInput!): SubscriptionPlanCreatePayload! 517 518 # Update a subscription plan 519 # 520 # Required permission: SubscriptionPlan:write 521 # 522 # Requires field selected: userErrors 523 # 524 # Arguments 525 # id: (self-explanatory) 526 # input: (self-explanatory) 527 (: Int!, : SubscriptionPlanUpdateInput!): SubscriptionPlanUpdatePayload! 528 529 # Update a subscription contract 530 # 531 # Required permission: Subscription:write 532 # 533 # Requires field selected: userErrors 534 # 535 # Arguments 536 # id: (self-explanatory) 537 # input: (self-explanatory) 538 (: Int!, : SubscriptionContractUpdateInput!): SubscriptionContractUpdatePayload! 539 540 # Set variants to a subscription plan. 541 # You can set up to 100 variants in one call. 542 # 543 # Required permission: SubscriptionPlan:write 544 # 545 # Requires field selected: userErrors 546 # 547 # Arguments 548 # input: (self-explanatory) 549 (: SubscriptionPlanVariantsSetInput!): SubscriptionPlanVariantsSetPayload! 550 551 # Unset variants from a subscription plan. 552 # You can unset up to 100 variants in one call. 553 # 554 # Required permission: SubscriptionPlan:write 555 # 556 # Requires field selected: userErrors 557 # 558 # Arguments 559 # input: (self-explanatory) 560 (: SubscriptionPlanVariantsUnsetInput!): SubscriptionPlanVariantsUnsetPayload! 561 562 # Create a size chart 563 # 564 # Required permission: SizeChart:write 565 # 566 # Requires field selected: userErrors 567 # 568 # Arguments 569 # input: (self-explanatory) 570 (: SizeChartCreateInput!): SizeChartCreatePayload! 571 572 # Update a size chart. Covers adding, removing and rearranging sizes. For renaming sizes use `updateSizeChartLabels` 573 # 574 # Required permission: SizeChart:write 575 # 576 # Requires field selected: userErrors 577 # 578 # Arguments 579 # id: (self-explanatory) 580 # externalId: (self-explanatory) 581 # input: (self-explanatory) 582 (: Int, : String, : SizeChartUpdateInput!): SizeChartUpdatePayload! 583 584 # Update size labels 585 # 586 # Required permission: SizeChart:write 587 # 588 # Requires field selected: userErrors 589 # 590 # Arguments 591 # id: (self-explanatory) 592 # externalId: (self-explanatory) 593 # input: (self-explanatory) 594 (: Int, : String, : SizeChartLabelsUpdateInput!): SizeChartUpdatePayload! 595 596 # Merge two size charts into one 597 # 598 # Required permission: SizeChart:write 599 # 600 # Requires field selected: userErrors 601 # 602 # Arguments 603 # input: (self-explanatory) 604 (: SizeChartMergeInput!): SizeChartUpdatePayload! 605 606 # Delete a size chart 607 # 608 # Required permission: SizeChart:write 609 # 610 # Requires field selected: userErrors 611 # 612 # Arguments 613 # id: (self-explanatory) 614 # externalId: (self-explanatory) 615 (: Int, : String): SizeChartDeletePayload! 616 617 # Create a bundle 618 # 619 # Required permission: Bundle:write 620 # 621 # Requires field selected: userErrors 622 # 623 # Arguments 624 # input: (self-explanatory) 625 (: BundleCreateInput!): BundleCreatePayload! 626 627 # Update a bundle 628 # 629 # Required permission: Bundle:write 630 # 631 # Requires field selected: userErrors 632 # 633 # Arguments 634 # id: (self-explanatory) 635 # input: (self-explanatory) 636 (: Int!, : BundleUpdateInput!): BundleUpdatePayload! 637 638 # Create a measurement chart 639 # 640 # Required permission: MeasurementChart:write 641 # 642 # Requires field selected: userErrors 643 # 644 # Arguments 645 # input: (self-explanatory) 646 (: MeasurementChartCreateInput!): MeasurementChartCreatePayload! 647 648 # Update a measurement chart 649 # 650 # Required permission: MeasurementChart:write 651 # 652 # Requires field selected: userErrors 653 # 654 # Arguments 655 # id: (self-explanatory) 656 # input: (self-explanatory) 657 (: Int!, : MeasurementChartUpdateInput!): MeasurementChartUpdatePayload! 658 659 # Delete a measurement chart 660 # 661 # Required permission: MeasurementChart:write 662 # 663 # Requires field selected: userErrors 664 # 665 # Arguments 666 # id: (self-explanatory) 667 (: Int!): MeasurementChartDeletePayload! 668 669 # Create a customer 670 # 671 # Required permission: Customer:write 672 # 673 # Requires field selected: userErrors 674 # 675 # Arguments 676 # input: (self-explanatory) 677 (: CustomerCreateInput!): CustomerCreatePayload! 678 679 # Update a customer 680 # 681 # Required permission: Customer:write 682 # 683 # Requires field selected: userErrors 684 # 685 # Arguments 686 # id: (self-explanatory) 687 # externalId: (self-explanatory) 688 # input: (self-explanatory) 689 (: Int, : String, : CustomerUpdateInput!): CustomerUpdatePayload! 690 691 # Delete a customer 692 # 693 # Required permission: Customer:write 694 # 695 # Requires field selected: userErrors 696 # 697 # Arguments 698 # id: (self-explanatory) 699 # externalId: (self-explanatory) 700 (: Int, : String): CustomerDeletePayload! 701 702 # Create an account 703 # 704 # Required permission: Account:write 705 # 706 # Requires field selected: userErrors 707 # 708 # Arguments 709 # input: (self-explanatory) 710 (: AccountCreateInput!): AccountCreatePayload! 711 712 # Update an account 713 # 714 # Required permission: Account:write 715 # 716 # Requires field selected: userErrors 717 # 718 # Arguments 719 # id: (self-explanatory) 720 # externalId: (self-explanatory) 721 # input: (self-explanatory) 722 (: Int, : String, : AccountUpdateInput!): AccountUpdatePayload! 723 724 # Delete an account 725 # 726 # Required permission: Account:write 727 # 728 # Requires field selected: userErrors 729 # 730 # Arguments 731 # id: (self-explanatory) 732 # externalId: (self-explanatory) 733 (: Int, : String): AccountDeletePayload! 734 735 # Create an address book entry for an account 736 # 737 # Required permission: Account:write 738 # 739 # Arguments 740 # input: (self-explanatory) 741 (: AddressBookEntryCreateInput!): AddressBookEntryCreatePayload! 742 743 # Update an address book entry for an account 744 # 745 # Required permission: Account:write 746 # 747 # Arguments 748 # id: (self-explanatory) 749 # externalId: (self-explanatory) 750 # input: (self-explanatory) 751 (: Int, : String, : AddressBookEntryUpdateInput!): AddressBookEntryUpdatePayload! 752 753 # Delete an address book from an account 754 # 755 # Required permission: Account:write 756 # 757 # Requires field selected: userErrors 758 # 759 # Arguments 760 # id: (self-explanatory) 761 # externalId: (self-explanatory) 762 (: Int, : String): AddressBookEntryDeletePayload! 763 764 # Create a buyer for an account 765 # 766 # Required permission: Buyer:write 767 # 768 # Requires field selected: userErrors 769 # 770 # Arguments 771 # input: (self-explanatory) 772 (: BuyerCreateInput!): BuyerCreatePayload! 773 774 # Update a buyer for an account 775 # 776 # Required permission: Buyer:write 777 # 778 # Requires field selected: userErrors 779 # 780 # Arguments 781 # id: (self-explanatory) 782 # externalId: (self-explanatory) 783 # input: (self-explanatory) 784 (: Int, : String, : BuyerUpdateInput!): BuyerUpdatePayload! 785 786 # Delete a buyer from an account 787 # 788 # Required permission: Buyer:write 789 # 790 # Requires field selected: userErrors 791 # 792 # Arguments 793 # id: (self-explanatory) 794 # externalId: (self-explanatory) 795 (: Int, : String): BuyerDeletePayload! 796 797 # Create a campaign 798 # 799 # Required permission: Campaign:write 800 # 801 # Requires field selected: userErrors 802 # 803 # Arguments 804 # input: (self-explanatory) 805 (: CampaignCreateInput!): CampaignCreatePayload! 806 807 # Update a campaign 808 # 809 # Required permission: Campaign:write 810 # 811 # Requires field selected: userErrors 812 # 813 # Arguments 814 # id: (self-explanatory) 815 # input: (self-explanatory) 816 (: Int!, : CampaignUpdateInput!): CampaignUpdatePayload! 817 818 # Delete a campaign 819 # 820 # Required permission: Campaign:write 821 # 822 # Requires field selected: userErrors 823 # 824 # Arguments 825 # id: (self-explanatory) 826 (: Int!): CampaignDeletePayload! 827 828 # Set campaign variants 829 # 830 # Required permission: Campaign:write 831 # 832 # Requires field selected: userErrors 833 # 834 # Arguments 835 # input: (self-explanatory) 836 (: CampaignVariantsSetInput!): CampaignVariantsSetPayload! 837 838 # Unset campaign variants 839 # 840 # Required permission: Campaign:write 841 # 842 # Requires field selected: userErrors 843 # 844 # Arguments 845 # input: (self-explanatory) 846 (: CampaignVariantsUnsetInput!): CampaignVariantsUnsetPayload! 847 848 # Create a market 849 # 850 # Required permission: Market:write 851 # 852 # Requires field selected: userErrors 853 # 854 # Arguments 855 # input: (self-explanatory) 856 (: MarketCreateInput!): MarketCreatePayload! 857 858 # Update a market 859 # 860 # Required permission: Market:write 861 # 862 # Requires field selected: userErrors 863 # 864 # Arguments 865 # id: (self-explanatory) 866 # externalId: (self-explanatory) 867 # input: (self-explanatory) 868 (: Int, : String, : MarketUpdateInput!): MarketUpdatePayload! 869 870 # Delete a market 871 # 872 # Required permission: Market:write 873 # 874 # Requires field selected: userErrors 875 # 876 # Arguments 877 # id: (self-explanatory) 878 # externalId: (self-explanatory) 879 (: Int, : String): MarketDeletePayload! 880 881 # Assign displays to a market 882 # 883 # Required permission: Display:write 884 # 885 # Arguments 886 # input: (self-explanatory) 887 (: MarketDisplaysSetInput!): MarketDisplaysSetPayload! 888 889 # Unassign displays from a market 890 # 891 # Required permission: Display:write 892 # 893 # Arguments 894 # input: (self-explanatory) 895 (: MarketDisplaysUnsetInput!): MarketDisplaysUnsetPayload! 896 897 # Create a category 898 # 899 # Required permission: Category:write 900 # 901 # Requires field selected: userErrors 902 # 903 # Arguments 904 # input: (self-explanatory) 905 (: CategoryCreateInput!): CategoryCreatePayload! 906 907 # Update a category 908 # 909 # Required permission: Category:write 910 # 911 # Requires field selected: userErrors 912 # 913 # Arguments 914 # id: (self-explanatory) 915 # input: (self-explanatory) 916 (: Int!, : CategoryUpdateInput!): CategoryUpdatePayload! 917 918 # Delete a category 919 # 920 # Required permission: Category:write 921 # 922 # Requires field selected: userErrors 923 # 924 # Arguments 925 # id: (self-explanatory) 926 # input: (self-explanatory) 927 (: Int!, : CategoryDeleteInput! = {deleteChildrenStrategy: RESTRICT_IF_PRESENT}): CategoryDeletePayload! 928 929 # Set category displays 930 # 931 # Required permission: Category:write 932 # 933 # Requires field selected: userErrors 934 # 935 # Arguments 936 # input: (self-explanatory) 937 (: CategoryDisplaysSetInput!): CategoryDisplaysSetPayload! 938 939 # Unset category displays 940 # 941 # Required permission: Category:write 942 # 943 # Requires field selected: userErrors 944 # 945 # Arguments 946 # input: (self-explanatory) 947 (: CategoryDisplaysUnsetInput!): CategoryDisplaysUnsetPayload! 948 949 # Sort displays of a category 950 # 951 # Required permission: Category:write 952 # 953 # Requires field selected: userErrors 954 # 955 # Arguments 956 # input: (self-explanatory) 957 (: CategoryDisplaysSortInput!): CategoryDisplaysSortPayload! 958 959 # Create a voucher 960 # 961 # Required permission: Voucher:write 962 # 963 # Requires field selected: userErrors 964 # 965 # Arguments 966 # input: (self-explanatory) 967 (: VoucherCreateInput!): VoucherCreatePayload! 968 969 # Update a voucher 970 # 971 # Required permission: Voucher:write 972 # 973 # Requires field selected: userErrors 974 # 975 # Arguments 976 # id: (self-explanatory) 977 # externalId: (self-explanatory) 978 # input: (self-explanatory) 979 (: Int, : String, : VoucherUpdateInput!): VoucherUpdatePayload! 980 981 # Delete a voucher 982 # 983 # Required permission: Voucher:write 984 # 985 # Requires field selected: userErrors 986 # 987 # Arguments 988 # id: (self-explanatory) 989 # externalId: (self-explanatory) 990 (: Int, : String): VoucherDeletePayload! 991 992 # Add an action to a voucher 993 # 994 # Required permission: Voucher:write 995 # 996 # Requires field selected: userErrors 997 # 998 # Arguments 999 # input: (self-explanatory) 1000 (: VoucherActionCreateInput!): VoucherActionCreatePayload! 1001 1002 # Update an action of voucher 1003 # 1004 # Required permission: Voucher:write 1005 # 1006 # Requires field selected: userErrors 1007 # 1008 # Arguments 1009 # id: (self-explanatory) 1010 # input: (self-explanatory) 1011 (: Int!, : VoucherActionUpdateInput!): VoucherActionUpdatePayload! 1012 1013 # Delete an action from voucher 1014 # 1015 # Required permission: Voucher:write 1016 # 1017 # Requires field selected: userErrors 1018 # 1019 # Arguments 1020 # id: (self-explanatory) 1021 (: Int!): VoucherActionDeletePayload! 1022 1023 # Update a DTC order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1024 # 1025 # Required permission: Order:write 1026 # 1027 # Requires field selected: userErrors 1028 # 1029 # Arguments 1030 # order: (self-explanatory) 1031 # input: (self-explanatory) 1032 (: OrderInput!, : DirectToConsumerOrderUpdateInput!): DirectToConsumerOrderUpdatePayload! 1033 1034 # Update a wholesale order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1035 # 1036 # Required permission: Order:write 1037 # 1038 # Requires field selected: userErrors 1039 # 1040 # Arguments 1041 # order: (self-explanatory) 1042 # input: (self-explanatory) 1043 (: OrderInput!, : WholesaleOrderUpdateInput!): WholesaleOrderUpdatePayload! 1044 1045 # Cancel a DTC order 1046 # 1047 # Required permission: Order:write 1048 # 1049 # Requires field selected: userErrors 1050 # 1051 # Arguments 1052 # order: (self-explanatory) 1053 # input: (self-explanatory) 1054 (: OrderInput!, : DirectToConsumerOrderCancelInput!): DirectToConsumerOrderCancelPayload! 1055 1056 # Cancel a Wholesale order 1057 # 1058 # Required permission: Order:write 1059 # 1060 # Requires field selected: userErrors 1061 # 1062 # Arguments 1063 # order: (self-explanatory) 1064 # input: (self-explanatory) 1065 (: OrderInput!, : WholesaleOrderCancelInput!): WholesaleOrderCancelPayload! 1066 1067 # Confirm an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1068 # 1069 # Required permission: Order:write 1070 # 1071 # Requires field selected: userErrors 1072 # 1073 # Arguments 1074 # input: (self-explanatory) 1075 (: OrderConfirmInput!): OrderConfirmPayload! 1076 1077 # Add a note to an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1078 # 1079 # Required permission: OrderHistory:write 1080 # 1081 # Requires field selected: userErrors 1082 # 1083 # Arguments 1084 # input: (self-explanatory) 1085 (: OrderNoteAddInput): OrderNoteAddPayload! 1086 1087 # Add an external link attachment to a wholesale order 1088 # 1089 # Required permission: OrderHistory:write 1090 # 1091 # Requires field selected: userErrors 1092 # 1093 # Arguments 1094 # input: (self-explanatory) 1095 (: OrderLinkAttachmentInput): OrderLinkAttachmentAddPayload! 1096 1097 # Lock/unlock an order. 1098 # If a user does not have permission to lock/unlock the order and tries to modify a locked order, it will be forbidden. 1099 # This includes creating a shipment and order allocation. 1100 # 1101 # Required permission: Order.isLocked:write 1102 # 1103 # Requires field selected: userErrors 1104 # 1105 # Arguments 1106 # input: (self-explanatory) 1107 (: OrdersLockInput!): OrdersLockPayload! 1108 1109 # Allocate stock for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1110 # 1111 # Required permission: Order:write 1112 # 1113 # Requires field selected: userErrors 1114 # 1115 # Arguments 1116 # input: (self-explanatory) 1117 (: OrderAllocateInput!): OrderAllocatePayload! 1118 1119 # Capture an order 1120 # 1121 # Required permission: Order:write 1122 # 1123 # Requires field selected: userErrors 1124 # 1125 # Arguments 1126 # order: (self-explanatory) 1127 (: OrderInput!): OrderCapturePayload! 1128 1129 # Create a shipment for an order that isn't locked (unless the user has 'Order.isLocked:write' permission) or on hold 1130 # 1131 # Required permission: Shipment:write 1132 # 1133 # Requires field selected: userErrors 1134 # 1135 # Arguments 1136 # input: (self-explanatory) 1137 (: ShipmentCreateInput!): ShipmentCreatePayload! 1138 1139 # Update a shipment 1140 # 1141 # Required permission: Shipment:write 1142 # 1143 # Requires field selected: userErrors 1144 # 1145 # Arguments 1146 # id: (self-explanatory) 1147 # externalId: (self-explanatory) 1148 # input: (self-explanatory) 1149 (: Int, : String, : ShipmentUpdateInput!): ShipmentUpdatePayload! 1150 1151 # Complete a shipment 1152 # 1153 # Required permission: Shipment:write 1154 # 1155 # Requires field selected: userErrors 1156 # 1157 # Arguments 1158 # id: (self-explanatory) 1159 # externalId: (self-explanatory) 1160 # input: (self-explanatory) 1161 (: Int, : String, : ShipmentCompleteInput): ShipmentCompletePayload 1162 1163 # Delete a shipment from an order that isn't locked (unless the user has 'Order.isLocked:write' permission) 1164 # 1165 # Required permission: Shipment:write 1166 # 1167 # Requires field selected: userErrors 1168 # 1169 # Arguments 1170 # id: (self-explanatory) 1171 # externalId: (self-explanatory) 1172 (: Int, : String): ShipmentDeletePayload! 1173 1174 # Capture a shipment. 1175 # Even if the mutation returns empty userErrors, a capture itself can be failed because a failed attempt is also saved 1176 # into a payment history entry and the mutation shows it in paymentHistoryEntry. 1177 # The best way to check whether the capture succeeded is to check shipment.isCaptured. 1178 # 1179 # If the order was captured before and there is some amount not assigned to any shipment, it will be set to 1180 # the shipment. If the total shipment amount is assigned that way, no real capture will be made. In this case, 1181 # paymentHistoryEntry cannot be created and it will be null, but the shipment field will be non-empty. 1182 # 1183 # Required permission: Payment.capture:write 1184 # 1185 # Requires field selected: userErrors 1186 # 1187 # Arguments 1188 # id: (self-explanatory) 1189 # externalId: (self-explanatory) 1190 (: Int, : String): ShipmentCapturePayload! 1191 1192 # Release remaining order authorization after all shipments are captured in order to release customer's funds that will 1193 # not be captured. Amount that will be released is authorization amount - total captured amount across all shipments. 1194 # 1195 # Required permission: Payment.cancel:write 1196 # 1197 # Requires field selected: userErrors 1198 # 1199 # Arguments 1200 # order: (self-explanatory) 1201 (: OrderInput): ReleaseRemainingOrderAuthorizationPayload! 1202 1203 # Create a return 1204 # 1205 # Required permission: Return:write 1206 # 1207 # Requires field selected: userErrors 1208 # 1209 # Arguments 1210 # input: (self-explanatory) 1211 (: ReturnCreateInput!): ReturnCreatePayload! 1212 1213 # Complete a return 1214 # 1215 # Required permission: Return:write 1216 # 1217 # Requires field selected: userErrors 1218 # 1219 # Arguments 1220 # id: (self-explanatory) 1221 # externalId: (self-explanatory) 1222 # input: (self-explanatory) 1223 (: Int, : String, : ReturnCompleteInput! = {sendEmail: false}): ReturnCompletePayload! 1224 1225 # Uncomplete a return 1226 # 1227 # Required permission: Return:write 1228 # 1229 # Requires field selected: userErrors 1230 # 1231 # Arguments 1232 # id: (self-explanatory) 1233 # externalId: (self-explanatory) 1234 (: Int, : String): ReturnUncompletePayload! 1235 1236 # Delete a return 1237 # 1238 # Required permission: Return:write 1239 # 1240 # Requires field selected: userErrors 1241 # 1242 # Arguments 1243 # id: (self-explanatory) 1244 # externalId: (self-explanatory) 1245 (: Int, : String): ReturnDeletePayload! 1246 1247 # Create a warehouse 1248 # 1249 # Required permission: Warehouse:write 1250 # 1251 # Requires field selected: userErrors 1252 # 1253 # Arguments 1254 # input: (self-explanatory) 1255 (: WarehouseCreateInput!): WarehouseCreatePayload! 1256 1257 # Update a warehouse 1258 # 1259 # Required permission: Warehouse:write 1260 # 1261 # Requires field selected: userErrors 1262 # 1263 # Arguments 1264 # id: (self-explanatory) 1265 # externalId: (self-explanatory) 1266 # input: (self-explanatory) 1267 (: Int!, : String, : WarehouseUpdateInput!): WarehouseUpdatePayload! 1268 1269 # Add payment information to an invoice 1270 # 1271 # Required permission: Invoice:write 1272 # 1273 # Requires field selected: userErrors 1274 # 1275 # Arguments 1276 # input: (self-explanatory) 1277 (: RegisterInvoicePaymentInput!): InvoicePaymentRegisterPayload! 1278 1279 # Only to mark as fully paid 1280 # 1281 # Required permission: Invoice:write 1282 # 1283 # Requires field selected: userErrors 1284 # 1285 # Arguments 1286 # input: (self-explanatory) 1287 (: MarkInvoiceAsPaidInput!): MarkInvoiceAsPaidPayload! 1288 1289 # Add item to the wishlist 1290 # 1291 # Required permission: Wishlist:write 1292 # 1293 # Requires field selected: userErrors 1294 # 1295 # Arguments 1296 # input: (self-explanatory) 1297 (: WishlistItemAddInput!): WishlistItemAddPayload! 1298 1299 # Remove item from the wishlist 1300 # 1301 # Required permission: Wishlist:write 1302 # 1303 # Requires field selected: userErrors 1304 # 1305 # Arguments 1306 # input: (self-explanatory) 1307 (: WishlistItemRemoveInput!): WishlistItemRemovePayload! 1308 1309 # Set ID conversion rules 1310 # 1311 # Required permission: IdConversion:write 1312 # 1313 # Requires field selected: userErrors 1314 # 1315 # Arguments 1316 # input: (self-explanatory) 1317 (: [IdConversionSetInput!]!): IdConversionsSetPayload! 1318 1319 # Unset ID conversion rules 1320 # 1321 # Required permission: IdConversion:write 1322 # 1323 # Requires field selected: userErrors 1324 # 1325 # Arguments 1326 # input: (self-explanatory) 1327 (: [IdConversionUnsetInput!]!): IdConversionsUnsetPayload! 1328 1329 # Add subvouchers to a voucher, a lightweight way to have 1330 # multiple individually tracked codes for a single voucher configuration 1331 # 1332 # Required permission: Voucher:write 1333 # 1334 # Requires field selected: userErrors 1335 # 1336 # Arguments 1337 # input: (self-explanatory) 1338 (: SubvouchersCreateInput!): SubvouchersPayload! 1339 1340 # Update a single subvoucher 1341 # 1342 # Required permission: Voucher:write 1343 # 1344 # Requires field selected: userErrors 1345 # 1346 # Arguments 1347 # id: (self-explanatory) 1348 # input: (self-explanatory) 1349 (: Int!, : SubvoucherUpdateInput!): SubvoucherPayload! 1350 1351 # Completely remove a subvoucher 1352 # 1353 # Required permission: Voucher:write 1354 # 1355 # Requires field selected: userErrors 1356 # 1357 # Arguments 1358 # id: (self-explanatory) 1359 (: Int!): SubvoucherRemovePayload! 1360 1361 # Add a size localization, which will define, how sizes in specified size charts are presented in given stores and 1362 # countries 1363 # 1364 # Required permission: SizeChart:write 1365 # 1366 # Requires field selected: userErrors 1367 # 1368 # Arguments 1369 # input: (self-explanatory) 1370 (: SizeLocalizationCreateInput!): SizeLocalizationCreatePayload! 1371 1372 # Update a size localization 1373 # 1374 # Required permission: SizeChart:write 1375 # 1376 # Requires field selected: userErrors 1377 # 1378 # Arguments 1379 # sizeLocalization: (self-explanatory) 1380 # input: (self-explanatory) 1381 ( 1382 : SizeLocalizationInput!, 1383 : SizeLocalizationUpdateInput! 1384 ): SizeLocalizationUpdatePayload! 1385 1386 # Set localized names for sizes in a given size localization 1387 # 1388 # Required permission: SizeChart:write 1389 # 1390 # Requires field selected: userErrors 1391 # 1392 # Arguments 1393 # sizeLocalization: (self-explanatory) 1394 # input: (self-explanatory) 1395 (: SizeLocalizationInput!, : [LocalizedSizesSetInput!]!): LocalizedSizesSetPayload! 1396 1397 # Subscribe to receive events of specified object and change types 1398 # 1399 # Required permission: Event:write 1400 # 1401 # Requires field selected: userErrors 1402 # 1403 # Arguments 1404 # input: (self-explanatory) 1405 (: [EventListenerSetInput!]!): EventListenerSetPayload! 1406 1407 # Unsubscribe from given object and change types. 1408 # It will result in deleting all queued events of these types. 1409 # 1410 # Required permission: Event:write 1411 # 1412 # Requires field selected: userErrors 1413 # 1414 # Arguments 1415 # input: (self-explanatory) 1416 (: [EventListenerUnsetInput!]!): EventListenerUnsetPayload! 1417 1418 # Confirm the given events. 1419 # It means they were processed on your side and they are no longer needed. 1420 # It is an essential mechanism to clean the events queue. 1421 # Limit is 200 events per call. 1422 # 1423 # Required permission: Event:write 1424 # 1425 # Requires field selected: userErrors 1426 # 1427 # Arguments 1428 # input: (self-explanatory) 1429 (: EventsConfirmInput!): EventsConfirmPayload! 1430 1431 # Required permission: MediaBatch:write 1432 # 1433 # Arguments 1434 # input: (self-explanatory) 1435 (: MediaBatchCreateInput!): MediaBatchCreatePayload! 1436 1437 }
link Required by
This element is not required by anyone