@nautical-commerce/graphql-schema 1.57.0-8-gdfd8dff58 → 1.57.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/nautical/schema.graphql +1328 -457
  2. package/package.json +1 -1
@@ -1051,10 +1051,16 @@ type Query {
1051
1051
  """End of the period to filter results"""
1052
1052
  endDate: Date
1053
1053
 
1054
+ """Vendor type of the payout"""
1055
+ vendorType: String @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
1056
+
1054
1057
  """Payout ID"""
1055
1058
  payoutId: ID
1056
1059
  ): VendorPayoutReport
1057
1060
  vendorPayoutList(
1061
+ """Vendor type of the payout"""
1062
+ vendorType: String
1063
+
1058
1064
  """Vendor ID"""
1059
1065
  vendorId: ID
1060
1066
  ): SingleVendorPayoutReport
@@ -1545,6 +1551,13 @@ type Query {
1545
1551
  """End of the period to filter results"""
1546
1552
  endDate: Date!
1547
1553
  ): InReportMarketplacePayoutsSummaryType
1554
+ insightsMarketplaceAffiliatePayoutsSummary(
1555
+ """Beginning of the period to filter results"""
1556
+ startDate: Date!
1557
+
1558
+ """End of the period to filter results"""
1559
+ endDate: Date!
1560
+ ): InReportMarketplaceAffiliatePayoutsSummaryType @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
1548
1561
  insightsMarketplaceTaxSummary(
1549
1562
  """Beginning of the period to filter results"""
1550
1563
  startDate: Date!
@@ -1781,6 +1794,7 @@ type Query {
1781
1794
  ): VoucherCountableConnection
1782
1795
  designerdata(name: String): DesignerDataType
1783
1796
  designerdatalist: [DesignerDataType!]!
1797
+ branding: BrandingType! @deprecated(reason: "This will be removed on October 25, 2024")
1784
1798
 
1785
1799
  """Token nexessary for connecting to the embedded integration platform"""
1786
1800
  integrationEmbeddingToken: String
@@ -1814,6 +1828,8 @@ type Query {
1814
1828
 
1815
1829
  """List of all tax rates available from tax gateway."""
1816
1830
  taxTypes: [TaxType!]!
1831
+ coredata(name: String): CoreDataType @deprecated(reason: "This will be removed on October 25, 2024")
1832
+ coredatalist: [CoreDataType!]! @deprecated(reason: "This will be removed on October 25, 2024")
1817
1833
 
1818
1834
  """Look up a checkout by token."""
1819
1835
  checkout(
@@ -1857,6 +1873,27 @@ type Query {
1857
1873
  last: Int
1858
1874
  ): CheckoutLineCountableConnection
1859
1875
 
1876
+ """List of webhook jobs"""
1877
+ channels(
1878
+ """Filtering options for webhook jobs"""
1879
+ filter: ChannelFilterInput
1880
+
1881
+ """Sort webhook jobs"""
1882
+ sortBy: ChannelSortingInput
1883
+
1884
+ """Return the elements in the list that come before the specified cursor."""
1885
+ before: String
1886
+
1887
+ """Return the elements in the list that come after the specified cursor."""
1888
+ after: String
1889
+
1890
+ """Return the first n elements from the list."""
1891
+ first: Int
1892
+
1893
+ """Return the last n elements from the list."""
1894
+ last: Int
1895
+ ): ChannelCountableConnection @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
1896
+
1860
1897
  """List of the shop's attributes."""
1861
1898
  attributes(
1862
1899
  """Filtering options for attributes."""
@@ -1968,6 +2005,55 @@ type Query {
1968
2005
  id: ID!
1969
2006
  ): [AgreementSellers!]!
1970
2007
 
2008
+ """List of the shop's affiliates"""
2009
+ affiliates(
2010
+ """Filtering options for affiliates."""
2011
+ filter: AffiliateFilterInput
2012
+
2013
+ """Sort affiliates."""
2014
+ sortBy: UserSortingInput
2015
+
2016
+ """Return the elements in the list that come before the specified cursor."""
2017
+ before: String
2018
+
2019
+ """Return the elements in the list that come after the specified cursor."""
2020
+ after: String
2021
+
2022
+ """Return the first n elements from the list."""
2023
+ first: Int
2024
+
2025
+ """Return the last n elements from the list."""
2026
+ last: Int
2027
+ ): UserCountableConnection @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2028
+ affiliate(
2029
+ """ID of the affiliate you are querying"""
2030
+ id: ID
2031
+ ): OptimizedAffiliate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2032
+
2033
+ """List of affiliates' codes"""
2034
+ affiliateCodes(
2035
+ """Affiliate ID to get codes for"""
2036
+ id: ID!
2037
+
2038
+ """Filtering options for affiliate codes"""
2039
+ filter: AffiliateCodeFilterInput
2040
+
2041
+ """Sort affiliate codes"""
2042
+ sortBy: AffiliateCodeSortingInput
2043
+
2044
+ """Return the elements in the list that come before the specified cursor."""
2045
+ before: String
2046
+
2047
+ """Return the elements in the list that come after the specified cursor."""
2048
+ after: String
2049
+
2050
+ """Return the first n elements from the list."""
2051
+ first: Int
2052
+
2053
+ """Return the last n elements from the list."""
2054
+ last: Int
2055
+ ): AffiliateCodesCountableConnection @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2056
+
1971
2057
  """Returns address validation rules."""
1972
2058
  addressValidationRules(
1973
2059
  """Two-letter ISO 3166-1 country code."""
@@ -2494,9 +2580,22 @@ type User implements Node & ObjectWithMetadata {
2494
2580
  """Return the last n elements from the list."""
2495
2581
  last: Int
2496
2582
  ): WishlistCountableConnection
2583
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2497
2584
  seller: Seller
2585
+ hasMicrosite: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2586
+ micrositeId: ID @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2498
2587
  isAssignable: Boolean
2499
2588
 
2589
+ """Date of last affiliate referral."""
2590
+ lastReferral: DateTime @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2591
+
2592
+ """Date of last affiliate confirmed order."""
2593
+ lastOrder: DateTime @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2594
+ affiliateReferrals: Int @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2595
+ affiliateOrders: Int @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2596
+ affiliateEarnings: Money @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
2597
+ agreement: Agreement
2598
+
2500
2599
  """List of documents associated with the user."""
2501
2600
  documents: [Document!]!
2502
2601
 
@@ -3537,6 +3636,7 @@ type VendorPayout implements Node & ObjectWithMetadata {
3537
3636
  gateway: String!
3538
3637
  payout: Payout!
3539
3638
  seller: Seller
3639
+ affiliate: User
3540
3640
  currency: String!
3541
3641
  average: Decimal!
3542
3642
  discounts: Decimal!
@@ -3594,6 +3694,7 @@ type Payout implements Node & ObjectWithMetadata {
3594
3694
  endDate: String!
3595
3695
  status: PayoutStatus!
3596
3696
  name: String
3697
+ vendorType: PayoutVendorType!
3597
3698
  currency: String!
3598
3699
  vendorPayouts(offset: Int, before: String, after: String, first: Int, last: Int): VendorPayoutCountableConnection!
3599
3700
  vendors: Int!
@@ -3625,6 +3726,15 @@ enum PayoutStatus {
3625
3726
  ERROR
3626
3727
  }
3627
3728
 
3729
+ """An enumeration."""
3730
+ enum PayoutVendorType {
3731
+ """Sellers"""
3732
+ SELLERS
3733
+
3734
+ """Affiliates"""
3735
+ AFFILIATES
3736
+ }
3737
+
3628
3738
  """An enumeration."""
3629
3739
  enum VendorPayoutStatus {
3630
3740
  """Paid"""
@@ -3742,6 +3852,8 @@ type Order implements Node & ObjectWithMetadata {
3742
3852
  displayGrossPrices: Boolean!
3743
3853
  customerNote: String!
3744
3854
  weight: Weight
3855
+ affiliate: User @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
3856
+ affiliateCode: AffiliateCodes @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
3745
3857
 
3746
3858
  """Data time when the order was imported from another platform."""
3747
3859
  importedAt: DateTime
@@ -3830,12 +3942,18 @@ type Order implements Node & ObjectWithMetadata {
3830
3942
  """Seller commission for the order"""
3831
3943
  sellerCommission: Money
3832
3944
 
3945
+ """Affiliate commission for the order"""
3946
+ affiliateCommission: Money @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
3947
+
3833
3948
  """Volume discount for the order"""
3834
3949
  volumeDiscount: TaxedMoney
3835
3950
 
3836
3951
  """Validation status for the order"""
3837
3952
  validationStatus: [ValidationStatus!]
3838
3953
 
3954
+ """Channel the order is associated with"""
3955
+ channel: Channel @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
3956
+
3839
3957
  """Latest bid made against the order."""
3840
3958
  currentBid: Bid @deprecated(reason: "This will be removed alongside bids and offers on November 21, 2024")
3841
3959
 
@@ -4845,6 +4963,7 @@ enum PermissionEnum {
4845
4963
  MANAGE_PAYOUTS
4846
4964
  MANAGE_PAYMENTS
4847
4965
  MANAGE_REFUNDS
4966
+ MANAGE_CHANNELS
4848
4967
  MANAGE_COLLECTIONS
4849
4968
  }
4850
4969
 
@@ -5440,61 +5559,83 @@ enum SaleTypeEnum {
5440
5559
  SPECIFIC_PRODUCT
5441
5560
  }
5442
5561
 
5443
- """Represents order fulfillment."""
5444
- type Fulfillment implements Node & ObjectWithMetadata {
5562
+ """Represents an affiliate code"""
5563
+ type AffiliateCodes implements Node {
5445
5564
  """The ID of the object"""
5446
5565
  id: ID!
5447
- fulfillmentOrder: Int!
5448
- relatedTo: Fulfillment
5449
- order: Order!
5566
+ externalId: String
5567
+ externalSource: String
5568
+ externalInventoryId: String
5450
5569
 
5451
- """Nautical order via order mapping"""
5452
- nauticalOrder: NauticalOrder
5453
- status: FulfillmentStatus!
5570
+ """The id of the affiliate that the code belongs to"""
5571
+ affiliate: User
5454
5572
 
5455
- """Fulfillment tracking company"""
5456
- trackingCompany: String
5573
+ """
5574
+ Number of times the code has been submitted (this includes when the customer did not complete an order)
5575
+ """
5576
+ uses: Int
5457
5577
 
5458
- """Fulfillment tracking number"""
5459
- trackingNumber: String
5578
+ """The new affiliate code"""
5579
+ code: String
5460
5580
 
5461
- """Fulfillment tracking url"""
5462
- trackingUrl: String
5463
- shippingLabelUrl: String
5464
- created: DateTime!
5465
- updated: DateTime!
5581
+ """Channel the code is associated with"""
5582
+ channel: Channel @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
5466
5583
 
5467
- """User who made the fulfillment. Requires MANAGE_STAFF permission."""
5468
- user: User
5584
+ """Whether or not the code is active"""
5585
+ isActive: Boolean
5586
+ createdAt: DateTime!
5587
+ updatedAt: DateTime!
5588
+ affiliateNauticalOrders(offset: Int, before: String, after: String, first: Int, last: Int): NauticalOrderCountableConnection!
5589
+ affiliateOrders(offset: Int, before: String, after: String, first: Int, last: Int): OrderCountableConnection!
5590
+ earnings: Money
5591
+ orders: Int
5592
+ }
5469
5593
 
5470
- """
5471
- List of private metadata items.Requires proper staff permissions to access.
5472
- """
5473
- privateMetadata: [MetadataItem!]!
5594
+ """Represents unique channel in Nautical."""
5595
+ type Channel implements Node {
5596
+ """The ID of the object"""
5597
+ id: ID!
5598
+ tenant: Tenant!
5599
+ createdAt: DateTime
5600
+ updatedAt: DateTime
5601
+ channel: String!
5602
+ affiliateCodes(offset: Int, before: String, after: String, first: Int, last: Int): AffiliateCodesCountableConnection!
5603
+ nauticalOrders(offset: Int, before: String, after: String, first: Int, last: Int): NauticalOrderCountableConnection!
5604
+ orders(offset: Int, before: String, after: String, first: Int, last: Int): OrderCountableConnection!
5605
+ }
5474
5606
 
5475
- """List of public metadata items. Can be accessed without permissions."""
5476
- metadata: [MetadataItem!]!
5607
+ type AffiliateCodesCountableConnection {
5608
+ """Pagination data for this connection."""
5609
+ pageInfo: PageInfo!
5610
+ edges: [AffiliateCodesCountableEdge!]!
5477
5611
 
5478
- """List of lines for the fulfillment."""
5479
- lines: [FulfillmentLine!]
5612
+ """A total count of items in the collection."""
5613
+ totalCount: Int
5614
+ }
5480
5615
 
5481
- """Seller who made the fulfillment."""
5482
- seller: Seller
5616
+ type AffiliateCodesCountableEdge {
5617
+ """The item at the end of the edge."""
5618
+ node: AffiliateCodes!
5483
5619
 
5484
- """User-friendly fulfillment status."""
5485
- statusDisplay: String
5620
+ """A cursor for use in pagination."""
5621
+ cursor: String!
5622
+ }
5486
5623
 
5487
- """Warehouse from fulfillment was fulfilled."""
5488
- warehouse: Warehouse
5624
+ type NauticalOrderCountableConnection {
5625
+ """Pagination data for this connection."""
5626
+ pageInfo: PageInfo!
5627
+ edges: [NauticalOrderCountableEdge!]!
5489
5628
 
5490
- """Sum of quantities across all lines."""
5491
- totalLinesQuantity: Int
5629
+ """A total count of items in the collection."""
5630
+ totalCount: Int
5631
+ }
5492
5632
 
5493
- """Total price across all quantities across all lines."""
5494
- totalLinesMoney: Money!
5633
+ type NauticalOrderCountableEdge {
5634
+ """The item at the end of the edge."""
5635
+ node: NauticalOrder!
5495
5636
 
5496
- """List of custom fields assigned to this fulfillment."""
5497
- customFields: [SelectedAttribute!]!
5637
+ """A cursor for use in pagination."""
5638
+ cursor: String!
5498
5639
  }
5499
5640
 
5500
5641
  """Represents a nautical order in the shop."""
@@ -5536,6 +5677,8 @@ type NauticalOrder implements Node & ObjectWithMetadata {
5536
5677
  displayGrossPrices: Boolean!
5537
5678
  customerNote: String!
5538
5679
  weight: Weight
5680
+ affiliate: User @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
5681
+ affiliateCode: AffiliateCodes @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
5539
5682
 
5540
5683
  """Data time when the order was imported from another platform."""
5541
5684
  importedAt: DateTime
@@ -5635,6 +5778,9 @@ type NauticalOrder implements Node & ObjectWithMetadata {
5635
5778
  """Returns True, if order requires shipping."""
5636
5779
  isShippingRequired: Boolean!
5637
5780
 
5781
+ """Channel the marketplace order is associated with"""
5782
+ channel: Channel @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
5783
+
5638
5784
  """Volume discount for the nautical order"""
5639
5785
  volumeDiscount: TaxedMoney
5640
5786
  shippingMethodName: String!
@@ -5732,42 +5878,32 @@ enum NauticalOrderSubStatus {
5732
5878
  OFFER_REJECTED
5733
5879
  }
5734
5880
 
5735
- enum OrderSubStatusEnum {
5736
- """In Review"""
5737
- IN_REVIEW
5738
-
5739
- """Quote Requested"""
5740
- QUOTE_REQUESTED
5741
-
5742
- """Awaiting Payment"""
5743
- AWAITING_PAYMENT
5744
-
5745
- """Complete"""
5746
- COMPLETE
5747
-
5748
- """Offer Approved"""
5749
- OFFER_APPROVED
5750
-
5751
- """Offer Cancelled"""
5752
- OFFER_CANCELLED
5881
+ """Represents order fulfillment."""
5882
+ type Fulfillment implements Node & ObjectWithMetadata {
5883
+ """The ID of the object"""
5884
+ id: ID!
5885
+ fulfillmentOrder: Int!
5886
+ relatedTo: Fulfillment
5887
+ order: Order!
5753
5888
 
5754
- """Offer Created"""
5755
- OFFER_CREATED
5889
+ """Nautical order via order mapping"""
5890
+ nauticalOrder: NauticalOrder
5891
+ status: FulfillmentStatus!
5756
5892
 
5757
- """Offer Expired"""
5758
- OFFER_EXPIRED
5893
+ """Fulfillment tracking company"""
5894
+ trackingCompany: String
5759
5895
 
5760
- """Offer Negotiating"""
5761
- OFFER_NEGOTIATING
5896
+ """Fulfillment tracking number"""
5897
+ trackingNumber: String
5762
5898
 
5763
- """Offer Rejected"""
5764
- OFFER_REJECTED
5765
- }
5899
+ """Fulfillment tracking url"""
5900
+ trackingUrl: String
5901
+ shippingLabelUrl: String
5902
+ created: DateTime!
5903
+ updated: DateTime!
5766
5904
 
5767
- """Represents order line of particular order."""
5768
- type OrderLine implements Node & ObjectWithMetadata {
5769
- """The ID of the object"""
5770
- id: ID!
5905
+ """User who made the fulfillment. Requires MANAGE_STAFF permission."""
5906
+ user: User
5771
5907
 
5772
5908
  """
5773
5909
  List of private metadata items.Requires proper staff permissions to access.
@@ -5776,54 +5912,136 @@ type OrderLine implements Node & ObjectWithMetadata {
5776
5912
 
5777
5913
  """List of public metadata items. Can be accessed without permissions."""
5778
5914
  metadata: [MetadataItem!]!
5779
- isLinePriceOverridden: Boolean!
5780
- unitPriceOverriddenNote: String
5781
- note: String
5782
- productName: String!
5783
- variantName: String!
5784
- productSku: String
5785
- isShippingRequired: Boolean!
5786
- quantityFulfilled: Int!
5787
- quantityDeclined: Int!
5788
- digitalContentUrl: DigitalContentUrl
5789
-
5790
- """The seller order for this line"""
5791
- order: Order!
5792
5915
 
5793
- """The nautical order line for this seller order line"""
5794
- nauticalOrderLine: NauticalOrderLine!
5916
+ """List of lines for the fulfillment."""
5917
+ lines: [FulfillmentLine!]
5795
5918
 
5796
- """The main thumbnail for the ordered product."""
5797
- thumbnail(
5798
- """Size of thumbnail."""
5799
- size: Int
5800
- ): Image
5919
+ """Seller who made the fulfillment."""
5920
+ seller: Seller
5801
5921
 
5802
- """Price of the single item in the order line."""
5803
- unitPrice: TaxedMoney
5922
+ """User-friendly fulfillment status."""
5923
+ statusDisplay: String
5804
5924
 
5805
- """Price of the order line."""
5806
- totalPrice: TaxedMoney
5925
+ """Warehouse from fulfillment was fulfilled."""
5926
+ warehouse: Warehouse
5807
5927
 
5808
- """
5809
- A purchased product variant. Note: this field may be null if the variant has been removed from stock at all.
5810
- """
5811
- variant: ProductVariant
5928
+ """Sum of quantities across all lines."""
5929
+ totalLinesQuantity: Int
5812
5930
 
5813
- """Product name in the customer's language."""
5814
- translatedProductName: String!
5931
+ """Total price across all quantities across all lines."""
5932
+ totalLinesPrice: Float @deprecated(reason: "This will be removed on October 25, 2024 and replaced by totalLinesMoney")
5815
5933
 
5816
- """Variant name in the customer's language."""
5817
- translatedVariantName: String!
5934
+ """Total price across all quantities across all lines."""
5935
+ totalLinesMoney: Money!
5818
5936
 
5819
- """List of allocations across warehouses."""
5820
- allocations: [Allocation!]
5937
+ """List of custom fields assigned to this fulfillment."""
5938
+ customFields: [SelectedAttribute!]!
5939
+ }
5821
5940
 
5822
- """The pricebook, if any, that changed the price of this line."""
5823
- priceBook: PriceBook
5941
+ """An enumeration."""
5942
+ enum FulfillmentStatus {
5943
+ """Fulfilled"""
5944
+ FULFILLED
5824
5945
 
5825
- """DEPRECATED: The number of items ordered on this order line."""
5826
- quantity: Int! @deprecated(reason: "Use the more explicit quantityOrdered instead. This will be removed on November 1, 2024")
5946
+ """Canceled"""
5947
+ CANCELED
5948
+
5949
+ """Returned"""
5950
+ RETURNED
5951
+
5952
+ """Declined"""
5953
+ DECLINED
5954
+
5955
+ """Return requested"""
5956
+ RETURN_REQUESTED
5957
+
5958
+ """Return authorized"""
5959
+ RETURN_AUTHORIZED
5960
+
5961
+ """Return declined"""
5962
+ RETURN_DECLINED
5963
+
5964
+ """Return received"""
5965
+ RETURN_RECEIVED
5966
+
5967
+ """Return complete"""
5968
+ RETURN_COMPLETE
5969
+
5970
+ """Return cancelled"""
5971
+ RETURN_CANCELLED
5972
+ }
5973
+
5974
+ """Represents line of the fulfillment."""
5975
+ type FulfillmentLine implements Node {
5976
+ """The ID of the object"""
5977
+ id: ID!
5978
+ quantity: Int!
5979
+ orderLine: OrderLine
5980
+
5981
+ """Reason customer requested item return."""
5982
+ returnReason: String
5983
+ }
5984
+
5985
+ """Represents order line of particular order."""
5986
+ type OrderLine implements Node & ObjectWithMetadata {
5987
+ """The ID of the object"""
5988
+ id: ID!
5989
+
5990
+ """
5991
+ List of private metadata items.Requires proper staff permissions to access.
5992
+ """
5993
+ privateMetadata: [MetadataItem!]!
5994
+
5995
+ """List of public metadata items. Can be accessed without permissions."""
5996
+ metadata: [MetadataItem!]!
5997
+ isLinePriceOverridden: Boolean!
5998
+ unitPriceOverriddenNote: String
5999
+ note: String
6000
+ productName: String!
6001
+ variantName: String!
6002
+ productSku: String
6003
+ isShippingRequired: Boolean!
6004
+ quantityFulfilled: Int!
6005
+ quantityDeclined: Int!
6006
+ digitalContentUrl: DigitalContentUrl
6007
+
6008
+ """The seller order for this line"""
6009
+ order: Order!
6010
+
6011
+ """The nautical order line for this seller order line"""
6012
+ nauticalOrderLine: NauticalOrderLine!
6013
+
6014
+ """The main thumbnail for the ordered product."""
6015
+ thumbnail(
6016
+ """Size of thumbnail."""
6017
+ size: Int
6018
+ ): Image
6019
+
6020
+ """Price of the single item in the order line."""
6021
+ unitPrice: TaxedMoney
6022
+
6023
+ """Price of the order line."""
6024
+ totalPrice: TaxedMoney
6025
+
6026
+ """
6027
+ A purchased product variant. Note: this field may be null if the variant has been removed from stock at all.
6028
+ """
6029
+ variant: ProductVariant
6030
+
6031
+ """Product name in the customer's language."""
6032
+ translatedProductName: String!
6033
+
6034
+ """Variant name in the customer's language."""
6035
+ translatedVariantName: String!
6036
+
6037
+ """List of allocations across warehouses."""
6038
+ allocations: [Allocation!]
6039
+
6040
+ """The pricebook, if any, that changed the price of this line."""
6041
+ priceBook: PriceBook
6042
+
6043
+ """DEPRECATED: The number of items ordered on this order line."""
6044
+ quantity: Int! @deprecated(reason: "Use the more explicit quantityOrdered instead. This will be removed on November 1, 2024")
5827
6045
 
5828
6046
  """The number of items ordered on this order line."""
5829
6047
  quantityOrdered: Int!
@@ -6191,6 +6409,38 @@ type ShippingZoneCountryArea implements Node {
6191
6409
  countryArea: CountryArea!
6192
6410
  }
6193
6411
 
6412
+ enum OrderSubStatusEnum {
6413
+ """In Review"""
6414
+ IN_REVIEW
6415
+
6416
+ """Quote Requested"""
6417
+ QUOTE_REQUESTED
6418
+
6419
+ """Awaiting Payment"""
6420
+ AWAITING_PAYMENT
6421
+
6422
+ """Complete"""
6423
+ COMPLETE
6424
+
6425
+ """Offer Approved"""
6426
+ OFFER_APPROVED
6427
+
6428
+ """Offer Cancelled"""
6429
+ OFFER_CANCELLED
6430
+
6431
+ """Offer Created"""
6432
+ OFFER_CREATED
6433
+
6434
+ """Offer Expired"""
6435
+ OFFER_EXPIRED
6436
+
6437
+ """Offer Negotiating"""
6438
+ OFFER_NEGOTIATING
6439
+
6440
+ """Offer Rejected"""
6441
+ OFFER_REJECTED
6442
+ }
6443
+
6194
6444
  enum OrderAction {
6195
6445
  """Represents the capture action."""
6196
6446
  CAPTURE
@@ -6940,50 +7190,6 @@ enum RefundTypeEnum {
6940
7190
  ORDERLINEREFUND
6941
7191
  }
6942
7192
 
6943
- """An enumeration."""
6944
- enum FulfillmentStatus {
6945
- """Fulfilled"""
6946
- FULFILLED
6947
-
6948
- """Canceled"""
6949
- CANCELED
6950
-
6951
- """Returned"""
6952
- RETURNED
6953
-
6954
- """Declined"""
6955
- DECLINED
6956
-
6957
- """Return requested"""
6958
- RETURN_REQUESTED
6959
-
6960
- """Return authorized"""
6961
- RETURN_AUTHORIZED
6962
-
6963
- """Return declined"""
6964
- RETURN_DECLINED
6965
-
6966
- """Return received"""
6967
- RETURN_RECEIVED
6968
-
6969
- """Return complete"""
6970
- RETURN_COMPLETE
6971
-
6972
- """Return cancelled"""
6973
- RETURN_CANCELLED
6974
- }
6975
-
6976
- """Represents line of the fulfillment."""
6977
- type FulfillmentLine implements Node {
6978
- """The ID of the object"""
6979
- id: ID!
6980
- quantity: Int!
6981
- orderLine: OrderLine
6982
-
6983
- """Reason customer requested item return."""
6984
- returnReason: String
6985
- }
6986
-
6987
7193
  """Extra fee associated with an order"""
6988
7194
  type OrderFee implements Node {
6989
7195
  """The ID of the object"""
@@ -7193,6 +7399,7 @@ type Agreement implements Node & ObjectWithMetadata {
7193
7399
  seoDescription: String
7194
7400
  slug: String!
7195
7401
  title: String!
7402
+ vendorType: AgreementVendorType!
7196
7403
 
7197
7404
  """Commission type"""
7198
7405
  commissionType: CommissionTypeEnum! @deprecated(reason: "Markup commissions will be removed on January 23, 2025.")
@@ -7205,6 +7412,7 @@ type Agreement implements Node & ObjectWithMetadata {
7205
7412
  If a markup commission is selected, this is the amount of the commission.
7206
7413
  """
7207
7414
  markupCommissionValue: Decimal @deprecated(reason: "Markup commissions will be removed on January 23, 2025.")
7415
+ agreementType: AgreementAgreementType!
7208
7416
  isActive: Boolean
7209
7417
 
7210
7418
  """List of granular commissions associated with the agreement."""
@@ -7223,6 +7431,15 @@ type Agreement implements Node & ObjectWithMetadata {
7223
7431
  metadata: [MetadataItem!]!
7224
7432
  }
7225
7433
 
7434
+ """An enumeration."""
7435
+ enum AgreementVendorType {
7436
+ """Seller"""
7437
+ SELLER
7438
+
7439
+ """Affiliate"""
7440
+ AFFILIATE
7441
+ }
7442
+
7226
7443
  enum CommissionTypeEnum {
7227
7444
  """Gross Price Commission"""
7228
7445
  MARKETPLACE
@@ -7239,6 +7456,15 @@ enum MarkupCommissionTypeEnum {
7239
7456
  PERCENTAGE
7240
7457
  }
7241
7458
 
7459
+ """An enumeration."""
7460
+ enum AgreementAgreementType {
7461
+ """Seller"""
7462
+ A_1
7463
+
7464
+ """Affiliate"""
7465
+ A_2
7466
+ }
7467
+
7242
7468
  """An agreement commission"""
7243
7469
  type AgreementCommission implements Node & ObjectWithMetadata {
7244
7470
  """The ID of the object"""
@@ -7316,6 +7542,7 @@ type Microsite implements Node & ObjectWithMetadata {
7316
7542
  name: String!
7317
7543
  slug: String!
7318
7544
  footerText: String
7545
+ affiliate: User @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
7319
7546
  seller: Seller
7320
7547
 
7321
7548
  """
@@ -8028,6 +8255,7 @@ input CustomerOrderFilterInput {
8028
8255
  paymentStatus: [PaymentChargeStatusEnum!]
8029
8256
  status: [OrderStatusFilter!]
8030
8257
  customer: String
8258
+ channel: String
8031
8259
  created: DateRangeInput
8032
8260
  metadata: MetadataFilterInput
8033
8261
  privateMetadata: MetadataFilterInput
@@ -8099,6 +8327,9 @@ enum OrderSortField {
8099
8327
  """Sort orders by fulfillment status."""
8100
8328
  FULFILLMENT_STATUS
8101
8329
 
8330
+ """Sort orders by channel."""
8331
+ CHANNEL
8332
+
8102
8333
  """Sort orders by total."""
8103
8334
  TOTAL
8104
8335
 
@@ -8112,27 +8343,11 @@ enum OrderSortField {
8112
8343
  EXTERNAL_SOURCE
8113
8344
  }
8114
8345
 
8115
- type NauticalOrderCountableConnection {
8116
- """Pagination data for this connection."""
8117
- pageInfo: PageInfo!
8118
- edges: [NauticalOrderCountableEdge!]!
8119
-
8120
- """A total count of items in the collection."""
8121
- totalCount: Int
8122
- }
8123
-
8124
- type NauticalOrderCountableEdge {
8125
- """The item at the end of the edge."""
8126
- node: NauticalOrder!
8127
-
8128
- """A cursor for use in pagination."""
8129
- cursor: String!
8130
- }
8131
-
8132
8346
  input CustomerNauticalOrderFilterInput {
8133
8347
  paymentStatus: [PaymentChargeStatusEnum!]
8134
8348
  status: [OrderStatusFilter!]
8135
8349
  customer: String
8350
+ channel: String
8136
8351
  created: DateRangeInput
8137
8352
  metadata: MetadataFilterInput
8138
8353
  privateMetadata: MetadataFilterInput
@@ -8880,15 +9095,24 @@ type Shop {
8880
9095
  """Whether the marketplace has enabled offer orders."""
8881
9096
  enableOfferOrders: Boolean
8882
9097
 
9098
+ """List of the shops's supported languages."""
9099
+ languages: [LanguageDisplay!]! @deprecated(reason: "This will be removed on October 29, 2024")
9100
+
8883
9101
  """Shop's name."""
8884
9102
  name: String!
8885
9103
 
9104
+ """Shop's navigation."""
9105
+ navigation: Navigation @deprecated(reason: "Fetch menus using the `menu` query with `slug` parameter. This will be removed on October 29, 2024.")
9106
+
8886
9107
  """List of available permissions."""
8887
9108
  permissions: [Permission!]!
8888
9109
 
8889
9110
  """List of possible phone prefixes."""
8890
9111
  phonePrefixes: [String!]!
8891
9112
 
9113
+ """Header text."""
9114
+ headerText: String @deprecated(reason: "This will be removed on October 29, 2024")
9115
+
8892
9116
  """Include taxes in prices."""
8893
9117
  includeTaxesInPrices: Boolean!
8894
9118
 
@@ -8931,6 +9155,11 @@ type Shop {
8931
9155
  """Gets active plugins."""
8932
9156
  activePlugins: [Plugin!]!
8933
9157
 
9158
+ """
9159
+ None if shop does not use Builder, otherwise this contains Builder public api key.
9160
+ """
9161
+ builderKey: String @deprecated(reason: "This will be removed on October 29, 2024")
9162
+
8934
9163
  """
8935
9164
  None if shop does not use Crisp, otherwise this contains Crisp Website ID.
8936
9165
  """
@@ -9024,46 +9253,121 @@ type Domain {
9024
9253
  url: String!
9025
9254
  }
9026
9255
 
9027
- """Plugin."""
9028
- type Plugin implements Node {
9029
- id: ID!
9030
- privateMetadata: JSONString!
9031
- metadata: JSONString!
9032
- company: String
9033
- category: PluginConfigurationCategory
9034
- descriptionShort: String!
9035
- logoUrl: String
9036
- created: DateTime!
9037
- externalUrl: String
9038
- supportUrl: String
9039
- allowSellers: Boolean
9040
- allowManyActivePluginsInCategory: Boolean!
9041
- tenant: Tenant!
9042
- identifier: String!
9043
- name: String!
9044
- description: String!
9045
- active: Boolean!
9046
- configuration: [ConfigurationItem!]
9047
- defaultConfiguration: [ConfigurationItem!]
9048
- supportSellerConfiguration: Boolean
9049
- version: String!
9050
- }
9256
+ type LanguageDisplay {
9257
+ """ISO 639 representation of the language name."""
9258
+ code: LanguageCodeEnum!
9051
9259
 
9052
- """An enumeration."""
9053
- enum PluginConfigurationCategory {
9054
- """Auth"""
9055
- AUTH
9260
+ """Full name of the language."""
9261
+ language: String!
9262
+ }
9056
9263
 
9057
- """Fulfillment"""
9058
- FULFILLMENT
9264
+ """Represents shop's navigation menus."""
9265
+ type Navigation {
9266
+ """Main navigation bar."""
9267
+ main: Menu
9059
9268
 
9060
- """Ecommerce"""
9061
- ECOMMERCE
9269
+ """Secondary navigation bar."""
9270
+ secondary: Menu
9271
+ }
9062
9272
 
9063
- """Data Connectivity"""
9064
- DATA_CONNECTIVITY
9273
+ """
9274
+ Represents a single menu - an object that is used to help navigate through the store.
9275
+ """
9276
+ type Menu implements Node {
9277
+ """The ID of the object"""
9278
+ id: ID!
9279
+ name: String!
9280
+ slug: String!
9281
+ items: [MenuItem!]!
9282
+ }
9065
9283
 
9066
- """Order Extensions"""
9284
+ """
9285
+ Represents a single item of the related menu. Can store categories, collection or pages.
9286
+ """
9287
+ type MenuItem implements Node {
9288
+ """The ID of the object"""
9289
+ id: ID!
9290
+ menu: Menu!
9291
+ name: String!
9292
+ parent: MenuItem
9293
+ category: Category
9294
+ collection: Collection
9295
+ page: Page
9296
+ level: Int!
9297
+ children: [MenuItem!]!
9298
+
9299
+ """URL to the menu item."""
9300
+ url: String
9301
+ }
9302
+
9303
+ """
9304
+ A static page that can be manually added by a shop operator through the dashboard.
9305
+ """
9306
+ type Page implements Node & ObjectWithMetadata {
9307
+ """The ID of the object"""
9308
+ id: ID!
9309
+ publicationDate: Date
9310
+ createdAt: DateTime!
9311
+ updatedAt: DateTime!
9312
+ content: String!
9313
+ contentHtml: String!
9314
+ seoTitle: String
9315
+ seoDescription: String
9316
+ slug: String!
9317
+ title: String!
9318
+
9319
+ """
9320
+ List of private metadata items.Requires proper staff permissions to access.
9321
+ """
9322
+ privateMetadata: [MetadataItem!]!
9323
+
9324
+ """List of public metadata items. Can be accessed without permissions."""
9325
+ metadata: [MetadataItem!]!
9326
+
9327
+ """Whether the page is published."""
9328
+ isPublished: Boolean!
9329
+ }
9330
+
9331
+ """Plugin."""
9332
+ type Plugin implements Node {
9333
+ id: ID!
9334
+ privateMetadata: JSONString!
9335
+ metadata: JSONString!
9336
+ company: String
9337
+ category: PluginConfigurationCategory
9338
+ descriptionShort: String!
9339
+ logoUrl: String
9340
+ created: DateTime!
9341
+ externalUrl: String
9342
+ supportUrl: String
9343
+ allowSellers: Boolean
9344
+ allowManyActivePluginsInCategory: Boolean!
9345
+ tenant: Tenant!
9346
+ identifier: String!
9347
+ name: String!
9348
+ description: String!
9349
+ active: Boolean!
9350
+ configuration: [ConfigurationItem!]
9351
+ defaultConfiguration: [ConfigurationItem!]
9352
+ supportSellerConfiguration: Boolean
9353
+ version: String!
9354
+ }
9355
+
9356
+ """An enumeration."""
9357
+ enum PluginConfigurationCategory {
9358
+ """Auth"""
9359
+ AUTH
9360
+
9361
+ """Fulfillment"""
9362
+ FULFILLMENT
9363
+
9364
+ """Ecommerce"""
9365
+ ECOMMERCE
9366
+
9367
+ """Data Connectivity"""
9368
+ DATA_CONNECTIVITY
9369
+
9370
+ """Order Extensions"""
9067
9371
  ORDER_EXTENSIONS
9068
9372
 
9069
9373
  """Utility"""
@@ -10629,6 +10933,7 @@ type OrderVendorSummaryType {
10629
10933
  revenue: Float
10630
10934
  totals: Int
10631
10935
  commission: Float
10936
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
10632
10937
  payout: Float
10633
10938
  vendors: Int
10634
10939
  adjustments: Decimal
@@ -10649,6 +10954,7 @@ type OrderVendorReportType {
10649
10954
  revenue: Float
10650
10955
  totals: Int
10651
10956
  commission: Float
10957
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
10652
10958
  payout: Float
10653
10959
  vendorId: Int
10654
10960
  vendor: Vendor
@@ -10678,6 +10984,7 @@ type SingleVendorReportType {
10678
10984
  revenue: Float
10679
10985
  totals: Int
10680
10986
  commission: Float
10987
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
10681
10988
  payout: Decimal
10682
10989
  adjustments: Decimal
10683
10990
  penalties: Decimal
@@ -10702,6 +11009,7 @@ type SingleVendorSummaryType {
10702
11009
  revenue: Float
10703
11010
  totals: Int
10704
11011
  commission: Float
11012
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
10705
11013
  payout: Float
10706
11014
  adjustments: Decimal
10707
11015
  penalties: Decimal
@@ -10726,34 +11034,6 @@ type PaymentCountableEdge {
10726
11034
  cursor: String!
10727
11035
  }
10728
11036
 
10729
- """
10730
- A static page that can be manually added by a shop operator through the dashboard.
10731
- """
10732
- type Page implements Node & ObjectWithMetadata {
10733
- """The ID of the object"""
10734
- id: ID!
10735
- publicationDate: Date
10736
- createdAt: DateTime!
10737
- updatedAt: DateTime!
10738
- content: String!
10739
- contentHtml: String!
10740
- seoTitle: String
10741
- seoDescription: String
10742
- slug: String!
10743
- title: String!
10744
-
10745
- """
10746
- List of private metadata items.Requires proper staff permissions to access.
10747
- """
10748
- privateMetadata: [MetadataItem!]!
10749
-
10750
- """List of public metadata items. Can be accessed without permissions."""
10751
- metadata: [MetadataItem!]!
10752
-
10753
- """Whether the page is published."""
10754
- isPublished: Boolean!
10755
- }
10756
-
10757
11037
  type PageCountableConnection {
10758
11038
  """Pagination data for this connection."""
10759
11039
  pageInfo: PageInfo!
@@ -10838,6 +11118,7 @@ input OrderFilterInput {
10838
11118
  paymentStatus: [PaymentChargeStatusEnum!]
10839
11119
  status: [OrderStatusFilter!]
10840
11120
  customer: String
11121
+ channel: String
10841
11122
  created: DateRangeInput
10842
11123
  metadata: MetadataFilterInput
10843
11124
  privateMetadata: MetadataFilterInput
@@ -10855,6 +11136,7 @@ input NauticalOrderFilterInput {
10855
11136
  paymentStatus: [PaymentChargeStatusEnum!]
10856
11137
  status: [OrderStatusFilter!]
10857
11138
  customer: String
11139
+ channel: String
10858
11140
  created: DateRangeInput
10859
11141
  metadata: MetadataFilterInput
10860
11142
  privateMetadata: MetadataFilterInput
@@ -10867,6 +11149,7 @@ input NauticalOrderFilterInput {
10867
11149
 
10868
11150
  input OrderDraftFilterInput {
10869
11151
  customer: String
11152
+ channel: String
10870
11153
  created: DateRangeInput
10871
11154
  metadata: MetadataFilterInput
10872
11155
  privateMetadata: MetadataFilterInput
@@ -10879,6 +11162,7 @@ input OrderDraftFilterInput {
10879
11162
 
10880
11163
  input NauticalOrderDraftFilterInput {
10881
11164
  customer: String
11165
+ channel: String
10882
11166
  created: DateRangeInput
10883
11167
  metadata: MetadataFilterInput
10884
11168
  privateMetadata: MetadataFilterInput
@@ -10891,6 +11175,7 @@ input NauticalOrderDraftFilterInput {
10891
11175
 
10892
11176
  input NauticalOrderQuoteFilterInput {
10893
11177
  customer: String
11178
+ channel: String
10894
11179
  created: DateRangeInput
10895
11180
  metadata: MetadataFilterInput
10896
11181
  privateMetadata: MetadataFilterInput
@@ -10909,6 +11194,7 @@ enum QuoteOrderSubStatusFilter {
10909
11194
 
10910
11195
  input OrderQuoteFilterInput {
10911
11196
  customer: String
11197
+ channel: String
10912
11198
  created: DateRangeInput
10913
11199
  metadata: MetadataFilterInput
10914
11200
  privateMetadata: MetadataFilterInput
@@ -11033,6 +11319,7 @@ type MicrositeCountableEdge {
11033
11319
  input MicrositeFilterInput {
11034
11320
  published: MicrositePublished
11035
11321
  search: String
11322
+ vendorType: MicrositeVendorType
11036
11323
  ids: [ID]
11037
11324
  metadata: MetadataFilterInput
11038
11325
  privateMetadata: MetadataFilterInput
@@ -11043,6 +11330,11 @@ enum MicrositePublished {
11043
11330
  HIDDEN
11044
11331
  }
11045
11332
 
11333
+ enum MicrositeVendorType {
11334
+ SELLER
11335
+ AFFILIATE
11336
+ }
11337
+
11046
11338
  input MicrositeSortingInput {
11047
11339
  """Specifies the direction in which to sort products."""
11048
11340
  direction: OrderDirection!
@@ -11065,36 +11357,6 @@ enum MicrositeSortField {
11065
11357
  PUBLICATION_DATE
11066
11358
  }
11067
11359
 
11068
- """
11069
- Represents a single menu - an object that is used to help navigate through the store.
11070
- """
11071
- type Menu implements Node {
11072
- """The ID of the object"""
11073
- id: ID!
11074
- name: String!
11075
- slug: String!
11076
- items: [MenuItem!]!
11077
- }
11078
-
11079
- """
11080
- Represents a single item of the related menu. Can store categories, collection or pages.
11081
- """
11082
- type MenuItem implements Node {
11083
- """The ID of the object"""
11084
- id: ID!
11085
- menu: Menu!
11086
- name: String!
11087
- parent: MenuItem
11088
- category: Category
11089
- collection: Collection
11090
- page: Page
11091
- level: Int!
11092
- children: [MenuItem!]!
11093
-
11094
- """URL to the menu item."""
11095
- url: String
11096
- }
11097
-
11098
11360
  type MenuCountableConnection {
11099
11361
  """Pagination data for this connection."""
11100
11362
  pageInfo: PageInfo!
@@ -12227,6 +12489,7 @@ type OrderSellerSummaryType {
12227
12489
  revenue: Float
12228
12490
  totals: Int
12229
12491
  commission: Float
12492
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12230
12493
  payout: Float
12231
12494
  sellers: Float
12232
12495
  }
@@ -12243,6 +12506,7 @@ type OrderCustomerReportType {
12243
12506
  revenue: Float
12244
12507
  totals: Int
12245
12508
  commission: Float
12509
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12246
12510
  payout: Float
12247
12511
  userId: Int
12248
12512
  user: User
@@ -12284,6 +12548,7 @@ type OrderSellerReportType {
12284
12548
  revenue: Float
12285
12549
  totals: Int
12286
12550
  commission: Float
12551
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12287
12552
  payout: Float
12288
12553
  sellerId: Int
12289
12554
  seller: Seller
@@ -12325,6 +12590,7 @@ type OrderMarketplaceReportType {
12325
12590
  revenue: Float
12326
12591
  totals: Int
12327
12592
  commission: Float
12593
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12328
12594
  payout: Float
12329
12595
  dimension: Date
12330
12596
  }
@@ -12361,6 +12627,65 @@ type InReportMarketplacePayoutsSummaryType {
12361
12627
  report: [OrderSellerReportType!]
12362
12628
  }
12363
12629
 
12630
+ type InReportMarketplaceAffiliatePayoutsSummaryType {
12631
+ """Category of the metric."""
12632
+ category: String!
12633
+
12634
+ """Title of the metric."""
12635
+ title: String!
12636
+
12637
+ """
12638
+ Description of main columns in report and summary. Note: report and summary can contain additional columns.
12639
+ """
12640
+ columns: [ColumnObjectType!]
12641
+
12642
+ """Info about applied filters."""
12643
+ filters: [FilterObjectType!]
12644
+
12645
+ """Total summary for selected period."""
12646
+ summary: OrderAffiliateSummaryType!
12647
+
12648
+ """
12649
+ Report where each row represent aggregated, by selected (in filters) dimension, summary.
12650
+ """
12651
+ report: [OrderAffiliateReportType!]
12652
+ }
12653
+
12654
+ type OrderAffiliateSummaryType {
12655
+ gross: Float
12656
+ orders: Int
12657
+ net: Float
12658
+ shipping: Float
12659
+ average: Float
12660
+ taxes: Float
12661
+ discounts: Float
12662
+ volumeDiscounts: Float
12663
+ revenue: Float
12664
+ totals: Int
12665
+ commission: Float
12666
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12667
+ payout: Float
12668
+ affiliates: Float
12669
+ }
12670
+
12671
+ type OrderAffiliateReportType {
12672
+ gross: Float
12673
+ orders: Int
12674
+ net: Float
12675
+ shipping: Float
12676
+ average: Float
12677
+ taxes: Float
12678
+ discounts: Float
12679
+ volumeDiscounts: Float
12680
+ revenue: Float
12681
+ totals: Int
12682
+ commission: Float
12683
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12684
+ payout: Float
12685
+ affiliateId: Int
12686
+ affiliate: User
12687
+ }
12688
+
12364
12689
  type InReportMarketplaceTaxSummaryType {
12365
12690
  """Category of the metric."""
12366
12691
  category: String!
@@ -12397,6 +12722,7 @@ type AbstractOrderSellerReportType {
12397
12722
  revenue: Float
12398
12723
  totals: Int
12399
12724
  commission: Float
12725
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12400
12726
  payout: Float
12401
12727
  }
12402
12728
 
@@ -12412,6 +12738,7 @@ type MarketplaceTaxReportType {
12412
12738
  revenue: Float
12413
12739
  totals: Int
12414
12740
  commission: Float
12741
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12415
12742
  payout: Float
12416
12743
  dimension: Date
12417
12744
  }
@@ -12452,6 +12779,7 @@ type MarketplaceTaxReportByLocaleType {
12452
12779
  revenue: Float
12453
12780
  totals: Int
12454
12781
  commission: Float
12782
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12455
12783
  payout: Float
12456
12784
  billingAddress_Country: String
12457
12785
  billingAddress_CountryArea: String
@@ -12663,6 +12991,7 @@ type DashboardSellerOrderPerformanceType {
12663
12991
  revenue: Float
12664
12992
  totals: Int
12665
12993
  commission: Float
12994
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12666
12995
  payout: Float
12667
12996
  sellerId: Int
12668
12997
  seller: Seller
@@ -12685,6 +13014,7 @@ type GraphDataType {
12685
13014
  revenue: Float
12686
13015
  totals: Int
12687
13016
  commission: Float
13017
+ affiliateCommission: Float @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
12688
13018
  payout: Float
12689
13019
  dimension: DateTime
12690
13020
  }
@@ -13051,6 +13381,27 @@ type DesignerDataType {
13051
13381
  jsonContent: JSONString!
13052
13382
  }
13053
13383
 
13384
+ type BrandingType {
13385
+ id: ID!
13386
+ tenant: Tenant!
13387
+ jsonContent: JSONString!
13388
+ logo(
13389
+ """Size of the image."""
13390
+ size: Int
13391
+ ): Image
13392
+ icon(
13393
+ """Size of the image."""
13394
+ size: Int
13395
+ ): Image
13396
+ favicon(
13397
+ """Size of the image."""
13398
+ size: Int
13399
+ ): Image
13400
+ logoHeight: Int
13401
+ logoWidth: Int
13402
+ footerText: String!
13403
+ }
13404
+
13054
13405
  """Represents a job data of exported file."""
13055
13406
  type ExportFile implements Node & Job {
13056
13407
  """The ID of the object"""
@@ -13162,6 +13513,12 @@ enum ExportFileSortField {
13162
13513
  UPDATED_AT
13163
13514
  }
13164
13515
 
13516
+ type CoreDataType {
13517
+ tenant: Tenant!
13518
+ name: String!
13519
+ jsonContent: JSONString!
13520
+ }
13521
+
13165
13522
  type CheckoutCountableConnection {
13166
13523
  """Pagination data for this connection."""
13167
13524
  pageInfo: PageInfo!
@@ -13196,6 +13553,45 @@ type CheckoutLineCountableEdge {
13196
13553
  cursor: String!
13197
13554
  }
13198
13555
 
13556
+ type ChannelCountableConnection {
13557
+ """Pagination data for this connection."""
13558
+ pageInfo: PageInfo!
13559
+ edges: [ChannelCountableEdge!]!
13560
+
13561
+ """A total count of items in the collection."""
13562
+ totalCount: Int
13563
+ }
13564
+
13565
+ type ChannelCountableEdge {
13566
+ """The item at the end of the edge."""
13567
+ node: Channel!
13568
+
13569
+ """A cursor for use in pagination."""
13570
+ cursor: String!
13571
+ }
13572
+
13573
+ input ChannelFilterInput {
13574
+ search: String
13575
+ createdAt: DateTime
13576
+ created: DateRangeInput
13577
+ }
13578
+
13579
+ input ChannelSortingInput {
13580
+ """Specifies the direction in which to sort products."""
13581
+ direction: OrderDirection!
13582
+
13583
+ """Sort channels by the selected field."""
13584
+ field: ChannelSortField!
13585
+ }
13586
+
13587
+ enum ChannelSortField {
13588
+ """Sort channels by channel."""
13589
+ CHANNEL
13590
+
13591
+ """Sort channels by created at."""
13592
+ CREATED_AT
13593
+ }
13594
+
13199
13595
  input AttributeSortingInput {
13200
13596
  """Specifies the direction in which to sort products."""
13201
13597
  direction: OrderDirection!
@@ -13355,18 +13751,62 @@ input AgreementFilterInput {
13355
13751
  search: String
13356
13752
  }
13357
13753
 
13358
- type AddressValidationData {
13359
- countryCode: String
13360
- countryName: String
13361
- addressFormat: String
13362
- addressLatinFormat: String
13363
- allowedFields: [String!]
13364
- requiredFields: [String!]
13365
- upperFields: [String!]
13366
- countryAreaType: String
13367
- countryAreaChoices: [ChoiceValue!]
13368
- cityType: String
13369
- cityChoices: [ChoiceValue!]
13754
+ input AffiliateFilterInput {
13755
+ dateJoined: DateRangeInput
13756
+ moneySpent: PriceRangeInput
13757
+ numberOfOrders: IntRangeInput
13758
+ placedOrders: DateRangeInput
13759
+ search: String
13760
+ }
13761
+
13762
+ type OptimizedAffiliate {
13763
+ affiliate: User
13764
+ channels: [OptimizedAffiliateChannels!] @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
13765
+ topCodes: [AffiliateCodes!]
13766
+ agreement: Agreement
13767
+ }
13768
+
13769
+ type OptimizedAffiliateChannels {
13770
+ channelName: String
13771
+ totalReferrals: Int
13772
+ }
13773
+
13774
+ input AffiliateCodeFilterInput {
13775
+ search: String
13776
+ isActive: Boolean
13777
+ }
13778
+
13779
+ input AffiliateCodeSortingInput {
13780
+ """Specifies the direction in which to sort products."""
13781
+ direction: OrderDirection!
13782
+
13783
+ """Sort affiliate_codes by the selected field."""
13784
+ field: AffiliateCodeSortField!
13785
+ }
13786
+
13787
+ enum AffiliateCodeSortField {
13788
+ """Sort affiliate codes by code."""
13789
+ CODE
13790
+
13791
+ """Sort affiliate codes by status."""
13792
+ STATUS
13793
+
13794
+ """Sort affiliate codes by referrals."""
13795
+ REFERRALS
13796
+ }
13797
+
13798
+ type AddressValidationData {
13799
+ countryCode: String
13800
+ countryName: String
13801
+ addressFormat: String
13802
+ addressLatinFormat: String
13803
+ allowedFields: [String!]
13804
+ requiredFields: [String!]
13805
+ upperFields: [String!]
13806
+ countryAreaType: String
13807
+ countryAreaChoices: [ChoiceValue!]
13808
+ cityType: String
13809
+ cityChoices: [ChoiceValue!]
13370
13810
  cityAreaType: String
13371
13811
  cityAreaChoices: [ChoiceValue!]
13372
13812
  postalCodeType: String
@@ -13470,7 +13910,7 @@ type Mutation {
13470
13910
  description: String
13471
13911
 
13472
13912
  """
13473
- Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/eps, application/zip, application/x-tif, application/excel, image/x-bmp, image/heif-sequence, application/vnd.ms-word, text/plain, text/csv, application/x-rar, image/tiff, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/gzip-compressed, image/jpeg, application/x-autocad, image/tif, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/heif, text/svg, text/svg-xml, image/png, application/csv, application/eps, application/x-acad, application/vnd.oasis.opendocument.text, text/pdf, image/heic-sequence, application/x-tar, image/x-dxf, application/x-rtf, application/x-eps, application/vnd.oasis.opendocument.presentation, image/x-tif, application/x-jpg, image/svg, image/x-eps, drawing/x-dwg, application/acad, application/x-zip-compressed, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/heic, application/pdf, application/gzipped, image/x-tiff, application/tiff, application/vnd.ms-excel, image/gif, text/x-pdf, application/dxf, application/acrobat, application/x-gzip, application/tif, image/bmp, image/webp, application/gzip, image/vnd.dwg, application/msword, image/dxf, application/vnd.ms-powerpoint, image/x-dwg, application/postscript, application/x-dwg, text/rtf, text/comma-separated-values, drawing/dwg, application/vnd.oasis.opendocument.spreadsheet, application/x-pdf, application/rtf, application/x-tiff, application/vnd.pdf, text/x-comma-separated-values, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/x-csv, application/svg+xml, pplication/vnd.rar, application/x-csv, image/x-ms-bmp, drawing/x-dwf, image/jpg, image/svg+xml, application/x-rar-compressed, application/dwg, application/x-dxf, application/jpg.
13913
+ Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/svg+xml, application/x-jpg, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/heif-sequence, application/pdf, image/png, image/heif, application/acad, application/tif, application/postscript, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/jpg, application/vnd.ms-excel, text/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/x-csv, application/x-tif, application/vnd.ms-powerpoint, application/svg+xml, image/heic, application/vnd.ms-word, image/tiff, image/x-tif, application/vnd.oasis.opendocument.presentation, application/tiff, application/zip, application/x-tar, application/rtf, application/excel, application/x-dxf, image/jpg, application/x-rar, image/gif, text/svg-xml, image/x-dxf, application/dwg, application/x-tiff, image/webp, application/x-csv, image/heic-sequence, application/vnd.oasis.opendocument.text, drawing/dwg, drawing/x-dwg, image/jpeg, application/x-autocad, text/plain, application/gzip-compressed, application/gzip, image/x-bmp, application/x-eps, image/x-ms-bmp, text/svg, pplication/vnd.rar, text/x-pdf, image/x-dwg, text/csv, image/x-eps, application/x-rar-compressed, image/eps, text/rtf, application/vnd.oasis.opendocument.spreadsheet, application/acrobat, image/tif, application/x-gzip, application/x-rtf, image/dxf, application/x-dwg, application/msword, image/svg, text/comma-separated-values, application/x-acad, application/vnd.pdf, drawing/x-dwf, application/dxf, application/x-pdf, image/bmp, text/x-comma-separated-values, image/x-tiff, application/eps, application/csv, application/gzipped, image/vnd.dwg, application/x-zip-compressed, application/vnd.openxmlformats-officedocument.wordprocessingml.document.
13474
13914
  """
13475
13915
  file: Upload!
13476
13916
 
@@ -13546,6 +13986,48 @@ type Mutation {
13546
13986
  """
13547
13987
  updatePeriodicTaskEnabled(enabled: Boolean): PeriodicTaskEnabledUpdate @deprecated(reason: "This will be removed on November 9, 2024")
13548
13988
 
13989
+ """Creates a new channel"""
13990
+ channelCreate(
13991
+ """Fields required to create a channel."""
13992
+ input: ChannelInput
13993
+ ): ChannelCreate @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
13994
+
13995
+ """Updates a channel."""
13996
+ channelUpdate(
13997
+ """ID of a channel to update."""
13998
+ id: ID!
13999
+
14000
+ """Fields required to update a channel."""
14001
+ input: ChannelInput!
14002
+ ): ChannelUpdate @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
14003
+
14004
+ """Updates an order channel"""
14005
+ orderChannelUpdate(
14006
+ """ID of the channel to associate with the order"""
14007
+ channel: ID
14008
+
14009
+ """ID of the order to update channel for"""
14010
+ id: ID!
14011
+ ): OrderChannelUpdate @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
14012
+
14013
+ """Updates a marketplace order channel."""
14014
+ nauticalOrderChannelUpdate(
14015
+ """ID of the channel to associate with the marketplace order"""
14016
+ channel: ID
14017
+
14018
+ """ID of the marketplace order to update channel for"""
14019
+ id: ID!
14020
+ ): NauticalOrderChannelUpdate @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
14021
+
14022
+ """Updates an affiliate code channel"""
14023
+ affiliateCodeChannelUpdate(
14024
+ """ID of the channel to associate with the affiliate code"""
14025
+ channel: ID
14026
+
14027
+ """ID of the affiliate code to update channel for"""
14028
+ id: ID!
14029
+ ): AffiliateCodeChannelUpdate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14030
+
13549
14031
  """Updates marketplace configuration."""
13550
14032
  marketplaceConfigurationUpdate(
13551
14033
  """Fields required to update marketplace configuration."""
@@ -13824,6 +14306,70 @@ type Mutation {
13824
14306
  input: MicrositeInput!
13825
14307
  ): MicrositeUpdate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13826
14308
 
14309
+ """Creates a new affiliate code"""
14310
+ affiliateCodeCreate(
14311
+ """Fields required to create an affiliate code."""
14312
+ input: AffiliateCodeCreateInput
14313
+ ): AffiliateCodeCreate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14314
+
14315
+ """Increments affiliate code uses"""
14316
+ affiliateCodeUse(
14317
+ """Affiliate code to increment use for"""
14318
+ code: String
14319
+ ): AffiliateCodeUse @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14320
+
14321
+ """Sets whether code is active"""
14322
+ affiliateCodeSetActive(
14323
+ """Whether the code is active or not"""
14324
+ isActive: Boolean
14325
+ ): AffiliateCodeSetActive @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14326
+
14327
+ """Activate or deactivate affiliate codes."""
14328
+ affiliateCodeBulkSetActive(
14329
+ """List of code IDs to (de)activate)."""
14330
+ ids: [ID!]!
14331
+
14332
+ """Determine if codes will be set active or not."""
14333
+ isActive: Boolean!
14334
+ ): AffiliateCodeBulkSetActive @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14335
+
14336
+ """
14337
+ Create an affiliate avatar. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
14338
+ """
14339
+ affiliateAvatarUpdate(
14340
+ affiliate: ID
14341
+
14342
+ """Represents an image file in a multipart request."""
14343
+ image: Upload!
14344
+ ): AffiliateAvatarUpdate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14345
+
14346
+ """Creates a new affiliate."""
14347
+ affiliateCreate(
14348
+ """Fields required to create a affiliate."""
14349
+ input: UserCreateInput!
14350
+ ): AffiliateCreate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14351
+
14352
+ """Updates an existing affiliate."""
14353
+ affiliateUpdate(
14354
+ """ID of a affiliate to update."""
14355
+ id: ID!
14356
+
14357
+ """Fields required to update a affiliate."""
14358
+ input: AffiliateInput!
14359
+ ): AffiliateUpdate @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14360
+
14361
+ """Deletes a affiliate."""
14362
+ affiliateDelete(
14363
+ """ID of a affiliate to delete."""
14364
+ id: ID!
14365
+ ): AffiliateDelete @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14366
+
14367
+ """Deletes affiliates."""
14368
+ affiliateBulkDelete(
14369
+ """List of user IDs to delete."""
14370
+ ids: [ID!]!
14371
+ ): AffiliateBulkDelete @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
14372
+
13827
14373
  """Creates a new agreement."""
13828
14374
  agreementCreate(
13829
14375
  """Fields required to create a agreement."""
@@ -14040,6 +14586,20 @@ type Mutation {
14040
14586
  """Update existing designer data."""
14041
14587
  designerDataUpdate(input: DesignerDataInput, name: String!): DesignerDataUpdate
14042
14588
 
14589
+ """Update existing branding."""
14590
+ brandingUpdate(input: BrandingInput): BrandingUpdate @deprecated(reason: "This will be removed on October 25, 2024")
14591
+
14592
+ """Delete branding images."""
14593
+ brandingImagesDelete(favicon: Boolean, icon: Boolean, logo: Boolean): BrandingImagesDelete @deprecated(reason: "This will be removed on October 25, 2024")
14594
+
14595
+ """Create core data."""
14596
+ coreDataCreate(input: CoreDataInput!): CoreDataCreate @deprecated(reason: "This will be removed on October 25, 2024")
14597
+
14598
+ """
14599
+ Update existing core data instance, return ok = True and coredata = None if no matching core data instance found.
14600
+ """
14601
+ coreDataUpdate(input: CoreDataInput!, name: String!): CoreDataUpdate @deprecated(reason: "This will be removed on October 25, 2024")
14602
+
14043
14603
  """Creates a new webhook subscription."""
14044
14604
  webhookCreate(
14045
14605
  """Fields required to create a webhook."""
@@ -15029,6 +15589,9 @@ type Mutation {
15029
15589
 
15030
15590
  """Completes creating an order."""
15031
15591
  draftOrderComplete(
15592
+ """ID of the channel to attach the order to"""
15593
+ channel: ID @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
15594
+
15032
15595
  """ID of the order that will be completed."""
15033
15596
  id: ID!
15034
15597
 
@@ -15043,6 +15606,9 @@ type Mutation {
15043
15606
 
15044
15607
  """Completes creating an order."""
15045
15608
  nauticalDraftOrderComplete(
15609
+ """ID of the channel to attach to nautical order"""
15610
+ channel: ID @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
15611
+
15046
15612
  """
15047
15613
  Optional ID of the Nautical Order to be completed. Either 'id' or 'token' must be provided to identify the Nautical Order. If both are provided, only the 'id' field will be used.
15048
15614
  """
@@ -15613,6 +16179,15 @@ type Mutation {
15613
16179
  input: [MetadataInput!]!
15614
16180
  ): PrivateMetadataUpdate
15615
16181
 
16182
+ """Assigns storefront's navigation menus."""
16183
+ assignNavigation(
16184
+ """ID of the menu."""
16185
+ menu: ID
16186
+
16187
+ """Type of the navigation bar to assign the menu to."""
16188
+ navigationType: NavigationType!
16189
+ ): AssignNavigation @deprecated(reason: "This will be removed on October 29, 2024")
16190
+
15616
16191
  """Creates a new Menu."""
15617
16192
  menuCreate(
15618
16193
  """Fields required to create a menu."""
@@ -15834,7 +16409,7 @@ type Mutation {
15834
16409
  """
15835
16410
  Whether the vendor to retrieve an onboarding link for is a SELLER or an AFFILIATE
15836
16411
  """
15837
- vendorType: String @deprecated(reason: "This will be removed on January 24, 2025.")
16412
+ vendorType: String!
15838
16413
  ): VendorPayoutOnboardingLinkRequest
15839
16414
 
15840
16415
  """
@@ -15987,11 +16562,14 @@ type Mutation {
15987
16562
  Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.
15988
16563
  """
15989
16564
  checkoutComplete(
16565
+ """ID of affiliate code used for checkout completion"""
16566
+ affiliate: ID @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
16567
+
15990
16568
  """Checkout ID."""
15991
16569
  checkoutId: ID!
15992
16570
 
15993
16571
  """ID of microsite that checkout was completed from"""
15994
- microsite: ID @deprecated(reason: "This will be removed on January 24, 2025.")
16572
+ microsite: ID
15995
16573
 
15996
16574
  """Client-side generated data required to finalize the payment."""
15997
16575
  paymentData: JSONString
@@ -16991,6 +17569,71 @@ type PeriodicTaskEnabledUpdate {
16991
17569
  task: WebhookPeriodicTask
16992
17570
  }
16993
17571
 
17572
+ """Creates a new channel"""
17573
+ type ChannelCreate {
17574
+ channelErrors: [ChannelError!]!
17575
+ channel: Channel
17576
+ }
17577
+
17578
+ type ChannelError {
17579
+ """
17580
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
17581
+ """
17582
+ field: String
17583
+
17584
+ """The error message."""
17585
+ message: String!
17586
+
17587
+ """The error code."""
17588
+ code: ChannelErrorCode!
17589
+ }
17590
+
17591
+ """An enumeration."""
17592
+ enum ChannelErrorCode {
17593
+ GRAPHQL_ERROR
17594
+ INVALID
17595
+ NOT_FOUND
17596
+ REQUIRED
17597
+ UNIQUE
17598
+ JWT_SIGNATURE_EXPIRED
17599
+ JWT_INVALID_TOKEN
17600
+ JWT_DECODE_ERROR
17601
+ JWT_MISSING_TOKEN
17602
+ JWT_INVALID_CSRF_TOKEN
17603
+ }
17604
+
17605
+ input ChannelInput {
17606
+ """Name of the channel."""
17607
+ channel: String
17608
+ }
17609
+
17610
+ """Updates a channel."""
17611
+ type ChannelUpdate {
17612
+ channelErrors: [ChannelError!]!
17613
+ channel: Channel
17614
+ }
17615
+
17616
+ """Updates an order channel"""
17617
+ type OrderChannelUpdate {
17618
+ """Updated order instance"""
17619
+ order: Order
17620
+ channelErrors: [ChannelError!]!
17621
+ }
17622
+
17623
+ """Updates a marketplace order channel."""
17624
+ type NauticalOrderChannelUpdate {
17625
+ """Updated marketplace order instance"""
17626
+ order: NauticalOrder
17627
+ channelErrors: [ChannelError!]!
17628
+ }
17629
+
17630
+ """Updates an affiliate code channel"""
17631
+ type AffiliateCodeChannelUpdate {
17632
+ """Updated affiliate code instance"""
17633
+ affiliateCode: AffiliateCodes
17634
+ channelErrors: [ChannelError!]!
17635
+ }
17636
+
16994
17637
  """Updates marketplace configuration."""
16995
17638
  type MarketplaceConfigurationUpdate {
16996
17639
  """Updated marketplace configuration."""
@@ -17181,7 +17824,7 @@ enum PayoutErrorCode {
17181
17824
 
17182
17825
  input PayoutCreateInput {
17183
17826
  """Vendor type for the payout"""
17184
- vendorType: String @deprecated(reason: "This will be removed on January 24, 2025")
17827
+ vendorType: String!
17185
17828
 
17186
17829
  """
17187
17830
  Payout end date. ISO 8601 standard. Can not be greater than current date.
@@ -17595,48 +18238,334 @@ type MicrositeRemoveProducts {
17595
18238
  micrositeErrors: [ProductError!]!
17596
18239
  }
17597
18240
 
17598
- """Updates a microsite."""
17599
- type MicrositeUpdate {
17600
- micrositeErrors: [ProductError!]!
17601
- microsite: Microsite
17602
- }
18241
+ """Updates a microsite."""
18242
+ type MicrositeUpdate {
18243
+ micrositeErrors: [ProductError!]!
18244
+ microsite: Microsite
18245
+ }
18246
+
18247
+ input MicrositeInput {
18248
+ """Informs whether a microsite is published."""
18249
+ isPublished: Boolean
18250
+
18251
+ """Name of the microsite."""
18252
+ name: String
18253
+
18254
+ """Text to appear in footer of microsite."""
18255
+ footerText: String
18256
+
18257
+ """Slug of the microsite."""
18258
+ slug: String
18259
+
18260
+ """Description of the microsite (plaintext, deprecated for input)."""
18261
+ description: String
18262
+
18263
+ """Description of the microsite (HTML)."""
18264
+ descriptionHtml: String
18265
+
18266
+ """Banner image file."""
18267
+ bannerImage: Upload
18268
+
18269
+ """Alt text for an image."""
18270
+ bannerImageAlt: String
18271
+
18272
+ """Logo image file."""
18273
+ logoImage: Upload
18274
+
18275
+ """Alt text for an image."""
18276
+ logoImageAlt: String
18277
+
18278
+ """Search engine optimization fields."""
18279
+ seo: SeoInput
18280
+
18281
+ """Publication date. ISO 8601 standard."""
18282
+ publicationDate: Date
18283
+ }
18284
+
18285
+ """Creates a new affiliate code"""
18286
+ type AffiliateCodeCreate {
18287
+ affiliateErrors: [AffiliateError!]!
18288
+ affiliateCodes: AffiliateCodes
18289
+ }
18290
+
18291
+ type AffiliateError {
18292
+ """
18293
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
18294
+ """
18295
+ field: String
18296
+
18297
+ """The error message."""
18298
+ message: String!
18299
+
18300
+ """The error code."""
18301
+ code: AffiliateErrorCode!
18302
+ }
18303
+
18304
+ """An enumeration."""
18305
+ enum AffiliateErrorCode {
18306
+ UNIQUE
18307
+ REQUIRED
18308
+ NOT_FOUND
18309
+ }
18310
+
18311
+ input AffiliateCodeCreateInput {
18312
+ """The id of the affiliate that the code belongs to"""
18313
+ affiliate: ID!
18314
+
18315
+ """The new affiliate code"""
18316
+ code: String
18317
+
18318
+ """ID of the channel code is used for"""
18319
+ channel: ID @deprecated(reason: "This will be removed on October 29, 2024 when channel support is removed.")
18320
+ }
18321
+
18322
+ """Increments affiliate code uses"""
18323
+ type AffiliateCodeUse {
18324
+ affiliateErrors: [AffiliateError!]!
18325
+ affiliateCodes: AffiliateCodes
18326
+ }
18327
+
18328
+ """Sets whether code is active"""
18329
+ type AffiliateCodeSetActive {
18330
+ affiliateErrors: [AffiliateError!]!
18331
+ affiliateCodes: AffiliateCodes
18332
+ }
18333
+
18334
+ """Activate or deactivate affiliate codes."""
18335
+ type AffiliateCodeBulkSetActive {
18336
+ """Returns how many objects were affected."""
18337
+ count: Int!
18338
+ codeErrors: [AccountError!]!
18339
+ }
18340
+
18341
+ type AccountError {
18342
+ """
18343
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
18344
+ """
18345
+ field: String
18346
+
18347
+ """The error message."""
18348
+ message: String!
18349
+
18350
+ """The error code."""
18351
+ code: AccountErrorCode!
18352
+ }
18353
+
18354
+ """An enumeration."""
18355
+ enum AccountErrorCode {
18356
+ ACTIVATE_OWN_ACCOUNT
18357
+ ACTIVATE_SUPERUSER_ACCOUNT
18358
+ ACCOUNT_NOT_ACTIVE
18359
+ ATTRIBUTE_CANNOT_BE_ASSIGNED
18360
+ DUPLICATED_INPUT_ITEM
18361
+ DEACTIVATE_OWN_ACCOUNT
18362
+ DEACTIVATE_SUPERUSER_ACCOUNT
18363
+ DELETE_NON_STAFF_USER
18364
+ DELETE_OWN_ACCOUNT
18365
+ DELETE_STAFF_ACCOUNT
18366
+ DELETE_SUPERUSER_ACCOUNT
18367
+ GRAPHQL_ERROR
18368
+ INVALID
18369
+ INVALID_PHONE
18370
+ INVALID_PASSWORD
18371
+ LEFT_NOT_MANAGEABLE_PERMISSION
18372
+ MUST_CHOOSE_PERMISSION_GROUP
18373
+ INVALID_CREDENTIALS
18374
+ NO_SELLER
18375
+ NOT_FOUND
18376
+ OUT_OF_SCOPE_SERVICE_ACCOUNT
18377
+ OUT_OF_SCOPE_USER
18378
+ OUT_OF_SCOPE_GROUP
18379
+ OUT_OF_SCOPE_PERMISSION
18380
+ PASSWORD_ENTIRELY_NUMERIC
18381
+ PASSWORD_IDENTICAL
18382
+ PASSWORD_TOO_COMMON
18383
+ PASSWORD_TOO_SHORT
18384
+ PASSWORD_TOO_SIMILAR
18385
+ REQUIRED
18386
+ UNIQUE
18387
+ JWT_SIGNATURE_EXPIRED
18388
+ JWT_INVALID_TOKEN
18389
+ JWT_DECODE_ERROR
18390
+ JWT_MISSING_TOKEN
18391
+ JWT_INVALID_CSRF_TOKEN
18392
+ }
18393
+
18394
+ """
18395
+ Create an affiliate avatar. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
18396
+ """
18397
+ type AffiliateAvatarUpdate {
18398
+ """An updated affiliate instance."""
18399
+ affiliate: User
18400
+ accountErrors: [AccountError!]!
18401
+ }
18402
+
18403
+ """Creates a new affiliate."""
18404
+ type AffiliateCreate {
18405
+ accountErrors: [AccountError!]!
18406
+ user: User
18407
+ }
18408
+
18409
+ input UserCreateInput {
18410
+ """Billing address of the customer."""
18411
+ defaultBillingAddress: AddressInput
18412
+
18413
+ """Shipping address of the customer."""
18414
+ defaultShippingAddress: AddressInput
18415
+
18416
+ """Given name."""
18417
+ firstName: String
18418
+
18419
+ """Family name."""
18420
+ lastName: String
18421
+
18422
+ """The unique email address of the user."""
18423
+ email: String
18424
+
18425
+ """User account is active."""
18426
+ isActive: Boolean
18427
+
18428
+ """User is staff member."""
18429
+ isStaff: Boolean
18430
+
18431
+ """User account is affiliate."""
18432
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
18433
+
18434
+ """A note about the user."""
18435
+ note: String
18436
+
18437
+ """Only filled out if the account is a business account."""
18438
+ companyName: String
18439
+
18440
+ """Personal phone number."""
18441
+ personalPhone: String
18442
+
18443
+ """Password url"""
18444
+ passwordUrl: String
18445
+
18446
+ """Tax exempt code"""
18447
+ taxExemptCode: String
18448
+
18449
+ """List of custom fields."""
18450
+ customFields: [AttributeValueInput!]
18451
+
18452
+ """Marketplace VAT identification number"""
18453
+ vatIdentificationNumber: String
18454
+
18455
+ """
18456
+ URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
18457
+ """
18458
+ redirectUrl: String
18459
+ }
18460
+
18461
+ input AttributeValueInput {
18462
+ """ID of the selected attribute."""
18463
+ id: ID
18464
+
18465
+ """
18466
+ The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
18467
+ """
18468
+ values: [String!]
18469
+
18470
+ """
18471
+ Value representation of the attribute value (e.g. color value for swatch attributes).
18472
+ """
18473
+ value: String
18474
+
18475
+ """Date and time representation of attribute value."""
18476
+ dateTime: DateTime
18477
+
18478
+ """Supports attribute values with long text (plain text)."""
18479
+ plainText: String
18480
+
18481
+ """Supports attribute values with long text (html)."""
18482
+ richText: String
18483
+
18484
+ """Numeric value to support money or numeric attribute values."""
18485
+ amount: Decimal
18486
+
18487
+ """Currency to support money attribute values."""
18488
+ currency: String
18489
+
18490
+ """
18491
+ Supports attribute values to reference any other nautical object (should be base64 ID)
18492
+ """
18493
+ reference: String
18494
+
18495
+ """Supports boolean attribute values."""
18496
+ boolean: Boolean
18497
+
18498
+ """Supports file type attribute values."""
18499
+ file: Upload
18500
+
18501
+ """URL type to support external links as attribute values."""
18502
+ fileUrl: String
18503
+ }
18504
+
18505
+ """Updates an existing affiliate."""
18506
+ type AffiliateUpdate {
18507
+ accountErrors: [AccountError!]!
18508
+ user: User
18509
+ }
18510
+
18511
+ input AffiliateInput {
18512
+ """Billing address of the customer."""
18513
+ defaultBillingAddress: AddressInput
18514
+
18515
+ """Shipping address of the customer."""
18516
+ defaultShippingAddress: AddressInput
18517
+
18518
+ """Given name."""
18519
+ firstName: String
18520
+
18521
+ """Family name."""
18522
+ lastName: String
17603
18523
 
17604
- input MicrositeInput {
17605
- """Informs whether a microsite is published."""
17606
- isPublished: Boolean
18524
+ """The unique email address of the user."""
18525
+ email: String
17607
18526
 
17608
- """Name of the microsite."""
17609
- name: String
18527
+ """User account is active."""
18528
+ isActive: Boolean
17610
18529
 
17611
- """Text to appear in footer of microsite."""
17612
- footerText: String
18530
+ """User is staff member."""
18531
+ isStaff: Boolean
17613
18532
 
17614
- """Slug of the microsite."""
17615
- slug: String
18533
+ """User account is affiliate."""
18534
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
17616
18535
 
17617
- """Description of the microsite (plaintext, deprecated for input)."""
17618
- description: String
18536
+ """A note about the user."""
18537
+ note: String
17619
18538
 
17620
- """Description of the microsite (HTML)."""
17621
- descriptionHtml: String
18539
+ """Only filled out if the account is a business account."""
18540
+ companyName: String
17622
18541
 
17623
- """Banner image file."""
17624
- bannerImage: Upload
18542
+ """Personal phone number."""
18543
+ personalPhone: String
17625
18544
 
17626
- """Alt text for an image."""
17627
- bannerImageAlt: String
18545
+ """Password url"""
18546
+ passwordUrl: String
17628
18547
 
17629
- """Logo image file."""
17630
- logoImage: Upload
18548
+ """Tax exempt code"""
18549
+ taxExemptCode: String
17631
18550
 
17632
- """Alt text for an image."""
17633
- logoImageAlt: String
18551
+ """List of custom fields."""
18552
+ customFields: [AttributeValueInput!]
17634
18553
 
17635
- """Search engine optimization fields."""
17636
- seo: SeoInput
18554
+ """ID of the plan to assign affiliate to."""
18555
+ plan: ID
18556
+ }
17637
18557
 
17638
- """Publication date. ISO 8601 standard."""
17639
- publicationDate: Date
18558
+ """Deletes a affiliate."""
18559
+ type AffiliateDelete {
18560
+ accountErrors: [AccountError!]!
18561
+ user: User
18562
+ }
18563
+
18564
+ """Deletes affiliates."""
18565
+ type AffiliateBulkDelete {
18566
+ """Returns how many objects were affected."""
18567
+ count: Int!
18568
+ affiliateErrors: [AccountError!]!
17640
18569
  }
17641
18570
 
17642
18571
  """Creates a new agreement."""
@@ -17700,6 +18629,9 @@ input AgreementInput {
17700
18629
  """Last update date. ISO 8601 standard."""
17701
18630
  updatedAt: String
17702
18631
 
18632
+ """Seller or Affiliate"""
18633
+ vendorType: VendorTypeEnum @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
18634
+
17703
18635
  """Gross Price, Markup, Absolute etc"""
17704
18636
  commissionType: CommissionTypeEnum
17705
18637
 
@@ -17710,6 +18642,14 @@ input AgreementInput {
17710
18642
  markupCommissionValue: Decimal
17711
18643
  }
17712
18644
 
18645
+ enum VendorTypeEnum {
18646
+ """Seller"""
18647
+ SELLER
18648
+
18649
+ """Affiliate"""
18650
+ AFFILIATE
18651
+ }
18652
+
17713
18653
  """Deletes a agreement."""
17714
18654
  type AgreementDelete {
17715
18655
  agreementErrors: [AgreementError!]!
@@ -18189,6 +19129,56 @@ type DesignerDataUpdate {
18189
19129
  designerErrors: [MarketplaceConfigurationError!]!
18190
19130
  }
18191
19131
 
19132
+ """Update existing branding."""
19133
+ type BrandingUpdate {
19134
+ ok: Boolean
19135
+ branding: BrandingType
19136
+ brandingErrors: [MarketplaceConfigurationError!]!
19137
+ }
19138
+
19139
+ input BrandingInput {
19140
+ jsonContent: JSONString
19141
+
19142
+ """Logo file."""
19143
+ logo: Upload
19144
+ logoHeight: Int
19145
+ logoWidth: Int
19146
+
19147
+ """Icon file."""
19148
+ icon: Upload
19149
+ footerText: String
19150
+
19151
+ """Favicon file."""
19152
+ favicon: Upload
19153
+ }
19154
+
19155
+ """Delete branding images."""
19156
+ type BrandingImagesDelete {
19157
+ branding: BrandingType
19158
+ brandingErrors: [MarketplaceConfigurationError!]!
19159
+ }
19160
+
19161
+ """Create core data."""
19162
+ type CoreDataCreate {
19163
+ ok: Boolean
19164
+ coredata: CoreDataType
19165
+ }
19166
+
19167
+ input CoreDataInput {
19168
+ name: String
19169
+ jsonContent: JSONString
19170
+ }
19171
+
19172
+ """
19173
+ Update existing core data instance, return ok = True and coredata = None if no matching core data instance found.
19174
+ """
19175
+ type CoreDataUpdate {
19176
+ ok: Boolean
19177
+ coredata: CoreDataType
19178
+ name: String
19179
+ jsonContent: JSONString
19180
+ }
19181
+
18192
19182
  """Creates a new webhook subscription."""
18193
19183
  type WebhookCreate {
18194
19184
  webhookErrors: [WebhookError!]!
@@ -19486,50 +20476,6 @@ input CategoryInput {
19486
20476
  customFields: [AttributeValueInput!]
19487
20477
  }
19488
20478
 
19489
- input AttributeValueInput {
19490
- """ID of the selected attribute."""
19491
- id: ID
19492
-
19493
- """
19494
- The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
19495
- """
19496
- values: [String!]
19497
-
19498
- """
19499
- Value representation of the attribute value (e.g. color value for swatch attributes).
19500
- """
19501
- value: String
19502
-
19503
- """Date and time representation of attribute value."""
19504
- dateTime: DateTime
19505
-
19506
- """Supports attribute values with long text (plain text)."""
19507
- plainText: String
19508
-
19509
- """Supports attribute values with long text (html)."""
19510
- richText: String
19511
-
19512
- """Numeric value to support money or numeric attribute values."""
19513
- amount: Decimal
19514
-
19515
- """Currency to support money attribute values."""
19516
- currency: String
19517
-
19518
- """
19519
- Supports attribute values to reference any other nautical object (should be base64 ID)
19520
- """
19521
- reference: String
19522
-
19523
- """Supports boolean attribute values."""
19524
- boolean: Boolean
19525
-
19526
- """Supports file type attribute values."""
19527
- file: Upload
19528
-
19529
- """URL type to support external links as attribute values."""
19530
- fileUrl: String
19531
- }
19532
-
19533
20479
  """Deletes a category."""
19534
20480
  type CategoryDelete {
19535
20481
  productErrors: [ProductError!]!
@@ -21265,6 +22211,9 @@ input NauticalHistoricalOrderInput {
21265
22211
  lines: [HistoricalOrderLineInput!]
21266
22212
  seller: ID
21267
22213
 
22214
+ """ID of the channel to attach the order to"""
22215
+ channel: ID
22216
+
21268
22217
  """Created date time of historical order in ISO 8601 format."""
21269
22218
  created: DateTime
21270
22219
 
@@ -22204,10 +23153,11 @@ type PrivateMetadataUpdate {
22204
23153
  item: ObjectWithMetadata
22205
23154
  }
22206
23155
 
22207
- """Creates a new Menu."""
22208
- type MenuCreate {
22209
- menuErrors: [MenuError!]!
23156
+ """Assigns storefront's navigation menus."""
23157
+ type AssignNavigation {
23158
+ """Assigned navigation menu."""
22210
23159
  menu: Menu
23160
+ menuErrors: [MenuError!]!
22211
23161
  }
22212
23162
 
22213
23163
  type MenuError {
@@ -22236,6 +23186,20 @@ enum MenuErrorCode {
22236
23186
  UNIQUE
22237
23187
  }
22238
23188
 
23189
+ enum NavigationType {
23190
+ """Main storefront navigation."""
23191
+ MAIN
23192
+
23193
+ """Secondary storefront navigation."""
23194
+ SECONDARY
23195
+ }
23196
+
23197
+ """Creates a new Menu."""
23198
+ type MenuCreate {
23199
+ menuErrors: [MenuError!]!
23200
+ menu: Menu
23201
+ }
23202
+
22239
23203
  input MenuCreateInput {
22240
23204
  """Name of the menu."""
22241
23205
  name: String!
@@ -23717,59 +24681,6 @@ type CreateToken {
23717
24681
  accountErrors: [AccountError!]!
23718
24682
  }
23719
24683
 
23720
- type AccountError {
23721
- """
23722
- Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
23723
- """
23724
- field: String
23725
-
23726
- """The error message."""
23727
- message: String!
23728
-
23729
- """The error code."""
23730
- code: AccountErrorCode!
23731
- }
23732
-
23733
- """An enumeration."""
23734
- enum AccountErrorCode {
23735
- ACTIVATE_OWN_ACCOUNT
23736
- ACTIVATE_SUPERUSER_ACCOUNT
23737
- ACCOUNT_NOT_ACTIVE
23738
- ATTRIBUTE_CANNOT_BE_ASSIGNED
23739
- DUPLICATED_INPUT_ITEM
23740
- DEACTIVATE_OWN_ACCOUNT
23741
- DEACTIVATE_SUPERUSER_ACCOUNT
23742
- DELETE_NON_STAFF_USER
23743
- DELETE_OWN_ACCOUNT
23744
- DELETE_STAFF_ACCOUNT
23745
- DELETE_SUPERUSER_ACCOUNT
23746
- GRAPHQL_ERROR
23747
- INVALID
23748
- INVALID_PHONE
23749
- INVALID_PASSWORD
23750
- LEFT_NOT_MANAGEABLE_PERMISSION
23751
- MUST_CHOOSE_PERMISSION_GROUP
23752
- INVALID_CREDENTIALS
23753
- NO_SELLER
23754
- NOT_FOUND
23755
- OUT_OF_SCOPE_SERVICE_ACCOUNT
23756
- OUT_OF_SCOPE_USER
23757
- OUT_OF_SCOPE_GROUP
23758
- OUT_OF_SCOPE_PERMISSION
23759
- PASSWORD_ENTIRELY_NUMERIC
23760
- PASSWORD_IDENTICAL
23761
- PASSWORD_TOO_COMMON
23762
- PASSWORD_TOO_SHORT
23763
- PASSWORD_TOO_SIMILAR
23764
- REQUIRED
23765
- UNIQUE
23766
- JWT_SIGNATURE_EXPIRED
23767
- JWT_INVALID_TOKEN
23768
- JWT_DECODE_ERROR
23769
- JWT_MISSING_TOKEN
23770
- JWT_INVALID_CSRF_TOKEN
23771
- }
23772
-
23773
24684
  """Create authorization URL."""
23774
24685
  type AuthURLGenerate {
23775
24686
  """Generated auth URL for google login."""
@@ -24026,55 +24937,6 @@ type CustomerCreate {
24026
24937
  user: User
24027
24938
  }
24028
24939
 
24029
- input UserCreateInput {
24030
- """Billing address of the customer."""
24031
- defaultBillingAddress: AddressInput
24032
-
24033
- """Shipping address of the customer."""
24034
- defaultShippingAddress: AddressInput
24035
-
24036
- """Given name."""
24037
- firstName: String
24038
-
24039
- """Family name."""
24040
- lastName: String
24041
-
24042
- """The unique email address of the user."""
24043
- email: String
24044
-
24045
- """User account is active."""
24046
- isActive: Boolean
24047
-
24048
- """User is staff member."""
24049
- isStaff: Boolean
24050
-
24051
- """A note about the user."""
24052
- note: String
24053
-
24054
- """Only filled out if the account is a business account."""
24055
- companyName: String
24056
-
24057
- """Personal phone number."""
24058
- personalPhone: String
24059
-
24060
- """Password url"""
24061
- passwordUrl: String
24062
-
24063
- """Tax exempt code"""
24064
- taxExemptCode: String
24065
-
24066
- """List of custom fields."""
24067
- customFields: [AttributeValueInput!]
24068
-
24069
- """Marketplace VAT identification number"""
24070
- vatIdentificationNumber: String
24071
-
24072
- """
24073
- URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
24074
- """
24075
- redirectUrl: String
24076
- }
24077
-
24078
24940
  """Updates an existing customer."""
24079
24941
  type CustomerUpdate {
24080
24942
  accountErrors: [AccountError!]!
@@ -24103,6 +24965,9 @@ input CustomerInput {
24103
24965
  """User is staff member."""
24104
24966
  isStaff: Boolean
24105
24967
 
24968
+ """User account is affiliate."""
24969
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
24970
+
24106
24971
  """A note about the user."""
24107
24972
  note: String
24108
24973
 
@@ -24182,6 +25047,9 @@ input StaffCreateInput {
24182
25047
  """User is staff member."""
24183
25048
  isStaff: Boolean
24184
25049
 
25050
+ """User account is affiliate."""
25051
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
25052
+
24185
25053
  """A note about the user."""
24186
25054
  note: String
24187
25055
 
@@ -24234,6 +25102,9 @@ input StaffUpdateInput {
24234
25102
  """User is staff member."""
24235
25103
  isStaff: Boolean
24236
25104
 
25105
+ """User account is affiliate."""
25106
+ isAffiliate: Boolean @deprecated(reason: "This will be removed on October 26, 2024 when affiliate support is removed.")
25107
+
24237
25108
  """A note about the user."""
24238
25109
  note: String
24239
25110