OBJECT
Query
The main queries are here, click to expand
link GraphQL Schema definition
1 type Query { 2 # Get single account data. 3 # 4 # Required permission: Account:read 5 # 6 # Store restrictions apply. 7 # 8 # Arguments 9 # id: (self-explanatory) 10 # externalId: (self-explanatory) 11 (: Int, : String): Account 12 13 # Get collection of accounts. 14 # 15 # Required permission: Account:read 16 # 17 # Limit must be in range 1 - 200 18 # 19 # Store restrictions apply. 20 # 21 # Arguments 22 # where: (self-explanatory) 23 # sort: (self-explanatory) 24 # limit: (self-explanatory) 25 # page: (self-explanatory) 26 (: AccountFilter, : [AccountSort!] = [id_ASC], : Int = 20, : Int = 1): [Account!]! 27 28 # Get accounts connection 29 # 30 # Required permission: Account:read 31 # 32 # Limit must be in range 1 - 200 33 # 34 # Store restrictions apply. 35 # 36 # Arguments 37 # where: (self-explanatory) 38 # sort: (self-explanatory) 39 # first: (self-explanatory) 40 # after: (self-explanatory) 41 # last: (self-explanatory) 42 # before: (self-explanatory) 43 (: AccountFilter, : [AccountSort!] = [id_ASC], : Int, : String, : Int, : String): AccountConnection! 44 45 # Get single admin user 46 # 47 # Required permission: AdminUser:read 48 # 49 # Arguments 50 # id: (self-explanatory) 51 (: Int): AdminUser 52 53 # Get collection of admin users 54 # 55 # Required permission: AdminUser:read 56 # 57 # Limit must be in range 1 - 200 58 # 59 # Arguments 60 # where: (self-explanatory) 61 # sort: (self-explanatory) 62 # limit: (self-explanatory) 63 # page: (self-explanatory) 64 (: AdminUserFilter, : [AdminUserSort!] = [id_ASC], : Int = 20, : Int = 1): [AdminUser!]! 65 66 # Get single affiliate data 67 # 68 # Required permission: Affiliate:read 69 # 70 # Store restrictions apply. 71 # 72 # Arguments 73 # id: (self-explanatory) 74 (: Int!): Affiliate 75 76 # Get collection of affiliates 77 # 78 # Required permission: Affiliate:read 79 # 80 # Limit must be in range 1 - 200 81 # 82 # Store restrictions apply. 83 # 84 # Arguments 85 # where: (self-explanatory) 86 # sort: (self-explanatory) 87 # limit: (self-explanatory) 88 # page: (self-explanatory) 89 (: AffiliateFilter, : [AffiliateSort!] = [id_ASC], : Int = 20, : Int = 1): [Affiliate!]! 90 91 # Get collection of allocation rules 92 # 93 # Required permission: AllocationRule:read 94 # 95 # Limit must be in range 1 - 200 96 # 97 # Arguments 98 # where: (self-explanatory) 99 # sort: (self-explanatory) 100 # limit: (self-explanatory) 101 # page: (self-explanatory) 102 (: AllocationRuleFilter = {isActive: true}, : [AllocationRuleSort!] = [id_ASC], : Int = 20, : Int): [AllocationRule!]! 103 104 # Get all defined attribute types 105 # 106 # Required permission: Attribute:read 107 # 108 # All elements are always returned 109 # 110 # Arguments 111 # where: (self-explanatory) 112 (: AttributeTypeFilter): [AttributeType!]! 113 114 # Get single brand data 115 # 116 # Required permission: Brand:read 117 # 118 # Store restrictions apply. 119 # 120 # Arguments 121 # id: (self-explanatory) 122 # externalId: (self-explanatory) 123 (: Int, : String): Brand 124 125 # Get collection of brands 126 # 127 # Required permission: Brand:read 128 # 129 # Limit must be in range 1 - 200 130 # 131 # Store restrictions apply. 132 # 133 # Arguments 134 # where: (self-explanatory) 135 # sort: (self-explanatory) 136 # limit: (self-explanatory) 137 # page: (self-explanatory) 138 (: BrandFilter, : [BrandSort!] = [id_ASC], : Int = 20, : Int = 1): [Brand!]! 139 140 # Get collection of brick and mortars 141 # 142 # Required permission: BrickAndMortar:read 143 # 144 # Limit must be in range 1 - 200 145 # 146 # Arguments 147 # where: (self-explanatory) 148 # sort: (self-explanatory) 149 # limit: (self-explanatory) 150 # page: (self-explanatory) 151 (: BrickAndMortarFilter, : [BrickAndMortarSort!] = [id_ASC], : Int = 20, : Int = 1): [BrickAndMortar!]! 152 153 # Get single bundle data 154 # 155 # Required permission: Bundle:read 156 # 157 # Arguments 158 # id: (self-explanatory) 159 (: Int!): Bundle 160 161 # Get collection of bundles 162 # 163 # Required permission: Bundle:read 164 # 165 # Limit must be in range 1 - 200 166 # 167 # Arguments 168 # where: (self-explanatory) 169 # sort: (self-explanatory) 170 # limit: (self-explanatory) 171 # page: (self-explanatory) 172 (: BundleFilter, : [BundleSort!] = [id_ASC], : Int = 20, : Int = 1): [Bundle!]! 173 174 # Get collection of bundles in the Relay connection form 175 # 176 # Required permission: Bundle:read 177 # 178 # Limit must be in range 1 - 200 179 # 180 # Arguments 181 # where: (self-explanatory) 182 # sort: (self-explanatory) 183 # first: (self-explanatory) 184 # after: (self-explanatory) 185 # last: (self-explanatory) 186 # before: (self-explanatory) 187 (: BundleFilter, : [BundleSort!] = [id_ASC], : Int, : String, : Int, : String): BundleConnection! 188 189 # Required permission: TaxRule:read 190 # 191 # Requires field selected: userErrors 192 # 193 # Arguments 194 # input: (self-explanatory) 195 (: OrderTaxesInput!): OrderTaxesPayload! 196 197 # Get campaigns 198 # 199 # Required permission: Campaign:read 200 # 201 # Limit must be in range 1 - 200 202 # 203 # Store restrictions apply. 204 # 205 # Arguments 206 # where: (self-explanatory) 207 # sort: (self-explanatory) 208 # limit: (self-explanatory) 209 # page: (self-explanatory) 210 (: CampaignFilter, : [CampaignSort!] = [id_DESC], : Int = 20, : Int = 1): [Campaign!]! 211 212 # Get collection of campaigns in the Relay connection form 213 # 214 # Required permission: Campaign:read 215 # 216 # Limit must be in range 1 - 200 217 # 218 # Store restrictions apply. 219 # 220 # Arguments 221 # where: (self-explanatory) 222 # sort: (self-explanatory) 223 # first: (self-explanatory) 224 # after: (self-explanatory) 225 # last: (self-explanatory) 226 # before: (self-explanatory) 227 ( 228 : CampaignFilter, 229 : [CampaignSort!] = [id_DESC], 230 : Int, 231 : String, 232 : Int, 233 : String 234 ): CampaignConnection! 235 236 # Get categories 237 # 238 # Required permission: Category:read 239 # 240 # Limit must be in range 1 - 200 241 # 242 # Store restrictions apply. 243 # 244 # Arguments 245 # where: (self-explanatory) 246 # sort: (self-explanatory) 247 # limit: (self-explanatory) 248 # page: (self-explanatory) 249 (: CategoryFilter, : [CategorySort!] = [customOrder_ASC], : Int = 20, : Int = 1): [Category!]! 250 251 # Get single collection data 252 # 253 # Required permission: Collection:read 254 # 255 # Arguments 256 # id: (self-explanatory) 257 # externalId: (self-explanatory) 258 (: Int, : String): Collection 259 260 # Get list of collections by any criteria 261 # 262 # Required permission: Collection:read 263 # 264 # Limit must be in range 1 - 200 265 # 266 # Arguments 267 # where: (self-explanatory) 268 # sort: (self-explanatory) 269 # limit: (self-explanatory) 270 # page: (self-explanatory) 271 (: CollectionFilter, : [CollectionSort!] = [id_ASC], : Int = 20, : Int = 1): [Collection!]! 272 273 # Get list of collections in the Relay connection form 274 # 275 # Required permission: Collection:read 276 # 277 # Limit must be in range 1 - 200 278 # 279 # Arguments 280 # where: (self-explanatory) 281 # sort: (self-explanatory) 282 # first: (self-explanatory) 283 # after: (self-explanatory) 284 # last: (self-explanatory) 285 # before: (self-explanatory) 286 ( 287 : CollectionFilter, 288 : [CollectionSort!] = [id_ASC], 289 : Int, 290 : String, 291 : Int, 292 : String 293 ): CollectionConnection! 294 295 # Get continents to group countries 296 # 297 # Required permission: Country:read 298 # 299 # Limit is optional 300 # 301 # Arguments 302 # where: (self-explanatory) 303 # sort: (self-explanatory) 304 # limit: (self-explanatory) 305 # page: (self-explanatory) 306 (: ContinentFilter, : [ContinentSort!] = [name_ASC], : Int, : Int): [Continent!]! 307 308 # Get collection of countries by any criteria 309 # 310 # Required permission: Country:read 311 # 312 # Limit is optional 313 # 314 # Arguments 315 # where: (self-explanatory) 316 # sort: (self-explanatory) 317 # limit: (self-explanatory) 318 # page: (self-explanatory) 319 (: CountryFilter, : [CountrySort!] = [name_ASC], : Int, : Int): [Country!]! 320 321 # Get single currency data 322 # 323 # Required permission: Currency:read 324 # 325 # Arguments 326 # id: (self-explanatory) 327 # externalId: (self-explanatory) 328 (: Int, : String): Currency 329 330 # Get collection of currencies by any criteria 331 # 332 # Required permission: Currency:read 333 # 334 # Limit is optional 335 # 336 # Arguments 337 # where: (self-explanatory) 338 # sort: (self-explanatory) 339 # limit: (self-explanatory) 340 # page: (self-explanatory) 341 (: CurrencyFilter, : [CurrencySort!] = [id_ASC], : Int, : Int): [Currency!]! 342 343 # Get single customer data 344 # 345 # Required permission: Customer:read 346 # 347 # Store restrictions apply. 348 # 349 # Arguments 350 # id: (self-explanatory) 351 # externalId: (self-explanatory) 352 (: Int, : String): Customer 353 354 # Get collection of customers by any criteria 355 # 356 # Required permission: Customer:read 357 # 358 # Limit must be in range 1 - 200 359 # 360 # Store restrictions apply. 361 # 362 # Arguments 363 # where: (self-explanatory) 364 # sort: (self-explanatory) 365 # limit: (self-explanatory) 366 # page: (self-explanatory) 367 (: CustomerFilter, : [CustomerSort!] = [id_ASC], : Int = 20, : Int = 1): [Customer!]! 368 369 # Get collection of customers in the Relay connection form 370 # 371 # Required permission: Customer:read 372 # 373 # Limit must be in range 1 - 200 374 # 375 # Store restrictions apply. 376 # 377 # Arguments 378 # where: (self-explanatory) 379 # sort: (self-explanatory) 380 # first: (self-explanatory) 381 # after: (self-explanatory) 382 # last: (self-explanatory) 383 # before: (self-explanatory) 384 ( 385 : CustomerFilter, 386 : [CustomerSort!] = [id_ASC], 387 : Int, 388 : String, 389 : Int, 390 : String 391 ): CustomerConnection! 392 393 # Get single delivery window data 394 # 395 # Required permission: DeliveryWindow:read 396 # 397 # Store restrictions apply. 398 # 399 # Arguments 400 # id: (self-explanatory) 401 # externalId: (self-explanatory) 402 (: Int, : String): DeliveryWindow 403 404 # Get delivery windows by any criteria 405 # 406 # Required permission: DeliveryWindow:read 407 # 408 # Limit must be in range 1 - 200 409 # 410 # Store restrictions apply. 411 # 412 # Arguments 413 # where: (self-explanatory) 414 # sort: (self-explanatory) 415 # limit: (self-explanatory) 416 # page: (self-explanatory) 417 (: DeliveryWindowFilter, : [DeliveryWindowSort!] = [id_ASC], : Int = 20, : Int = 1): [DeliveryWindow!]! 418 419 # Get single voucher data 420 # 421 # Required permission: Voucher:read 422 # 423 # Store restrictions apply. 424 # 425 # Arguments 426 # id: (self-explanatory) 427 # externalId: (self-explanatory) 428 (: Int, : String): Voucher 429 430 # Get collection of vouchers 431 # 432 # Required permission: Voucher:read 433 # 434 # Limit must be in range 1 - 200 435 # 436 # Store restrictions apply. 437 # 438 # Arguments 439 # where: (self-explanatory) 440 # sort: (self-explanatory) 441 # limit: (self-explanatory) 442 # page: (self-explanatory) 443 (: VoucherFilter, : [VoucherSort!] = [priority_ASC, id_ASC], : Int = 20, : Int = 1): [Voucher!]! 444 445 # Get single display data 446 # 447 # Required permission: Display:read 448 # 449 # Store restrictions apply. 450 # 451 # Arguments 452 # id: (self-explanatory) 453 (: Int!): Display 454 455 # Get collection of displays by any criteria 456 # 457 # Required permission: Display:read 458 # 459 # Limit must be in range 1 - 200 460 # 461 # Store restrictions apply. 462 # 463 # Arguments 464 # where: (self-explanatory) 465 # sort: (self-explanatory) 466 # limit: (self-explanatory) 467 # page: (self-explanatory) 468 (: DisplayFilter, : [DisplaySort!] = [id_ASC], : Int = 20, : Int = 1): [Display!]! 469 470 # Get collection of display items by any criteria 471 # 472 # Required permission: Display:read 473 # 474 # Limit must be in range 1 - 200 475 # 476 # Store restrictions apply. 477 # 478 # Arguments 479 # where: (self-explanatory) 480 # sort: (self-explanatory) 481 # limit: (self-explanatory) 482 # page: (self-explanatory) 483 (: DisplayItemFilter, : [DisplayItemSort!] = [customOrder_ASC], : Int = 20, : Int = 1): [DisplayItem!]! 484 485 # Get collection of displays in the Relay connection form 486 # 487 # Required permission: Display:read 488 # 489 # Limit must be in range 1 - 200 490 # 491 # Store restrictions apply. 492 # 493 # Arguments 494 # where: (self-explanatory) 495 # sort: (self-explanatory) 496 # first: (self-explanatory) 497 # after: (self-explanatory) 498 # last: (self-explanatory) 499 # before: (self-explanatory) 500 (: DisplayFilter, : [DisplaySort!] = [id_ASC], : Int, : String, : Int, : String): DisplayConnection! 501 502 # Get a list of document templates 503 # 504 # Required permission: DocumentTemplate:read 505 # 506 # Limit must be in range 1 - 200 507 # 508 # Store restrictions apply. 509 # 510 # Arguments 511 # where: (self-explanatory) 512 # sort: (self-explanatory) 513 # limit: (self-explanatory) 514 # page: (self-explanatory) 515 (: DocumentTemplateFilter, : [DocumentTemplateSort!] = [id_DESC], : Int = 20, : Int = 1): [DocumentTemplate!]! 516 517 # Required permission: Folder:read 518 # 519 # Arguments 520 # id: (self-explanatory) 521 # externalId: (self-explanatory) 522 (: Int, : String): Folder 523 524 # Get folders 525 # 526 # Required permission: Folder:read 527 # 528 # Limit must be in range 1 - 200 529 # 530 # Arguments 531 # where: (self-explanatory) 532 # sort: (self-explanatory) 533 # limit: (self-explanatory) 534 # page: (self-explanatory) 535 (: FolderFilter, : [FolderSort!] = [customOrder_ASC], : Int = 20, : Int = 1): [Folder!]! 536 537 # Get Gift Certificate Generators 538 # 539 # Required permission: GiftCertificateGenerator:read 540 # 541 # Limit must be in range 1 - 200 542 # 543 # Store restrictions apply. 544 # 545 # Arguments 546 # where: (self-explanatory) 547 # sort: (self-explanatory) 548 # limit: (self-explanatory) 549 # page: (self-explanatory) 550 ( 551 : GiftCertificateGeneratorFilter, 552 : [GiftCertificateGeneratorSort!] = [id_ASC], 553 : Int = 20, 554 : Int = 1 555 ): [GiftCertificateGenerator!]! 556 557 # Get all users for which tokens were generated 558 # 559 # Required permission: admin 560 # 561 # Limit must be in range 1 - 200 562 # 563 # Arguments 564 # where: (self-explanatory) 565 # sort: (self-explanatory) 566 # limit: (self-explanatory) 567 # page: (self-explanatory) 568 (: GraphQLAccessFilter, : [GraphQLAccessSort!] = [id_DESC], : Int = 20, : Int = 1): [GraphQLAccess!]! 569 570 # Get all integration names so that one can select it instead of typing 571 # 572 # Required permission: admin 573 # 574 # All elements are always returned 575 : [String!]! 576 577 # Get all ID conversion table entries 578 # 579 # Required permission: IdConversion:read 580 # 581 # Limit must be in range 1 - 200 582 # 583 # Arguments 584 # where: (self-explanatory) 585 # sort: (self-explanatory) 586 # limit: (self-explanatory) 587 # page: (self-explanatory) 588 (: IdConversionEntryFilter, : [IdConversionEntrySort!] = [id_ASC], : Int = 20, : Int = 1): [IdConversionEntry!]! 589 590 # Get single invoice data 591 # 592 # Required permission: Invoice:read 593 # 594 # Store restrictions apply. 595 # 596 # Arguments 597 # id: (self-explanatory) 598 # externalId: (self-explanatory) 599 (: Int, : String): Invoice 600 601 # Get all invoices 602 # 603 # Required permission: Invoice:read 604 # 605 # Limit must be in range 1 - 200 606 # 607 # Store restrictions apply. 608 # 609 # Arguments 610 # where: (self-explanatory) 611 # sort: (self-explanatory) 612 # limit: (self-explanatory) 613 # page: (self-explanatory) 614 (: InvoiceFilter, : [InvoiceSort!] = [number_DESC, id_ASC], : Int = 20, : Int = 1): [Invoice!]! 615 616 # Get collection of invoices in the Relay connection form 617 # 618 # Required permission: Invoice:read 619 # 620 # Limit must be in range 1 - 200 621 # 622 # Store restrictions apply. 623 # 624 # Arguments 625 # where: (self-explanatory) 626 # sort: (self-explanatory) 627 # first: (self-explanatory) 628 # after: (self-explanatory) 629 # last: (self-explanatory) 630 # before: (self-explanatory) 631 (: InvoiceFilter, : [InvoiceSort!] = [number_DESC, id_ASC], : Int, : String, : Int, : String): InvoiceConnection! 632 633 # Get invoice payments 634 # 635 # Required permission: Invoice:read 636 # 637 # Limit must be in range 1 - 200 638 # 639 # Arguments 640 # where: (self-explanatory) 641 # sort: (self-explanatory) 642 # limit: (self-explanatory) 643 # page: (self-explanatory) 644 (: InvoicePaymentFilter, : [InvoicePaymentSort!] = [id_ASC], : Int = 20, : Int = 1): [InvoicePayment!]! 645 646 # Get all known languages 647 # 648 # Required permission: Language:read 649 # 650 # Limit is optional 651 # 652 # Arguments 653 # where: (self-explanatory) 654 # sort: (self-explanatory) 655 # limit: (self-explanatory) 656 # page: (self-explanatory) 657 (: LanguageFilter, : [LanguageSort!] = [code_ASC, id_ASC], : Int, : Int): [Language!]! 658 659 # List translatable fields for each object type. 660 # Includes dynamic attributes along their objects, and mapped ones under MappedAttribute type. 661 # 662 # Required permission: Translation:read 663 # 664 # All elements are always returned 665 # 666 # Arguments 667 # where: (self-explanatory) 668 (: TranslatableFieldsFilter): [TranslatableObjectFields!]! 669 670 # Get a list of mapped (non-dynamic) attributes 671 # 672 # Required permission: Attribute:read 673 # 674 # Limit must be in range 1 - 200 675 # 676 # Arguments 677 # where: (self-explanatory) 678 # sort: (self-explanatory) 679 # limit: (self-explanatory) 680 # page: (self-explanatory) 681 (: MappedAttributeFilter, : [MappedAttributeSort!] = [id_ASC], : Int = 20, : Int = 1): [MappedAttribute!]! 682 683 # Get single market data 684 # 685 # Required permission: Market:read 686 # 687 # Store restrictions apply. 688 # 689 # Arguments 690 # id: (self-explanatory) 691 # externalId: (self-explanatory) 692 (: Int, : String): Market 693 694 # Get all markets 695 # 696 # Required permission: Market:read 697 # 698 # Limit is optional 699 # 700 # Store restrictions apply. 701 # 702 # Arguments 703 # where: (self-explanatory) 704 # sort: (self-explanatory) 705 # limit: (self-explanatory) 706 # page: (self-explanatory) 707 (: MarketFilter, : [MarketSort!] = [id_ASC], : Int, : Int): [Market!]! 708 709 # Get single measurementChart 710 # 711 # Required permission: MeasurementChart:read 712 # 713 # Arguments 714 # id: (self-explanatory) 715 (: Int!): MeasurementChart 716 717 # Get all measurementCharts 718 # 719 # Required permission: MeasurementChart:read 720 # 721 # Limit is optional 722 # 723 # Arguments 724 # where: (self-explanatory) 725 # sort: (self-explanatory) 726 # limit: (self-explanatory) 727 # page: (self-explanatory) 728 (: MeasurementChartFilter, : [MeasurementChartSort!] = [id_ASC], : Int, : Int): [MeasurementChart!]! 729 730 # Get all media sizes available for ProductMedia 731 # 732 # Required permission: none 733 # 734 # All elements are always returned 735 : [MediaSize!]! 736 737 # Get all newsletter subscriptions 738 # 739 # Required permission: NewsletterSubscription:read 740 # 741 # Limit must be in range 1 - 200 742 # 743 # Store restrictions apply. 744 # 745 # Arguments 746 # where: (self-explanatory) 747 # sort: (self-explanatory) 748 # limit: (self-explanatory) 749 # page: (self-explanatory) 750 ( 751 : NewsletterSubscriptionFilter, 752 : [NewsletterSubscriptionSort!] = [id_ASC], 753 : Int = 20, 754 : Int = 1 755 ): [NewsletterSubscription!]! 756 757 # Get single order data 758 # 759 # Required permission: Order:read 760 # 761 # Store restrictions apply. 762 # 763 # Arguments 764 # id: (self-explanatory) 765 # number: (self-explanatory) 766 # externalId: (self-explanatory) 767 (: String, : Int, : String): Order 768 769 # Get all orders 770 # 771 # Required permission: Order:read 772 # 773 # Limit must be in range 1 - 100 774 # 775 # Store restrictions apply. 776 # 777 # Arguments 778 # where: (self-explanatory) 779 # sort: (self-explanatory) 780 # limit: (self-explanatory) 781 # page: (self-explanatory) 782 (: OrderFilter, : [OrderSort!] = [number_DESC], : Int = 20, : Int = 1): [Order!]! 783 784 # Get collection of orders in the Relay connection form 785 # 786 # Required permission: Order:read 787 # 788 # Limit must be in range 1 - 100 789 # 790 # Store restrictions apply. 791 # 792 # Arguments 793 # where: (self-explanatory) 794 # sort: (self-explanatory) 795 # first: (self-explanatory) 796 # after: (self-explanatory) 797 # last: (self-explanatory) 798 # before: (self-explanatory) 799 (: OrderFilter, : [OrderSort!] = [number_DESC], : Int, : String, : Int, : String): OrderConnection! 800 801 # Get all permission names 802 # 803 # Required permission: admin 804 # 805 # All elements are always returned 806 : [String!]! 807 808 # Get payment history 809 # 810 # Required permission: PaymentHistory:read 811 # 812 # Limit must be in range 1 - 200 813 # 814 # Arguments 815 # where: (self-explanatory) 816 # sort: (self-explanatory) 817 # limit: (self-explanatory) 818 # page: (self-explanatory) 819 ( 820 : PaymentHistoryEntryFilter, 821 : [PaymentHistoryEntrySort!] = [id_DESC], 822 : Int = 20, 823 : Int = 1 824 ): [PaymentHistoryEntry!]! 825 826 # Get payment terms 827 # 828 # Required permission: PaymentTerms:read 829 # 830 # Limit is optional 831 # 832 # Store restrictions apply. 833 # 834 # Arguments 835 # where: (self-explanatory) 836 # sort: (self-explanatory) 837 # limit: (self-explanatory) 838 # page: (self-explanatory) 839 (: PaymentTermsFilter, : [PaymentTermsSort!] = [id_ASC], : Int, : Int): [PaymentTerms!]! 840 841 # Get single pricelist data 842 # 843 # Required permission: Pricelist:read 844 # 845 # Store restrictions apply. 846 # 847 # Arguments 848 # id: (self-explanatory) 849 # externalId: (self-explanatory) 850 (: Int, : String): Pricelist 851 852 # Get collection of pricelists by any criteria 853 # 854 # Required permission: Pricelist:read 855 # 856 # Limit must be in range 1 - 200 857 # 858 # Store restrictions apply. 859 # 860 # Arguments 861 # where: (self-explanatory) 862 # sort: (self-explanatory) 863 # limit: (self-explanatory) 864 # page: (self-explanatory) 865 (: PricelistFilter, : [PricelistSort!] = [id_ASC], : Int = 20, : Int = 1): [Pricelist!]! 866 867 # Get single price alteration data 868 # 869 # Required permission: Price:read 870 # 871 # Store restrictions apply. 872 # 873 # Arguments 874 # id: (self-explanatory) 875 (: Int!): PriceAlteration 876 877 # Get price alterations 878 # 879 # Required permission: Price:read 880 # 881 # All elements are always returned 882 # 883 # Store restrictions apply. 884 # 885 # Arguments 886 # where: (self-explanatory) 887 # sort: (self-explanatory) 888 (: PriceAlterationFilter, : [PriceAlterationSort!]): [PriceAlteration!]! 889 890 # Get single product data 891 # 892 # Required permission: Product:read 893 # 894 # Arguments 895 # id: (self-explanatory) 896 # externalId: (self-explanatory) 897 (: Int, : String): Product 898 899 # Get collection of products by any criteria 900 # 901 # Required permission: Product:read 902 # 903 # Limit must be in range 1 - 200 904 # 905 # Arguments 906 # where: (self-explanatory) 907 # sort: (self-explanatory) 908 # limit: (self-explanatory) 909 # page: (self-explanatory) 910 (: ProductFilter, : [ProductSort!] = [id_ASC], : Int = 20, : Int = 1): [Product!]! 911 912 # Get collection of products in the Relay connection form 913 # 914 # Required permission: Product:read 915 # 916 # Limit must be in range 1 - 200 917 # 918 # Arguments 919 # where: (self-explanatory) 920 # sort: (self-explanatory) 921 # first: (self-explanatory) 922 # after: (self-explanatory) 923 # last: (self-explanatory) 924 # before: (self-explanatory) 925 (: ProductFilter, : [ProductSort!] = [id_ASC], : Int, : String, : Int, : String): ProductConnection! 926 927 # Get collection of product sizes by any criteria 928 # 929 # Required permission: ProductSize:read 930 # 931 # Limit must be in range 1 - 200 932 # 933 # Arguments 934 # where: (self-explanatory) 935 # sort: (self-explanatory) 936 # limit: (self-explanatory) 937 # page: (self-explanatory) 938 (: ProductSizeFilter, : [ProductSizeSort!] = [id_ASC], : Int = 20, : Int = 1): [ProductSize!]! 939 940 # Get collection of product sizes in the Relay connection form 941 # 942 # Required permission: ProductSize:read 943 # 944 # Limit must be in range 1 - 200 945 # 946 # Arguments 947 # where: (self-explanatory) 948 # sort: (self-explanatory) 949 # first: (self-explanatory) 950 # after: (self-explanatory) 951 # last: (self-explanatory) 952 # before: (self-explanatory) 953 ( 954 : ProductSizeFilter, 955 : [ProductSizeSort!] = [id_ASC], 956 : Int, 957 : String, 958 : Int, 959 : String 960 ): ProductSizeConnection! 961 962 # Get single product variant data 963 # 964 # Required permission: ProductVariant:read 965 # 966 # Arguments 967 # id: (self-explanatory) 968 # externalId: (self-explanatory) 969 (: Int, : String): ProductVariant 970 971 # Get collection of product variants by any criteria 972 # 973 # Required permission: ProductVariant:read 974 # 975 # Limit must be in range 1 - 200 976 # 977 # Arguments 978 # where: (self-explanatory) 979 # sort: (self-explanatory) 980 # limit: (self-explanatory) 981 # page: (self-explanatory) 982 (: ProductVariantFilter, : [ProductVariantSort!] = [id_ASC], : Int = 20, : Int = 1): [ProductVariant!]! 983 984 # Get collection of product variants in the Relay connection form 985 # 986 # Required permission: ProductVariant:read 987 # 988 # Limit must be in range 1 - 200 989 # 990 # Arguments 991 # where: (self-explanatory) 992 # sort: (self-explanatory) 993 # first: (self-explanatory) 994 # after: (self-explanatory) 995 # last: (self-explanatory) 996 # before: (self-explanatory) 997 ( 998 : ProductVariantFilter, 999 : [ProductVariantSort!] = [id_ASC], 1000 : Int, 1001 : String, 1002 : Int, 1003 : String 1004 ): ProductVariantConnection! 1005 1006 # Get single return data 1007 # 1008 # Required permission: Return:read 1009 # 1010 # Store restrictions apply. 1011 # 1012 # Arguments 1013 # id: (self-explanatory) 1014 # externalId: (self-explanatory) 1015 (: Int, : String): Return 1016 1017 # Get collection of returns by any criteria 1018 # 1019 # Required permission: Return:read 1020 # 1021 # Limit must be in range 1 - 200 1022 # 1023 # Store restrictions apply. 1024 # 1025 # Arguments 1026 # where: (self-explanatory) 1027 # sort: (self-explanatory) 1028 # limit: (self-explanatory) 1029 # page: (self-explanatory) 1030 (: ReturnFilter, : [ReturnSort!] = [id_ASC], : Int = 20, : Int = 1): [Return!]! 1031 1032 # Get collection of returns in the Relay connection form 1033 # 1034 # Required permission: Return:read 1035 # 1036 # Limit must be in range 1 - 200 1037 # 1038 # Store restrictions apply. 1039 # 1040 # Arguments 1041 # where: (self-explanatory) 1042 # sort: (self-explanatory) 1043 # first: (self-explanatory) 1044 # after: (self-explanatory) 1045 # last: (self-explanatory) 1046 # before: (self-explanatory) 1047 (: ReturnFilter, : [ReturnSort!] = [id_ASC], : Int, : String, : Int, : String): ReturnConnection! 1048 1049 # Get single sales representative 1050 # 1051 # Required permission: SalesRepresentative:read 1052 # 1053 # Arguments 1054 # id: (self-explanatory) 1055 # externalId: (self-explanatory) 1056 (: Int, : String): SalesRepresentative 1057 1058 # Get collection of sales representatives 1059 # 1060 # Required permission: SalesRepresentative:read 1061 # 1062 # Limit must be in range 1 - 200 1063 # 1064 # Arguments 1065 # where: (self-explanatory) 1066 # sort: (self-explanatory) 1067 # limit: (self-explanatory) 1068 # page: (self-explanatory) 1069 ( 1070 : SalesRepresentativeFilter, 1071 : [SalesRepresentativeSort!] = [id_ASC], 1072 : Int = 20, 1073 : Int = 1 1074 ): [SalesRepresentative!]! 1075 1076 # Get single shipment data 1077 # 1078 # Required permission: Shipment:read 1079 # 1080 # Store restrictions apply. 1081 # 1082 # Arguments 1083 # id: (self-explanatory) 1084 # externalId: (self-explanatory) 1085 (: Int, : String): Shipment 1086 1087 # Get collection of shipments by any criteria 1088 # 1089 # Required permission: Shipment:read 1090 # 1091 # Limit must be in range 1 - 200 1092 # 1093 # Store restrictions apply. 1094 # 1095 # Arguments 1096 # where: (self-explanatory) 1097 # sort: (self-explanatory) 1098 # limit: (self-explanatory) 1099 # page: (self-explanatory) 1100 (: ShipmentFilter, : [ShipmentSort!] = [id_DESC], : Int = 20, : Int = 1): [Shipment!]! 1101 1102 # Get collection of shipments in Relay connection form 1103 # 1104 # Required permission: Shipment:read 1105 # 1106 # Limit must be in range 1 - 200 1107 # 1108 # Store restrictions apply. 1109 # 1110 # Arguments 1111 # where: (self-explanatory) 1112 # sort: (self-explanatory) 1113 # first: (self-explanatory) 1114 # after: (self-explanatory) 1115 # last: (self-explanatory) 1116 # before: (self-explanatory) 1117 ( 1118 : ShipmentFilter, 1119 : [ShipmentSort!] = [id_DESC], 1120 : Int, 1121 : String, 1122 : Int, 1123 : String 1124 ): ShipmentConnection! 1125 1126 # Get shipping options 1127 # 1128 # Required permission: ShippingOption:read 1129 # 1130 # Limit must be in range 1 - 200 1131 # 1132 # Store restrictions apply. 1133 # 1134 # Arguments 1135 # where: (self-explanatory) 1136 # sort: (self-explanatory) 1137 # limit: (self-explanatory) 1138 # page: (self-explanatory) 1139 (: ShippingOptionFilter, : [ShippingOptionSort!] = [name_ASC, id_ASC], : Int = 20, : Int = 1): [ShippingOption!]! 1140 1141 # Get shipping terms 1142 # 1143 # Required permission: ShippingTerms:read 1144 # 1145 # Limit is optional 1146 # 1147 # Store restrictions apply. 1148 # 1149 # Arguments 1150 # where: (self-explanatory) 1151 # sort: (self-explanatory) 1152 # limit: (self-explanatory) 1153 # page: (self-explanatory) 1154 (: ShippingTermsFilter, : [ShippingTermsSort!] = [id_ASC], : Int, : Int): [ShippingTerms!]! 1155 1156 # Get single size chart 1157 # 1158 # Required permission: SizeChart:read 1159 # 1160 # Arguments 1161 # id: (self-explanatory) 1162 # externalId: (self-explanatory) 1163 (: Int, : String): SizeChart 1164 1165 # Get collection of size charts by any criteria 1166 # 1167 # Required permission: SizeChart:read 1168 # 1169 # Limit is optional 1170 # 1171 # Arguments 1172 # where: (self-explanatory) 1173 # sort: (self-explanatory) 1174 # limit: (self-explanatory) 1175 # page: (self-explanatory) 1176 (: SizeChartFilter, : [SizeChartSort!] = [id_ASC], : Int, : Int): [SizeChart!]! 1177 1178 # Get single size localization 1179 # 1180 # Required permission: SizeChart:read 1181 # 1182 # Arguments 1183 # id: (self-explanatory) 1184 (: Int!): SizeLocalization 1185 1186 # Get collection of size localizations by any criteria 1187 # 1188 # Required permission: SizeChart:read 1189 # 1190 # Limit is optional 1191 # 1192 # Arguments 1193 # where: (self-explanatory) 1194 # sort: (self-explanatory) 1195 # limit: (self-explanatory) 1196 # page: (self-explanatory) 1197 (: SizeLocalizationFilter, : [SizeLocalizationSort!] = [id_ASC], : Int, : Int): [SizeLocalization!]! 1198 1199 # Get single store data 1200 # 1201 # Required permission: Store:read 1202 # 1203 # Store restrictions apply. 1204 # 1205 # Arguments 1206 # id: (self-explanatory) 1207 (: Int!): Store 1208 1209 # Get collection of stores by any criteria 1210 # 1211 # Required permission: Store:read 1212 # 1213 # Limit is optional 1214 # 1215 # Store restrictions apply. 1216 # 1217 # Arguments 1218 # where: (self-explanatory) 1219 # sort: (self-explanatory) 1220 # limit: (self-explanatory) 1221 # page: (self-explanatory) 1222 (: StoreFilter, : [StoreSort!] = [id_ASC], : Int, : Int): [Store!]! 1223 1224 # Get collection of store plugins by any criteria 1225 # 1226 # Required permission: StorePlugin:read 1227 # 1228 # Limit is optional 1229 # 1230 # Store restrictions apply. 1231 # 1232 # Arguments 1233 # where: (self-explanatory) 1234 # sort: (self-explanatory) 1235 # limit: (self-explanatory) 1236 # page: (self-explanatory) 1237 (: StorePluginFilter, : [StorePluginSort!] = [id_ASC], : Int, : Int): [StorePlugin!]! 1238 1239 # Get collection of subscription plans by any criteria 1240 # 1241 # Required permission: SubscriptionPlan:read 1242 # 1243 # Limit must be in range 1 - 200 1244 # 1245 # Store restrictions apply. 1246 # 1247 # Arguments 1248 # where: (self-explanatory) 1249 # sort: (self-explanatory) 1250 # limit: (self-explanatory) 1251 # page: (self-explanatory) 1252 (: SubscriptionPlanFilter, : [SubscriptionPlanSort!] = [naturalSort_ASC, id_ASC], : Int = 20, : Int = 1): [SubscriptionPlan!]! 1253 1254 # Get defined tax classes 1255 # 1256 # Required permission: TaxClass:read 1257 # 1258 # Limit is optional 1259 # 1260 # Arguments 1261 # where: (self-explanatory) 1262 # sort: (self-explanatory) 1263 # limit: (self-explanatory) 1264 # page: (self-explanatory) 1265 (: TaxClassFilter, : [TaxClassSort!] = [id_ASC], : Int, : Int): [TaxClass!]! 1266 1267 # Get defined tax groups 1268 # 1269 # Required permission: TaxRule:read 1270 # 1271 # Limit is optional 1272 # 1273 # Arguments 1274 # where: (self-explanatory) 1275 # sort: (self-explanatory) 1276 # limit: (self-explanatory) 1277 # page: (self-explanatory) 1278 (: TaxGroupFilter, : [TaxGroupSort!] = [id_ASC], : Int, : Int): [TaxGroup!]! 1279 1280 # Get defined tax rules 1281 # 1282 # Required permission: TaxRule:read 1283 # 1284 # Limit must be in range 1 - 200 1285 # 1286 # Arguments 1287 # where: (self-explanatory) 1288 # sort: (self-explanatory) 1289 # limit: (self-explanatory) 1290 # page: (self-explanatory) 1291 (: TaxRuleFilter, : [TaxRuleSort!] = [id_ASC], : Int = 20, : Int = 1): [TaxRule!]! 1292 1293 # Get data of currently authenticated user 1294 # 1295 # Required permission: none 1296 : GraphQLUser! 1297 1298 # Get single warehouse 1299 # 1300 # Required permission: Warehouse:read 1301 # 1302 # Arguments 1303 # id: (self-explanatory) 1304 # externalId: (self-explanatory) 1305 (: Int, : String): Warehouse 1306 1307 # Get collection of warehouses 1308 # 1309 # Required permission: Warehouse:read 1310 # 1311 # Limit must be in range 1 - 200 1312 # 1313 # Arguments 1314 # where: (self-explanatory) 1315 # sort: (self-explanatory) 1316 # limit: (self-explanatory) 1317 # page: (self-explanatory) 1318 (: WarehouseFilter, : [WarehouseSort!] = [customSort_ASC, id_ASC], : Int = 20, : Int = 1): [Warehouse!]! 1319 1320 # Get collection of warehouse deliveries in Relay connection form 1321 # 1322 # Required permission: StockChange:read 1323 # 1324 # Limit must be in range 1 - 200 1325 # 1326 # Arguments 1327 # where: (self-explanatory) 1328 # sort: (self-explanatory) 1329 # first: (self-explanatory) 1330 # after: (self-explanatory) 1331 # last: (self-explanatory) 1332 # before: (self-explanatory) 1333 ( 1334 : StockChangeFilter, 1335 : [StockChangeSort!] = [id_DESC], 1336 : Int, 1337 : String, 1338 : Int, 1339 : String 1340 ): StockChangeConnection! 1341 1342 # Get collection of stock change lines 1343 # 1344 # Required permission: StockChange:read 1345 # 1346 # Limit must be in range 1 - 200 1347 # 1348 # Arguments 1349 # where: (self-explanatory) 1350 # sort: (self-explanatory) 1351 # limit: (self-explanatory) 1352 # page: (self-explanatory) 1353 (: StockChangeLineFilter, : [StockChangeLineSort!] = [id_ASC], : Int = 20, : Int = 1): [StockChangeLine!]! 1354 1355 # Required permission: StockChange:read 1356 # 1357 # Limit must be in range 1 - 200 1358 # 1359 # Arguments 1360 # where: (self-explanatory) 1361 # sort: (self-explanatory) 1362 # first: (self-explanatory) 1363 # after: (self-explanatory) 1364 # last: (self-explanatory) 1365 # before: (self-explanatory) 1366 ( 1367 : StockChangeLineFilter, 1368 : [StockChangeLineSort!] = [id_ASC], 1369 : Int, 1370 : String, 1371 : Int, 1372 : String 1373 ): StockChangeLineConnection! 1374 1375 # Get a list of subscriptions 1376 # 1377 # Required permission: Subscription:read 1378 # 1379 # Limit must be in range 1 - 200 1380 # 1381 # Store restrictions apply. 1382 # 1383 # Arguments 1384 # where: (self-explanatory) 1385 # sort: (self-explanatory) 1386 # limit: (self-explanatory) 1387 # page: (self-explanatory) 1388 (: SubscriptionFilter, : [SubscriptionSort!] = [id_DESC], : Int = 20, : Int = 1): [Subscription!]! 1389 1390 # Get a list of subscription contracts 1391 # 1392 # Required permission: Subscription:read 1393 # 1394 # Limit must be in range 1 - 200 1395 # 1396 # Store restrictions apply. 1397 # 1398 # Arguments 1399 # where: (self-explanatory) 1400 # sort: (self-explanatory) 1401 # limit: (self-explanatory) 1402 # page: (self-explanatory) 1403 ( 1404 : SubscriptionContractFilter, 1405 : [SubscriptionContractSort!] = [id_DESC], 1406 : Int = 20, 1407 : Int = 1 1408 ): [SubscriptionContract!]! 1409 1410 # Get available rate limits 1411 # 1412 # Required permission: none 1413 # 1414 # All elements are always returned 1415 # 1416 # Arguments 1417 # where: (self-explanatory) 1418 (: RateLimitFilter): [RateLimit!]! 1419 1420 # Get the counter(s) for any object type 1421 # 1422 # Required permission: none 1423 : Counters! 1424 1425 # Calculates how much discount the provided vouchers give to the provided selection 1426 # 1427 # Required permission: Voucher:read 1428 # 1429 # Arguments 1430 # input: (self-explanatory) 1431 (: CalculateVoucherInput!): CalculateVouchersPayload! 1432 1433 # Get subvouchers 1434 # 1435 # Required permission: Voucher:read 1436 # 1437 # Limit must be in range 1 - 200 1438 # 1439 # Arguments 1440 # where: (self-explanatory) 1441 # sort: (self-explanatory) 1442 # limit: (self-explanatory) 1443 # page: (self-explanatory) 1444 (: SubvoucherFilter, : [SubvoucherSort!] = [id_ASC], : Int = 20, : Int = 1): [Subvoucher!]! 1445 1446 # Get a list of purchase orders 1447 # 1448 # Required permission: PurchaseOrder:read 1449 # 1450 # Limit must be in range 1 - 200 1451 # 1452 # Arguments 1453 # where: (self-explanatory) 1454 # sort: (self-explanatory) 1455 # limit: (self-explanatory) 1456 # page: (self-explanatory) 1457 (: PurchaseOrderFilter, : [PurchaseOrderSort!] = [id_DESC], : Int = 20, : Int = 1): [PurchaseOrder!]! 1458 1459 # Get collection of purchase orders in the Relay connection form 1460 # 1461 # Required permission: PurchaseOrder:read 1462 # 1463 # Limit must be in range 1 - 200 1464 # 1465 # Arguments 1466 # where: (self-explanatory) 1467 # sort: (self-explanatory) 1468 # first: (self-explanatory) 1469 # after: (self-explanatory) 1470 # last: (self-explanatory) 1471 # before: (self-explanatory) 1472 ( 1473 : PurchaseOrderFilter, 1474 : [PurchaseOrderSort!] = [id_DESC], 1475 : Int, 1476 : String, 1477 : Int, 1478 : String 1479 ): PurchaseOrderConnection! 1480 1481 # Get a list of purchase order deliveries 1482 # 1483 # Required permission: PurchaseOrderDelivery:read 1484 # 1485 # Limit must be in range 1 - 200 1486 # 1487 # Arguments 1488 # where: (self-explanatory) 1489 # sort: (self-explanatory) 1490 # limit: (self-explanatory) 1491 # page: (self-explanatory) 1492 ( 1493 : PurchaseOrderDeliveryFilter, 1494 : [PurchaseOrderDeliverySort!] = [id_DESC], 1495 : Int = 20, 1496 : Int = 1 1497 ): [PurchaseOrderDelivery!]! 1498 1499 # Get collection of purchase order deliveries in the Relay connection form 1500 # 1501 # Required permission: PurchaseOrderDelivery:read 1502 # 1503 # Limit must be in range 1 - 200 1504 # 1505 # Arguments 1506 # where: (self-explanatory) 1507 # sort: (self-explanatory) 1508 # first: (self-explanatory) 1509 # after: (self-explanatory) 1510 # last: (self-explanatory) 1511 # before: (self-explanatory) 1512 ( 1513 : PurchaseOrderDeliveryFilter, 1514 : [PurchaseOrderDeliverySort!] = [id_DESC], 1515 : Int, 1516 : String, 1517 : Int, 1518 : String 1519 ): PurchaseOrderDeliveryConnection! 1520 1521 # Get single supplier data by ID 1522 # 1523 # Required permission: Supplier:read 1524 # 1525 # Arguments 1526 # id: (self-explanatory) 1527 (: Int!): Supplier 1528 1529 # Get a list of suppliers 1530 # 1531 # Required permission: Supplier:read 1532 # 1533 # Limit must be in range 1 - 200 1534 # 1535 # Arguments 1536 # where: (self-explanatory) 1537 # sort: (self-explanatory) 1538 # limit: (self-explanatory) 1539 # page: (self-explanatory) 1540 (: SupplierFilter, : [SupplierSort!] = [name_ASC], : Int = 20, : Int = 1): [Supplier!]! 1541 1542 # Required permission: Event:read 1543 # 1544 # All elements are always returned 1545 # 1546 # Arguments 1547 # where: (self-explanatory) 1548 (: EventListenerFilter): [EventListener!]! 1549 1550 # Get N oldest events. 1551 # After they are processed, they must be confirmed by calling the confirmEvents mutation. 1552 # Otherwise, the repetitive calls of the query will be returning the same events. 1553 # You can filter by object type and change type for all types of events, and additionally 1554 # filter by store and market for events that are related to them. 1555 # 1556 # Required permission: Event:read 1557 # 1558 # Limit must be in range 1 - 200 1559 # 1560 # Store restrictions apply. 1561 # 1562 # Arguments 1563 # where: (self-explanatory) 1564 # limit: (self-explanatory) 1565 (: EventFilter, : Int! = 20): [Event!]! 1566 1567 # Required permission: MediaBatch:read 1568 # 1569 # Arguments 1570 # queueId: (self-explanatory) 1571 (: String!): MediaBatch 1572 1573 }
link Required by
This element is not required by anyone