@nautical-commerce/graphql-schema 4.17.0 → 4.19.0
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 +77 -8
- package/package.json +1 -1
package/nautical/schema.graphql
CHANGED
|
@@ -2743,6 +2743,18 @@ type BulkProductVideoError {
|
|
|
2743
2743
|
index: Int
|
|
2744
2744
|
}
|
|
2745
2745
|
|
|
2746
|
+
"""A warning on a product a bulk mutation created or updated."""
|
|
2747
|
+
type BulkProductWarning {
|
|
2748
|
+
"""Index of the input row the product came from."""
|
|
2749
|
+
index: Int!
|
|
2750
|
+
|
|
2751
|
+
"""Code of the warning message."""
|
|
2752
|
+
code: ProductWarningEnum!
|
|
2753
|
+
|
|
2754
|
+
"""Warning message."""
|
|
2755
|
+
message: String!
|
|
2756
|
+
}
|
|
2757
|
+
|
|
2746
2758
|
"""Represents errors from bulk stock operations."""
|
|
2747
2759
|
type BulkStockError {
|
|
2748
2760
|
field: String
|
|
@@ -5258,7 +5270,9 @@ type CustomerEvent implements Node {
|
|
|
5258
5270
|
"""Number of objects concerned by the event."""
|
|
5259
5271
|
count: Int
|
|
5260
5272
|
|
|
5261
|
-
"""
|
|
5273
|
+
"""
|
|
5274
|
+
User whose activity log holds the event: the customer for self-service events, and the staff user who acted for staff actions. Null when an app with no attached user made the change.
|
|
5275
|
+
"""
|
|
5262
5276
|
user: User
|
|
5263
5277
|
|
|
5264
5278
|
"""The concerned order."""
|
|
@@ -5333,7 +5347,9 @@ input CustomerInput {
|
|
|
5333
5347
|
"""URL for password reset."""
|
|
5334
5348
|
passwordUrl: String = null
|
|
5335
5349
|
|
|
5336
|
-
"""
|
|
5350
|
+
"""
|
|
5351
|
+
ID of the seller to add the customer to when upgrading them to staff. It must resolve to a seller the requestor can access. When omitted, the customer is upgraded without a seller; none is created.
|
|
5352
|
+
"""
|
|
5337
5353
|
seller: ID = null
|
|
5338
5354
|
|
|
5339
5355
|
"""Tax exemption code."""
|
|
@@ -11051,10 +11067,14 @@ type Mutation {
|
|
|
11051
11067
|
"""
|
|
11052
11068
|
sellerAgreementAssign(input: SellerAgreementInput!): SellerAgreementAssign!
|
|
11053
11069
|
|
|
11054
|
-
"""
|
|
11070
|
+
"""
|
|
11071
|
+
Seller acknowledges the agreement awaiting their decision: Seller.agreementAwaitingDecision, which can differ from Seller.agreement. Pass input.sellerAgreement to sign only the agreement the seller was shown.
|
|
11072
|
+
"""
|
|
11055
11073
|
sellerAgreementAcknowledge(id: ID!, input: SellerAgreementAcknowledgeInput = null): SellerAgreementAcknowledge!
|
|
11056
11074
|
|
|
11057
|
-
"""
|
|
11075
|
+
"""
|
|
11076
|
+
Seller declines the agreement awaiting their decision: Seller.agreementAwaitingDecision, which can differ from Seller.agreement. Pass input.sellerAgreement to decline only the agreement the seller was shown.
|
|
11077
|
+
"""
|
|
11058
11078
|
sellerAgreementDecline(id: ID!, input: SellerAgreementDeclineInput = null): SellerAgreementDecline!
|
|
11059
11079
|
|
|
11060
11080
|
"""
|
|
@@ -15708,6 +15728,11 @@ type ProductBulkCreate {
|
|
|
15708
15728
|
List of errors that occurred executing the mutation. An entry's `index` identifies the input row it came from. Note that an entry with `field: "image"` does NOT mean the row failed: that product was created and only its rejected image was dropped, so treating every `index` in this list as a failed row would mark a successfully created product as failed.
|
|
15709
15729
|
"""
|
|
15710
15730
|
bulkProductErrors: [BulkProductError!]!
|
|
15731
|
+
|
|
15732
|
+
"""
|
|
15733
|
+
Warnings on the created or updated products, each with the index of the input row its product came from. They are the product's own `warnings`. A product created without variants carries `DEFAULT_VARIANT_REQUIRED` until it gets one, so `hasWarnings` is true for each such product: look for a code instead, such as `PRODUCT_ATTRIBUTE_VALUE_REQUIRED` for a required attribute left without a value. Only a row whose product is in `products` has entries. A row refused only its image keeps its product, and so its warnings. A row whose attributes could not be written has none: its product is saved unpublished, and reported only in `bulkProductErrors`.
|
|
15734
|
+
"""
|
|
15735
|
+
bulkProductWarnings: [BulkProductWarning!]!
|
|
15711
15736
|
}
|
|
15712
15737
|
|
|
15713
15738
|
input ProductBulkCreateInput {
|
|
@@ -15821,6 +15846,16 @@ input ProductBulkCreateInput {
|
|
|
15821
15846
|
When enabled, other sellers can create their own variants on this product.
|
|
15822
15847
|
"""
|
|
15823
15848
|
allowSellerVariants: Boolean = null
|
|
15849
|
+
|
|
15850
|
+
"""
|
|
15851
|
+
Public metadata for the product. On an upsert the keys are merged into the product's metadata as metadataUpdate merges them: keys not sent are kept. A row whose metadata is refused is skipped; the other rows are still written.
|
|
15852
|
+
"""
|
|
15853
|
+
metadata: [MetadataInput!] = null
|
|
15854
|
+
|
|
15855
|
+
"""
|
|
15856
|
+
Private metadata for the product, merged on an upsert as privateMetadataUpdate merges it. Needs the permission privateMetadataUpdate needs for a product. A row whose metadata is refused is skipped; the other rows are still written.
|
|
15857
|
+
"""
|
|
15858
|
+
privateMetadata: [MetadataInput!] = null
|
|
15824
15859
|
}
|
|
15825
15860
|
|
|
15826
15861
|
"""Result of product bulk delete mutation."""
|
|
@@ -16090,6 +16125,7 @@ enum ProductErrorCode {
|
|
|
16090
16125
|
COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
|
|
16091
16126
|
INVENTORY_FIELD_CANNOT_BE_EDITED
|
|
16092
16127
|
REQUIRED_PRODUCT_ID_OR_PRODUCT_TYPE_ID
|
|
16128
|
+
MEDIA_FETCH_FAILED
|
|
16093
16129
|
}
|
|
16094
16130
|
|
|
16095
16131
|
"""Product fields available for export."""
|
|
@@ -17290,14 +17326,16 @@ type ProductVariantAuditEventCountableEdge {
|
|
|
17290
17326
|
|
|
17291
17327
|
"""Result of product variant bulk create mutation."""
|
|
17292
17328
|
type ProductVariantBulkCreate {
|
|
17293
|
-
"""
|
|
17329
|
+
"""
|
|
17330
|
+
Number of variants created or updated. A row whose externalSource and externalId match a variant of the product updates it.
|
|
17331
|
+
"""
|
|
17294
17332
|
count: Int!
|
|
17295
17333
|
|
|
17296
|
-
"""The created product variants."""
|
|
17334
|
+
"""The created and updated product variants."""
|
|
17297
17335
|
productVariants: [ProductVariant!]!
|
|
17298
17336
|
|
|
17299
17337
|
"""
|
|
17300
|
-
List of errors that occurred executing the mutation. Carries two kinds. If `count` is 0 and `productVariants` is empty the batch was rejected outright and nothing was
|
|
17338
|
+
List of errors that occurred executing the mutation. Carries two kinds. If `count` is 0 and `productVariants` is empty the batch was rejected outright and nothing was written. Otherwise the batch committed and every entry is advisory: the variant at `index` was written, but with `field: "image"` its image was rejected, or not added because the row updated an existing variant, and with `field: "stocks"` its stocks were not applied because the row updated an existing variant.
|
|
17301
17339
|
"""
|
|
17302
17340
|
productErrors: [BulkProductError!]!
|
|
17303
17341
|
|
|
@@ -17375,6 +17413,16 @@ input ProductVariantBulkCreateInput {
|
|
|
17375
17413
|
|
|
17376
17414
|
"""Initial image to associate with the variant."""
|
|
17377
17415
|
image: Upload = null
|
|
17416
|
+
|
|
17417
|
+
"""
|
|
17418
|
+
Public metadata for the variant. On an upsert the keys are merged into the variant's metadata as metadataUpdate merges them: keys not sent are kept. A row whose metadata is refused fails the whole batch, as any refused row does here.
|
|
17419
|
+
"""
|
|
17420
|
+
metadata: [MetadataInput!] = null
|
|
17421
|
+
|
|
17422
|
+
"""
|
|
17423
|
+
Private metadata for the variant, merged on an upsert as privateMetadataUpdate merges it. Needs the permission privateMetadataUpdate needs for a variant. A row whose metadata is refused fails the whole batch, as any refused row does here.
|
|
17424
|
+
"""
|
|
17425
|
+
privateMetadata: [MetadataInput!] = null
|
|
17378
17426
|
}
|
|
17379
17427
|
|
|
17380
17428
|
"""Result of product variant bulk delete mutation."""
|
|
@@ -18053,6 +18101,7 @@ enum ProductWarningEnum {
|
|
|
18053
18101
|
SELLER_PAUSED
|
|
18054
18102
|
SELLER_DIGITAL_SUSPENDED
|
|
18055
18103
|
SELLER_AGREEMENT_UNACKNOWLEDGED
|
|
18104
|
+
IMAGE_FETCH_FAILED
|
|
18056
18105
|
}
|
|
18057
18106
|
|
|
18058
18107
|
"""Result of products export mutation."""
|
|
@@ -20782,6 +20831,11 @@ type Seller implements Node & ObjectWithMetadata {
|
|
|
20782
20831
|
"""Date seller acknowledged their agreement"""
|
|
20783
20832
|
agreementAcknowledged: DateTime
|
|
20784
20833
|
|
|
20834
|
+
"""
|
|
20835
|
+
The seller agreement that sellerAgreementAcknowledge signs and sellerAgreementDecline declines: the one in force while it is unsigned, else the next unsigned one due. It differs from `agreement`, which is always the agreement in force, once that one is signed and another is scheduled. With nothing left unsigned it is the one in force, else the next one due, and its acknowledgedOn is already set. Requires the seller's owner or MANAGE_MARKETPLACE.
|
|
20836
|
+
"""
|
|
20837
|
+
agreementAwaitingDecision: AgreementSellers
|
|
20838
|
+
|
|
20785
20839
|
"""External payout source plugin identifier"""
|
|
20786
20840
|
externalPayoutSource: SellerExternalPayoutSource
|
|
20787
20841
|
|
|
@@ -21027,6 +21081,11 @@ type SellerAgreementAcknowledge {
|
|
|
21027
21081
|
input SellerAgreementAcknowledgeInput {
|
|
21028
21082
|
"""Reason why seller decided to accept the agreement."""
|
|
21029
21083
|
agreementDecisionReason: String = null
|
|
21084
|
+
|
|
21085
|
+
"""
|
|
21086
|
+
ID of the seller agreement shown to the seller, from Seller.agreementAwaitingDecision. When given, nothing is signed unless it is still the agreement awaiting the seller's decision.
|
|
21087
|
+
"""
|
|
21088
|
+
sellerAgreement: ID = null
|
|
21030
21089
|
}
|
|
21031
21090
|
|
|
21032
21091
|
"""Result of seller agreement assign mutation."""
|
|
@@ -21054,6 +21113,11 @@ type SellerAgreementDecline {
|
|
|
21054
21113
|
input SellerAgreementDeclineInput {
|
|
21055
21114
|
"""Reason why seller decided to decline the agreement."""
|
|
21056
21115
|
agreementDecisionReason: String = null
|
|
21116
|
+
|
|
21117
|
+
"""
|
|
21118
|
+
ID of the seller agreement shown to the seller, from Seller.agreementAwaitingDecision. When given, nothing is declined unless it is still the agreement awaiting the seller's decision.
|
|
21119
|
+
"""
|
|
21120
|
+
sellerAgreement: ID = null
|
|
21057
21121
|
}
|
|
21058
21122
|
|
|
21059
21123
|
"""Result of seller agreement delete mutation."""
|
|
@@ -23506,6 +23570,11 @@ type TokenRefresh {
|
|
|
23506
23570
|
"""New JWT token."""
|
|
23507
23571
|
token: String
|
|
23508
23572
|
|
|
23573
|
+
"""
|
|
23574
|
+
New JWT refresh token. Every refresh issues one: store it in place of the token sent, so the session lasts from its last use rather than from sign-in, up to a fixed limit after sign-in. Returned when the refresh token was sent as an argument; a refresh from the cookie updates the cookie instead.
|
|
23575
|
+
"""
|
|
23576
|
+
refreshToken: String
|
|
23577
|
+
|
|
23509
23578
|
"""The authenticated user."""
|
|
23510
23579
|
user: User
|
|
23511
23580
|
|
|
@@ -23716,7 +23785,7 @@ type User implements Node & ObjectWithMetadata {
|
|
|
23716
23785
|
events: [CustomerEvent!]!
|
|
23717
23786
|
|
|
23718
23787
|
"""
|
|
23719
|
-
Unified change-history feed for this customer. Projects the legacy CustomerEvent log into a TimelineEntry list ordered most-recent-first, so customer history renders through the same dashboard component as the order, seller and product timelines.
|
|
23788
|
+
Unified change-history feed for this customer. Projects the legacy CustomerEvent log into a TimelineEntry list ordered most-recent-first, so customer history renders through the same dashboard component as the order, seller and product timelines. Entries report an unknown actor, because CustomerEvent.user is the customer an event concerns on some events and the staff user who acted on others. Optional `kinds` argument filters server-side.
|
|
23720
23789
|
"""
|
|
23721
23790
|
timeline(kinds: [TimelineEntryKind!] = null): [TimelineEntry!]!
|
|
23722
23791
|
|