@nautical-commerce/graphql-schema 1.65.2 → 1.66.0-10-g1b56e8bd5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/nautical/schema.graphql +513 -489
- package/package.json +1 -1
package/nautical/schema.graphql
CHANGED
@@ -499,6 +499,36 @@ type Query {
|
|
499
499
|
last: Int
|
500
500
|
): RefundCountableConnection
|
501
501
|
|
502
|
+
"""Look up a policy by ID or slug."""
|
503
|
+
policy(
|
504
|
+
"""ID of the policy."""
|
505
|
+
id: ID
|
506
|
+
|
507
|
+
"""The slug of the policy."""
|
508
|
+
slug: String
|
509
|
+
): Policy
|
510
|
+
|
511
|
+
"""List of the shop's policies."""
|
512
|
+
policies(
|
513
|
+
"""Sort policies."""
|
514
|
+
sortBy: PolicySortingInput
|
515
|
+
|
516
|
+
"""Filtering options for policies."""
|
517
|
+
filter: PolicyFilterInput
|
518
|
+
|
519
|
+
"""Return the elements in the list that come before the specified cursor."""
|
520
|
+
before: String
|
521
|
+
|
522
|
+
"""Return the elements in the list that come after the specified cursor."""
|
523
|
+
after: String
|
524
|
+
|
525
|
+
"""Return the first n elements from the list."""
|
526
|
+
first: Int
|
527
|
+
|
528
|
+
"""Return the last n elements from the list."""
|
529
|
+
last: Int
|
530
|
+
): PolicyCountableConnection
|
531
|
+
|
502
532
|
"""Look up digital content by ID."""
|
503
533
|
digitalContent(
|
504
534
|
"""ID of the digital content."""
|
@@ -611,9 +641,6 @@ type Query {
|
|
611
641
|
"""
|
612
642
|
identifier: ID
|
613
643
|
|
614
|
-
"""Microsite ID to filter by"""
|
615
|
-
microsite: ID
|
616
|
-
|
617
644
|
"""Return the elements in the list that come before the specified cursor."""
|
618
645
|
before: String
|
619
646
|
|
@@ -1441,42 +1468,6 @@ type Query {
|
|
1441
1468
|
"""Return all nautical configuration items"""
|
1442
1469
|
nauticalConfigurationList: [NauticalConfiguration!]
|
1443
1470
|
|
1444
|
-
"""Look up a microsite by ID or slug"""
|
1445
|
-
microsite(
|
1446
|
-
"""ID of the microsite."""
|
1447
|
-
id: ID
|
1448
|
-
|
1449
|
-
"""Slug of the microsite"""
|
1450
|
-
slug: String
|
1451
|
-
): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
1452
|
-
|
1453
|
-
"""List of microsites"""
|
1454
|
-
microsites(
|
1455
|
-
"""Filtering options for microsites"""
|
1456
|
-
filter: MicrositeFilterInput
|
1457
|
-
|
1458
|
-
"""Sort microsites"""
|
1459
|
-
sortBy: MicrositeSortingInput
|
1460
|
-
|
1461
|
-
"""Return the elements in the list that come before the specified cursor."""
|
1462
|
-
before: String
|
1463
|
-
|
1464
|
-
"""Return the elements in the list that come after the specified cursor."""
|
1465
|
-
after: String
|
1466
|
-
|
1467
|
-
"""Return the first n elements from the list."""
|
1468
|
-
first: Int
|
1469
|
-
|
1470
|
-
"""Return the last n elements from the list."""
|
1471
|
-
last: Int
|
1472
|
-
): MicrositeCountableConnection @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
1473
|
-
|
1474
|
-
"""Look up microsite by vendor ID"""
|
1475
|
-
vendorMicrosite(
|
1476
|
-
"""ID of vendor to fetch microsite for."""
|
1477
|
-
id: ID!
|
1478
|
-
): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
1479
|
-
|
1480
1471
|
"""Look up a navigation menu by ID or name."""
|
1481
1472
|
menu(
|
1482
1473
|
"""ID of the menu."""
|
@@ -1572,14 +1563,14 @@ type Query {
|
|
1572
1563
|
|
1573
1564
|
"""End of the period to filter results"""
|
1574
1565
|
endDate: Date!
|
1575
|
-
): InReportOrderCustomerSummaryType
|
1566
|
+
): InReportOrderCustomerSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1576
1567
|
insightsOrdersSellerSummary(
|
1577
1568
|
"""Beginning of the period to filter results"""
|
1578
1569
|
startDate: Date!
|
1579
1570
|
|
1580
1571
|
"""End of the period to filter results"""
|
1581
1572
|
endDate: Date!
|
1582
|
-
): InReportOrderSellerSummaryType
|
1573
|
+
): InReportOrderSellerSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1583
1574
|
insightsOrdersMarketplaceSummary(
|
1584
1575
|
"""Beginning of the period to filter results"""
|
1585
1576
|
startDate: Date!
|
@@ -1589,14 +1580,14 @@ type Query {
|
|
1589
1580
|
|
1590
1581
|
"""Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
|
1591
1582
|
dimension: InsightDimensionEnum = MONTH
|
1592
|
-
): InReportOrderMarketplaceSummaryType
|
1583
|
+
): InReportOrderMarketplaceSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1593
1584
|
insightsMarketplacePayoutsSummary(
|
1594
1585
|
"""Beginning of the period to filter results"""
|
1595
1586
|
startDate: Date!
|
1596
1587
|
|
1597
1588
|
"""End of the period to filter results"""
|
1598
1589
|
endDate: Date!
|
1599
|
-
): InReportMarketplacePayoutsSummaryType
|
1590
|
+
): InReportMarketplacePayoutsSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1600
1591
|
insightsMarketplaceTaxSummary(
|
1601
1592
|
"""Beginning of the period to filter results"""
|
1602
1593
|
startDate: Date!
|
@@ -1606,21 +1597,21 @@ type Query {
|
|
1606
1597
|
|
1607
1598
|
"""Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
|
1608
1599
|
dimension: InsightDimensionEnum = YEAR
|
1609
|
-
): InReportMarketplaceTaxSummaryType
|
1600
|
+
): InReportMarketplaceTaxSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1610
1601
|
insightsMarketplaceTaxesByCountry(
|
1611
1602
|
"""Beginning of the period to filter results"""
|
1612
1603
|
startDate: Date!
|
1613
1604
|
|
1614
1605
|
"""End of the period to filter results"""
|
1615
1606
|
endDate: Date!
|
1616
|
-
): InReportMarketplaceTaxesByCountryType
|
1607
|
+
): InReportMarketplaceTaxesByCountryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1617
1608
|
insightsMarketplaceTaxesByCountryArea(
|
1618
1609
|
"""Beginning of the period to filter results"""
|
1619
1610
|
startDate: Date!
|
1620
1611
|
|
1621
1612
|
"""End of the period to filter results"""
|
1622
1613
|
endDate: Date!
|
1623
|
-
): InReportMarketplaceTaxesByCountryType
|
1614
|
+
): InReportMarketplaceTaxesByCountryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1624
1615
|
insightsTopPerformingProducts(
|
1625
1616
|
"""Beginning of the period to filter results"""
|
1626
1617
|
startDate: Date!
|
@@ -1665,7 +1656,7 @@ type Query {
|
|
1665
1656
|
|
1666
1657
|
"""Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
|
1667
1658
|
dimension: InsightDimensionEnum = DAY
|
1668
|
-
): InReportMarketplacePaymentsSummaryType
|
1659
|
+
): InReportMarketplacePaymentsSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
|
1669
1660
|
dashboardOrdersSummary(
|
1670
1661
|
"""ID of seller for filtering"""
|
1671
1662
|
identifier: ID
|
@@ -1978,6 +1969,14 @@ type Query {
|
|
1978
1969
|
id: ID!
|
1979
1970
|
): App
|
1980
1971
|
|
1972
|
+
"""Dashboard integrations for the given contexts"""
|
1973
|
+
dashboardUiIntegrations(
|
1974
|
+
"""
|
1975
|
+
Contexts that integrations should be filtered to. If not specified, all contexts will be returned.
|
1976
|
+
"""
|
1977
|
+
contexts: [AppDashboardIntegrationContextEnum!]
|
1978
|
+
): [AppDashboardIntegration!]!
|
1979
|
+
|
1981
1980
|
"""Look up a marketplace agreement by ID or slug."""
|
1982
1981
|
agreement(
|
1983
1982
|
"""ID of the marketplace agreement."""
|
@@ -2194,6 +2193,7 @@ enum EventTypeEnum {
|
|
2194
2193
|
partial_order_cancel
|
2195
2194
|
order_refund_confirmation
|
2196
2195
|
pending_quote
|
2196
|
+
merchant_account_set_password
|
2197
2197
|
account_set_staff_password
|
2198
2198
|
csv_export_products_success
|
2199
2199
|
csv_export_failed
|
@@ -2592,9 +2592,6 @@ type CountryDisplay {
|
|
2592
2592
|
"""List of required address fields for the country."""
|
2593
2593
|
requiredFields: [String!]
|
2594
2594
|
|
2595
|
-
"""List of allowed country area choices for this country."""
|
2596
|
-
allowedCountryAreas: [String!] @deprecated(reason: "Use detailedAllowedCountryAreas instead which returns the code for each area as well. This field will be removed after December 31, 2024.")
|
2597
|
-
|
2598
2595
|
"""List of allowed country area choices including codes"""
|
2599
2596
|
detailedAllowedCountryAreas: [CountryArea!]!
|
2600
2597
|
}
|
@@ -2764,7 +2761,6 @@ enum ShippingMethodTypeEnum {
|
|
2764
2761
|
}
|
2765
2762
|
|
2766
2763
|
type MultiSellerShippingMethod {
|
2767
|
-
seller: Int @deprecated(reason: "Use sellerId instead. This will be removed on December 31, 2024.")
|
2768
2764
|
sellerId: ID!
|
2769
2765
|
sellerName: String!
|
2770
2766
|
value: [ShippingMethod!]!
|
@@ -3107,7 +3103,7 @@ type Product implements Node & ObjectWithMetadata {
|
|
3107
3103
|
isAvailableForPurchase: Boolean
|
3108
3104
|
|
3109
3105
|
"""
|
3110
|
-
Product sort order in the specific collection
|
3106
|
+
Product sort order in the specific collection. Make sense only as a part of the parent 'collection(s)' queries.
|
3111
3107
|
"""
|
3112
3108
|
sortOrder: Int
|
3113
3109
|
|
@@ -3212,9 +3208,6 @@ type Seller implements Node & ObjectWithMetadata {
|
|
3212
3208
|
"""Date seller acknowledged their existing agreement."""
|
3213
3209
|
agreementAcknowledged: DateTime
|
3214
3210
|
canUseInStorefront: Boolean
|
3215
|
-
|
3216
|
-
"""Microsite of the seller."""
|
3217
|
-
microsite: Microsite
|
3218
3211
|
pk: Int
|
3219
3212
|
externalPayoutStatus: Boolean
|
3220
3213
|
externalPayoutSchedule: String
|
@@ -4593,7 +4586,6 @@ input AttributeFilterInput {
|
|
4593
4586
|
inCollection: ID
|
4594
4587
|
inProductSearch: String
|
4595
4588
|
inVariantSearch: String
|
4596
|
-
inMicrosite: ID
|
4597
4589
|
inCategory: ID
|
4598
4590
|
|
4599
4591
|
"""
|
@@ -4711,6 +4703,12 @@ type App implements Node & ObjectWithMetadata {
|
|
4711
4703
|
"""Type of the app."""
|
4712
4704
|
type: AppTypeEnum
|
4713
4705
|
|
4706
|
+
"""List of dashboard integrations for this app"""
|
4707
|
+
dashboardIntegrations: [AppDashboardIntegration!]
|
4708
|
+
|
4709
|
+
"""List of storefront integrations for this app"""
|
4710
|
+
storefrontIntegrations: [AppStorefrontIntegration!]
|
4711
|
+
|
4714
4712
|
"""List of webhooks assigned to this app."""
|
4715
4713
|
webhooks: [Webhook!]
|
4716
4714
|
|
@@ -4804,6 +4802,59 @@ enum AppTypeEnum {
|
|
4804
4802
|
THIRDPARTY
|
4805
4803
|
}
|
4806
4804
|
|
4805
|
+
"""Represents a dashboard integration for an App."""
|
4806
|
+
type AppDashboardIntegration implements Node {
|
4807
|
+
"""The ID of the object"""
|
4808
|
+
id: ID!
|
4809
|
+
|
4810
|
+
"""
|
4811
|
+
App this integration is for. This may be null for integrations that come from plugins.
|
4812
|
+
"""
|
4813
|
+
app: App
|
4814
|
+
|
4815
|
+
"""What context this integration should be rendered in"""
|
4816
|
+
context: AppDashboardIntegrationContextEnum!
|
4817
|
+
|
4818
|
+
"""The URL to load for this integration"""
|
4819
|
+
iframeUrl: String!
|
4820
|
+
}
|
4821
|
+
|
4822
|
+
enum AppDashboardIntegrationContextEnum {
|
4823
|
+
"""Nautical order details page"""
|
4824
|
+
NAUTICAL_ORDER
|
4825
|
+
|
4826
|
+
"""Seller order details page"""
|
4827
|
+
ORDER
|
4828
|
+
}
|
4829
|
+
|
4830
|
+
"""Represents a storefront integration for an App."""
|
4831
|
+
type AppStorefrontIntegration implements Node {
|
4832
|
+
"""The ID of the object"""
|
4833
|
+
id: ID!
|
4834
|
+
|
4835
|
+
"""
|
4836
|
+
App this integration is for. This may be null for integrations that come from plugins.
|
4837
|
+
"""
|
4838
|
+
app: App
|
4839
|
+
|
4840
|
+
"""What context this integration should be rendered in"""
|
4841
|
+
context: AppStorefrontIntegrationContextEnum!
|
4842
|
+
|
4843
|
+
"""JSON string of params to pass to the remote component"""
|
4844
|
+
params: String!
|
4845
|
+
|
4846
|
+
"""The URL to the remote component to load"""
|
4847
|
+
componentUrl: String!
|
4848
|
+
}
|
4849
|
+
|
4850
|
+
enum AppStorefrontIntegrationContextEnum {
|
4851
|
+
"""Product details page"""
|
4852
|
+
PRODUCT_DETAILS
|
4853
|
+
|
4854
|
+
"""Sitewide"""
|
4855
|
+
SITE
|
4856
|
+
}
|
4857
|
+
|
4807
4858
|
"""Webhook."""
|
4808
4859
|
type Webhook implements Node {
|
4809
4860
|
name: String!
|
@@ -4851,8 +4902,6 @@ enum WebhookEventTypeEnum {
|
|
4851
4902
|
INVOICE_DELETED
|
4852
4903
|
INVOICE_REQUESTED
|
4853
4904
|
INVOICE_SENT
|
4854
|
-
MICROSITE_CREATED
|
4855
|
-
MICROSITE_UPDATED
|
4856
4905
|
NAUTICAL_ORDER_CANCELLED
|
4857
4906
|
NAUTICAL_ORDER_CREATED
|
4858
4907
|
NAUTICAL_ORDER_FULFILLED
|
@@ -7011,7 +7060,7 @@ type AgreementSellersCountableEdge {
|
|
7011
7060
|
}
|
7012
7061
|
|
7013
7062
|
"""A seller agreement mapping"""
|
7014
|
-
type AgreementSellers implements Node
|
7063
|
+
type AgreementSellers implements Node {
|
7015
7064
|
"""The ID of the object"""
|
7016
7065
|
id: ID!
|
7017
7066
|
tenant: Tenant!
|
@@ -7019,20 +7068,12 @@ type AgreementSellers implements Node & ObjectWithMetadata {
|
|
7019
7068
|
acknowledgedOn: DateTime
|
7020
7069
|
plan: Agreement
|
7021
7070
|
effectiveAt: DateTime!
|
7022
|
-
|
7023
|
-
"""
|
7024
|
-
List of private metadata items.Requires proper staff permissions to access.
|
7025
|
-
"""
|
7026
|
-
privateMetadata: [MetadataItem!]!
|
7027
|
-
|
7028
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
7029
|
-
metadata: [MetadataItem!]!
|
7030
7071
|
}
|
7031
7072
|
|
7032
7073
|
"""
|
7033
7074
|
A marketplace agreement created, edited and maintianed in the dashboard
|
7034
7075
|
"""
|
7035
|
-
type Agreement implements Node
|
7076
|
+
type Agreement implements Node {
|
7036
7077
|
"""The ID of the object"""
|
7037
7078
|
id: ID!
|
7038
7079
|
publicationDate: Date
|
@@ -7066,14 +7107,6 @@ type Agreement implements Node & ObjectWithMetadata {
|
|
7066
7107
|
|
7067
7108
|
"""List of extra fees associated with the agreement."""
|
7068
7109
|
fees: [AgreementFees!]!
|
7069
|
-
|
7070
|
-
"""
|
7071
|
-
List of private metadata items.Requires proper staff permissions to access.
|
7072
|
-
"""
|
7073
|
-
privateMetadata: [MetadataItem!]!
|
7074
|
-
|
7075
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
7076
|
-
metadata: [MetadataItem!]!
|
7077
7110
|
}
|
7078
7111
|
|
7079
7112
|
enum CommissionTypeEnum {
|
@@ -7093,20 +7126,12 @@ enum MarkupCommissionTypeEnum {
|
|
7093
7126
|
}
|
7094
7127
|
|
7095
7128
|
"""An agreement commission"""
|
7096
|
-
type AgreementCommission implements Node
|
7129
|
+
type AgreementCommission implements Node {
|
7097
7130
|
"""The ID of the object"""
|
7098
7131
|
id: ID!
|
7099
7132
|
tenant: Tenant!
|
7100
7133
|
commission: Decimal!
|
7101
7134
|
agreement: Agreement!
|
7102
|
-
|
7103
|
-
"""
|
7104
|
-
List of private metadata items.Requires proper staff permissions to access.
|
7105
|
-
"""
|
7106
|
-
privateMetadata: [MetadataItem!]!
|
7107
|
-
|
7108
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
7109
|
-
metadata: [MetadataItem!]!
|
7110
7135
|
instance: Category
|
7111
7136
|
}
|
7112
7137
|
|
@@ -7157,61 +7182,6 @@ type WarehouseCountableEdge {
|
|
7157
7182
|
cursor: String!
|
7158
7183
|
}
|
7159
7184
|
|
7160
|
-
"""Represents a microsite of products."""
|
7161
|
-
type Microsite implements Node & ObjectWithMetadata {
|
7162
|
-
"""The ID of the object"""
|
7163
|
-
id: ID!
|
7164
|
-
publicationDate: Date
|
7165
|
-
description: String!
|
7166
|
-
descriptionHtml: String!
|
7167
|
-
seoTitle: String
|
7168
|
-
seoDescription: String
|
7169
|
-
name: String!
|
7170
|
-
slug: String!
|
7171
|
-
footerText: String
|
7172
|
-
seller: Seller
|
7173
|
-
|
7174
|
-
"""
|
7175
|
-
List of private metadata items.Requires proper staff permissions to access.
|
7176
|
-
"""
|
7177
|
-
privateMetadata: [MetadataItem!]!
|
7178
|
-
|
7179
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
7180
|
-
metadata: [MetadataItem!]!
|
7181
|
-
|
7182
|
-
"""List of products in this microsite."""
|
7183
|
-
products(
|
7184
|
-
"""Filtering options for products."""
|
7185
|
-
filter: ProductFilterInput
|
7186
|
-
|
7187
|
-
"""Sort products."""
|
7188
|
-
sortBy: ProductOrder
|
7189
|
-
|
7190
|
-
"""Return the elements in the list that come before the specified cursor."""
|
7191
|
-
before: String
|
7192
|
-
|
7193
|
-
"""Return the elements in the list that come after the specified cursor."""
|
7194
|
-
after: String
|
7195
|
-
|
7196
|
-
"""Return the first n elements from the list."""
|
7197
|
-
first: Int
|
7198
|
-
|
7199
|
-
"""Return the last n elements from the list."""
|
7200
|
-
last: Int
|
7201
|
-
): ProductCountableConnection
|
7202
|
-
bannerImage(
|
7203
|
-
"""Size of the image."""
|
7204
|
-
size: Int
|
7205
|
-
): Image
|
7206
|
-
logoImage(
|
7207
|
-
"""Size of the image."""
|
7208
|
-
size: Int
|
7209
|
-
): Image
|
7210
|
-
|
7211
|
-
"""Whether the microsite is published."""
|
7212
|
-
isPublished: Boolean!
|
7213
|
-
}
|
7214
|
-
|
7215
7185
|
"""Document"""
|
7216
7186
|
type Document {
|
7217
7187
|
"""Global ID of the Document."""
|
@@ -8126,8 +8096,6 @@ enum WebhookSampleEventTypeEnum {
|
|
8126
8096
|
INVOICE_DELETED
|
8127
8097
|
INVOICE_REQUESTED
|
8128
8098
|
INVOICE_SENT
|
8129
|
-
MICROSITE_CREATED
|
8130
|
-
MICROSITE_UPDATED
|
8131
8099
|
NAUTICAL_ORDER_CANCELLED
|
8132
8100
|
NAUTICAL_ORDER_CREATED
|
8133
8101
|
NAUTICAL_ORDER_FULFILLED
|
@@ -8671,7 +8639,15 @@ type Shop {
|
|
8671
8639
|
"""
|
8672
8640
|
None if shop does not use Crisp, otherwise this contains Crisp Website ID.
|
8673
8641
|
"""
|
8674
|
-
crispWebsiteId: String
|
8642
|
+
crispWebsiteId: String @deprecated(reason: "This will be removed on April 7, 2025.")
|
8643
|
+
|
8644
|
+
"""Storefront integrations for the given contexts"""
|
8645
|
+
storefrontUiIntegrations(
|
8646
|
+
"""
|
8647
|
+
Contexts that integrations should be filtered to. If not specified, all contexts will be returned.
|
8648
|
+
"""
|
8649
|
+
contexts: [AppStorefrontIntegrationContextEnum!]
|
8650
|
+
): [AppStorefrontIntegration!]!
|
8675
8651
|
|
8676
8652
|
"""Determines whether seller products require approval"""
|
8677
8653
|
requireProductApproval: Boolean
|
@@ -8942,7 +8918,7 @@ input ShippingZoneFilterInput {
|
|
8942
8918
|
search: String
|
8943
8919
|
}
|
8944
8920
|
|
8945
|
-
type PublicSeller implements Node {
|
8921
|
+
type PublicSeller implements Node & ObjectWithMetadata {
|
8946
8922
|
"""The ID of the object"""
|
8947
8923
|
id: ID!
|
8948
8924
|
companyName: String!
|
@@ -8958,6 +8934,14 @@ type PublicSeller implements Node {
|
|
8958
8934
|
): Image
|
8959
8935
|
products(offset: Int, before: String, after: String, first: Int, last: Int): ProductCountableConnection!
|
8960
8936
|
variants(offset: Int, before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection!
|
8937
|
+
|
8938
|
+
"""
|
8939
|
+
List of private metadata items.Requires proper staff permissions to access.
|
8940
|
+
"""
|
8941
|
+
privateMetadata: [MetadataItem!]!
|
8942
|
+
|
8943
|
+
"""List of public metadata items. Can be accessed without permissions."""
|
8944
|
+
metadata: [MetadataItem!]!
|
8961
8945
|
storeDescription: String
|
8962
8946
|
storeDescriptionPlainText: String
|
8963
8947
|
}
|
@@ -9130,6 +9114,100 @@ enum RefundSortField {
|
|
9130
9114
|
TOKEN
|
9131
9115
|
}
|
9132
9116
|
|
9117
|
+
"""
|
9118
|
+
A policy that can be manually added by a shop operator through the dashboard.
|
9119
|
+
"""
|
9120
|
+
type Policy implements Node & ObjectWithMetadata {
|
9121
|
+
"""The ID of the object"""
|
9122
|
+
id: ID!
|
9123
|
+
publicationDate: Date
|
9124
|
+
createdAt: DateTime!
|
9125
|
+
updatedAt: DateTime!
|
9126
|
+
content: String!
|
9127
|
+
contentHtml: String!
|
9128
|
+
seoTitle: String
|
9129
|
+
seoDescription: String
|
9130
|
+
category: PolicyCategory!
|
9131
|
+
slug: String!
|
9132
|
+
title: String!
|
9133
|
+
|
9134
|
+
"""
|
9135
|
+
List of private metadata items.Requires proper staff permissions to access.
|
9136
|
+
"""
|
9137
|
+
privateMetadata: [MetadataItem!]!
|
9138
|
+
|
9139
|
+
"""List of public metadata items. Can be accessed without permissions."""
|
9140
|
+
metadata: [MetadataItem!]!
|
9141
|
+
|
9142
|
+
"""Whether the policy is published."""
|
9143
|
+
isPublished: Boolean!
|
9144
|
+
}
|
9145
|
+
|
9146
|
+
"""An enumeration."""
|
9147
|
+
enum PolicyCategory {
|
9148
|
+
"""Terms of Service"""
|
9149
|
+
TERMS_OF_SERVICE
|
9150
|
+
|
9151
|
+
"""Privacy Policy"""
|
9152
|
+
PRIVACY_POLICY
|
9153
|
+
|
9154
|
+
"""Returns & Refund"""
|
9155
|
+
RETURNS_AND_REFUNDS
|
9156
|
+
|
9157
|
+
"""Shipping Policy"""
|
9158
|
+
SHIPPING_POLICY
|
9159
|
+
|
9160
|
+
"""Custom"""
|
9161
|
+
CUSTOM
|
9162
|
+
}
|
9163
|
+
|
9164
|
+
type PolicyCountableConnection {
|
9165
|
+
"""Pagination data for this connection."""
|
9166
|
+
pageInfo: PageInfo!
|
9167
|
+
edges: [PolicyCountableEdge!]!
|
9168
|
+
|
9169
|
+
"""A total count of items in the collection."""
|
9170
|
+
totalCount: Int
|
9171
|
+
}
|
9172
|
+
|
9173
|
+
type PolicyCountableEdge {
|
9174
|
+
"""The item at the end of the edge."""
|
9175
|
+
node: Policy!
|
9176
|
+
|
9177
|
+
"""A cursor for use in pagination."""
|
9178
|
+
cursor: String!
|
9179
|
+
}
|
9180
|
+
|
9181
|
+
input PolicySortingInput {
|
9182
|
+
"""Specifies the direction in which to sort products."""
|
9183
|
+
direction: OrderDirection!
|
9184
|
+
|
9185
|
+
"""Sort policies by the selected field."""
|
9186
|
+
field: PolicySortField!
|
9187
|
+
}
|
9188
|
+
|
9189
|
+
enum PolicySortField {
|
9190
|
+
"""Sort policies by title."""
|
9191
|
+
TITLE
|
9192
|
+
|
9193
|
+
"""Sort policies by slug."""
|
9194
|
+
SLUG
|
9195
|
+
|
9196
|
+
"""Sort policies by visibility."""
|
9197
|
+
VISIBILITY
|
9198
|
+
|
9199
|
+
"""Sort policies by creation date."""
|
9200
|
+
CREATION_DATE
|
9201
|
+
|
9202
|
+
"""Sort policies by publication date."""
|
9203
|
+
PUBLICATION_DATE
|
9204
|
+
}
|
9205
|
+
|
9206
|
+
input PolicyFilterInput {
|
9207
|
+
search: String
|
9208
|
+
isPublished: Boolean
|
9209
|
+
}
|
9210
|
+
|
9133
9211
|
type DigitalContentCountableConnection {
|
9134
9212
|
"""Pagination data for this connection."""
|
9135
9213
|
pageInfo: PageInfo!
|
@@ -10776,100 +10854,48 @@ type NauticalConfiguration {
|
|
10776
10854
|
configurationValueString: String
|
10777
10855
|
}
|
10778
10856
|
|
10779
|
-
|
10857
|
+
"""
|
10858
|
+
Represents a single menu - an object that is used to help navigate through the store.
|
10859
|
+
"""
|
10860
|
+
type Menu implements Node {
|
10861
|
+
"""The ID of the object"""
|
10862
|
+
id: ID!
|
10863
|
+
name: String!
|
10864
|
+
slug: String!
|
10865
|
+
items: [MenuItem!]!
|
10866
|
+
}
|
10867
|
+
|
10868
|
+
"""
|
10869
|
+
Represents a single item of the related menu. Can store categories, collection or pages.
|
10870
|
+
"""
|
10871
|
+
type MenuItem implements Node {
|
10872
|
+
"""The ID of the object"""
|
10873
|
+
id: ID!
|
10874
|
+
menu: Menu!
|
10875
|
+
name: String!
|
10876
|
+
parent: MenuItem
|
10877
|
+
category: Category
|
10878
|
+
collection: Collection
|
10879
|
+
page: Page
|
10880
|
+
level: Int!
|
10881
|
+
children: [MenuItem!]!
|
10882
|
+
|
10883
|
+
"""URL to the menu item."""
|
10884
|
+
url: String
|
10885
|
+
}
|
10886
|
+
|
10887
|
+
type MenuCountableConnection {
|
10780
10888
|
"""Pagination data for this connection."""
|
10781
10889
|
pageInfo: PageInfo!
|
10782
|
-
edges: [
|
10890
|
+
edges: [MenuCountableEdge!]!
|
10783
10891
|
|
10784
10892
|
"""A total count of items in the collection."""
|
10785
10893
|
totalCount: Int
|
10786
10894
|
}
|
10787
10895
|
|
10788
|
-
type
|
10896
|
+
type MenuCountableEdge {
|
10789
10897
|
"""The item at the end of the edge."""
|
10790
|
-
node:
|
10791
|
-
|
10792
|
-
"""A cursor for use in pagination."""
|
10793
|
-
cursor: String!
|
10794
|
-
}
|
10795
|
-
|
10796
|
-
input MicrositeFilterInput {
|
10797
|
-
published: MicrositePublished
|
10798
|
-
search: String
|
10799
|
-
ids: [ID]
|
10800
|
-
metadata: MetadataFilterInput
|
10801
|
-
privateMetadata: MetadataFilterInput
|
10802
|
-
}
|
10803
|
-
|
10804
|
-
enum MicrositePublished {
|
10805
|
-
PUBLISHED
|
10806
|
-
HIDDEN
|
10807
|
-
}
|
10808
|
-
|
10809
|
-
input MicrositeSortingInput {
|
10810
|
-
"""Specifies the direction in which to sort products."""
|
10811
|
-
direction: OrderDirection!
|
10812
|
-
|
10813
|
-
"""Sort microsites by the selected field."""
|
10814
|
-
field: MicrositeSortField!
|
10815
|
-
}
|
10816
|
-
|
10817
|
-
enum MicrositeSortField {
|
10818
|
-
"""Sort microsites by name."""
|
10819
|
-
NAME
|
10820
|
-
|
10821
|
-
"""Sort microsites by availability."""
|
10822
|
-
AVAILABILITY
|
10823
|
-
|
10824
|
-
"""Sort microsites by product count."""
|
10825
|
-
PRODUCT_COUNT
|
10826
|
-
|
10827
|
-
"""Sort microsites by publication date."""
|
10828
|
-
PUBLICATION_DATE
|
10829
|
-
}
|
10830
|
-
|
10831
|
-
"""
|
10832
|
-
Represents a single menu - an object that is used to help navigate through the store.
|
10833
|
-
"""
|
10834
|
-
type Menu implements Node {
|
10835
|
-
"""The ID of the object"""
|
10836
|
-
id: ID!
|
10837
|
-
name: String!
|
10838
|
-
slug: String!
|
10839
|
-
items: [MenuItem!]!
|
10840
|
-
}
|
10841
|
-
|
10842
|
-
"""
|
10843
|
-
Represents a single item of the related menu. Can store categories, collection or pages.
|
10844
|
-
"""
|
10845
|
-
type MenuItem implements Node {
|
10846
|
-
"""The ID of the object"""
|
10847
|
-
id: ID!
|
10848
|
-
menu: Menu!
|
10849
|
-
name: String!
|
10850
|
-
parent: MenuItem
|
10851
|
-
category: Category
|
10852
|
-
collection: Collection
|
10853
|
-
page: Page
|
10854
|
-
level: Int!
|
10855
|
-
children: [MenuItem!]!
|
10856
|
-
|
10857
|
-
"""URL to the menu item."""
|
10858
|
-
url: String
|
10859
|
-
}
|
10860
|
-
|
10861
|
-
type MenuCountableConnection {
|
10862
|
-
"""Pagination data for this connection."""
|
10863
|
-
pageInfo: PageInfo!
|
10864
|
-
edges: [MenuCountableEdge!]!
|
10865
|
-
|
10866
|
-
"""A total count of items in the collection."""
|
10867
|
-
totalCount: Int
|
10868
|
-
}
|
10869
|
-
|
10870
|
-
type MenuCountableEdge {
|
10871
|
-
"""The item at the end of the edge."""
|
10872
|
-
node: Menu!
|
10898
|
+
node: Menu!
|
10873
10899
|
|
10874
10900
|
"""A cursor for use in pagination."""
|
10875
10901
|
cursor: String!
|
@@ -11005,6 +11031,11 @@ type MarketplaceConfiguration {
|
|
11005
11031
|
customerSetPasswordUrl: String
|
11006
11032
|
includeTaxesInPrices: Boolean!
|
11007
11033
|
chargeTaxesOnShipping: Boolean!
|
11034
|
+
|
11035
|
+
"""
|
11036
|
+
The marketplace's end trial date, or null if the marketplace is not in trial mode.
|
11037
|
+
"""
|
11038
|
+
trialEndsAt: DateTime
|
11008
11039
|
}
|
11009
11040
|
|
11010
11041
|
enum MarketplaceConfigurationPayoutAutomationStrategyEnum {
|
@@ -11693,6 +11724,9 @@ enum EmailEventMessageType {
|
|
11693
11724
|
"""Pending Quote"""
|
11694
11725
|
PENDING_QUOTE
|
11695
11726
|
|
11727
|
+
"""Merchant Account Set Password"""
|
11728
|
+
MERCHANT_ACCOUNT_SET_PASSWORD
|
11729
|
+
|
11696
11730
|
"""Account Set Staff Password"""
|
11697
11731
|
ACCOUNT_SET_STAFF_PASSWORD
|
11698
11732
|
|
@@ -11813,6 +11847,9 @@ enum NotifyEventTypeEnum {
|
|
11813
11847
|
"""Pending Quote"""
|
11814
11848
|
PENDING_QUOTE
|
11815
11849
|
|
11850
|
+
"""Merchant Account Set Password"""
|
11851
|
+
MERCHANT_ACCOUNT_SET_PASSWORD
|
11852
|
+
|
11816
11853
|
"""Account Set Staff Password"""
|
11817
11854
|
ACCOUNT_SET_STAFF_PASSWORD
|
11818
11855
|
|
@@ -13138,7 +13175,7 @@ enum StaffMemberStatus {
|
|
13138
13175
|
DEACTIVATED
|
13139
13176
|
}
|
13140
13177
|
|
13141
|
-
union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection |
|
13178
|
+
union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | ProductImage | ProductStatusLog | Group | CatalogImportProcess | CatalogImportProcessLogRecord
|
13142
13179
|
|
13143
13180
|
scalar _Any
|
13144
13181
|
|
@@ -13172,7 +13209,7 @@ type Mutation {
|
|
13172
13209
|
description: String
|
13173
13210
|
|
13174
13211
|
"""
|
13175
|
-
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/
|
13212
|
+
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/gzipped, application/vnd.oasis.opendocument.spreadsheet, application/x-acad, application/vnd.oasis.opendocument.presentation, image/bmp, application/postscript, application/vnd.ms-powerpoint, image/svg+xml, text/svg-xml, application/x-dxf, image/jpg, application/excel, image/vnd.dwg, application/x-jpg, application/vnd.openxmlformats-officedocument.presentationml.slideshow, text/pdf, application/csv, image/jpeg, application/tif, image/x-tiff, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/heif-sequence, application/dxf, image/dxf, text/rtf, application/gzip-compressed, image/x-bmp, image/x-eps, application/svg+xml, pplication/vnd.rar, image/x-ms-bmp, application/x-gzip, application/x-csv, application/x-autocad, image/gif, text/svg, application/eps, text/x-csv, application/x-tiff, application/x-rar, application/x-pdf, drawing/dwg, image/heif, image/x-dxf, image/webp, application/rtf, image/heic-sequence, application/zip, image/tif, application/x-tif, text/plain, text/csv, image/svg, application/msword, image/heic, drawing/x-dwf, application/x-dwg, application/vnd.ms-word, application/vnd.pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/acad, image/eps, application/dwg, application/gzip, image/x-dwg, application/tiff, image/png, application/pdf, application/jpg, application/x-rar-compressed, application/x-zip-compressed, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/x-tar, text/x-pdf, text/x-comma-separated-values, application/vnd.oasis.opendocument.text, application/vnd.ms-excel, application/acrobat, application/x-rtf, image/tiff, drawing/x-dwg, application/x-eps, image/x-tif, text/comma-separated-values.
|
13176
13213
|
"""
|
13177
13214
|
file: Upload!
|
13178
13215
|
|
@@ -13440,69 +13477,6 @@ type Mutation {
|
|
13440
13477
|
wishlistId: ID
|
13441
13478
|
): WishlistRemoveProductVariant
|
13442
13479
|
|
13443
|
-
"""Adds products to a microsite."""
|
13444
|
-
micrositeAddProducts(
|
13445
|
-
"""ID of a microsite."""
|
13446
|
-
micrositeId: ID!
|
13447
|
-
|
13448
|
-
"""List of product IDs."""
|
13449
|
-
products: [ID!]!
|
13450
|
-
): MicrositeAddProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13451
|
-
|
13452
|
-
"""Creates a new microsite."""
|
13453
|
-
micrositeCreate(
|
13454
|
-
"""Fields required to create a microsite."""
|
13455
|
-
input: MicrositeCreateInput!
|
13456
|
-
): MicrositeCreate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13457
|
-
|
13458
|
-
"""Deletes a microsite."""
|
13459
|
-
micrositeDelete(
|
13460
|
-
"""ID of a microsite to delete."""
|
13461
|
-
id: ID!
|
13462
|
-
): MicrositeDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13463
|
-
|
13464
|
-
"""Reorder the products of a microsite."""
|
13465
|
-
micrositeReorderProducts(
|
13466
|
-
"""ID of a microsite."""
|
13467
|
-
micrositeId: ID!
|
13468
|
-
|
13469
|
-
"""The microsite products position operations."""
|
13470
|
-
moves: [MoveProductInput!]!
|
13471
|
-
): MicrositeReorderProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13472
|
-
|
13473
|
-
"""Deletes microsites."""
|
13474
|
-
micrositeBulkDelete(
|
13475
|
-
"""List of microsite IDs to delete."""
|
13476
|
-
ids: [ID!]!
|
13477
|
-
): MicrositeBulkDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13478
|
-
|
13479
|
-
"""Publish microsites."""
|
13480
|
-
micrositeBulkPublish(
|
13481
|
-
"""List of microsites IDs to (un)publish."""
|
13482
|
-
ids: [ID!]!
|
13483
|
-
|
13484
|
-
"""Determine if microsites will be published or not."""
|
13485
|
-
isPublished: Boolean!
|
13486
|
-
): MicrositeBulkPublish @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13487
|
-
|
13488
|
-
"""Remove products from a microsite."""
|
13489
|
-
micrositeRemoveProducts(
|
13490
|
-
"""ID of a microsite."""
|
13491
|
-
micrositeId: ID!
|
13492
|
-
|
13493
|
-
"""List of product IDs."""
|
13494
|
-
products: [ID!]!
|
13495
|
-
): MicrositeRemoveProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13496
|
-
|
13497
|
-
"""Updates a microsite."""
|
13498
|
-
micrositeUpdate(
|
13499
|
-
"""ID of a microsite to update."""
|
13500
|
-
id: ID!
|
13501
|
-
|
13502
|
-
"""Fields required to update a microsite."""
|
13503
|
-
input: MicrositeInput!
|
13504
|
-
): MicrositeUpdate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13505
|
-
|
13506
13480
|
"""Creates a new agreement."""
|
13507
13481
|
agreementCreate(
|
13508
13482
|
"""Fields required to create a agreement."""
|
@@ -14043,6 +14017,42 @@ type Mutation {
|
|
14043
14017
|
refundId: ID!
|
14044
14018
|
): RefundPaymentsDelete
|
14045
14019
|
|
14020
|
+
"""Creates a new policy."""
|
14021
|
+
policyCreate(
|
14022
|
+
"""Fields required to create a policy."""
|
14023
|
+
input: PolicyInput!
|
14024
|
+
): PolicyCreate
|
14025
|
+
|
14026
|
+
"""Deletes a policy."""
|
14027
|
+
policyDelete(
|
14028
|
+
"""ID of the policy to delete."""
|
14029
|
+
id: ID!
|
14030
|
+
): PolicyDelete
|
14031
|
+
|
14032
|
+
"""Deletes policy."""
|
14033
|
+
policyBulkDelete(
|
14034
|
+
"""List of policy IDs to delete."""
|
14035
|
+
ids: [ID!]!
|
14036
|
+
): PolicyBulkDelete
|
14037
|
+
|
14038
|
+
"""Publish policy."""
|
14039
|
+
policyBulkPublish(
|
14040
|
+
"""List of policy IDs to (un)publish."""
|
14041
|
+
ids: [ID!]!
|
14042
|
+
|
14043
|
+
"""Determine if policy will be published or not."""
|
14044
|
+
isPublished: Boolean!
|
14045
|
+
): PolicyBulkPublish
|
14046
|
+
|
14047
|
+
"""Updates an existing policy."""
|
14048
|
+
policyUpdate(
|
14049
|
+
"""ID of the policy to update."""
|
14050
|
+
id: ID!
|
14051
|
+
|
14052
|
+
"""Fields required to update a policy."""
|
14053
|
+
input: PolicyInput!
|
14054
|
+
): PolicyUpdate
|
14055
|
+
|
14046
14056
|
"""Creates a new price book."""
|
14047
14057
|
priceBookCreate(
|
14048
14058
|
"""Fields required to create a price book."""
|
@@ -15999,6 +16009,30 @@ type Mutation {
|
|
15999
16009
|
token: String!
|
16000
16010
|
): AppTokenVerify
|
16001
16011
|
|
16012
|
+
"""Creates a new dashboard integration for an app."""
|
16013
|
+
appDashboardIntegrationCreate(
|
16014
|
+
"""Fields required to create a dashboard integration."""
|
16015
|
+
input: AppDashboardIntegrationInput!
|
16016
|
+
): AppDashboardIntegrationCreate
|
16017
|
+
|
16018
|
+
"""Deletes an app storefront integration from the app."""
|
16019
|
+
appDashboardIntegrationDelete(
|
16020
|
+
"""ID of a app dashboard integration to delete."""
|
16021
|
+
id: ID!
|
16022
|
+
): AppDashboardIntegrationDelete
|
16023
|
+
|
16024
|
+
"""Creates a new storefront integration for an app."""
|
16025
|
+
appStorefrontIntegrationCreate(
|
16026
|
+
"""Fields required to create a storefront integration."""
|
16027
|
+
input: AppStorefrontIntegrationInput!
|
16028
|
+
): AppStorefrontIntegrationCreate
|
16029
|
+
|
16030
|
+
"""Deletes an app storefront integration from the app."""
|
16031
|
+
appStorefrontIntegrationDelete(
|
16032
|
+
"""ID of a app storefront integration to delete."""
|
16033
|
+
id: ID!
|
16034
|
+
): AppStorefrontIntegrationDelete
|
16035
|
+
|
16002
16036
|
"""Install new app by using app manifest."""
|
16003
16037
|
appInstall(
|
16004
16038
|
"""Fields required to install a new app."""
|
@@ -16990,200 +17024,6 @@ type WishlistRemoveProductVariant {
|
|
16990
17024
|
wishlistErrors: [WishlistError!]!
|
16991
17025
|
}
|
16992
17026
|
|
16993
|
-
"""Adds products to a microsite."""
|
16994
|
-
type MicrositeAddProducts {
|
16995
|
-
"""Microsite to which products will be added."""
|
16996
|
-
microsite: Microsite
|
16997
|
-
micrositeErrors: [ProductError!]!
|
16998
|
-
}
|
16999
|
-
|
17000
|
-
type ProductError {
|
17001
|
-
"""
|
17002
|
-
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
17003
|
-
"""
|
17004
|
-
field: String
|
17005
|
-
|
17006
|
-
"""The error message."""
|
17007
|
-
message: String!
|
17008
|
-
|
17009
|
-
"""The error code."""
|
17010
|
-
code: ProductErrorCode!
|
17011
|
-
|
17012
|
-
"""List of attributes IDs which causes the error."""
|
17013
|
-
attributes: [ID!]
|
17014
|
-
}
|
17015
|
-
|
17016
|
-
"""An enumeration."""
|
17017
|
-
enum ProductErrorCode {
|
17018
|
-
ALREADY_EXISTS
|
17019
|
-
ATTRIBUTE_ALREADY_ASSIGNED
|
17020
|
-
ATTRIBUTE_CANNOT_BE_ASSIGNED
|
17021
|
-
ATTRIBUTE_VARIANTS_DISABLED
|
17022
|
-
DUPLICATED_INPUT_ITEM
|
17023
|
-
GRAPHQL_ERROR
|
17024
|
-
INVALID
|
17025
|
-
INVALID_PHONE
|
17026
|
-
NOT_PRODUCTS_IMAGE
|
17027
|
-
NOT_PRODUCTS_VARIANT
|
17028
|
-
NOT_FOUND
|
17029
|
-
REQUIRED
|
17030
|
-
UNIQUE
|
17031
|
-
VARIANT_NO_DIGITAL_CONTENT
|
17032
|
-
VARIANT_IN_ACTIVE_ORDER
|
17033
|
-
CATEGORY_CANNOT_BE_ASSIGNED
|
17034
|
-
CATEGORY_CANNOT_BE_DELETED
|
17035
|
-
COLLECTION_CANNOT_BE_CHANGED
|
17036
|
-
COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
|
17037
|
-
COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
|
17038
|
-
INVENTORY_FIELD_CANNOT_BE_EDITED
|
17039
|
-
}
|
17040
|
-
|
17041
|
-
"""Creates a new microsite."""
|
17042
|
-
type MicrositeCreate {
|
17043
|
-
micrositeErrors: [ProductError!]!
|
17044
|
-
microsite: Microsite
|
17045
|
-
}
|
17046
|
-
|
17047
|
-
input MicrositeCreateInput {
|
17048
|
-
"""Informs whether a microsite is published."""
|
17049
|
-
isPublished: Boolean
|
17050
|
-
|
17051
|
-
"""Name of the microsite."""
|
17052
|
-
name: String
|
17053
|
-
|
17054
|
-
"""Text to appear in footer of microsite."""
|
17055
|
-
footerText: String
|
17056
|
-
|
17057
|
-
"""Slug of the microsite."""
|
17058
|
-
slug: String
|
17059
|
-
|
17060
|
-
"""Description of the microsite (plaintext, deprecated for input)."""
|
17061
|
-
description: String
|
17062
|
-
|
17063
|
-
"""Description of the microsite (HTML)."""
|
17064
|
-
descriptionHtml: String
|
17065
|
-
|
17066
|
-
"""Banner image file."""
|
17067
|
-
bannerImage: Upload
|
17068
|
-
|
17069
|
-
"""Alt text for an image."""
|
17070
|
-
bannerImageAlt: String
|
17071
|
-
|
17072
|
-
"""Logo image file."""
|
17073
|
-
logoImage: Upload
|
17074
|
-
|
17075
|
-
"""Alt text for an image."""
|
17076
|
-
logoImageAlt: String
|
17077
|
-
|
17078
|
-
"""Search engine optimization fields."""
|
17079
|
-
seo: SeoInput
|
17080
|
-
|
17081
|
-
"""Publication date. ISO 8601 standard."""
|
17082
|
-
publicationDate: Date
|
17083
|
-
|
17084
|
-
"""List of products to be added to the microsite."""
|
17085
|
-
products: [ID!]
|
17086
|
-
|
17087
|
-
"""Vendor that microsite belongs to"""
|
17088
|
-
vendor: ID!
|
17089
|
-
}
|
17090
|
-
|
17091
|
-
input SeoInput {
|
17092
|
-
"""SEO title."""
|
17093
|
-
title: String
|
17094
|
-
|
17095
|
-
"""SEO description."""
|
17096
|
-
description: String
|
17097
|
-
}
|
17098
|
-
|
17099
|
-
"""Deletes a microsite."""
|
17100
|
-
type MicrositeDelete {
|
17101
|
-
micrositeErrors: [ProductError!]!
|
17102
|
-
microsite: Microsite
|
17103
|
-
}
|
17104
|
-
|
17105
|
-
"""Reorder the products of a microsite."""
|
17106
|
-
type MicrositeReorderProducts {
|
17107
|
-
"""Microsite from which products are reordered."""
|
17108
|
-
microsite: Microsite
|
17109
|
-
micrositeErrors: [ProductError!]!
|
17110
|
-
}
|
17111
|
-
|
17112
|
-
input MoveProductInput {
|
17113
|
-
"""The ID of the product to move."""
|
17114
|
-
productId: ID!
|
17115
|
-
|
17116
|
-
"""
|
17117
|
-
The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
|
17118
|
-
"""
|
17119
|
-
sortOrder: Int
|
17120
|
-
}
|
17121
|
-
|
17122
|
-
"""Deletes microsites."""
|
17123
|
-
type MicrositeBulkDelete {
|
17124
|
-
"""Returns how many objects were affected."""
|
17125
|
-
count: Int!
|
17126
|
-
micrositeErrors: [ProductError!]!
|
17127
|
-
}
|
17128
|
-
|
17129
|
-
"""Publish microsites."""
|
17130
|
-
type MicrositeBulkPublish {
|
17131
|
-
"""Returns how many objects were affected."""
|
17132
|
-
count: Int!
|
17133
|
-
micrositeErrors: [ProductError!]!
|
17134
|
-
}
|
17135
|
-
|
17136
|
-
"""Remove products from a microsite."""
|
17137
|
-
type MicrositeRemoveProducts {
|
17138
|
-
"""Microsite from which products will be removed."""
|
17139
|
-
microsite: Microsite
|
17140
|
-
micrositeErrors: [ProductError!]!
|
17141
|
-
}
|
17142
|
-
|
17143
|
-
"""Updates a microsite."""
|
17144
|
-
type MicrositeUpdate {
|
17145
|
-
micrositeErrors: [ProductError!]!
|
17146
|
-
microsite: Microsite
|
17147
|
-
}
|
17148
|
-
|
17149
|
-
input MicrositeInput {
|
17150
|
-
"""Informs whether a microsite is published."""
|
17151
|
-
isPublished: Boolean
|
17152
|
-
|
17153
|
-
"""Name of the microsite."""
|
17154
|
-
name: String
|
17155
|
-
|
17156
|
-
"""Text to appear in footer of microsite."""
|
17157
|
-
footerText: String
|
17158
|
-
|
17159
|
-
"""Slug of the microsite."""
|
17160
|
-
slug: String
|
17161
|
-
|
17162
|
-
"""Description of the microsite (plaintext, deprecated for input)."""
|
17163
|
-
description: String
|
17164
|
-
|
17165
|
-
"""Description of the microsite (HTML)."""
|
17166
|
-
descriptionHtml: String
|
17167
|
-
|
17168
|
-
"""Banner image file."""
|
17169
|
-
bannerImage: Upload
|
17170
|
-
|
17171
|
-
"""Alt text for an image."""
|
17172
|
-
bannerImageAlt: String
|
17173
|
-
|
17174
|
-
"""Logo image file."""
|
17175
|
-
logoImage: Upload
|
17176
|
-
|
17177
|
-
"""Alt text for an image."""
|
17178
|
-
logoImageAlt: String
|
17179
|
-
|
17180
|
-
"""Search engine optimization fields."""
|
17181
|
-
seo: SeoInput
|
17182
|
-
|
17183
|
-
"""Publication date. ISO 8601 standard."""
|
17184
|
-
publicationDate: Date
|
17185
|
-
}
|
17186
|
-
|
17187
17027
|
"""Creates a new agreement."""
|
17188
17028
|
type AgreementCreate {
|
17189
17029
|
agreementErrors: [AgreementError!]!
|
@@ -17255,6 +17095,14 @@ input AgreementInput {
|
|
17255
17095
|
markupCommissionValue: Decimal
|
17256
17096
|
}
|
17257
17097
|
|
17098
|
+
input SeoInput {
|
17099
|
+
"""SEO title."""
|
17100
|
+
title: String
|
17101
|
+
|
17102
|
+
"""SEO description."""
|
17103
|
+
description: String
|
17104
|
+
}
|
17105
|
+
|
17258
17106
|
"""Deletes a agreement."""
|
17259
17107
|
type AgreementDelete {
|
17260
17108
|
agreementErrors: [AgreementError!]!
|
@@ -18637,6 +18485,80 @@ type RefundPaymentsDelete {
|
|
18637
18485
|
refundErrors: [RefundError!]!
|
18638
18486
|
}
|
18639
18487
|
|
18488
|
+
"""Creates a new policy."""
|
18489
|
+
type PolicyCreate {
|
18490
|
+
policyErrors: [PolicyError!]!
|
18491
|
+
policy: Policy
|
18492
|
+
}
|
18493
|
+
|
18494
|
+
type PolicyError {
|
18495
|
+
"""
|
18496
|
+
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
18497
|
+
"""
|
18498
|
+
field: String
|
18499
|
+
|
18500
|
+
"""The error message."""
|
18501
|
+
message: String!
|
18502
|
+
|
18503
|
+
"""The error code."""
|
18504
|
+
code: PolicyErrorCode!
|
18505
|
+
}
|
18506
|
+
|
18507
|
+
"""An enumeration."""
|
18508
|
+
enum PolicyErrorCode {
|
18509
|
+
GRAPHQL_ERROR
|
18510
|
+
INVALID
|
18511
|
+
NOT_FOUND
|
18512
|
+
REQUIRED
|
18513
|
+
UNIQUE
|
18514
|
+
}
|
18515
|
+
|
18516
|
+
input PolicyInput {
|
18517
|
+
"""Policy internal name."""
|
18518
|
+
slug: String
|
18519
|
+
|
18520
|
+
"""Policy title."""
|
18521
|
+
title: String
|
18522
|
+
|
18523
|
+
"""Policy content (HTML)."""
|
18524
|
+
contentHtml: String
|
18525
|
+
|
18526
|
+
"""Determines if the policy is visible in the storefront."""
|
18527
|
+
isPublished: Boolean
|
18528
|
+
|
18529
|
+
"""Publication date. ISO 8601 standard."""
|
18530
|
+
publicationDate: String
|
18531
|
+
|
18532
|
+
"""Search engine optimization fields."""
|
18533
|
+
seo: SeoInput
|
18534
|
+
}
|
18535
|
+
|
18536
|
+
"""Deletes a policy."""
|
18537
|
+
type PolicyDelete {
|
18538
|
+
policyErrors: [PolicyError!]!
|
18539
|
+
policy: Policy
|
18540
|
+
}
|
18541
|
+
|
18542
|
+
"""Deletes policy."""
|
18543
|
+
type PolicyBulkDelete {
|
18544
|
+
"""Returns how many objects were affected."""
|
18545
|
+
count: Int!
|
18546
|
+
policyErrors: [PolicyError!]!
|
18547
|
+
}
|
18548
|
+
|
18549
|
+
"""Publish policy."""
|
18550
|
+
type PolicyBulkPublish {
|
18551
|
+
"""Returns how many objects were affected."""
|
18552
|
+
count: Int!
|
18553
|
+
policyErrors: [PolicyError!]!
|
18554
|
+
}
|
18555
|
+
|
18556
|
+
"""Updates an existing policy."""
|
18557
|
+
type PolicyUpdate {
|
18558
|
+
policyErrors: [PolicyError!]!
|
18559
|
+
policy: Policy
|
18560
|
+
}
|
18561
|
+
|
18640
18562
|
"""Creates a new price book."""
|
18641
18563
|
type PriceBookCreate {
|
18642
18564
|
priceBookErrors: [PriceBookError!]!
|
@@ -18950,6 +18872,47 @@ type CategoryCreate {
|
|
18950
18872
|
category: Category
|
18951
18873
|
}
|
18952
18874
|
|
18875
|
+
type ProductError {
|
18876
|
+
"""
|
18877
|
+
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
18878
|
+
"""
|
18879
|
+
field: String
|
18880
|
+
|
18881
|
+
"""The error message."""
|
18882
|
+
message: String!
|
18883
|
+
|
18884
|
+
"""The error code."""
|
18885
|
+
code: ProductErrorCode!
|
18886
|
+
|
18887
|
+
"""List of attributes IDs which causes the error."""
|
18888
|
+
attributes: [ID!]
|
18889
|
+
}
|
18890
|
+
|
18891
|
+
"""An enumeration."""
|
18892
|
+
enum ProductErrorCode {
|
18893
|
+
ALREADY_EXISTS
|
18894
|
+
ATTRIBUTE_ALREADY_ASSIGNED
|
18895
|
+
ATTRIBUTE_CANNOT_BE_ASSIGNED
|
18896
|
+
ATTRIBUTE_VARIANTS_DISABLED
|
18897
|
+
DUPLICATED_INPUT_ITEM
|
18898
|
+
GRAPHQL_ERROR
|
18899
|
+
INVALID
|
18900
|
+
INVALID_PHONE
|
18901
|
+
NOT_PRODUCTS_IMAGE
|
18902
|
+
NOT_PRODUCTS_VARIANT
|
18903
|
+
NOT_FOUND
|
18904
|
+
REQUIRED
|
18905
|
+
UNIQUE
|
18906
|
+
VARIANT_NO_DIGITAL_CONTENT
|
18907
|
+
VARIANT_IN_ACTIVE_ORDER
|
18908
|
+
CATEGORY_CANNOT_BE_ASSIGNED
|
18909
|
+
CATEGORY_CANNOT_BE_DELETED
|
18910
|
+
COLLECTION_CANNOT_BE_CHANGED
|
18911
|
+
COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
|
18912
|
+
COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
|
18913
|
+
INVENTORY_FIELD_CANNOT_BE_EDITED
|
18914
|
+
}
|
18915
|
+
|
18953
18916
|
input CategoryInput {
|
18954
18917
|
"""Category description (plaintext, deprecated as input)."""
|
18955
18918
|
description: String
|
@@ -19116,6 +19079,16 @@ type CollectionReorderProducts {
|
|
19116
19079
|
productErrors: [ProductError!]!
|
19117
19080
|
}
|
19118
19081
|
|
19082
|
+
input MoveProductInput {
|
19083
|
+
"""The ID of the product to move."""
|
19084
|
+
productId: ID!
|
19085
|
+
|
19086
|
+
"""
|
19087
|
+
The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
|
19088
|
+
"""
|
19089
|
+
sortOrder: Int
|
19090
|
+
}
|
19091
|
+
|
19119
19092
|
"""Deletes collections."""
|
19120
19093
|
type CollectionBulkDelete {
|
19121
19094
|
"""Returns how many objects were affected."""
|
@@ -23048,6 +23021,57 @@ type AppTokenVerify {
|
|
23048
23021
|
appErrors: [AppError!]!
|
23049
23022
|
}
|
23050
23023
|
|
23024
|
+
"""Creates a new dashboard integration for an app."""
|
23025
|
+
type AppDashboardIntegrationCreate {
|
23026
|
+
appErrors: [AppError!]!
|
23027
|
+
appDashboardIntegration: AppDashboardIntegration
|
23028
|
+
}
|
23029
|
+
|
23030
|
+
input AppDashboardIntegrationInput {
|
23031
|
+
"""ID of app."""
|
23032
|
+
app: ID!
|
23033
|
+
|
23034
|
+
"""URL to the iframe"""
|
23035
|
+
iframeUrl: String!
|
23036
|
+
|
23037
|
+
"""Context for where this integration should render"""
|
23038
|
+
context: AppDashboardIntegrationContextEnum!
|
23039
|
+
}
|
23040
|
+
|
23041
|
+
"""Deletes an app storefront integration from the app."""
|
23042
|
+
type AppDashboardIntegrationDelete {
|
23043
|
+
appErrors: [AppError!]!
|
23044
|
+
appDashboardIntegration: AppDashboardIntegration
|
23045
|
+
}
|
23046
|
+
|
23047
|
+
"""Creates a new storefront integration for an app."""
|
23048
|
+
type AppStorefrontIntegrationCreate {
|
23049
|
+
appErrors: [AppError!]!
|
23050
|
+
appStorefrontIntegration: AppStorefrontIntegration
|
23051
|
+
}
|
23052
|
+
|
23053
|
+
input AppStorefrontIntegrationInput {
|
23054
|
+
"""ID of app."""
|
23055
|
+
app: ID!
|
23056
|
+
|
23057
|
+
"""URL to the remote component to load"""
|
23058
|
+
componentUrl: String!
|
23059
|
+
|
23060
|
+
"""Context for where this integration should render"""
|
23061
|
+
context: AppStorefrontIntegrationContextEnum!
|
23062
|
+
|
23063
|
+
"""
|
23064
|
+
JSON formatted string containing any params to pass to the component during render
|
23065
|
+
"""
|
23066
|
+
params: String
|
23067
|
+
}
|
23068
|
+
|
23069
|
+
"""Deletes an app storefront integration from the app."""
|
23070
|
+
type AppStorefrontIntegrationDelete {
|
23071
|
+
appErrors: [AppError!]!
|
23072
|
+
appStorefrontIntegration: AppStorefrontIntegration
|
23073
|
+
}
|
23074
|
+
|
23051
23075
|
"""Install new app by using app manifest."""
|
23052
23076
|
type AppInstall {
|
23053
23077
|
appErrors: [AppError!]!
|