@nautical-commerce/graphql-schema 1.87.0-8-gdbcd1b546 → 1.87.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 +623 -637
- package/package.json +1 -1
package/nautical/schema.graphql
CHANGED
@@ -3794,6 +3794,7 @@ type VendorPayout implements Node & ObjectWithMetadata {
|
|
3794
3794
|
|
3795
3795
|
""""""
|
3796
3796
|
ledgerVersion: BigInt!
|
3797
|
+
orders(offset: Int, before: String, after: String, first: Int, last: Int): OrderCountableConnection!
|
3797
3798
|
refundLines(offset: Int, before: String, after: String, first: Int, last: Int): RefundLineCountableConnection!
|
3798
3799
|
|
3799
3800
|
"""
|
@@ -3832,21 +3833,6 @@ type VendorPayout implements Node & ObjectWithMetadata {
|
|
3832
3833
|
refundAmount: Decimal! @deprecated(reason: "This will be removed on August 6, 2025. Use the refund field instead.")
|
3833
3834
|
shipping: Decimal! @deprecated(reason: "This will be removed on August 6, 2025. Use the shippingMoney field instead.")
|
3834
3835
|
volumeDiscounts: Decimal! @deprecated(reason: "This will be removed on August 6, 2025.")
|
3835
|
-
|
3836
|
-
"""List of orders included in this vendor payout"""
|
3837
|
-
orders(
|
3838
|
-
"""Return the elements in the list that come before the specified cursor."""
|
3839
|
-
before: String
|
3840
|
-
|
3841
|
-
"""Return the elements in the list that come after the specified cursor."""
|
3842
|
-
after: String
|
3843
|
-
|
3844
|
-
"""Return the first n elements from the list."""
|
3845
|
-
first: Int
|
3846
|
-
|
3847
|
-
"""Return the last n elements from the list."""
|
3848
|
-
last: Int
|
3849
|
-
): OrderCountableConnection!
|
3850
3836
|
}
|
3851
3837
|
|
3852
3838
|
type Payout implements Node & ObjectWithMetadata {
|
@@ -3917,292 +3903,66 @@ enum VendorPayoutStatus {
|
|
3917
3903
|
ERROR
|
3918
3904
|
}
|
3919
3905
|
|
3920
|
-
type
|
3921
|
-
"""Pagination data for this connection."""
|
3922
|
-
pageInfo: PageInfo!
|
3923
|
-
edges: [RefundLineCountableEdge!]!
|
3924
|
-
|
3925
|
-
"""A total count of items in the collection."""
|
3926
|
-
totalCount: Int
|
3927
|
-
}
|
3928
|
-
|
3929
|
-
type RefundLineCountableEdge {
|
3930
|
-
"""The item at the end of the edge."""
|
3931
|
-
node: RefundLine!
|
3932
|
-
|
3933
|
-
"""A cursor for use in pagination."""
|
3934
|
-
cursor: String!
|
3935
|
-
}
|
3936
|
-
|
3937
|
-
"""Represents a refund line"""
|
3938
|
-
type RefundLine implements Node {
|
3939
|
-
createdAt: DateTime!
|
3940
|
-
updatedAt: DateTime!
|
3941
|
-
|
3942
|
-
"""The ID of the object"""
|
3943
|
-
id: ID!
|
3944
|
-
|
3945
|
-
"""Indicates who is paying for the cost of this refund line"""
|
3946
|
-
chargedTo: RefundChargeToEnum!
|
3947
|
-
|
3948
|
-
"""Currency code that this refund line is in"""
|
3949
|
-
currency: String!
|
3950
|
-
|
3951
|
-
"""How does this refund line apply to the original order"""
|
3952
|
-
lineScope: RefundLineScopeEnum!
|
3953
|
-
|
3954
|
-
"""How is this refund line amount calculated"""
|
3955
|
-
lineType: RefundLineTypeEnum!
|
3956
|
-
|
3957
|
-
"""
|
3958
|
-
If configured as a percentage refund, this is the percentage of the scope value that is to be refunded. This is in the range [0. 100]
|
3959
|
-
"""
|
3960
|
-
percentage: Float!
|
3961
|
-
|
3962
|
-
"""
|
3963
|
-
If configured as a quantity based refund, this is the number of fulfilled units refunded.
|
3964
|
-
"""
|
3965
|
-
quantityFulfilled: Int!
|
3966
|
-
|
3967
|
-
"""
|
3968
|
-
If configured as a quantity based refund, this is the number of unfulfilled units refunded.
|
3969
|
-
"""
|
3970
|
-
quantityUnfulfilled: Int!
|
3971
|
-
|
3972
|
-
"""The refund this refund line is contained in"""
|
3973
|
-
refund: Refund!
|
3974
|
-
|
3975
|
-
"""The scope that this refund line applies to"""
|
3976
|
-
refundScope: RefundScope!
|
3977
|
-
|
3978
|
-
"""The total for this refund line"""
|
3979
|
-
total: TaxedMoney!
|
3980
|
-
}
|
3981
|
-
|
3982
|
-
enum RefundChargeToEnum {
|
3983
|
-
"""Marketplace"""
|
3984
|
-
MARKETPLACE
|
3985
|
-
|
3986
|
-
"""Seller"""
|
3987
|
-
SELLER
|
3988
|
-
}
|
3989
|
-
|
3990
|
-
enum RefundLineScopeEnum {
|
3991
|
-
"""Buyer Order"""
|
3992
|
-
BUYERORDER
|
3993
|
-
|
3994
|
-
"""Order Line"""
|
3995
|
-
ORDERLINE
|
3996
|
-
|
3997
|
-
"""Seller Order"""
|
3998
|
-
SELLERORDER
|
3999
|
-
}
|
4000
|
-
|
4001
|
-
enum RefundLineTypeEnum {
|
4002
|
-
ENTIRE_SCOPE
|
4003
|
-
FIXED_AMOUNT
|
4004
|
-
PARTIAL_QUANTITY
|
4005
|
-
PERCENTAGE
|
4006
|
-
SHIPPING
|
4007
|
-
TAX
|
4008
|
-
}
|
4009
|
-
|
4010
|
-
"""
|
4011
|
-
Represents a refund scoped to an nautical order, a seller order, or a seller order line
|
4012
|
-
"""
|
4013
|
-
type Refund implements Node & ObjectWithMetadata {
|
4014
|
-
createdAt: DateTime!
|
4015
|
-
updatedAt: DateTime!
|
4016
|
-
description: String!
|
4017
|
-
descriptionHtml: String!
|
4018
|
-
|
4019
|
-
"""The ID of the object"""
|
4020
|
-
id: ID!
|
4021
|
-
lines(offset: Int, before: String, after: String, first: Int, last: Int): RefundLineCountableConnection!
|
4022
|
-
payments(offset: Int, before: String, after: String, first: Int, last: Int): RefundPaymentCountableConnection!
|
4023
|
-
|
4024
|
-
"""
|
4025
|
-
List of private metadata items.Requires proper staff permissions to access.
|
4026
|
-
"""
|
4027
|
-
privateMetadata: [MetadataItem!]!
|
4028
|
-
|
4029
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
4030
|
-
metadata: [MetadataItem!]!
|
4031
|
-
|
4032
|
-
"""
|
4033
|
-
The buyer who is receiving the refund. This may be NULL in the case of refunds issued against anonymous orders
|
4034
|
-
"""
|
4035
|
-
buyer: User
|
4036
|
-
|
4037
|
-
"""
|
4038
|
-
Optional external ID which can be used to synchronize Nautical refunds to data in an external system
|
4039
|
-
"""
|
4040
|
-
externalId: String
|
4041
|
-
|
4042
|
-
"""Human readable name of the refund"""
|
4043
|
-
name: String!
|
4044
|
-
|
4045
|
-
"""The order that this refund is against"""
|
4046
|
-
order: NauticalOrder!
|
4047
|
-
|
4048
|
-
"""Status of the refund"""
|
4049
|
-
status: RefundStatusEnum!
|
4050
|
-
|
4051
|
-
"""Unique UUID associated with the refund"""
|
4052
|
-
token: String!
|
4053
|
-
|
4054
|
-
"""
|
4055
|
-
Type of the refund: manual or order line. An order line refund is scoped to either an OrderLine or an Order with the lineType of Shipping. A manual refund is scoped either to a BuyerOrder or a SellerOrder with any lineType besides Shipping
|
4056
|
-
"""
|
4057
|
-
refundType: RefundTypeEnum!
|
4058
|
-
}
|
4059
|
-
|
4060
|
-
type RefundPaymentCountableConnection {
|
3906
|
+
type OrderCountableConnection {
|
4061
3907
|
"""Pagination data for this connection."""
|
4062
3908
|
pageInfo: PageInfo!
|
4063
|
-
edges: [
|
3909
|
+
edges: [OrderCountableEdge!]!
|
4064
3910
|
|
4065
3911
|
"""A total count of items in the collection."""
|
4066
3912
|
totalCount: Int
|
4067
3913
|
}
|
4068
3914
|
|
4069
|
-
type
|
3915
|
+
type OrderCountableEdge {
|
4070
3916
|
"""The item at the end of the edge."""
|
4071
|
-
node:
|
3917
|
+
node: Order!
|
4072
3918
|
|
4073
3919
|
"""A cursor for use in pagination."""
|
4074
3920
|
cursor: String!
|
4075
3921
|
}
|
4076
3922
|
|
4077
|
-
"""Represents
|
4078
|
-
type
|
4079
|
-
createdAt: DateTime!
|
4080
|
-
updatedAt: DateTime!
|
4081
|
-
|
4082
|
-
"""The ID of the object"""
|
4083
|
-
id: ID!
|
4084
|
-
|
4085
|
-
"""How this payment is made"""
|
4086
|
-
paymentType: RefundPaymentTypeEnum!
|
4087
|
-
|
4088
|
-
"""The refund this refund line is contained in"""
|
4089
|
-
refund: Refund!
|
4090
|
-
|
4091
|
-
"""The reverse payment"""
|
4092
|
-
refundMethod: RefundMethod!
|
4093
|
-
}
|
4094
|
-
|
4095
|
-
enum RefundPaymentTypeEnum {
|
4096
|
-
"""Transaction"""
|
4097
|
-
TRANSACTION
|
4098
|
-
|
4099
|
-
"""Voucher"""
|
4100
|
-
VOUCHER
|
4101
|
-
}
|
4102
|
-
|
4103
|
-
union RefundMethod = Transaction | Voucher
|
4104
|
-
|
4105
|
-
"""An object representing a single payment."""
|
4106
|
-
type Transaction implements Node {
|
4107
|
-
"""The ID of the object"""
|
4108
|
-
id: ID!
|
4109
|
-
created: DateTime!
|
4110
|
-
payment: Payment!
|
4111
|
-
token: String!
|
4112
|
-
kind: TransactionKind!
|
4113
|
-
isSuccess: Boolean!
|
4114
|
-
error: String
|
4115
|
-
|
4116
|
-
"""Total amount of the transaction."""
|
4117
|
-
amount: Money
|
4118
|
-
}
|
4119
|
-
|
4120
|
-
"""Represents a payment of a given type."""
|
4121
|
-
type Payment implements Node & ObjectWithMetadata {
|
4122
|
-
"""The ID of the object"""
|
4123
|
-
id: ID!
|
4124
|
-
gateway: String!
|
4125
|
-
isActive: Boolean!
|
4126
|
-
created: DateTime!
|
4127
|
-
modified: DateTime!
|
4128
|
-
token: String!
|
4129
|
-
checkout: Checkout
|
4130
|
-
nauticalOrder: NauticalOrder
|
4131
|
-
paymentMethodType: String!
|
4132
|
-
paymentMethodToken: String
|
4133
|
-
customerIpAddress: String
|
4134
|
-
|
4135
|
-
"""
|
4136
|
-
List of private metadata items.Requires proper staff permissions to access.
|
4137
|
-
"""
|
4138
|
-
privateMetadata: [MetadataItem!]!
|
4139
|
-
|
4140
|
-
"""List of public metadata items. Can be accessed without permissions."""
|
4141
|
-
metadata: [MetadataItem!]!
|
4142
|
-
|
4143
|
-
"""Internal payment status."""
|
4144
|
-
chargeStatus: PaymentChargeStatusEnum!
|
4145
|
-
|
4146
|
-
"""
|
4147
|
-
List of actions that can be performed in the current state of a payment.
|
4148
|
-
"""
|
4149
|
-
actions: [OrderAction!]!
|
4150
|
-
|
4151
|
-
"""Total amount of the payment."""
|
4152
|
-
total: Money
|
4153
|
-
|
4154
|
-
"""Total amount captured for this payment."""
|
4155
|
-
capturedAmount: Money
|
4156
|
-
|
4157
|
-
"""List of all transactions within this payment."""
|
4158
|
-
transactions: [Transaction!]
|
4159
|
-
|
4160
|
-
"""Maximum amount of money that can be captured."""
|
4161
|
-
availableCaptureAmount: Money
|
4162
|
-
|
4163
|
-
"""Maximum amount of money that can be refunded."""
|
4164
|
-
availableRefundAmount: Money
|
4165
|
-
|
4166
|
-
"""The details of the card used for this payment."""
|
4167
|
-
creditCard: CreditCard
|
4168
|
-
}
|
4169
|
-
|
4170
|
-
"""Represents a nautical order in the shop."""
|
4171
|
-
type NauticalOrder implements Node & ObjectWithMetadata {
|
3923
|
+
"""Represents an order in the shop."""
|
3924
|
+
type Order implements Node & ObjectWithMetadata {
|
4172
3925
|
"""The ID of the object"""
|
4173
3926
|
id: ID!
|
4174
3927
|
externalId: String
|
4175
3928
|
externalSource: String
|
4176
|
-
orderSource:
|
3929
|
+
orderSource: OrderOrderSource!
|
3930
|
+
|
3931
|
+
"""Seller this order belongs to"""
|
3932
|
+
seller: Seller
|
4177
3933
|
created: DateTime!
|
4178
3934
|
updated: DateTime
|
4179
3935
|
|
4180
3936
|
"""Order status"""
|
4181
|
-
status:
|
4182
|
-
subStatus:
|
3937
|
+
status: OrderStatus!
|
3938
|
+
subStatus: OrderSubStatus
|
4183
3939
|
user: User
|
4184
3940
|
languageCode: String!
|
4185
3941
|
trackingClientId: String!
|
4186
3942
|
billingAddress: Address
|
4187
3943
|
shippingAddress: Address
|
3944
|
+
vatCode: String!
|
3945
|
+
euInvoiceMessaging: String
|
3946
|
+
vatIdentificationNumber: String
|
3947
|
+
mpVatIdentificationNumber: String
|
4188
3948
|
currency: String!
|
3949
|
+
shippingMethod: ShippingMethod
|
3950
|
+
shippingMethodName: String
|
3951
|
+
|
3952
|
+
"""Total price of shipping."""
|
3953
|
+
shippingPrice: TaxedMoney
|
4189
3954
|
|
4190
3955
|
"""
|
4191
|
-
Indicates that the
|
3956
|
+
Indicates that the shipping price is set manually by user rather than taken from a related shipping method.
|
4192
3957
|
"""
|
4193
|
-
|
3958
|
+
isShippingPriceOverridden: Boolean!
|
4194
3959
|
|
4195
|
-
"""
|
4196
|
-
|
4197
|
-
|
4198
|
-
|
4199
|
-
mpVatIdentificationNumber: String
|
3960
|
+
"""
|
3961
|
+
Indicates that the order is being fulfilled by the marketplace and the seller is not responsible for shipping.
|
3962
|
+
"""
|
3963
|
+
fulfilledByMarketplace: Boolean!
|
4200
3964
|
token: String!
|
4201
|
-
|
4202
|
-
"""Token of the checkout instance that this order was created from."""
|
4203
|
-
checkoutToken: String
|
4204
3965
|
voucher: Voucher
|
4205
|
-
shippingDiscount: Money
|
4206
3966
|
discount: Money
|
4207
3967
|
discountName: String
|
4208
3968
|
translatedDiscountName: String
|
@@ -4212,7 +3972,6 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
4212
3972
|
|
4213
3973
|
"""Data time when the order was imported from another platform."""
|
4214
3974
|
importedAt: DateTime
|
4215
|
-
poNumbers: [String!]
|
4216
3975
|
|
4217
3976
|
"""
|
4218
3977
|
List of private metadata items.Requires proper staff permissions to access.
|
@@ -4222,32 +3981,20 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
4222
3981
|
"""List of public metadata items. Can be accessed without permissions."""
|
4223
3982
|
metadata: [MetadataItem!]!
|
4224
3983
|
|
4225
|
-
"""
|
4226
|
-
|
3984
|
+
"""List of shipments for the order."""
|
3985
|
+
fulfillments: [Fulfillment!]!
|
3986
|
+
fees: [OrderFee!]
|
4227
3987
|
|
4228
|
-
"""List of
|
4229
|
-
|
3988
|
+
"""List of order lines."""
|
3989
|
+
lines: [OrderLine!]!
|
4230
3990
|
|
4231
3991
|
"""
|
4232
3992
|
List of sub-statuses that can be changed to based on current state of the order
|
4233
3993
|
"""
|
4234
3994
|
allowedSubStatuses: [OrderSubStatusEnum!] @deprecated(reason: "This will be removed on September 9, 2025.")
|
4235
3995
|
|
4236
|
-
"""
|
4237
|
-
|
4238
|
-
|
4239
|
-
"""List of nautical order lines."""
|
4240
|
-
lines: [NauticalOrderLine!]!
|
4241
|
-
|
4242
|
-
"""
|
4243
|
-
List of actions that can be performed in the current state of an order.
|
4244
|
-
"""
|
4245
|
-
actions: [OrderAction!]!
|
4246
|
-
|
4247
|
-
"""
|
4248
|
-
Available shipping methods for each seller in this order. Note: this field designed for 'nauticalOrder(:id)' query.
|
4249
|
-
"""
|
4250
|
-
availableShippingMethodsBySeller: [MultiSellerShippingMethod!]
|
3996
|
+
"""Shipping methods that can be used with this order."""
|
3997
|
+
availableShippingMethods: [ShippingMethod!]
|
4251
3998
|
|
4252
3999
|
"""List of order invoices."""
|
4253
4000
|
invoices: [Invoice!]
|
@@ -4255,6 +4002,9 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
4255
4002
|
"""User-friendly number of an order."""
|
4256
4003
|
number: String
|
4257
4004
|
|
4005
|
+
"""User-friendly number of the marketplace order this order belongs to."""
|
4006
|
+
marketplaceOrderNumber: String
|
4007
|
+
|
4258
4008
|
"""Informs if an order is fully paid."""
|
4259
4009
|
isPaid: Boolean
|
4260
4010
|
|
@@ -4264,12 +4014,15 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
4264
4014
|
"""User-friendly payment status."""
|
4265
4015
|
paymentStatusDisplay: String!
|
4266
4016
|
|
4267
|
-
"""List of payments for the order."""
|
4268
|
-
payments: [Payment!]
|
4269
|
-
|
4270
4017
|
"""Total amount of the order."""
|
4271
4018
|
total: TaxedMoney
|
4272
4019
|
|
4020
|
+
"""Total of the order including any discounts."""
|
4021
|
+
discountedTotal: TaxedMoney
|
4022
|
+
|
4023
|
+
"""Original total amount of the order."""
|
4024
|
+
originalTotal: TaxedMoney
|
4025
|
+
|
4273
4026
|
"""The sum of line prices not including shipping."""
|
4274
4027
|
subtotal: TaxedMoney
|
4275
4028
|
|
@@ -4281,52 +4034,50 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
4281
4034
|
"""
|
4282
4035
|
canFinalize: Boolean!
|
4283
4036
|
|
4284
|
-
"""Validation status for the order"""
|
4285
|
-
validationStatus: [ValidationStatus!]
|
4286
|
-
|
4287
|
-
"""Amount authorized for the order across all payments."""
|
4288
|
-
totalAuthorized: Money
|
4289
|
-
|
4290
|
-
"""Amount captured for the order across all payments."""
|
4291
|
-
totalCaptured: Money
|
4292
|
-
|
4293
|
-
"""Amount refunded for the order across all payments."""
|
4294
|
-
totalRefunded: Money
|
4295
|
-
|
4296
4037
|
"""List of events associated with the order."""
|
4297
|
-
events: [
|
4298
|
-
|
4299
|
-
"""The difference between the paid and the order total amount."""
|
4300
|
-
totalBalance(
|
4301
|
-
"""Should the balance be returned positive or negative."""
|
4302
|
-
positive: Boolean
|
4303
|
-
): Money!
|
4038
|
+
events: [OrderEvent!]
|
4304
4039
|
|
4305
4040
|
"""Email address of the customer."""
|
4306
4041
|
userEmail: String
|
4307
4042
|
|
4308
4043
|
"""Returns True, if order requires shipping."""
|
4309
4044
|
isShippingRequired: Boolean!
|
4310
|
-
shippingMethodName: String!
|
4311
4045
|
|
4312
|
-
"""
|
4313
|
-
|
4046
|
+
"""Order payout status."""
|
4047
|
+
payoutStatus: OrderPayoutStatusEnum
|
4314
4048
|
|
4315
|
-
"""
|
4316
|
-
|
4049
|
+
"""Summary of all payouts of this order"""
|
4050
|
+
payoutsSummary(
|
4051
|
+
"""Order payout status."""
|
4052
|
+
payoutStatus: PayoutStatusEnum
|
4053
|
+
): [OrderPayoutSummary!]!
|
4317
4054
|
|
4318
|
-
"""
|
4319
|
-
|
4055
|
+
"""Remaining available balance to be paid out."""
|
4056
|
+
availablePayoutBalance: Money
|
4320
4057
|
|
4321
|
-
"""
|
4322
|
-
|
4058
|
+
"""Seller commission for the order"""
|
4059
|
+
sellerCommission: Money
|
4323
4060
|
|
4324
|
-
"""
|
4325
|
-
|
4061
|
+
"""Validation status for the order"""
|
4062
|
+
validationStatus: [ValidationStatus!]
|
4063
|
+
|
4064
|
+
"""
|
4065
|
+
Determines if seller is the only seller on the related nautical order. Note: if nautical order doesn't exist - will return None.
|
4066
|
+
"""
|
4067
|
+
isOnlySellerOnNauticalOrder: Boolean
|
4068
|
+
|
4069
|
+
"""Marketplace order that this seller order belongs to."""
|
4070
|
+
marketplaceOrder: NauticalOrder
|
4071
|
+
|
4072
|
+
"""All vendor payouts that contain this order"""
|
4073
|
+
vendorPayouts: [VendorPayout!]
|
4074
|
+
|
4075
|
+
"""Voucher discount for the order"""
|
4076
|
+
voucherDiscount: Money
|
4326
4077
|
}
|
4327
4078
|
|
4328
4079
|
"""An enumeration."""
|
4329
|
-
enum
|
4080
|
+
enum OrderOrderSource {
|
4330
4081
|
"""checkout"""
|
4331
4082
|
CHECKOUT
|
4332
4083
|
|
@@ -4341,7 +4092,7 @@ enum NauticalOrderOrderSource {
|
|
4341
4092
|
}
|
4342
4093
|
|
4343
4094
|
"""An enumeration."""
|
4344
|
-
enum
|
4095
|
+
enum OrderStatus {
|
4345
4096
|
DRAFT
|
4346
4097
|
UNFULFILLED
|
4347
4098
|
PARTIALLY_FULFILLED
|
@@ -4356,7 +4107,7 @@ enum NauticalOrderStatus {
|
|
4356
4107
|
}
|
4357
4108
|
|
4358
4109
|
"""An enumeration."""
|
4359
|
-
enum
|
4110
|
+
enum OrderSubStatus {
|
4360
4111
|
"""Awaiting Payment"""
|
4361
4112
|
AWAITING_PAYMENT
|
4362
4113
|
|
@@ -5905,49 +5656,42 @@ type Fulfillment implements Node & ObjectWithMetadata {
|
|
5905
5656
|
customFields: [SelectedAttribute!]!
|
5906
5657
|
}
|
5907
5658
|
|
5908
|
-
"""Represents
|
5909
|
-
type
|
5659
|
+
"""Represents a nautical order in the shop."""
|
5660
|
+
type NauticalOrder implements Node & ObjectWithMetadata {
|
5910
5661
|
"""The ID of the object"""
|
5911
5662
|
id: ID!
|
5912
5663
|
externalId: String
|
5913
5664
|
externalSource: String
|
5914
|
-
orderSource:
|
5915
|
-
|
5916
|
-
"""Seller this order belongs to"""
|
5917
|
-
seller: Seller
|
5665
|
+
orderSource: NauticalOrderOrderSource!
|
5918
5666
|
created: DateTime!
|
5919
5667
|
updated: DateTime
|
5920
5668
|
|
5921
5669
|
"""Order status"""
|
5922
|
-
status:
|
5923
|
-
subStatus:
|
5670
|
+
status: NauticalOrderStatus!
|
5671
|
+
subStatus: NauticalOrderSubStatus
|
5924
5672
|
user: User
|
5925
5673
|
languageCode: String!
|
5926
5674
|
trackingClientId: String!
|
5927
5675
|
billingAddress: Address
|
5928
5676
|
shippingAddress: Address
|
5929
|
-
vatCode: String!
|
5930
|
-
euInvoiceMessaging: String
|
5931
|
-
vatIdentificationNumber: String
|
5932
|
-
mpVatIdentificationNumber: String
|
5933
5677
|
currency: String!
|
5934
|
-
shippingMethod: ShippingMethod
|
5935
|
-
shippingMethodName: String
|
5936
|
-
|
5937
|
-
"""Total price of shipping."""
|
5938
|
-
shippingPrice: TaxedMoney
|
5939
5678
|
|
5940
5679
|
"""
|
5941
|
-
Indicates that the shipping price is set manually by user rather than taken from a related shipping method.
|
5680
|
+
Indicates that the marketplace shipping price is set manually by user rather than taken from a related shipping method.
|
5942
5681
|
"""
|
5943
|
-
|
5682
|
+
isMarketplaceShippingPriceOverridden: Boolean!
|
5944
5683
|
|
5945
|
-
"""
|
5946
|
-
|
5947
|
-
|
5948
|
-
|
5684
|
+
"""Total price of shipping."""
|
5685
|
+
shippingPrice: TaxedMoney
|
5686
|
+
euInvoiceMessaging: String
|
5687
|
+
vatIdentificationNumber: String
|
5688
|
+
mpVatIdentificationNumber: String
|
5949
5689
|
token: String!
|
5690
|
+
|
5691
|
+
"""Token of the checkout instance that this order was created from."""
|
5692
|
+
checkoutToken: String
|
5950
5693
|
voucher: Voucher
|
5694
|
+
shippingDiscount: Money
|
5951
5695
|
discount: Money
|
5952
5696
|
discountName: String
|
5953
5697
|
translatedDiscountName: String
|
@@ -5957,6 +5701,7 @@ type Order implements Node & ObjectWithMetadata {
|
|
5957
5701
|
|
5958
5702
|
"""Data time when the order was imported from another platform."""
|
5959
5703
|
importedAt: DateTime
|
5704
|
+
poNumbers: [String!]
|
5960
5705
|
|
5961
5706
|
"""
|
5962
5707
|
List of private metadata items.Requires proper staff permissions to access.
|
@@ -5966,20 +5711,32 @@ type Order implements Node & ObjectWithMetadata {
|
|
5966
5711
|
"""List of public metadata items. Can be accessed without permissions."""
|
5967
5712
|
metadata: [MetadataItem!]!
|
5968
5713
|
|
5969
|
-
"""
|
5970
|
-
|
5971
|
-
fees: [OrderFee!]
|
5714
|
+
"""Available shipping methods for the order."""
|
5715
|
+
availableMarketplaceShippingMethods: [ShippingMethod!]
|
5972
5716
|
|
5973
|
-
"""List of order
|
5974
|
-
|
5717
|
+
"""List of seller shipments for the order."""
|
5718
|
+
sellerFulfillments: [Fulfillment!]!
|
5975
5719
|
|
5976
5720
|
"""
|
5977
5721
|
List of sub-statuses that can be changed to based on current state of the order
|
5978
5722
|
"""
|
5979
5723
|
allowedSubStatuses: [OrderSubStatusEnum!] @deprecated(reason: "This will be removed on September 9, 2025.")
|
5980
5724
|
|
5981
|
-
"""
|
5982
|
-
|
5725
|
+
"""List"""
|
5726
|
+
sellerUnfulfilled: [OrderLine!]!
|
5727
|
+
|
5728
|
+
"""List of nautical order lines."""
|
5729
|
+
lines: [NauticalOrderLine!]!
|
5730
|
+
|
5731
|
+
"""
|
5732
|
+
List of actions that can be performed in the current state of an order.
|
5733
|
+
"""
|
5734
|
+
actions: [OrderAction!]!
|
5735
|
+
|
5736
|
+
"""
|
5737
|
+
Available shipping methods for each seller in this order. Note: this field designed for 'nauticalOrder(:id)' query.
|
5738
|
+
"""
|
5739
|
+
availableShippingMethodsBySeller: [MultiSellerShippingMethod!]
|
5983
5740
|
|
5984
5741
|
"""List of order invoices."""
|
5985
5742
|
invoices: [Invoice!]
|
@@ -5987,9 +5744,6 @@ type Order implements Node & ObjectWithMetadata {
|
|
5987
5744
|
"""User-friendly number of an order."""
|
5988
5745
|
number: String
|
5989
5746
|
|
5990
|
-
"""User-friendly number of the marketplace order this order belongs to."""
|
5991
|
-
marketplaceOrderNumber: String
|
5992
|
-
|
5993
5747
|
"""Informs if an order is fully paid."""
|
5994
5748
|
isPaid: Boolean
|
5995
5749
|
|
@@ -5999,70 +5753,69 @@ type Order implements Node & ObjectWithMetadata {
|
|
5999
5753
|
"""User-friendly payment status."""
|
6000
5754
|
paymentStatusDisplay: String!
|
6001
5755
|
|
5756
|
+
"""List of payments for the order."""
|
5757
|
+
payments: [Payment!]
|
5758
|
+
|
6002
5759
|
"""Total amount of the order."""
|
6003
5760
|
total: TaxedMoney
|
6004
5761
|
|
6005
|
-
"""Total of the order including any discounts."""
|
6006
|
-
discountedTotal: TaxedMoney
|
6007
|
-
|
6008
|
-
"""Original total amount of the order."""
|
6009
|
-
originalTotal: TaxedMoney
|
6010
|
-
|
6011
5762
|
"""The sum of line prices not including shipping."""
|
6012
5763
|
subtotal: TaxedMoney
|
6013
5764
|
|
6014
|
-
"""User-friendly order status."""
|
6015
|
-
statusDisplay: String
|
5765
|
+
"""User-friendly order status."""
|
5766
|
+
statusDisplay: String
|
5767
|
+
|
5768
|
+
"""
|
5769
|
+
Informs whether a draft order can be finalized (turned into a regular order).
|
5770
|
+
"""
|
5771
|
+
canFinalize: Boolean!
|
5772
|
+
|
5773
|
+
"""Validation status for the order"""
|
5774
|
+
validationStatus: [ValidationStatus!]
|
5775
|
+
|
5776
|
+
"""Amount authorized for the order across all payments."""
|
5777
|
+
totalAuthorized: Money
|
5778
|
+
|
5779
|
+
"""Amount captured for the order across all payments."""
|
5780
|
+
totalCaptured: Money
|
6016
5781
|
|
6017
|
-
"""
|
6018
|
-
|
6019
|
-
"""
|
6020
|
-
canFinalize: Boolean!
|
5782
|
+
"""Amount refunded for the order across all payments."""
|
5783
|
+
totalRefunded: Money
|
6021
5784
|
|
6022
5785
|
"""List of events associated with the order."""
|
6023
|
-
events: [
|
5786
|
+
events: [NauticalOrderEvent!]
|
5787
|
+
|
5788
|
+
"""The difference between the paid and the order total amount."""
|
5789
|
+
totalBalance(
|
5790
|
+
"""Should the balance be returned positive or negative."""
|
5791
|
+
positive: Boolean
|
5792
|
+
): Money!
|
6024
5793
|
|
6025
5794
|
"""Email address of the customer."""
|
6026
5795
|
userEmail: String
|
6027
5796
|
|
6028
5797
|
"""Returns True, if order requires shipping."""
|
6029
5798
|
isShippingRequired: Boolean!
|
5799
|
+
shippingMethodName: String!
|
6030
5800
|
|
6031
|
-
"""
|
6032
|
-
|
6033
|
-
|
6034
|
-
"""Summary of all payouts of this order"""
|
6035
|
-
payoutsSummary(
|
6036
|
-
"""Order payout status."""
|
6037
|
-
payoutStatus: PayoutStatusEnum
|
6038
|
-
): [OrderPayoutSummary!]!
|
6039
|
-
|
6040
|
-
"""Remaining available balance to be paid out."""
|
6041
|
-
availablePayoutBalance: Money
|
6042
|
-
|
6043
|
-
"""Seller commission for the order"""
|
6044
|
-
sellerCommission: Money
|
6045
|
-
|
6046
|
-
"""Validation status for the order"""
|
6047
|
-
validationStatus: [ValidationStatus!]
|
5801
|
+
"""List of all the vendor orders connected to this marketplace order."""
|
5802
|
+
subOrders: [Order!]
|
6048
5803
|
|
6049
|
-
"""
|
6050
|
-
|
6051
|
-
"""
|
6052
|
-
isOnlySellerOnNauticalOrder: Boolean
|
5804
|
+
"""List of all the refunds for this marketplace order."""
|
5805
|
+
refunds: [Refund!]
|
6053
5806
|
|
6054
|
-
"""
|
6055
|
-
|
5807
|
+
"""Total price of shipping for this order."""
|
5808
|
+
marketplaceShippingPrice: TaxedMoney!
|
6056
5809
|
|
6057
|
-
"""
|
6058
|
-
|
5810
|
+
"""Shipping method for this order."""
|
5811
|
+
marketplaceShippingMethod: ShippingMethod
|
6059
5812
|
|
6060
|
-
"""
|
6061
|
-
|
5813
|
+
"""Name of the shipping method for this order."""
|
5814
|
+
marketplaceShippingMethodName: String
|
6062
5815
|
}
|
6063
5816
|
|
6064
5817
|
"""An enumeration."""
|
6065
|
-
enum
|
5818
|
+
enum NauticalOrderOrderSource {
|
6066
5819
|
"""checkout"""
|
6067
5820
|
CHECKOUT
|
6068
5821
|
|
@@ -6077,7 +5830,7 @@ enum OrderOrderSource {
|
|
6077
5830
|
}
|
6078
5831
|
|
6079
5832
|
"""An enumeration."""
|
6080
|
-
enum
|
5833
|
+
enum NauticalOrderStatus {
|
6081
5834
|
DRAFT
|
6082
5835
|
UNFULFILLED
|
6083
5836
|
PARTIALLY_FULFILLED
|
@@ -6092,7 +5845,7 @@ enum OrderStatus {
|
|
6092
5845
|
}
|
6093
5846
|
|
6094
5847
|
"""An enumeration."""
|
6095
|
-
enum
|
5848
|
+
enum NauticalOrderSubStatus {
|
6096
5849
|
"""Awaiting Payment"""
|
6097
5850
|
AWAITING_PAYMENT
|
6098
5851
|
|
@@ -6100,40 +5853,12 @@ enum OrderSubStatus {
|
|
6100
5853
|
COMPLETE
|
6101
5854
|
}
|
6102
5855
|
|
6103
|
-
|
6104
|
-
|
6105
|
-
|
6106
|
-
id: ID!
|
6107
|
-
tenant: Tenant!
|
6108
|
-
order: Order
|
6109
|
-
|
6110
|
-
"""Currency of the fee."""
|
6111
|
-
currency: NauticalCurrency!
|
6112
|
-
transactionAmount: Decimal!
|
6113
|
-
|
6114
|
-
"""Transaction currency of the fee."""
|
6115
|
-
transactionCurrency: NauticalCurrency!
|
6116
|
-
transactionFee: Money
|
6117
|
-
domiciledAmount: Decimal!
|
6118
|
-
domiciledFee: Money
|
6119
|
-
|
6120
|
-
"""Source fee type."""
|
6121
|
-
source: SourceFeeEnum
|
6122
|
-
name: String!
|
6123
|
-
notes: String!
|
6124
|
-
data: JSONString!
|
6125
|
-
}
|
6126
|
-
|
6127
|
-
type NauticalCurrency {
|
6128
|
-
code: String!
|
6129
|
-
}
|
6130
|
-
|
6131
|
-
enum SourceFeeEnum {
|
6132
|
-
"""Agreement Fees"""
|
6133
|
-
AGREEMENT_FEES
|
5856
|
+
enum OrderSubStatusEnum {
|
5857
|
+
"""Awaiting Payment"""
|
5858
|
+
AWAITING_PAYMENT
|
6134
5859
|
|
6135
|
-
"""
|
6136
|
-
|
5860
|
+
"""Complete"""
|
5861
|
+
COMPLETE
|
6137
5862
|
}
|
6138
5863
|
|
6139
5864
|
"""Represents order line of particular order."""
|
@@ -6421,12 +6146,18 @@ type ShippingZoneCountryArea implements Node {
|
|
6421
6146
|
countryArea: CountryArea!
|
6422
6147
|
}
|
6423
6148
|
|
6424
|
-
enum
|
6425
|
-
"""
|
6426
|
-
|
6149
|
+
enum OrderAction {
|
6150
|
+
"""Represents the capture action."""
|
6151
|
+
CAPTURE
|
6427
6152
|
|
6428
|
-
"""
|
6429
|
-
|
6153
|
+
"""Represents a mark-as-paid action."""
|
6154
|
+
MARK_AS_PAID
|
6155
|
+
|
6156
|
+
"""Represents a refund action."""
|
6157
|
+
REFUND
|
6158
|
+
|
6159
|
+
"""Represents a void action."""
|
6160
|
+
VOID
|
6430
6161
|
}
|
6431
6162
|
|
6432
6163
|
"""Represents an Invoice."""
|
@@ -6455,59 +6186,189 @@ type Invoice implements ObjectWithMetadata & Job & Node {
|
|
6455
6186
|
"""Date time of job last update in ISO 8601 format."""
|
6456
6187
|
updatedAt: DateTime!
|
6457
6188
|
|
6458
|
-
"""Job message."""
|
6459
|
-
message: String
|
6189
|
+
"""Job message."""
|
6190
|
+
message: String
|
6191
|
+
|
6192
|
+
"""URL to download an invoice."""
|
6193
|
+
url: String
|
6194
|
+
}
|
6195
|
+
|
6196
|
+
interface Job {
|
6197
|
+
"""Job status."""
|
6198
|
+
status: JobStatusEnum!
|
6199
|
+
|
6200
|
+
"""Created date time of job in ISO 8601 format."""
|
6201
|
+
createdAt: DateTime!
|
6202
|
+
|
6203
|
+
"""Date time of job last update in ISO 8601 format."""
|
6204
|
+
updatedAt: DateTime!
|
6205
|
+
|
6206
|
+
"""Job message."""
|
6207
|
+
message: String
|
6208
|
+
}
|
6209
|
+
|
6210
|
+
enum JobStatusEnum {
|
6211
|
+
"""Pending"""
|
6212
|
+
PENDING
|
6213
|
+
|
6214
|
+
"""Processing"""
|
6215
|
+
PROCESSING
|
6216
|
+
|
6217
|
+
"""Success"""
|
6218
|
+
SUCCESS
|
6219
|
+
|
6220
|
+
"""Failed"""
|
6221
|
+
FAILED
|
6222
|
+
|
6223
|
+
"""Deleted"""
|
6224
|
+
DELETED
|
6225
|
+
}
|
6226
|
+
|
6227
|
+
"Represents possible statuses of a payment.\n\n The following statuses are possible:\n - NOT_CHARGED - no funds were take off the customer founding source yet.\n - PARTIALLY_CHARGED - funds were taken off the customer's funding source,\n partly covering the payment amount.\n - FULLY_CHARGED - funds were taken off the customer founding source,\n partly or completely covering the payment amount.\n - PARTIALLY_REFUNDED - part of charged funds were returned to the customer.\n - FULLY_REFUNDED - all charged funds were returned to the customer.\n "
|
6228
|
+
enum PaymentChargeStatusEnum {
|
6229
|
+
NOT_CHARGED
|
6230
|
+
PENDING
|
6231
|
+
PARTIALLY_CHARGED
|
6232
|
+
FULLY_CHARGED
|
6233
|
+
PARTIALLY_REFUNDED
|
6234
|
+
FULLY_REFUNDED
|
6235
|
+
REFUSED
|
6236
|
+
CANCELLED
|
6237
|
+
VOIDED
|
6238
|
+
}
|
6239
|
+
|
6240
|
+
"""Represents a payment of a given type."""
|
6241
|
+
type Payment implements Node & ObjectWithMetadata {
|
6242
|
+
"""The ID of the object"""
|
6243
|
+
id: ID!
|
6244
|
+
gateway: String!
|
6245
|
+
isActive: Boolean!
|
6246
|
+
created: DateTime!
|
6247
|
+
modified: DateTime!
|
6248
|
+
token: String!
|
6249
|
+
checkout: Checkout
|
6250
|
+
nauticalOrder: NauticalOrder
|
6251
|
+
paymentMethodType: String!
|
6252
|
+
paymentMethodToken: String
|
6253
|
+
customerIpAddress: String
|
6254
|
+
|
6255
|
+
"""
|
6256
|
+
List of private metadata items.Requires proper staff permissions to access.
|
6257
|
+
"""
|
6258
|
+
privateMetadata: [MetadataItem!]!
|
6259
|
+
|
6260
|
+
"""List of public metadata items. Can be accessed without permissions."""
|
6261
|
+
metadata: [MetadataItem!]!
|
6262
|
+
|
6263
|
+
"""Internal payment status."""
|
6264
|
+
chargeStatus: PaymentChargeStatusEnum!
|
6265
|
+
|
6266
|
+
"""
|
6267
|
+
List of actions that can be performed in the current state of a payment.
|
6268
|
+
"""
|
6269
|
+
actions: [OrderAction!]!
|
6270
|
+
|
6271
|
+
"""Total amount of the payment."""
|
6272
|
+
total: Money
|
6273
|
+
|
6274
|
+
"""Total amount captured for this payment."""
|
6275
|
+
capturedAmount: Money
|
6276
|
+
|
6277
|
+
"""List of all transactions within this payment."""
|
6278
|
+
transactions: [Transaction!]
|
6279
|
+
|
6280
|
+
"""Maximum amount of money that can be captured."""
|
6281
|
+
availableCaptureAmount: Money
|
6282
|
+
|
6283
|
+
"""Maximum amount of money that can be refunded."""
|
6284
|
+
availableRefundAmount: Money
|
6285
|
+
|
6286
|
+
"""The details of the card used for this payment."""
|
6287
|
+
creditCard: CreditCard
|
6288
|
+
}
|
6289
|
+
|
6290
|
+
"""An object representing a single payment."""
|
6291
|
+
type Transaction implements Node {
|
6292
|
+
"""The ID of the object"""
|
6293
|
+
id: ID!
|
6294
|
+
created: DateTime!
|
6295
|
+
payment: Payment!
|
6296
|
+
token: String!
|
6297
|
+
kind: TransactionKind!
|
6298
|
+
isSuccess: Boolean!
|
6299
|
+
error: String
|
6300
|
+
|
6301
|
+
"""Total amount of the transaction."""
|
6302
|
+
amount: Money
|
6303
|
+
}
|
6304
|
+
|
6305
|
+
"""An enumeration."""
|
6306
|
+
enum TransactionKind {
|
6307
|
+
"""Authorization"""
|
6308
|
+
AUTH
|
6309
|
+
|
6310
|
+
"""Capture"""
|
6311
|
+
CAPTURE
|
6312
|
+
|
6313
|
+
"""Capture failed"""
|
6314
|
+
CAPTURE_FAILED
|
6315
|
+
|
6316
|
+
"""Action to confirm"""
|
6317
|
+
ACTION_TO_CONFIRM
|
6318
|
+
|
6319
|
+
"""Void"""
|
6320
|
+
VOID
|
6321
|
+
|
6322
|
+
"""Pending"""
|
6323
|
+
PENDING
|
6324
|
+
|
6325
|
+
"""Refund"""
|
6326
|
+
REFUND
|
6327
|
+
|
6328
|
+
"""Refund in progress"""
|
6329
|
+
REFUND_ONGOING
|
6460
6330
|
|
6461
|
-
"""
|
6462
|
-
|
6463
|
-
}
|
6331
|
+
"""Refund failed"""
|
6332
|
+
REFUND_FAILED
|
6464
6333
|
|
6465
|
-
|
6466
|
-
|
6467
|
-
status: JobStatusEnum!
|
6334
|
+
"""Refund reversed"""
|
6335
|
+
REFUND_REVERSED
|
6468
6336
|
|
6469
|
-
"""
|
6470
|
-
|
6337
|
+
"""Confirm"""
|
6338
|
+
CONFIRM
|
6471
6339
|
|
6472
|
-
"""
|
6473
|
-
|
6340
|
+
"""Cancel"""
|
6341
|
+
CANCEL
|
6474
6342
|
|
6475
|
-
"""
|
6476
|
-
|
6343
|
+
"""Created"""
|
6344
|
+
CREATED
|
6477
6345
|
}
|
6478
6346
|
|
6479
|
-
|
6480
|
-
"""
|
6481
|
-
|
6347
|
+
type CreditCard {
|
6348
|
+
"""Card brand."""
|
6349
|
+
brand: String!
|
6482
6350
|
|
6483
|
-
"""
|
6484
|
-
|
6351
|
+
"""First 4 digits of the card number."""
|
6352
|
+
firstDigits: String
|
6485
6353
|
|
6486
|
-
"""
|
6487
|
-
|
6354
|
+
"""Last 4 digits of the card number."""
|
6355
|
+
lastDigits: String!
|
6488
6356
|
|
6489
|
-
"""
|
6490
|
-
|
6357
|
+
"""Two-digit number representing the card’s expiration month."""
|
6358
|
+
expMonth: Int
|
6491
6359
|
|
6492
|
-
"""
|
6493
|
-
|
6360
|
+
"""Four-digit number representing the card’s expiration year."""
|
6361
|
+
expYear: Int
|
6494
6362
|
}
|
6495
6363
|
|
6496
|
-
|
6497
|
-
|
6498
|
-
|
6499
|
-
|
6500
|
-
PARTIALLY_CHARGED
|
6501
|
-
FULLY_CHARGED
|
6502
|
-
PARTIALLY_REFUNDED
|
6503
|
-
FULLY_REFUNDED
|
6504
|
-
REFUSED
|
6505
|
-
CANCELLED
|
6506
|
-
VOIDED
|
6364
|
+
type ValidationStatus {
|
6365
|
+
message: String
|
6366
|
+
code: String
|
6367
|
+
variant: ID
|
6507
6368
|
}
|
6508
6369
|
|
6509
6370
|
"""History log of the order."""
|
6510
|
-
type
|
6371
|
+
type NauticalOrderEvent implements Node {
|
6511
6372
|
"""The ID of the object"""
|
6512
6373
|
id: ID!
|
6513
6374
|
|
@@ -6515,7 +6376,7 @@ type OrderEvent implements Node {
|
|
6515
6376
|
date: DateTime!
|
6516
6377
|
|
6517
6378
|
"""Order event type."""
|
6518
|
-
type: OrderEventsEnum
|
6379
|
+
type: OrderEventsEnum!
|
6519
6380
|
|
6520
6381
|
"""User who performed the action."""
|
6521
6382
|
user: User
|
@@ -6554,10 +6415,7 @@ type OrderEvent implements Node {
|
|
6554
6415
|
oversoldItems: [String!]
|
6555
6416
|
|
6556
6417
|
"""The concerned lines."""
|
6557
|
-
lines: [
|
6558
|
-
|
6559
|
-
"""The lines fulfilled."""
|
6560
|
-
fulfilledItems: [FulfillmentLine!]
|
6418
|
+
lines: [NauticalOrderEventOrderLineObject!]
|
6561
6419
|
|
6562
6420
|
"""The warehouse were items were restocked."""
|
6563
6421
|
warehouse: Warehouse
|
@@ -6753,81 +6611,239 @@ enum OrderEventsEmailsEnum {
|
|
6753
6611
|
PAYMENT_LINK_SENT
|
6754
6612
|
}
|
6755
6613
|
|
6756
|
-
type
|
6614
|
+
type NauticalOrderEventOrderLineObject {
|
6757
6615
|
"""The variant quantity."""
|
6758
6616
|
quantity: Int
|
6759
6617
|
|
6760
6618
|
"""The order line."""
|
6761
|
-
orderLine:
|
6619
|
+
orderLine: NauticalOrderLine
|
6762
6620
|
|
6763
6621
|
"""The variant name."""
|
6764
6622
|
itemName: String
|
6765
6623
|
}
|
6766
6624
|
|
6767
|
-
"""
|
6768
|
-
|
6625
|
+
"""
|
6626
|
+
Represents a refund scoped to an nautical order, a seller order, or a seller order line
|
6627
|
+
"""
|
6628
|
+
type Refund implements Node & ObjectWithMetadata {
|
6629
|
+
createdAt: DateTime!
|
6630
|
+
updatedAt: DateTime!
|
6631
|
+
description: String!
|
6632
|
+
descriptionHtml: String!
|
6633
|
+
|
6769
6634
|
"""The ID of the object"""
|
6770
6635
|
id: ID!
|
6771
|
-
|
6772
|
-
|
6636
|
+
lines(offset: Int, before: String, after: String, first: Int, last: Int): RefundLineCountableConnection!
|
6637
|
+
payments(offset: Int, before: String, after: String, first: Int, last: Int): RefundPaymentCountableConnection!
|
6773
6638
|
|
6774
|
-
"""
|
6775
|
-
|
6639
|
+
"""
|
6640
|
+
List of private metadata items.Requires proper staff permissions to access.
|
6641
|
+
"""
|
6642
|
+
privateMetadata: [MetadataItem!]!
|
6643
|
+
|
6644
|
+
"""List of public metadata items. Can be accessed without permissions."""
|
6645
|
+
metadata: [MetadataItem!]!
|
6646
|
+
|
6647
|
+
"""
|
6648
|
+
The buyer who is receiving the refund. This may be NULL in the case of refunds issued against anonymous orders
|
6649
|
+
"""
|
6650
|
+
buyer: User
|
6651
|
+
|
6652
|
+
"""
|
6653
|
+
Optional external ID which can be used to synchronize Nautical refunds to data in an external system
|
6654
|
+
"""
|
6655
|
+
externalId: String
|
6656
|
+
|
6657
|
+
"""Human readable name of the refund"""
|
6658
|
+
name: String!
|
6659
|
+
|
6660
|
+
"""The order that this refund is against"""
|
6661
|
+
order: NauticalOrder!
|
6662
|
+
|
6663
|
+
"""Status of the refund"""
|
6664
|
+
status: RefundStatusEnum!
|
6665
|
+
|
6666
|
+
"""Unique UUID associated with the refund"""
|
6667
|
+
token: String!
|
6668
|
+
|
6669
|
+
"""
|
6670
|
+
Type of the refund: manual or order line. An order line refund is scoped to either an OrderLine or an Order with the lineType of Shipping. A manual refund is scoped either to a BuyerOrder or a SellerOrder with any lineType besides Shipping
|
6671
|
+
"""
|
6672
|
+
refundType: RefundTypeEnum!
|
6776
6673
|
}
|
6777
6674
|
|
6778
|
-
|
6779
|
-
"""
|
6780
|
-
|
6675
|
+
type RefundLineCountableConnection {
|
6676
|
+
"""Pagination data for this connection."""
|
6677
|
+
pageInfo: PageInfo!
|
6678
|
+
edges: [RefundLineCountableEdge!]!
|
6781
6679
|
|
6782
|
-
"""
|
6783
|
-
|
6680
|
+
"""A total count of items in the collection."""
|
6681
|
+
totalCount: Int
|
6682
|
+
}
|
6784
6683
|
|
6785
|
-
|
6786
|
-
|
6684
|
+
type RefundLineCountableEdge {
|
6685
|
+
"""The item at the end of the edge."""
|
6686
|
+
node: RefundLine!
|
6787
6687
|
|
6788
|
-
"""
|
6789
|
-
|
6688
|
+
"""A cursor for use in pagination."""
|
6689
|
+
cursor: String!
|
6690
|
+
}
|
6691
|
+
|
6692
|
+
"""Represents a refund line"""
|
6693
|
+
type RefundLine implements Node {
|
6694
|
+
createdAt: DateTime!
|
6695
|
+
updatedAt: DateTime!
|
6696
|
+
|
6697
|
+
"""The ID of the object"""
|
6698
|
+
id: ID!
|
6699
|
+
|
6700
|
+
"""Indicates who is paying for the cost of this refund line"""
|
6701
|
+
chargedTo: RefundChargeToEnum!
|
6702
|
+
|
6703
|
+
"""Currency code that this refund line is in"""
|
6704
|
+
currency: String!
|
6705
|
+
|
6706
|
+
"""How does this refund line apply to the original order"""
|
6707
|
+
lineScope: RefundLineScopeEnum!
|
6708
|
+
|
6709
|
+
"""How is this refund line amount calculated"""
|
6710
|
+
lineType: RefundLineTypeEnum!
|
6711
|
+
|
6712
|
+
"""
|
6713
|
+
If configured as a percentage refund, this is the percentage of the scope value that is to be refunded. This is in the range [0. 100]
|
6714
|
+
"""
|
6715
|
+
percentage: Float!
|
6716
|
+
|
6717
|
+
"""
|
6718
|
+
If configured as a quantity based refund, this is the number of fulfilled units refunded.
|
6719
|
+
"""
|
6720
|
+
quantityFulfilled: Int!
|
6721
|
+
|
6722
|
+
"""
|
6723
|
+
If configured as a quantity based refund, this is the number of unfulfilled units refunded.
|
6724
|
+
"""
|
6725
|
+
quantityUnfulfilled: Int!
|
6726
|
+
|
6727
|
+
"""The refund this refund line is contained in"""
|
6728
|
+
refund: Refund!
|
6729
|
+
|
6730
|
+
"""The scope that this refund line applies to"""
|
6731
|
+
refundScope: RefundScope!
|
6732
|
+
|
6733
|
+
"""The total for this refund line"""
|
6734
|
+
total: TaxedMoney!
|
6735
|
+
}
|
6736
|
+
|
6737
|
+
enum RefundChargeToEnum {
|
6738
|
+
"""Marketplace"""
|
6739
|
+
MARKETPLACE
|
6740
|
+
|
6741
|
+
"""Seller"""
|
6742
|
+
SELLER
|
6743
|
+
}
|
6744
|
+
|
6745
|
+
enum RefundLineScopeEnum {
|
6746
|
+
"""Buyer Order"""
|
6747
|
+
BUYERORDER
|
6748
|
+
|
6749
|
+
"""Order Line"""
|
6750
|
+
ORDERLINE
|
6751
|
+
|
6752
|
+
"""Seller Order"""
|
6753
|
+
SELLERORDER
|
6754
|
+
}
|
6755
|
+
|
6756
|
+
enum RefundLineTypeEnum {
|
6757
|
+
ENTIRE_SCOPE
|
6758
|
+
FIXED_AMOUNT
|
6759
|
+
PARTIAL_QUANTITY
|
6760
|
+
PERCENTAGE
|
6761
|
+
SHIPPING
|
6762
|
+
TAX
|
6763
|
+
}
|
6764
|
+
|
6765
|
+
union RefundScope = NauticalOrder | Order | OrderLine
|
6766
|
+
|
6767
|
+
type RefundPaymentCountableConnection {
|
6768
|
+
"""Pagination data for this connection."""
|
6769
|
+
pageInfo: PageInfo!
|
6770
|
+
edges: [RefundPaymentCountableEdge!]!
|
6771
|
+
|
6772
|
+
"""A total count of items in the collection."""
|
6773
|
+
totalCount: Int
|
6774
|
+
}
|
6775
|
+
|
6776
|
+
type RefundPaymentCountableEdge {
|
6777
|
+
"""The item at the end of the edge."""
|
6778
|
+
node: RefundPayment!
|
6779
|
+
|
6780
|
+
"""A cursor for use in pagination."""
|
6781
|
+
cursor: String!
|
6782
|
+
}
|
6783
|
+
|
6784
|
+
"""Represents a refund payment"""
|
6785
|
+
type RefundPayment implements Node {
|
6786
|
+
createdAt: DateTime!
|
6787
|
+
updatedAt: DateTime!
|
6788
|
+
|
6789
|
+
"""The ID of the object"""
|
6790
|
+
id: ID!
|
6791
|
+
|
6792
|
+
"""How this payment is made"""
|
6793
|
+
paymentType: RefundPaymentTypeEnum!
|
6794
|
+
|
6795
|
+
"""The refund this refund line is contained in"""
|
6796
|
+
refund: Refund!
|
6797
|
+
|
6798
|
+
"""The reverse payment"""
|
6799
|
+
refundMethod: RefundMethod!
|
6800
|
+
}
|
6790
6801
|
|
6791
|
-
|
6792
|
-
|
6802
|
+
enum RefundPaymentTypeEnum {
|
6803
|
+
"""Transaction"""
|
6804
|
+
TRANSACTION
|
6793
6805
|
|
6794
|
-
"""
|
6795
|
-
|
6806
|
+
"""Voucher"""
|
6807
|
+
VOUCHER
|
6796
6808
|
}
|
6797
6809
|
|
6798
|
-
|
6799
|
-
"""Commissions that affected the payout"""
|
6800
|
-
commissions: Money!
|
6810
|
+
union RefundMethod = Transaction | Voucher
|
6801
6811
|
|
6802
|
-
|
6803
|
-
|
6812
|
+
enum RefundStatusEnum {
|
6813
|
+
"""Requested"""
|
6814
|
+
REQUESTED
|
6804
6815
|
|
6805
|
-
"""
|
6806
|
-
|
6816
|
+
"""Canceled"""
|
6817
|
+
CANCELED
|
6807
6818
|
|
6808
|
-
"""
|
6809
|
-
|
6819
|
+
"""Declined"""
|
6820
|
+
DECLINED
|
6810
6821
|
|
6811
|
-
"""
|
6812
|
-
|
6822
|
+
"""Approved"""
|
6823
|
+
APPROVED
|
6813
6824
|
|
6814
|
-
"""
|
6815
|
-
|
6825
|
+
"""Processing"""
|
6826
|
+
PROCESSING
|
6816
6827
|
|
6817
|
-
"""
|
6818
|
-
|
6828
|
+
"""Failed"""
|
6829
|
+
FAILED
|
6819
6830
|
|
6820
|
-
"""
|
6821
|
-
|
6831
|
+
"""Paid"""
|
6832
|
+
PAID
|
6822
6833
|
|
6823
|
-
"""
|
6824
|
-
|
6834
|
+
"""Locked"""
|
6835
|
+
LOCKED
|
6836
|
+
|
6837
|
+
"""Settled"""
|
6838
|
+
SETTLED
|
6825
6839
|
}
|
6826
6840
|
|
6827
|
-
|
6828
|
-
|
6829
|
-
|
6830
|
-
|
6841
|
+
enum RefundTypeEnum {
|
6842
|
+
"""Manual Refund"""
|
6843
|
+
MANUALREFUND
|
6844
|
+
|
6845
|
+
"""Order Line Refund"""
|
6846
|
+
ORDERLINEREFUND
|
6831
6847
|
}
|
6832
6848
|
|
6833
6849
|
"""An enumeration."""
|
@@ -6863,22 +6879,55 @@ enum FulfillmentStatus {
|
|
6863
6879
|
RETURN_CANCELLED
|
6864
6880
|
}
|
6865
6881
|
|
6866
|
-
|
6867
|
-
|
6868
|
-
|
6882
|
+
"""Represents line of the fulfillment."""
|
6883
|
+
type FulfillmentLine implements Node {
|
6884
|
+
"""The ID of the object"""
|
6885
|
+
id: ID!
|
6886
|
+
quantity: Int!
|
6887
|
+
orderLine: OrderLine
|
6869
6888
|
|
6870
|
-
"""
|
6871
|
-
|
6889
|
+
"""Reason customer requested item return."""
|
6890
|
+
returnReason: String
|
6891
|
+
}
|
6872
6892
|
|
6873
|
-
|
6874
|
-
|
6893
|
+
"""Extra fee associated with an order"""
|
6894
|
+
type OrderFee implements Node {
|
6895
|
+
"""The ID of the object"""
|
6896
|
+
id: ID!
|
6897
|
+
tenant: Tenant!
|
6898
|
+
order: Order
|
6875
6899
|
|
6876
|
-
"""
|
6877
|
-
|
6900
|
+
"""Currency of the fee."""
|
6901
|
+
currency: NauticalCurrency!
|
6902
|
+
transactionAmount: Decimal!
|
6903
|
+
|
6904
|
+
"""Transaction currency of the fee."""
|
6905
|
+
transactionCurrency: NauticalCurrency!
|
6906
|
+
transactionFee: Money
|
6907
|
+
domiciledAmount: Decimal!
|
6908
|
+
domiciledFee: Money
|
6909
|
+
|
6910
|
+
"""Source fee type."""
|
6911
|
+
source: SourceFeeEnum
|
6912
|
+
name: String!
|
6913
|
+
notes: String!
|
6914
|
+
data: JSONString!
|
6915
|
+
}
|
6916
|
+
|
6917
|
+
type NauticalCurrency {
|
6918
|
+
code: String!
|
6919
|
+
}
|
6920
|
+
|
6921
|
+
enum SourceFeeEnum {
|
6922
|
+
"""Agreement Fees"""
|
6923
|
+
AGREEMENT_FEES
|
6924
|
+
|
6925
|
+
"""Manual Order Fee"""
|
6926
|
+
MANUAL_ORDER_FEE
|
6878
6927
|
}
|
6879
6928
|
|
6880
6929
|
"""History log of the order."""
|
6881
|
-
type
|
6930
|
+
type OrderEvent implements Node {
|
6882
6931
|
"""The ID of the object"""
|
6883
6932
|
id: ID!
|
6884
6933
|
|
@@ -6886,7 +6935,7 @@ type NauticalOrderEvent implements Node {
|
|
6886
6935
|
date: DateTime!
|
6887
6936
|
|
6888
6937
|
"""Order event type."""
|
6889
|
-
type: OrderEventsEnum
|
6938
|
+
type: OrderEventsEnum
|
6890
6939
|
|
6891
6940
|
"""User who performed the action."""
|
6892
6941
|
user: User
|
@@ -6925,121 +6974,75 @@ type NauticalOrderEvent implements Node {
|
|
6925
6974
|
oversoldItems: [String!]
|
6926
6975
|
|
6927
6976
|
"""The concerned lines."""
|
6928
|
-
lines: [
|
6977
|
+
lines: [OrderEventOrderLineObject!]
|
6978
|
+
|
6979
|
+
"""The lines fulfilled."""
|
6980
|
+
fulfilledItems: [FulfillmentLine!]
|
6929
6981
|
|
6930
6982
|
"""The warehouse were items were restocked."""
|
6931
6983
|
warehouse: Warehouse
|
6932
6984
|
}
|
6933
6985
|
|
6934
|
-
type
|
6986
|
+
type OrderEventOrderLineObject {
|
6935
6987
|
"""The variant quantity."""
|
6936
6988
|
quantity: Int
|
6937
6989
|
|
6938
6990
|
"""The order line."""
|
6939
|
-
orderLine:
|
6991
|
+
orderLine: OrderLine
|
6940
6992
|
|
6941
6993
|
"""The variant name."""
|
6942
6994
|
itemName: String
|
6943
6995
|
}
|
6944
6996
|
|
6945
|
-
|
6946
|
-
"""
|
6947
|
-
|
6948
|
-
|
6949
|
-
"""First 4 digits of the card number."""
|
6950
|
-
firstDigits: String
|
6951
|
-
|
6952
|
-
"""Last 4 digits of the card number."""
|
6953
|
-
lastDigits: String!
|
6954
|
-
|
6955
|
-
"""Two-digit number representing the card’s expiration month."""
|
6956
|
-
expMonth: Int
|
6957
|
-
|
6958
|
-
"""Four-digit number representing the card’s expiration year."""
|
6959
|
-
expYear: Int
|
6960
|
-
}
|
6961
|
-
|
6962
|
-
"""An enumeration."""
|
6963
|
-
enum TransactionKind {
|
6964
|
-
"""Authorization"""
|
6965
|
-
AUTH
|
6966
|
-
|
6967
|
-
"""Capture"""
|
6968
|
-
CAPTURE
|
6969
|
-
|
6970
|
-
"""Capture failed"""
|
6971
|
-
CAPTURE_FAILED
|
6972
|
-
|
6973
|
-
"""Action to confirm"""
|
6974
|
-
ACTION_TO_CONFIRM
|
6975
|
-
|
6976
|
-
"""Void"""
|
6977
|
-
VOID
|
6978
|
-
|
6979
|
-
"""Pending"""
|
6980
|
-
PENDING
|
6981
|
-
|
6982
|
-
"""Refund"""
|
6983
|
-
REFUND
|
6984
|
-
|
6985
|
-
"""Refund in progress"""
|
6986
|
-
REFUND_ONGOING
|
6997
|
+
enum OrderPayoutStatusEnum {
|
6998
|
+
"""Not ready"""
|
6999
|
+
NOT_READY
|
6987
7000
|
|
6988
|
-
"""
|
6989
|
-
|
7001
|
+
"""Not paid"""
|
7002
|
+
NOT_PAID
|
6990
7003
|
|
6991
|
-
"""
|
6992
|
-
|
7004
|
+
"""Ready for payout"""
|
7005
|
+
READY_FOR_PAYOUT
|
6993
7006
|
|
6994
|
-
"""
|
6995
|
-
|
7007
|
+
"""Paid out"""
|
7008
|
+
PAID_OUT
|
6996
7009
|
|
6997
|
-
"""
|
6998
|
-
|
7010
|
+
"""Partially paid out"""
|
7011
|
+
PARTIALLY_PAID_OUT
|
6999
7012
|
|
7000
|
-
"""
|
7001
|
-
|
7013
|
+
"""Error"""
|
7014
|
+
ERROR
|
7002
7015
|
}
|
7003
7016
|
|
7004
|
-
|
7005
|
-
"""
|
7006
|
-
|
7007
|
-
|
7008
|
-
"""Canceled"""
|
7009
|
-
CANCELED
|
7010
|
-
|
7011
|
-
"""Declined"""
|
7012
|
-
DECLINED
|
7017
|
+
type OrderPayoutSummary {
|
7018
|
+
"""Commissions that affected the payout"""
|
7019
|
+
commissions: Money!
|
7013
7020
|
|
7014
|
-
"""
|
7015
|
-
|
7021
|
+
"""Discounts that affected payouts"""
|
7022
|
+
discounts: Money!
|
7016
7023
|
|
7017
|
-
"""
|
7018
|
-
|
7024
|
+
"""Fees that affect the payout"""
|
7025
|
+
fees: Money!
|
7019
7026
|
|
7020
|
-
"""
|
7021
|
-
|
7027
|
+
"""Refunds that affected the payout"""
|
7028
|
+
refunds: Money!
|
7022
7029
|
|
7023
|
-
"""
|
7024
|
-
|
7030
|
+
"""Commissions that were reduced as a result of refunds"""
|
7031
|
+
refundsCommission: Money!
|
7025
7032
|
|
7026
|
-
"""
|
7027
|
-
|
7033
|
+
"""Sales in the payout"""
|
7034
|
+
sales: Money!
|
7028
7035
|
|
7029
|
-
"""
|
7030
|
-
|
7031
|
-
}
|
7036
|
+
"""Shipping in the payout"""
|
7037
|
+
shipping: Money!
|
7032
7038
|
|
7033
|
-
|
7034
|
-
|
7035
|
-
MANUALREFUND
|
7039
|
+
"""Total for this payout"""
|
7040
|
+
total: Money!
|
7036
7041
|
|
7037
|
-
"""
|
7038
|
-
|
7042
|
+
"""Vendor Payout associated with this data"""
|
7043
|
+
vendorPayout: VendorPayout!
|
7039
7044
|
}
|
7040
7045
|
|
7041
|
-
union RefundScope = NauticalOrder | Order | OrderLine
|
7042
|
-
|
7043
7046
|
"""History log of the vendor payout."""
|
7044
7047
|
type VendorPayoutEvent implements Node {
|
7045
7048
|
"""The ID of the object"""
|
@@ -7084,23 +7087,6 @@ enum VendorPayoutEventsEnum {
|
|
7084
7087
|
VENDOR_PAYOUT_EMAIL_SENT
|
7085
7088
|
}
|
7086
7089
|
|
7087
|
-
type OrderCountableConnection {
|
7088
|
-
"""Pagination data for this connection."""
|
7089
|
-
pageInfo: PageInfo!
|
7090
|
-
edges: [OrderCountableEdge!]!
|
7091
|
-
|
7092
|
-
"""A total count of items in the collection."""
|
7093
|
-
totalCount: Int
|
7094
|
-
}
|
7095
|
-
|
7096
|
-
type OrderCountableEdge {
|
7097
|
-
"""The item at the end of the edge."""
|
7098
|
-
node: Order!
|
7099
|
-
|
7100
|
-
"""A cursor for use in pagination."""
|
7101
|
-
cursor: String!
|
7102
|
-
}
|
7103
|
-
|
7104
7090
|
type AgreementSellersCountableConnection {
|
7105
7091
|
"""Pagination data for this connection."""
|
7106
7092
|
pageInfo: PageInfo!
|
@@ -11355,7 +11341,7 @@ type Mutation {
|
|
11355
11341
|
description: String
|
11356
11342
|
|
11357
11343
|
"""
|
11358
|
-
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/
|
11344
|
+
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/acrobat, image/x-bmp, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/svg, application/x-tiff, image/x-tif, application/dxf, text/plain, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/eps, application/x-csv, application/zip, application/x-autocad, application/x-pdf, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/gzip-compressed, application/vnd.ms-powerpoint, application/x-rtf, text/x-comma-separated-values, application/tif, application/vnd.pdf, image/heif, application/gzipped, image/x-tiff, drawing/x-dwf, image/jpg, application/dwg, application/x-jpg, image/jpeg, application/excel, image/heic, text/rtf, text/pdf, text/x-pdf, application/tiff, application/pdf, text/svg, application/csv, image/png, application/jpg, application/eps, text/comma-separated-values, application/vnd.ms-excel, image/tif, image/webp, application/vnd.ms-word, image/tiff, text/csv, application/x-dxf, application/x-tar, image/gif, image/heic-sequence, application/rtf, image/svg+xml, pplication/vnd.rar, application/x-acad, image/x-ms-bmp, application/postscript, application/vnd.oasis.opendocument.presentation, drawing/dwg, text/x-csv, application/x-rar, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/x-tif, image/x-dxf, application/gzip, image/bmp, image/x-dwg, application/acad, application/x-eps, image/heif-sequence, image/dxf, drawing/x-dwg, application/x-dwg, application/x-gzip, application/msword, application/vnd.oasis.opendocument.text, application/svg+xml, image/x-eps, application/x-rar-compressed, application/vnd.oasis.opendocument.spreadsheet, image/vnd.dwg, text/svg-xml, application/x-zip-compressed.
|
11359
11345
|
"""
|
11360
11346
|
file: Upload!
|
11361
11347
|
|