@nautical-commerce/graphql-schema 1.66.0-2-gd69864898 → 1.66.0-20-g3c1367e91
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 +402 -447
- 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."""
|
@@ -2841,7 +2840,9 @@ type ProductVariant implements Node & ObjectWithMetadata {
|
|
2841
2840
|
id: ID!
|
2842
2841
|
createdAt: DateTime!
|
2843
2842
|
updatedAt: DateTime!
|
2844
|
-
|
2843
|
+
|
2844
|
+
"""Product model code"""
|
2845
|
+
description: String @deprecated(reason: "This will be removed on April 15, 2025.")
|
2845
2846
|
descriptionHtml: String!
|
2846
2847
|
externalId: String
|
2847
2848
|
externalSource: String
|
@@ -2895,7 +2896,7 @@ type ProductVariant implements Node & ObjectWithMetadata {
|
|
2895
2896
|
pricing: VariantPricingInfo
|
2896
2897
|
|
2897
2898
|
"""Whether this variant is visible on the buyer side or not"""
|
2898
|
-
isVisible: Boolean!
|
2899
|
+
isVisible: Boolean! @deprecated(reason: "This will be removed on April 15, 2025.")
|
2899
2900
|
|
2900
2901
|
"""Product variant size info."""
|
2901
2902
|
size: VariantSize
|
@@ -2996,16 +2997,16 @@ type Product implements Node & ObjectWithMetadata {
|
|
2996
2997
|
seller: Seller
|
2997
2998
|
|
2998
2999
|
"""Manufacturer Product Number"""
|
2999
|
-
mpn: String
|
3000
|
+
mpn: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
3000
3001
|
|
3001
3002
|
"""Brand of the product"""
|
3002
|
-
brand: String
|
3003
|
+
brand: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
3003
3004
|
|
3004
3005
|
"""Manufacturer of the product"""
|
3005
|
-
manufacturer: String
|
3006
|
+
manufacturer: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
3006
3007
|
|
3007
3008
|
"""Product model code"""
|
3008
|
-
model: String
|
3009
|
+
model: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
3009
3010
|
seoTitle: String
|
3010
3011
|
seoDescription: String
|
3011
3012
|
productType: ProductType
|
@@ -3104,7 +3105,7 @@ type Product implements Node & ObjectWithMetadata {
|
|
3104
3105
|
isAvailableForPurchase: Boolean
|
3105
3106
|
|
3106
3107
|
"""
|
3107
|
-
Product sort order in the specific collection
|
3108
|
+
Product sort order in the specific collection. Make sense only as a part of the parent 'collection(s)' queries.
|
3108
3109
|
"""
|
3109
3110
|
sortOrder: Int
|
3110
3111
|
|
@@ -3134,7 +3135,7 @@ type Product implements Node & ObjectWithMetadata {
|
|
3134
3135
|
"""
|
3135
3136
|
The product's sorting priority weight in query results. A larger value indicates a higher priority. This field can be used in both ascending and descending sorting methods.
|
3136
3137
|
"""
|
3137
|
-
sortPriorityWeight: Decimal
|
3138
|
+
sortPriorityWeight: Decimal @deprecated(reason: "This field will be removed on April 15, 2025.")
|
3138
3139
|
|
3139
3140
|
"""List of logs for product status changes."""
|
3140
3141
|
productStatusLogs: [ProductStatusLog!]
|
@@ -3209,9 +3210,6 @@ type Seller implements Node & ObjectWithMetadata {
|
|
3209
3210
|
"""Date seller acknowledged their existing agreement."""
|
3210
3211
|
agreementAcknowledged: DateTime
|
3211
3212
|
canUseInStorefront: Boolean
|
3212
|
-
|
3213
|
-
"""Microsite of the seller."""
|
3214
|
-
microsite: Microsite
|
3215
3213
|
pk: Int
|
3216
3214
|
externalPayoutStatus: Boolean
|
3217
3215
|
externalPayoutSchedule: String
|
@@ -4590,7 +4588,6 @@ input AttributeFilterInput {
|
|
4590
4588
|
inCollection: ID
|
4591
4589
|
inProductSearch: String
|
4592
4590
|
inVariantSearch: String
|
4593
|
-
inMicrosite: ID
|
4594
4591
|
inCategory: ID
|
4595
4592
|
|
4596
4593
|
"""
|
@@ -4708,6 +4705,9 @@ type App implements Node & ObjectWithMetadata {
|
|
4708
4705
|
"""Type of the app."""
|
4709
4706
|
type: AppTypeEnum
|
4710
4707
|
|
4708
|
+
"""List of dashboard integrations for this app"""
|
4709
|
+
dashboardIntegrations: [AppDashboardIntegration!]
|
4710
|
+
|
4711
4711
|
"""List of storefront integrations for this app"""
|
4712
4712
|
storefrontIntegrations: [AppStorefrontIntegration!]
|
4713
4713
|
|
@@ -4804,6 +4804,31 @@ enum AppTypeEnum {
|
|
4804
4804
|
THIRDPARTY
|
4805
4805
|
}
|
4806
4806
|
|
4807
|
+
"""Represents a dashboard integration for an App."""
|
4808
|
+
type AppDashboardIntegration implements Node {
|
4809
|
+
"""The ID of the object"""
|
4810
|
+
id: ID!
|
4811
|
+
|
4812
|
+
"""
|
4813
|
+
App this integration is for. This may be null for integrations that come from plugins.
|
4814
|
+
"""
|
4815
|
+
app: App
|
4816
|
+
|
4817
|
+
"""What context this integration should be rendered in"""
|
4818
|
+
context: AppDashboardIntegrationContextEnum!
|
4819
|
+
|
4820
|
+
"""The URL to load for this integration"""
|
4821
|
+
iframeUrl: String!
|
4822
|
+
}
|
4823
|
+
|
4824
|
+
enum AppDashboardIntegrationContextEnum {
|
4825
|
+
"""Nautical order details page"""
|
4826
|
+
NAUTICAL_ORDER
|
4827
|
+
|
4828
|
+
"""Seller order details page"""
|
4829
|
+
ORDER
|
4830
|
+
}
|
4831
|
+
|
4807
4832
|
"""Represents a storefront integration for an App."""
|
4808
4833
|
type AppStorefrontIntegration implements Node {
|
4809
4834
|
"""The ID of the object"""
|
@@ -4879,8 +4904,6 @@ enum WebhookEventTypeEnum {
|
|
4879
4904
|
INVOICE_DELETED
|
4880
4905
|
INVOICE_REQUESTED
|
4881
4906
|
INVOICE_SENT
|
4882
|
-
MICROSITE_CREATED
|
4883
|
-
MICROSITE_UPDATED
|
4884
4907
|
NAUTICAL_ORDER_CANCELLED
|
4885
4908
|
NAUTICAL_ORDER_CREATED
|
4886
4909
|
NAUTICAL_ORDER_FULFILLED
|
@@ -7161,61 +7184,6 @@ type WarehouseCountableEdge {
|
|
7161
7184
|
cursor: String!
|
7162
7185
|
}
|
7163
7186
|
|
7164
|
-
"""Represents a microsite of products."""
|
7165
|
-
type Microsite implements Node & ObjectWithMetadata {
|
7166
|
-
"""The ID of the object"""
|
7167
|
-
id: ID!
|
7168
|
-
publicationDate: Date
|
7169
|
-
description: String!
|
7170
|
-
descriptionHtml: String!
|
7171
|
-
seoTitle: String
|
7172
|
-
seoDescription: String
|
7173
|
-
name: String!
|
7174
|
-
slug: String!
|
7175
|
-
footerText: String
|
7176
|
-
seller: Seller
|
7177
|
-
|
7178
|
-
"""
|
7179
|
-
List of private metadata items.Requires proper staff permissions to access.
|
7180
|
-
"""
|
7181
|
-
privateMetadata: [MetadataItem!]!
|
7182
|
-
|
7183
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
7184
|
-
metadata: [MetadataItem!]!
|
7185
|
-
|
7186
|
-
"""List of products in this microsite."""
|
7187
|
-
products(
|
7188
|
-
"""Filtering options for products."""
|
7189
|
-
filter: ProductFilterInput
|
7190
|
-
|
7191
|
-
"""Sort products."""
|
7192
|
-
sortBy: ProductOrder
|
7193
|
-
|
7194
|
-
"""Return the elements in the list that come before the specified cursor."""
|
7195
|
-
before: String
|
7196
|
-
|
7197
|
-
"""Return the elements in the list that come after the specified cursor."""
|
7198
|
-
after: String
|
7199
|
-
|
7200
|
-
"""Return the first n elements from the list."""
|
7201
|
-
first: Int
|
7202
|
-
|
7203
|
-
"""Return the last n elements from the list."""
|
7204
|
-
last: Int
|
7205
|
-
): ProductCountableConnection
|
7206
|
-
bannerImage(
|
7207
|
-
"""Size of the image."""
|
7208
|
-
size: Int
|
7209
|
-
): Image
|
7210
|
-
logoImage(
|
7211
|
-
"""Size of the image."""
|
7212
|
-
size: Int
|
7213
|
-
): Image
|
7214
|
-
|
7215
|
-
"""Whether the microsite is published."""
|
7216
|
-
isPublished: Boolean!
|
7217
|
-
}
|
7218
|
-
|
7219
7187
|
"""Document"""
|
7220
7188
|
type Document {
|
7221
7189
|
"""Global ID of the Document."""
|
@@ -8130,8 +8098,6 @@ enum WebhookSampleEventTypeEnum {
|
|
8130
8098
|
INVOICE_DELETED
|
8131
8099
|
INVOICE_REQUESTED
|
8132
8100
|
INVOICE_SENT
|
8133
|
-
MICROSITE_CREATED
|
8134
|
-
MICROSITE_UPDATED
|
8135
8101
|
NAUTICAL_ORDER_CANCELLED
|
8136
8102
|
NAUTICAL_ORDER_CREATED
|
8137
8103
|
NAUTICAL_ORDER_FULFILLED
|
@@ -9150,6 +9116,100 @@ enum RefundSortField {
|
|
9150
9116
|
TOKEN
|
9151
9117
|
}
|
9152
9118
|
|
9119
|
+
"""
|
9120
|
+
A policy that can be manually added by a shop operator through the dashboard.
|
9121
|
+
"""
|
9122
|
+
type Policy implements Node & ObjectWithMetadata {
|
9123
|
+
"""The ID of the object"""
|
9124
|
+
id: ID!
|
9125
|
+
publicationDate: Date
|
9126
|
+
createdAt: DateTime!
|
9127
|
+
updatedAt: DateTime!
|
9128
|
+
content: String!
|
9129
|
+
contentHtml: String!
|
9130
|
+
seoTitle: String
|
9131
|
+
seoDescription: String
|
9132
|
+
category: PolicyCategory!
|
9133
|
+
slug: String!
|
9134
|
+
title: String!
|
9135
|
+
|
9136
|
+
"""
|
9137
|
+
List of private metadata items.Requires proper staff permissions to access.
|
9138
|
+
"""
|
9139
|
+
privateMetadata: [MetadataItem!]!
|
9140
|
+
|
9141
|
+
"""List of public metadata items. Can be accessed without permissions."""
|
9142
|
+
metadata: [MetadataItem!]!
|
9143
|
+
|
9144
|
+
"""Whether the policy is published."""
|
9145
|
+
isPublished: Boolean!
|
9146
|
+
}
|
9147
|
+
|
9148
|
+
"""An enumeration."""
|
9149
|
+
enum PolicyCategory {
|
9150
|
+
"""Terms of Service"""
|
9151
|
+
TERMS_OF_SERVICE
|
9152
|
+
|
9153
|
+
"""Privacy Policy"""
|
9154
|
+
PRIVACY_POLICY
|
9155
|
+
|
9156
|
+
"""Returns & Refund"""
|
9157
|
+
RETURNS_AND_REFUNDS
|
9158
|
+
|
9159
|
+
"""Shipping Policy"""
|
9160
|
+
SHIPPING_POLICY
|
9161
|
+
|
9162
|
+
"""Custom"""
|
9163
|
+
CUSTOM
|
9164
|
+
}
|
9165
|
+
|
9166
|
+
type PolicyCountableConnection {
|
9167
|
+
"""Pagination data for this connection."""
|
9168
|
+
pageInfo: PageInfo!
|
9169
|
+
edges: [PolicyCountableEdge!]!
|
9170
|
+
|
9171
|
+
"""A total count of items in the collection."""
|
9172
|
+
totalCount: Int
|
9173
|
+
}
|
9174
|
+
|
9175
|
+
type PolicyCountableEdge {
|
9176
|
+
"""The item at the end of the edge."""
|
9177
|
+
node: Policy!
|
9178
|
+
|
9179
|
+
"""A cursor for use in pagination."""
|
9180
|
+
cursor: String!
|
9181
|
+
}
|
9182
|
+
|
9183
|
+
input PolicySortingInput {
|
9184
|
+
"""Specifies the direction in which to sort products."""
|
9185
|
+
direction: OrderDirection!
|
9186
|
+
|
9187
|
+
"""Sort policies by the selected field."""
|
9188
|
+
field: PolicySortField!
|
9189
|
+
}
|
9190
|
+
|
9191
|
+
enum PolicySortField {
|
9192
|
+
"""Sort policies by title."""
|
9193
|
+
TITLE
|
9194
|
+
|
9195
|
+
"""Sort policies by slug."""
|
9196
|
+
SLUG
|
9197
|
+
|
9198
|
+
"""Sort policies by visibility."""
|
9199
|
+
VISIBILITY
|
9200
|
+
|
9201
|
+
"""Sort policies by creation date."""
|
9202
|
+
CREATION_DATE
|
9203
|
+
|
9204
|
+
"""Sort policies by publication date."""
|
9205
|
+
PUBLICATION_DATE
|
9206
|
+
}
|
9207
|
+
|
9208
|
+
input PolicyFilterInput {
|
9209
|
+
search: String
|
9210
|
+
isPublished: Boolean
|
9211
|
+
}
|
9212
|
+
|
9153
9213
|
type DigitalContentCountableConnection {
|
9154
9214
|
"""Pagination data for this connection."""
|
9155
9215
|
pageInfo: PageInfo!
|
@@ -10796,58 +10856,6 @@ type NauticalConfiguration {
|
|
10796
10856
|
configurationValueString: String
|
10797
10857
|
}
|
10798
10858
|
|
10799
|
-
type MicrositeCountableConnection {
|
10800
|
-
"""Pagination data for this connection."""
|
10801
|
-
pageInfo: PageInfo!
|
10802
|
-
edges: [MicrositeCountableEdge!]!
|
10803
|
-
|
10804
|
-
"""A total count of items in the collection."""
|
10805
|
-
totalCount: Int
|
10806
|
-
}
|
10807
|
-
|
10808
|
-
type MicrositeCountableEdge {
|
10809
|
-
"""The item at the end of the edge."""
|
10810
|
-
node: Microsite!
|
10811
|
-
|
10812
|
-
"""A cursor for use in pagination."""
|
10813
|
-
cursor: String!
|
10814
|
-
}
|
10815
|
-
|
10816
|
-
input MicrositeFilterInput {
|
10817
|
-
published: MicrositePublished
|
10818
|
-
search: String
|
10819
|
-
ids: [ID]
|
10820
|
-
metadata: MetadataFilterInput
|
10821
|
-
privateMetadata: MetadataFilterInput
|
10822
|
-
}
|
10823
|
-
|
10824
|
-
enum MicrositePublished {
|
10825
|
-
PUBLISHED
|
10826
|
-
HIDDEN
|
10827
|
-
}
|
10828
|
-
|
10829
|
-
input MicrositeSortingInput {
|
10830
|
-
"""Specifies the direction in which to sort products."""
|
10831
|
-
direction: OrderDirection!
|
10832
|
-
|
10833
|
-
"""Sort microsites by the selected field."""
|
10834
|
-
field: MicrositeSortField!
|
10835
|
-
}
|
10836
|
-
|
10837
|
-
enum MicrositeSortField {
|
10838
|
-
"""Sort microsites by name."""
|
10839
|
-
NAME
|
10840
|
-
|
10841
|
-
"""Sort microsites by availability."""
|
10842
|
-
AVAILABILITY
|
10843
|
-
|
10844
|
-
"""Sort microsites by product count."""
|
10845
|
-
PRODUCT_COUNT
|
10846
|
-
|
10847
|
-
"""Sort microsites by publication date."""
|
10848
|
-
PUBLICATION_DATE
|
10849
|
-
}
|
10850
|
-
|
10851
10859
|
"""
|
10852
10860
|
Represents a single menu - an object that is used to help navigate through the store.
|
10853
10861
|
"""
|
@@ -13169,7 +13177,7 @@ enum StaffMemberStatus {
|
|
13169
13177
|
DEACTIVATED
|
13170
13178
|
}
|
13171
13179
|
|
13172
|
-
union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection |
|
13180
|
+
union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | ProductImage | ProductStatusLog | Group | CatalogImportProcess | CatalogImportProcessLogRecord
|
13173
13181
|
|
13174
13182
|
scalar _Any
|
13175
13183
|
|
@@ -13203,7 +13211,7 @@ type Mutation {
|
|
13203
13211
|
description: String
|
13204
13212
|
|
13205
13213
|
"""
|
13206
|
-
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/
|
13214
|
+
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/x-tif, application/x-csv, text/svg-xml, application/acad, application/x-gzip, image/heic, image/x-dxf, image/svg, image/heif-sequence, image/x-dwg, image/x-bmp, application/vnd.ms-word, drawing/x-dwf, application/excel, image/webp, image/vnd.dwg, application/x-rar, text/rtf, application/pdf, image/heic-sequence, application/gzip-compressed, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.pdf, application/x-dxf, image/tif, application/jpg, application/vnd.ms-excel, application/eps, application/x-eps, application/gzip, application/vnd.ms-powerpoint, image/tiff, text/svg, application/x-pdf, image/dxf, application/dxf, text/plain, image/bmp, image/x-tiff, application/gzipped, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/gif, image/jpeg, image/x-tif, application/x-autocad, text/csv, application/postscript, application/vnd.oasis.opendocument.text, text/x-csv, image/eps, application/zip, application/x-acad, pplication/vnd.rar, image/x-eps, application/msword, application/tif, application/x-rar-compressed, text/x-comma-separated-values, text/pdf, image/png, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/rtf, application/tiff, application/x-dwg, application/x-tiff, image/svg+xml, application/dwg, application/x-tar, image/jpg, application/vnd.oasis.opendocument.presentation, application/x-zip-compressed, application/vnd.oasis.opendocument.spreadsheet, text/x-pdf, drawing/dwg, drawing/x-dwg, application/svg+xml, application/acrobat, application/x-jpg, image/heif, application/x-rtf, text/comma-separated-values, image/x-ms-bmp, application/csv.
|
13207
13215
|
"""
|
13208
13216
|
file: Upload!
|
13209
13217
|
|
@@ -13471,69 +13479,6 @@ type Mutation {
|
|
13471
13479
|
wishlistId: ID
|
13472
13480
|
): WishlistRemoveProductVariant
|
13473
13481
|
|
13474
|
-
"""Adds products to a microsite."""
|
13475
|
-
micrositeAddProducts(
|
13476
|
-
"""ID of a microsite."""
|
13477
|
-
micrositeId: ID!
|
13478
|
-
|
13479
|
-
"""List of product IDs."""
|
13480
|
-
products: [ID!]!
|
13481
|
-
): MicrositeAddProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13482
|
-
|
13483
|
-
"""Creates a new microsite."""
|
13484
|
-
micrositeCreate(
|
13485
|
-
"""Fields required to create a microsite."""
|
13486
|
-
input: MicrositeCreateInput!
|
13487
|
-
): MicrositeCreate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13488
|
-
|
13489
|
-
"""Deletes a microsite."""
|
13490
|
-
micrositeDelete(
|
13491
|
-
"""ID of a microsite to delete."""
|
13492
|
-
id: ID!
|
13493
|
-
): MicrositeDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13494
|
-
|
13495
|
-
"""Reorder the products of a microsite."""
|
13496
|
-
micrositeReorderProducts(
|
13497
|
-
"""ID of a microsite."""
|
13498
|
-
micrositeId: ID!
|
13499
|
-
|
13500
|
-
"""The microsite products position operations."""
|
13501
|
-
moves: [MoveProductInput!]!
|
13502
|
-
): MicrositeReorderProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13503
|
-
|
13504
|
-
"""Deletes microsites."""
|
13505
|
-
micrositeBulkDelete(
|
13506
|
-
"""List of microsite IDs to delete."""
|
13507
|
-
ids: [ID!]!
|
13508
|
-
): MicrositeBulkDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13509
|
-
|
13510
|
-
"""Publish microsites."""
|
13511
|
-
micrositeBulkPublish(
|
13512
|
-
"""List of microsites IDs to (un)publish."""
|
13513
|
-
ids: [ID!]!
|
13514
|
-
|
13515
|
-
"""Determine if microsites will be published or not."""
|
13516
|
-
isPublished: Boolean!
|
13517
|
-
): MicrositeBulkPublish @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13518
|
-
|
13519
|
-
"""Remove products from a microsite."""
|
13520
|
-
micrositeRemoveProducts(
|
13521
|
-
"""ID of a microsite."""
|
13522
|
-
micrositeId: ID!
|
13523
|
-
|
13524
|
-
"""List of product IDs."""
|
13525
|
-
products: [ID!]!
|
13526
|
-
): MicrositeRemoveProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13527
|
-
|
13528
|
-
"""Updates a microsite."""
|
13529
|
-
micrositeUpdate(
|
13530
|
-
"""ID of a microsite to update."""
|
13531
|
-
id: ID!
|
13532
|
-
|
13533
|
-
"""Fields required to update a microsite."""
|
13534
|
-
input: MicrositeInput!
|
13535
|
-
): MicrositeUpdate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
|
13536
|
-
|
13537
13482
|
"""Creates a new agreement."""
|
13538
13483
|
agreementCreate(
|
13539
13484
|
"""Fields required to create a agreement."""
|
@@ -14074,6 +14019,42 @@ type Mutation {
|
|
14074
14019
|
refundId: ID!
|
14075
14020
|
): RefundPaymentsDelete
|
14076
14021
|
|
14022
|
+
"""Creates a new policy."""
|
14023
|
+
policyCreate(
|
14024
|
+
"""Fields required to create a policy."""
|
14025
|
+
input: PolicyInput!
|
14026
|
+
): PolicyCreate
|
14027
|
+
|
14028
|
+
"""Deletes a policy."""
|
14029
|
+
policyDelete(
|
14030
|
+
"""ID of the policy to delete."""
|
14031
|
+
id: ID!
|
14032
|
+
): PolicyDelete
|
14033
|
+
|
14034
|
+
"""Deletes policy."""
|
14035
|
+
policyBulkDelete(
|
14036
|
+
"""List of policy IDs to delete."""
|
14037
|
+
ids: [ID!]!
|
14038
|
+
): PolicyBulkDelete
|
14039
|
+
|
14040
|
+
"""Publish policy."""
|
14041
|
+
policyBulkPublish(
|
14042
|
+
"""List of policy IDs to (un)publish."""
|
14043
|
+
ids: [ID!]!
|
14044
|
+
|
14045
|
+
"""Determine if policy will be published or not."""
|
14046
|
+
isPublished: Boolean!
|
14047
|
+
): PolicyBulkPublish
|
14048
|
+
|
14049
|
+
"""Updates an existing policy."""
|
14050
|
+
policyUpdate(
|
14051
|
+
"""ID of the policy to update."""
|
14052
|
+
id: ID!
|
14053
|
+
|
14054
|
+
"""Fields required to update a policy."""
|
14055
|
+
input: PolicyInput!
|
14056
|
+
): PolicyUpdate
|
14057
|
+
|
14077
14058
|
"""Creates a new price book."""
|
14078
14059
|
priceBookCreate(
|
14079
14060
|
"""Fields required to create a price book."""
|
@@ -16030,6 +16011,18 @@ type Mutation {
|
|
16030
16011
|
token: String!
|
16031
16012
|
): AppTokenVerify
|
16032
16013
|
|
16014
|
+
"""Creates a new dashboard integration for an app."""
|
16015
|
+
appDashboardIntegrationCreate(
|
16016
|
+
"""Fields required to create a dashboard integration."""
|
16017
|
+
input: AppDashboardIntegrationInput!
|
16018
|
+
): AppDashboardIntegrationCreate
|
16019
|
+
|
16020
|
+
"""Deletes an app storefront integration from the app."""
|
16021
|
+
appDashboardIntegrationDelete(
|
16022
|
+
"""ID of a app dashboard integration to delete."""
|
16023
|
+
id: ID!
|
16024
|
+
): AppDashboardIntegrationDelete
|
16025
|
+
|
16033
16026
|
"""Creates a new storefront integration for an app."""
|
16034
16027
|
appStorefrontIntegrationCreate(
|
16035
16028
|
"""Fields required to create a storefront integration."""
|
@@ -16379,7 +16372,7 @@ type Mutation {
|
|
16379
16372
|
permissionGroupCreate(
|
16380
16373
|
"""Input fields to create permission group."""
|
16381
16374
|
input: PermissionGroupCreateInput!
|
16382
|
-
): PermissionGroupCreate
|
16375
|
+
): PermissionGroupCreate @deprecated(reason: "This will be removed on April 14, 2025")
|
16383
16376
|
|
16384
16377
|
"""Update permission group."""
|
16385
16378
|
permissionGroupUpdate(
|
@@ -16394,7 +16387,7 @@ type Mutation {
|
|
16394
16387
|
permissionGroupDelete(
|
16395
16388
|
"""ID of the group to delete."""
|
16396
16389
|
id: ID!
|
16397
|
-
): PermissionGroupDelete
|
16390
|
+
): PermissionGroupDelete @deprecated(reason: "This will be removed on April 14, 2025")
|
16398
16391
|
}
|
16399
16392
|
|
16400
16393
|
"""EmailTemplate update mutation."""
|
@@ -17033,200 +17026,6 @@ type WishlistRemoveProductVariant {
|
|
17033
17026
|
wishlistErrors: [WishlistError!]!
|
17034
17027
|
}
|
17035
17028
|
|
17036
|
-
"""Adds products to a microsite."""
|
17037
|
-
type MicrositeAddProducts {
|
17038
|
-
"""Microsite to which products will be added."""
|
17039
|
-
microsite: Microsite
|
17040
|
-
micrositeErrors: [ProductError!]!
|
17041
|
-
}
|
17042
|
-
|
17043
|
-
type ProductError {
|
17044
|
-
"""
|
17045
|
-
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
17046
|
-
"""
|
17047
|
-
field: String
|
17048
|
-
|
17049
|
-
"""The error message."""
|
17050
|
-
message: String!
|
17051
|
-
|
17052
|
-
"""The error code."""
|
17053
|
-
code: ProductErrorCode!
|
17054
|
-
|
17055
|
-
"""List of attributes IDs which causes the error."""
|
17056
|
-
attributes: [ID!]
|
17057
|
-
}
|
17058
|
-
|
17059
|
-
"""An enumeration."""
|
17060
|
-
enum ProductErrorCode {
|
17061
|
-
ALREADY_EXISTS
|
17062
|
-
ATTRIBUTE_ALREADY_ASSIGNED
|
17063
|
-
ATTRIBUTE_CANNOT_BE_ASSIGNED
|
17064
|
-
ATTRIBUTE_VARIANTS_DISABLED
|
17065
|
-
DUPLICATED_INPUT_ITEM
|
17066
|
-
GRAPHQL_ERROR
|
17067
|
-
INVALID
|
17068
|
-
INVALID_PHONE
|
17069
|
-
NOT_PRODUCTS_IMAGE
|
17070
|
-
NOT_PRODUCTS_VARIANT
|
17071
|
-
NOT_FOUND
|
17072
|
-
REQUIRED
|
17073
|
-
UNIQUE
|
17074
|
-
VARIANT_NO_DIGITAL_CONTENT
|
17075
|
-
VARIANT_IN_ACTIVE_ORDER
|
17076
|
-
CATEGORY_CANNOT_BE_ASSIGNED
|
17077
|
-
CATEGORY_CANNOT_BE_DELETED
|
17078
|
-
COLLECTION_CANNOT_BE_CHANGED
|
17079
|
-
COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
|
17080
|
-
COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
|
17081
|
-
INVENTORY_FIELD_CANNOT_BE_EDITED
|
17082
|
-
}
|
17083
|
-
|
17084
|
-
"""Creates a new microsite."""
|
17085
|
-
type MicrositeCreate {
|
17086
|
-
micrositeErrors: [ProductError!]!
|
17087
|
-
microsite: Microsite
|
17088
|
-
}
|
17089
|
-
|
17090
|
-
input MicrositeCreateInput {
|
17091
|
-
"""Informs whether a microsite is published."""
|
17092
|
-
isPublished: Boolean
|
17093
|
-
|
17094
|
-
"""Name of the microsite."""
|
17095
|
-
name: String
|
17096
|
-
|
17097
|
-
"""Text to appear in footer of microsite."""
|
17098
|
-
footerText: String
|
17099
|
-
|
17100
|
-
"""Slug of the microsite."""
|
17101
|
-
slug: String
|
17102
|
-
|
17103
|
-
"""Description of the microsite (plaintext, deprecated for input)."""
|
17104
|
-
description: String
|
17105
|
-
|
17106
|
-
"""Description of the microsite (HTML)."""
|
17107
|
-
descriptionHtml: String
|
17108
|
-
|
17109
|
-
"""Banner image file."""
|
17110
|
-
bannerImage: Upload
|
17111
|
-
|
17112
|
-
"""Alt text for an image."""
|
17113
|
-
bannerImageAlt: String
|
17114
|
-
|
17115
|
-
"""Logo image file."""
|
17116
|
-
logoImage: Upload
|
17117
|
-
|
17118
|
-
"""Alt text for an image."""
|
17119
|
-
logoImageAlt: String
|
17120
|
-
|
17121
|
-
"""Search engine optimization fields."""
|
17122
|
-
seo: SeoInput
|
17123
|
-
|
17124
|
-
"""Publication date. ISO 8601 standard."""
|
17125
|
-
publicationDate: Date
|
17126
|
-
|
17127
|
-
"""List of products to be added to the microsite."""
|
17128
|
-
products: [ID!]
|
17129
|
-
|
17130
|
-
"""Vendor that microsite belongs to"""
|
17131
|
-
vendor: ID!
|
17132
|
-
}
|
17133
|
-
|
17134
|
-
input SeoInput {
|
17135
|
-
"""SEO title."""
|
17136
|
-
title: String
|
17137
|
-
|
17138
|
-
"""SEO description."""
|
17139
|
-
description: String
|
17140
|
-
}
|
17141
|
-
|
17142
|
-
"""Deletes a microsite."""
|
17143
|
-
type MicrositeDelete {
|
17144
|
-
micrositeErrors: [ProductError!]!
|
17145
|
-
microsite: Microsite
|
17146
|
-
}
|
17147
|
-
|
17148
|
-
"""Reorder the products of a microsite."""
|
17149
|
-
type MicrositeReorderProducts {
|
17150
|
-
"""Microsite from which products are reordered."""
|
17151
|
-
microsite: Microsite
|
17152
|
-
micrositeErrors: [ProductError!]!
|
17153
|
-
}
|
17154
|
-
|
17155
|
-
input MoveProductInput {
|
17156
|
-
"""The ID of the product to move."""
|
17157
|
-
productId: ID!
|
17158
|
-
|
17159
|
-
"""
|
17160
|
-
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.
|
17161
|
-
"""
|
17162
|
-
sortOrder: Int
|
17163
|
-
}
|
17164
|
-
|
17165
|
-
"""Deletes microsites."""
|
17166
|
-
type MicrositeBulkDelete {
|
17167
|
-
"""Returns how many objects were affected."""
|
17168
|
-
count: Int!
|
17169
|
-
micrositeErrors: [ProductError!]!
|
17170
|
-
}
|
17171
|
-
|
17172
|
-
"""Publish microsites."""
|
17173
|
-
type MicrositeBulkPublish {
|
17174
|
-
"""Returns how many objects were affected."""
|
17175
|
-
count: Int!
|
17176
|
-
micrositeErrors: [ProductError!]!
|
17177
|
-
}
|
17178
|
-
|
17179
|
-
"""Remove products from a microsite."""
|
17180
|
-
type MicrositeRemoveProducts {
|
17181
|
-
"""Microsite from which products will be removed."""
|
17182
|
-
microsite: Microsite
|
17183
|
-
micrositeErrors: [ProductError!]!
|
17184
|
-
}
|
17185
|
-
|
17186
|
-
"""Updates a microsite."""
|
17187
|
-
type MicrositeUpdate {
|
17188
|
-
micrositeErrors: [ProductError!]!
|
17189
|
-
microsite: Microsite
|
17190
|
-
}
|
17191
|
-
|
17192
|
-
input MicrositeInput {
|
17193
|
-
"""Informs whether a microsite is published."""
|
17194
|
-
isPublished: Boolean
|
17195
|
-
|
17196
|
-
"""Name of the microsite."""
|
17197
|
-
name: String
|
17198
|
-
|
17199
|
-
"""Text to appear in footer of microsite."""
|
17200
|
-
footerText: String
|
17201
|
-
|
17202
|
-
"""Slug of the microsite."""
|
17203
|
-
slug: String
|
17204
|
-
|
17205
|
-
"""Description of the microsite (plaintext, deprecated for input)."""
|
17206
|
-
description: String
|
17207
|
-
|
17208
|
-
"""Description of the microsite (HTML)."""
|
17209
|
-
descriptionHtml: String
|
17210
|
-
|
17211
|
-
"""Banner image file."""
|
17212
|
-
bannerImage: Upload
|
17213
|
-
|
17214
|
-
"""Alt text for an image."""
|
17215
|
-
bannerImageAlt: String
|
17216
|
-
|
17217
|
-
"""Logo image file."""
|
17218
|
-
logoImage: Upload
|
17219
|
-
|
17220
|
-
"""Alt text for an image."""
|
17221
|
-
logoImageAlt: String
|
17222
|
-
|
17223
|
-
"""Search engine optimization fields."""
|
17224
|
-
seo: SeoInput
|
17225
|
-
|
17226
|
-
"""Publication date. ISO 8601 standard."""
|
17227
|
-
publicationDate: Date
|
17228
|
-
}
|
17229
|
-
|
17230
17029
|
"""Creates a new agreement."""
|
17231
17030
|
type AgreementCreate {
|
17232
17031
|
agreementErrors: [AgreementError!]!
|
@@ -17298,6 +17097,14 @@ input AgreementInput {
|
|
17298
17097
|
markupCommissionValue: Decimal
|
17299
17098
|
}
|
17300
17099
|
|
17100
|
+
input SeoInput {
|
17101
|
+
"""SEO title."""
|
17102
|
+
title: String
|
17103
|
+
|
17104
|
+
"""SEO description."""
|
17105
|
+
description: String
|
17106
|
+
}
|
17107
|
+
|
17301
17108
|
"""Deletes a agreement."""
|
17302
17109
|
type AgreementDelete {
|
17303
17110
|
agreementErrors: [AgreementError!]!
|
@@ -18680,6 +18487,80 @@ type RefundPaymentsDelete {
|
|
18680
18487
|
refundErrors: [RefundError!]!
|
18681
18488
|
}
|
18682
18489
|
|
18490
|
+
"""Creates a new policy."""
|
18491
|
+
type PolicyCreate {
|
18492
|
+
policyErrors: [PolicyError!]!
|
18493
|
+
policy: Policy
|
18494
|
+
}
|
18495
|
+
|
18496
|
+
type PolicyError {
|
18497
|
+
"""
|
18498
|
+
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
18499
|
+
"""
|
18500
|
+
field: String
|
18501
|
+
|
18502
|
+
"""The error message."""
|
18503
|
+
message: String!
|
18504
|
+
|
18505
|
+
"""The error code."""
|
18506
|
+
code: PolicyErrorCode!
|
18507
|
+
}
|
18508
|
+
|
18509
|
+
"""An enumeration."""
|
18510
|
+
enum PolicyErrorCode {
|
18511
|
+
GRAPHQL_ERROR
|
18512
|
+
INVALID
|
18513
|
+
NOT_FOUND
|
18514
|
+
REQUIRED
|
18515
|
+
UNIQUE
|
18516
|
+
}
|
18517
|
+
|
18518
|
+
input PolicyInput {
|
18519
|
+
"""Policy internal name."""
|
18520
|
+
slug: String
|
18521
|
+
|
18522
|
+
"""Policy title."""
|
18523
|
+
title: String
|
18524
|
+
|
18525
|
+
"""Policy content (HTML)."""
|
18526
|
+
contentHtml: String
|
18527
|
+
|
18528
|
+
"""Determines if the policy is visible in the storefront."""
|
18529
|
+
isPublished: Boolean
|
18530
|
+
|
18531
|
+
"""Publication date. ISO 8601 standard."""
|
18532
|
+
publicationDate: String
|
18533
|
+
|
18534
|
+
"""Search engine optimization fields."""
|
18535
|
+
seo: SeoInput
|
18536
|
+
}
|
18537
|
+
|
18538
|
+
"""Deletes a policy."""
|
18539
|
+
type PolicyDelete {
|
18540
|
+
policyErrors: [PolicyError!]!
|
18541
|
+
policy: Policy
|
18542
|
+
}
|
18543
|
+
|
18544
|
+
"""Deletes policy."""
|
18545
|
+
type PolicyBulkDelete {
|
18546
|
+
"""Returns how many objects were affected."""
|
18547
|
+
count: Int!
|
18548
|
+
policyErrors: [PolicyError!]!
|
18549
|
+
}
|
18550
|
+
|
18551
|
+
"""Publish policy."""
|
18552
|
+
type PolicyBulkPublish {
|
18553
|
+
"""Returns how many objects were affected."""
|
18554
|
+
count: Int!
|
18555
|
+
policyErrors: [PolicyError!]!
|
18556
|
+
}
|
18557
|
+
|
18558
|
+
"""Updates an existing policy."""
|
18559
|
+
type PolicyUpdate {
|
18560
|
+
policyErrors: [PolicyError!]!
|
18561
|
+
policy: Policy
|
18562
|
+
}
|
18563
|
+
|
18683
18564
|
"""Creates a new price book."""
|
18684
18565
|
type PriceBookCreate {
|
18685
18566
|
priceBookErrors: [PriceBookError!]!
|
@@ -18993,6 +18874,47 @@ type CategoryCreate {
|
|
18993
18874
|
category: Category
|
18994
18875
|
}
|
18995
18876
|
|
18877
|
+
type ProductError {
|
18878
|
+
"""
|
18879
|
+
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
|
18880
|
+
"""
|
18881
|
+
field: String
|
18882
|
+
|
18883
|
+
"""The error message."""
|
18884
|
+
message: String!
|
18885
|
+
|
18886
|
+
"""The error code."""
|
18887
|
+
code: ProductErrorCode!
|
18888
|
+
|
18889
|
+
"""List of attributes IDs which causes the error."""
|
18890
|
+
attributes: [ID!]
|
18891
|
+
}
|
18892
|
+
|
18893
|
+
"""An enumeration."""
|
18894
|
+
enum ProductErrorCode {
|
18895
|
+
ALREADY_EXISTS
|
18896
|
+
ATTRIBUTE_ALREADY_ASSIGNED
|
18897
|
+
ATTRIBUTE_CANNOT_BE_ASSIGNED
|
18898
|
+
ATTRIBUTE_VARIANTS_DISABLED
|
18899
|
+
DUPLICATED_INPUT_ITEM
|
18900
|
+
GRAPHQL_ERROR
|
18901
|
+
INVALID
|
18902
|
+
INVALID_PHONE
|
18903
|
+
NOT_PRODUCTS_IMAGE
|
18904
|
+
NOT_PRODUCTS_VARIANT
|
18905
|
+
NOT_FOUND
|
18906
|
+
REQUIRED
|
18907
|
+
UNIQUE
|
18908
|
+
VARIANT_NO_DIGITAL_CONTENT
|
18909
|
+
VARIANT_IN_ACTIVE_ORDER
|
18910
|
+
CATEGORY_CANNOT_BE_ASSIGNED
|
18911
|
+
CATEGORY_CANNOT_BE_DELETED
|
18912
|
+
COLLECTION_CANNOT_BE_CHANGED
|
18913
|
+
COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
|
18914
|
+
COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
|
18915
|
+
INVENTORY_FIELD_CANNOT_BE_EDITED
|
18916
|
+
}
|
18917
|
+
|
18996
18918
|
input CategoryInput {
|
18997
18919
|
"""Category description (plaintext, deprecated as input)."""
|
18998
18920
|
description: String
|
@@ -19159,6 +19081,16 @@ type CollectionReorderProducts {
|
|
19159
19081
|
productErrors: [ProductError!]!
|
19160
19082
|
}
|
19161
19083
|
|
19084
|
+
input MoveProductInput {
|
19085
|
+
"""The ID of the product to move."""
|
19086
|
+
productId: ID!
|
19087
|
+
|
19088
|
+
"""
|
19089
|
+
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.
|
19090
|
+
"""
|
19091
|
+
sortOrder: Int
|
19092
|
+
}
|
19093
|
+
|
19162
19094
|
"""Deletes collections."""
|
19163
19095
|
type CollectionBulkDelete {
|
19164
19096
|
"""Returns how many objects were affected."""
|
@@ -19314,16 +19246,16 @@ input ProductCreateInput {
|
|
19314
19246
|
visibleInListings: Boolean
|
19315
19247
|
|
19316
19248
|
"""Manufacturer product number"""
|
19317
|
-
mpn: String
|
19249
|
+
mpn: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19318
19250
|
|
19319
19251
|
"""Product brand"""
|
19320
|
-
brand: String
|
19252
|
+
brand: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19321
19253
|
|
19322
19254
|
"""Manufacturer of the product"""
|
19323
|
-
manufacturer: String
|
19255
|
+
manufacturer: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19324
19256
|
|
19325
19257
|
"""Product model code"""
|
19326
|
-
model: String
|
19258
|
+
model: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19327
19259
|
|
19328
19260
|
"""Override price for grouped products"""
|
19329
19261
|
overridePrice: Boolean
|
@@ -19340,7 +19272,7 @@ input ProductCreateInput {
|
|
19340
19272
|
subStatusReason: String
|
19341
19273
|
|
19342
19274
|
"""Sort priority for product"""
|
19343
|
-
sortPriorityWeight: Decimal
|
19275
|
+
sortPriorityWeight: Decimal @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19344
19276
|
|
19345
19277
|
"""
|
19346
19278
|
Set whether this product requires shipping by default, will be overridden by product type if provided
|
@@ -19530,16 +19462,16 @@ input ProductInput {
|
|
19530
19462
|
visibleInListings: Boolean
|
19531
19463
|
|
19532
19464
|
"""Manufacturer product number"""
|
19533
|
-
mpn: String
|
19465
|
+
mpn: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19534
19466
|
|
19535
19467
|
"""Product brand"""
|
19536
|
-
brand: String
|
19468
|
+
brand: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19537
19469
|
|
19538
19470
|
"""Manufacturer of the product"""
|
19539
|
-
manufacturer: String
|
19471
|
+
manufacturer: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19540
19472
|
|
19541
19473
|
"""Product model code"""
|
19542
|
-
model: String
|
19474
|
+
model: String @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19543
19475
|
|
19544
19476
|
"""Override price for grouped products"""
|
19545
19477
|
overridePrice: Boolean
|
@@ -19556,7 +19488,7 @@ input ProductInput {
|
|
19556
19488
|
subStatusReason: String
|
19557
19489
|
|
19558
19490
|
"""Sort priority for product"""
|
19559
|
-
sortPriorityWeight: Decimal
|
19491
|
+
sortPriorityWeight: Decimal @deprecated(reason: "This field will be removed on April 15, 2025.")
|
19560
19492
|
|
19561
19493
|
"""
|
19562
19494
|
Set whether this product requires shipping by default, will be overridden by product type if provided
|
@@ -19837,7 +19769,7 @@ input ProductVariantCreateInput {
|
|
19837
19769
|
costPrice: PositiveDecimal
|
19838
19770
|
|
19839
19771
|
"""Description of the product variant."""
|
19840
|
-
description: String
|
19772
|
+
description: String @deprecated(reason: "This will be removed on April 15, 2025.")
|
19841
19773
|
|
19842
19774
|
"""Product variant description (HTML)."""
|
19843
19775
|
descriptionHtml: String
|
@@ -19978,7 +19910,7 @@ input ProductVariantBulkCreateInput {
|
|
19978
19910
|
costPrice: PositiveDecimal
|
19979
19911
|
|
19980
19912
|
"""Description of the product variant."""
|
19981
|
-
description: String
|
19913
|
+
description: String @deprecated(reason: "This will be removed on April 15, 2025.")
|
19982
19914
|
|
19983
19915
|
"""Product variant description (HTML)."""
|
19984
19916
|
descriptionHtml: String
|
@@ -20157,7 +20089,7 @@ input ProductVariantInput {
|
|
20157
20089
|
costPrice: PositiveDecimal
|
20158
20090
|
|
20159
20091
|
"""Description of the product variant."""
|
20160
|
-
description: String
|
20092
|
+
description: String @deprecated(reason: "This will be removed on April 15, 2025.")
|
20161
20093
|
|
20162
20094
|
"""Product variant description (HTML)."""
|
20163
20095
|
descriptionHtml: String
|
@@ -23091,6 +23023,29 @@ type AppTokenVerify {
|
|
23091
23023
|
appErrors: [AppError!]!
|
23092
23024
|
}
|
23093
23025
|
|
23026
|
+
"""Creates a new dashboard integration for an app."""
|
23027
|
+
type AppDashboardIntegrationCreate {
|
23028
|
+
appErrors: [AppError!]!
|
23029
|
+
appDashboardIntegration: AppDashboardIntegration
|
23030
|
+
}
|
23031
|
+
|
23032
|
+
input AppDashboardIntegrationInput {
|
23033
|
+
"""ID of app."""
|
23034
|
+
app: ID!
|
23035
|
+
|
23036
|
+
"""URL to the iframe"""
|
23037
|
+
iframeUrl: String!
|
23038
|
+
|
23039
|
+
"""Context for where this integration should render"""
|
23040
|
+
context: AppDashboardIntegrationContextEnum!
|
23041
|
+
}
|
23042
|
+
|
23043
|
+
"""Deletes an app storefront integration from the app."""
|
23044
|
+
type AppDashboardIntegrationDelete {
|
23045
|
+
appErrors: [AppError!]!
|
23046
|
+
appDashboardIntegration: AppDashboardIntegration
|
23047
|
+
}
|
23048
|
+
|
23094
23049
|
"""Creates a new storefront integration for an app."""
|
23095
23050
|
type AppStorefrontIntegrationCreate {
|
23096
23051
|
appErrors: [AppError!]!
|
@@ -23863,7 +23818,7 @@ enum PermissionGroupErrorCode {
|
|
23863
23818
|
|
23864
23819
|
input PermissionGroupCreateInput {
|
23865
23820
|
"""List of permission code names to assign to this group."""
|
23866
|
-
addPermissions: [PermissionEnum!]
|
23821
|
+
addPermissions: [PermissionEnum!] @deprecated(reason: "This will be removed on April 14, 2025")
|
23867
23822
|
|
23868
23823
|
"""List of users to assign to this group."""
|
23869
23824
|
addUsers: [ID!]
|
@@ -23880,7 +23835,7 @@ type PermissionGroupUpdate {
|
|
23880
23835
|
|
23881
23836
|
input PermissionGroupUpdateInput {
|
23882
23837
|
"""List of permission code names to assign to this group."""
|
23883
|
-
addPermissions: [PermissionEnum!]
|
23838
|
+
addPermissions: [PermissionEnum!] @deprecated(reason: "This will be removed on April 14, 2025")
|
23884
23839
|
|
23885
23840
|
"""List of users to assign to this group."""
|
23886
23841
|
addUsers: [ID!]
|
@@ -23889,7 +23844,7 @@ input PermissionGroupUpdateInput {
|
|
23889
23844
|
name: String
|
23890
23845
|
|
23891
23846
|
"""List of permission code names to unassign from this group."""
|
23892
|
-
removePermissions: [PermissionEnum!]
|
23847
|
+
removePermissions: [PermissionEnum!] @deprecated(reason: "This will be removed on April 14, 2025")
|
23893
23848
|
|
23894
23849
|
"""List of users to unassign from this group."""
|
23895
23850
|
removeUsers: [ID!]
|