@nautical-commerce/graphql-schema 1.87.4 → 1.88.0-1-g0e153cfe6
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 +639 -625
- package/package.json +1 -1
package/nautical/schema.graphql
CHANGED
@@ -3794,7 +3794,6 @@ 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!
|
3798
3797
|
refundLines(offset: Int, before: String, after: String, first: Int, last: Int): RefundLineCountableConnection!
|
3799
3798
|
|
3800
3799
|
"""
|
@@ -3833,6 +3832,21 @@ type VendorPayout implements Node & ObjectWithMetadata {
|
|
3833
3832
|
refundAmount: Decimal! @deprecated(reason: "This will be removed on August 6, 2025. Use the refund field instead.")
|
3834
3833
|
shipping: Decimal! @deprecated(reason: "This will be removed on August 6, 2025. Use the shippingMoney field instead.")
|
3835
3834
|
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!
|
3836
3850
|
}
|
3837
3851
|
|
3838
3852
|
type Payout implements Node & ObjectWithMetadata {
|
@@ -3903,66 +3917,292 @@ enum VendorPayoutStatus {
|
|
3903
3917
|
ERROR
|
3904
3918
|
}
|
3905
3919
|
|
3906
|
-
type
|
3920
|
+
type RefundLineCountableConnection {
|
3907
3921
|
"""Pagination data for this connection."""
|
3908
3922
|
pageInfo: PageInfo!
|
3909
|
-
edges: [
|
3923
|
+
edges: [RefundLineCountableEdge!]!
|
3910
3924
|
|
3911
3925
|
"""A total count of items in the collection."""
|
3912
3926
|
totalCount: Int
|
3913
3927
|
}
|
3914
3928
|
|
3915
|
-
type
|
3929
|
+
type RefundLineCountableEdge {
|
3916
3930
|
"""The item at the end of the edge."""
|
3917
|
-
node:
|
3931
|
+
node: RefundLine!
|
3918
3932
|
|
3919
3933
|
"""A cursor for use in pagination."""
|
3920
3934
|
cursor: String!
|
3921
3935
|
}
|
3922
3936
|
|
3923
|
-
"""Represents
|
3924
|
-
type
|
3937
|
+
"""Represents a refund line"""
|
3938
|
+
type RefundLine implements Node {
|
3939
|
+
createdAt: DateTime!
|
3940
|
+
updatedAt: DateTime!
|
3941
|
+
|
3925
3942
|
"""The ID of the object"""
|
3926
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
|
+
"""
|
3927
4040
|
externalId: String
|
3928
|
-
externalSource: String
|
3929
|
-
orderSource: OrderOrderSource!
|
3930
4041
|
|
3931
|
-
"""
|
3932
|
-
|
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 {
|
4061
|
+
"""Pagination data for this connection."""
|
4062
|
+
pageInfo: PageInfo!
|
4063
|
+
edges: [RefundPaymentCountableEdge!]!
|
4064
|
+
|
4065
|
+
"""A total count of items in the collection."""
|
4066
|
+
totalCount: Int
|
4067
|
+
}
|
4068
|
+
|
4069
|
+
type RefundPaymentCountableEdge {
|
4070
|
+
"""The item at the end of the edge."""
|
4071
|
+
node: RefundPayment!
|
4072
|
+
|
4073
|
+
"""A cursor for use in pagination."""
|
4074
|
+
cursor: String!
|
4075
|
+
}
|
4076
|
+
|
4077
|
+
"""Represents a refund payment"""
|
4078
|
+
type RefundPayment implements Node {
|
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 {
|
4172
|
+
"""The ID of the object"""
|
4173
|
+
id: ID!
|
4174
|
+
externalId: String
|
4175
|
+
externalSource: String
|
4176
|
+
orderSource: NauticalOrderOrderSource!
|
3933
4177
|
created: DateTime!
|
3934
4178
|
updated: DateTime
|
3935
4179
|
|
3936
4180
|
"""Order status"""
|
3937
|
-
status:
|
3938
|
-
subStatus:
|
4181
|
+
status: NauticalOrderStatus!
|
4182
|
+
subStatus: NauticalOrderSubStatus
|
3939
4183
|
user: User
|
3940
4184
|
languageCode: String!
|
3941
4185
|
trackingClientId: String!
|
3942
4186
|
billingAddress: Address
|
3943
4187
|
shippingAddress: Address
|
3944
|
-
vatCode: String!
|
3945
|
-
euInvoiceMessaging: String
|
3946
|
-
vatIdentificationNumber: String
|
3947
|
-
mpVatIdentificationNumber: String
|
3948
4188
|
currency: String!
|
3949
|
-
shippingMethod: ShippingMethod
|
3950
|
-
shippingMethodName: String
|
3951
|
-
|
3952
|
-
"""Total price of shipping."""
|
3953
|
-
shippingPrice: TaxedMoney
|
3954
4189
|
|
3955
4190
|
"""
|
3956
|
-
Indicates that the shipping price is set manually by user rather than taken from a related shipping method.
|
4191
|
+
Indicates that the marketplace shipping price is set manually by user rather than taken from a related shipping method.
|
3957
4192
|
"""
|
3958
|
-
|
4193
|
+
isMarketplaceShippingPriceOverridden: Boolean!
|
3959
4194
|
|
3960
|
-
"""
|
3961
|
-
|
3962
|
-
|
3963
|
-
|
4195
|
+
"""Total price of shipping."""
|
4196
|
+
shippingPrice: TaxedMoney
|
4197
|
+
euInvoiceMessaging: String
|
4198
|
+
vatIdentificationNumber: String
|
4199
|
+
mpVatIdentificationNumber: String
|
3964
4200
|
token: String!
|
4201
|
+
|
4202
|
+
"""Token of the checkout instance that this order was created from."""
|
4203
|
+
checkoutToken: String
|
3965
4204
|
voucher: Voucher
|
4205
|
+
shippingDiscount: Money
|
3966
4206
|
discount: Money
|
3967
4207
|
discountName: String
|
3968
4208
|
translatedDiscountName: String
|
@@ -3972,6 +4212,7 @@ type Order implements Node & ObjectWithMetadata {
|
|
3972
4212
|
|
3973
4213
|
"""Data time when the order was imported from another platform."""
|
3974
4214
|
importedAt: DateTime
|
4215
|
+
poNumbers: [String!]
|
3975
4216
|
|
3976
4217
|
"""
|
3977
4218
|
List of private metadata items.Requires proper staff permissions to access.
|
@@ -3981,20 +4222,32 @@ type Order implements Node & ObjectWithMetadata {
|
|
3981
4222
|
"""List of public metadata items. Can be accessed without permissions."""
|
3982
4223
|
metadata: [MetadataItem!]!
|
3983
4224
|
|
3984
|
-
"""
|
3985
|
-
|
3986
|
-
fees: [OrderFee!]
|
4225
|
+
"""Available shipping methods for the order."""
|
4226
|
+
availableMarketplaceShippingMethods: [ShippingMethod!]
|
3987
4227
|
|
3988
|
-
"""List of order
|
3989
|
-
|
4228
|
+
"""List of seller shipments for the order."""
|
4229
|
+
sellerFulfillments: [Fulfillment!]!
|
3990
4230
|
|
3991
4231
|
"""
|
3992
4232
|
List of sub-statuses that can be changed to based on current state of the order
|
3993
4233
|
"""
|
3994
4234
|
allowedSubStatuses: [OrderSubStatusEnum!] @deprecated(reason: "This will be removed on September 9, 2025.")
|
3995
4235
|
|
3996
|
-
"""
|
3997
|
-
|
4236
|
+
"""List"""
|
4237
|
+
sellerUnfulfilled: [OrderLine!]!
|
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!]
|
3998
4251
|
|
3999
4252
|
"""List of order invoices."""
|
4000
4253
|
invoices: [Invoice!]
|
@@ -4002,9 +4255,6 @@ type Order implements Node & ObjectWithMetadata {
|
|
4002
4255
|
"""User-friendly number of an order."""
|
4003
4256
|
number: String
|
4004
4257
|
|
4005
|
-
"""User-friendly number of the marketplace order this order belongs to."""
|
4006
|
-
marketplaceOrderNumber: String
|
4007
|
-
|
4008
4258
|
"""Informs if an order is fully paid."""
|
4009
4259
|
isPaid: Boolean
|
4010
4260
|
|
@@ -4014,15 +4264,12 @@ type Order implements Node & ObjectWithMetadata {
|
|
4014
4264
|
"""User-friendly payment status."""
|
4015
4265
|
paymentStatusDisplay: String!
|
4016
4266
|
|
4267
|
+
"""List of payments for the order."""
|
4268
|
+
payments: [Payment!]
|
4269
|
+
|
4017
4270
|
"""Total amount of the order."""
|
4018
4271
|
total: TaxedMoney
|
4019
4272
|
|
4020
|
-
"""Total of the order including any discounts."""
|
4021
|
-
discountedTotal: TaxedMoney
|
4022
|
-
|
4023
|
-
"""Original total amount of the order."""
|
4024
|
-
originalTotal: TaxedMoney
|
4025
|
-
|
4026
4273
|
"""The sum of line prices not including shipping."""
|
4027
4274
|
subtotal: TaxedMoney
|
4028
4275
|
|
@@ -4034,50 +4281,52 @@ type Order implements Node & ObjectWithMetadata {
|
|
4034
4281
|
"""
|
4035
4282
|
canFinalize: Boolean!
|
4036
4283
|
|
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
|
+
|
4037
4296
|
"""List of events associated with the order."""
|
4038
|
-
events: [
|
4297
|
+
events: [NauticalOrderEvent!]
|
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!
|
4039
4304
|
|
4040
4305
|
"""Email address of the customer."""
|
4041
4306
|
userEmail: String
|
4042
4307
|
|
4043
4308
|
"""Returns True, if order requires shipping."""
|
4044
4309
|
isShippingRequired: Boolean!
|
4310
|
+
shippingMethodName: String!
|
4045
4311
|
|
4046
|
-
"""
|
4047
|
-
|
4048
|
-
|
4049
|
-
"""Summary of all payouts of this order"""
|
4050
|
-
payoutsSummary(
|
4051
|
-
"""Order payout status."""
|
4052
|
-
payoutStatus: PayoutStatusEnum
|
4053
|
-
): [OrderPayoutSummary!]!
|
4054
|
-
|
4055
|
-
"""Remaining available balance to be paid out."""
|
4056
|
-
availablePayoutBalance: Money
|
4057
|
-
|
4058
|
-
"""Seller commission for the order"""
|
4059
|
-
sellerCommission: Money
|
4060
|
-
|
4061
|
-
"""Validation status for the order"""
|
4062
|
-
validationStatus: [ValidationStatus!]
|
4312
|
+
"""List of all the vendor orders connected to this marketplace order."""
|
4313
|
+
subOrders: [Order!]
|
4063
4314
|
|
4064
|
-
"""
|
4065
|
-
|
4066
|
-
"""
|
4067
|
-
isOnlySellerOnNauticalOrder: Boolean
|
4315
|
+
"""List of all the refunds for this marketplace order."""
|
4316
|
+
refunds: [Refund!]
|
4068
4317
|
|
4069
|
-
"""
|
4070
|
-
|
4318
|
+
"""Total price of shipping for this order."""
|
4319
|
+
marketplaceShippingPrice: TaxedMoney!
|
4071
4320
|
|
4072
|
-
"""
|
4073
|
-
|
4321
|
+
"""Shipping method for this order."""
|
4322
|
+
marketplaceShippingMethod: ShippingMethod
|
4074
4323
|
|
4075
|
-
"""
|
4076
|
-
|
4324
|
+
"""Name of the shipping method for this order."""
|
4325
|
+
marketplaceShippingMethodName: String
|
4077
4326
|
}
|
4078
4327
|
|
4079
4328
|
"""An enumeration."""
|
4080
|
-
enum
|
4329
|
+
enum NauticalOrderOrderSource {
|
4081
4330
|
"""checkout"""
|
4082
4331
|
CHECKOUT
|
4083
4332
|
|
@@ -4092,7 +4341,7 @@ enum OrderOrderSource {
|
|
4092
4341
|
}
|
4093
4342
|
|
4094
4343
|
"""An enumeration."""
|
4095
|
-
enum
|
4344
|
+
enum NauticalOrderStatus {
|
4096
4345
|
DRAFT
|
4097
4346
|
UNFULFILLED
|
4098
4347
|
PARTIALLY_FULFILLED
|
@@ -4107,7 +4356,7 @@ enum OrderStatus {
|
|
4107
4356
|
}
|
4108
4357
|
|
4109
4358
|
"""An enumeration."""
|
4110
|
-
enum
|
4359
|
+
enum NauticalOrderSubStatus {
|
4111
4360
|
"""Awaiting Payment"""
|
4112
4361
|
AWAITING_PAYMENT
|
4113
4362
|
|
@@ -5656,42 +5905,49 @@ type Fulfillment implements Node & ObjectWithMetadata {
|
|
5656
5905
|
customFields: [SelectedAttribute!]!
|
5657
5906
|
}
|
5658
5907
|
|
5659
|
-
"""Represents
|
5660
|
-
type
|
5908
|
+
"""Represents an order in the shop."""
|
5909
|
+
type Order implements Node & ObjectWithMetadata {
|
5661
5910
|
"""The ID of the object"""
|
5662
5911
|
id: ID!
|
5663
5912
|
externalId: String
|
5664
5913
|
externalSource: String
|
5665
|
-
orderSource:
|
5914
|
+
orderSource: OrderOrderSource!
|
5915
|
+
|
5916
|
+
"""Seller this order belongs to"""
|
5917
|
+
seller: Seller
|
5666
5918
|
created: DateTime!
|
5667
5919
|
updated: DateTime
|
5668
5920
|
|
5669
5921
|
"""Order status"""
|
5670
|
-
status:
|
5671
|
-
subStatus:
|
5922
|
+
status: OrderStatus!
|
5923
|
+
subStatus: OrderSubStatus
|
5672
5924
|
user: User
|
5673
5925
|
languageCode: String!
|
5674
5926
|
trackingClientId: String!
|
5675
5927
|
billingAddress: Address
|
5676
5928
|
shippingAddress: Address
|
5929
|
+
vatCode: String!
|
5930
|
+
euInvoiceMessaging: String
|
5931
|
+
vatIdentificationNumber: String
|
5932
|
+
mpVatIdentificationNumber: String
|
5677
5933
|
currency: String!
|
5934
|
+
shippingMethod: ShippingMethod
|
5935
|
+
shippingMethodName: String
|
5936
|
+
|
5937
|
+
"""Total price of shipping."""
|
5938
|
+
shippingPrice: TaxedMoney
|
5678
5939
|
|
5679
5940
|
"""
|
5680
|
-
Indicates that the
|
5941
|
+
Indicates that the shipping price is set manually by user rather than taken from a related shipping method.
|
5681
5942
|
"""
|
5682
|
-
|
5943
|
+
isShippingPriceOverridden: Boolean!
|
5683
5944
|
|
5684
|
-
"""
|
5685
|
-
|
5686
|
-
|
5687
|
-
|
5688
|
-
mpVatIdentificationNumber: String
|
5945
|
+
"""
|
5946
|
+
Indicates that the order is being fulfilled by the marketplace and the seller is not responsible for shipping.
|
5947
|
+
"""
|
5948
|
+
fulfilledByMarketplace: Boolean!
|
5689
5949
|
token: String!
|
5690
|
-
|
5691
|
-
"""Token of the checkout instance that this order was created from."""
|
5692
|
-
checkoutToken: String
|
5693
5950
|
voucher: Voucher
|
5694
|
-
shippingDiscount: Money
|
5695
5951
|
discount: Money
|
5696
5952
|
discountName: String
|
5697
5953
|
translatedDiscountName: String
|
@@ -5701,7 +5957,6 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
5701
5957
|
|
5702
5958
|
"""Data time when the order was imported from another platform."""
|
5703
5959
|
importedAt: DateTime
|
5704
|
-
poNumbers: [String!]
|
5705
5960
|
|
5706
5961
|
"""
|
5707
5962
|
List of private metadata items.Requires proper staff permissions to access.
|
@@ -5711,32 +5966,20 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
5711
5966
|
"""List of public metadata items. Can be accessed without permissions."""
|
5712
5967
|
metadata: [MetadataItem!]!
|
5713
5968
|
|
5714
|
-
"""
|
5715
|
-
|
5969
|
+
"""List of shipments for the order."""
|
5970
|
+
fulfillments: [Fulfillment!]!
|
5971
|
+
fees: [OrderFee!]
|
5716
5972
|
|
5717
|
-
"""List of
|
5718
|
-
|
5973
|
+
"""List of order lines."""
|
5974
|
+
lines: [OrderLine!]!
|
5719
5975
|
|
5720
5976
|
"""
|
5721
5977
|
List of sub-statuses that can be changed to based on current state of the order
|
5722
5978
|
"""
|
5723
5979
|
allowedSubStatuses: [OrderSubStatusEnum!] @deprecated(reason: "This will be removed on September 9, 2025.")
|
5724
5980
|
|
5725
|
-
"""
|
5726
|
-
|
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!]
|
5981
|
+
"""Shipping methods that can be used with this order."""
|
5982
|
+
availableShippingMethods: [ShippingMethod!]
|
5740
5983
|
|
5741
5984
|
"""List of order invoices."""
|
5742
5985
|
invoices: [Invoice!]
|
@@ -5744,6 +5987,9 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
5744
5987
|
"""User-friendly number of an order."""
|
5745
5988
|
number: String
|
5746
5989
|
|
5990
|
+
"""User-friendly number of the marketplace order this order belongs to."""
|
5991
|
+
marketplaceOrderNumber: String
|
5992
|
+
|
5747
5993
|
"""Informs if an order is fully paid."""
|
5748
5994
|
isPaid: Boolean
|
5749
5995
|
|
@@ -5753,69 +5999,70 @@ type NauticalOrder implements Node & ObjectWithMetadata {
|
|
5753
5999
|
"""User-friendly payment status."""
|
5754
6000
|
paymentStatusDisplay: String!
|
5755
6001
|
|
5756
|
-
"""List of payments for the order."""
|
5757
|
-
payments: [Payment!]
|
5758
|
-
|
5759
6002
|
"""Total amount of the order."""
|
5760
6003
|
total: TaxedMoney
|
5761
6004
|
|
5762
|
-
"""
|
5763
|
-
|
5764
|
-
|
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!]
|
6005
|
+
"""Total of the order including any discounts."""
|
6006
|
+
discountedTotal: TaxedMoney
|
5775
6007
|
|
5776
|
-
"""
|
5777
|
-
|
6008
|
+
"""Original total amount of the order."""
|
6009
|
+
originalTotal: TaxedMoney
|
5778
6010
|
|
5779
|
-
"""
|
5780
|
-
|
6011
|
+
"""The sum of line prices not including shipping."""
|
6012
|
+
subtotal: TaxedMoney
|
5781
6013
|
|
5782
|
-
"""
|
5783
|
-
|
6014
|
+
"""User-friendly order status."""
|
6015
|
+
statusDisplay: String
|
5784
6016
|
|
5785
|
-
"""
|
5786
|
-
|
6017
|
+
"""
|
6018
|
+
Informs whether a draft order can be finalized (turned into a regular order).
|
6019
|
+
"""
|
6020
|
+
canFinalize: Boolean!
|
5787
6021
|
|
5788
|
-
"""
|
5789
|
-
|
5790
|
-
"""Should the balance be returned positive or negative."""
|
5791
|
-
positive: Boolean
|
5792
|
-
): Money!
|
6022
|
+
"""List of events associated with the order."""
|
6023
|
+
events: [OrderEvent!]
|
5793
6024
|
|
5794
6025
|
"""Email address of the customer."""
|
5795
6026
|
userEmail: String
|
5796
6027
|
|
5797
6028
|
"""Returns True, if order requires shipping."""
|
5798
6029
|
isShippingRequired: Boolean!
|
5799
|
-
shippingMethodName: String!
|
5800
6030
|
|
5801
|
-
"""
|
5802
|
-
|
6031
|
+
"""Order payout status."""
|
6032
|
+
payoutStatus: OrderPayoutStatusEnum
|
5803
6033
|
|
5804
|
-
"""
|
5805
|
-
|
6034
|
+
"""Summary of all payouts of this order"""
|
6035
|
+
payoutsSummary(
|
6036
|
+
"""Order payout status."""
|
6037
|
+
payoutStatus: PayoutStatusEnum
|
6038
|
+
): [OrderPayoutSummary!]!
|
5806
6039
|
|
5807
|
-
"""
|
5808
|
-
|
6040
|
+
"""Remaining available balance to be paid out."""
|
6041
|
+
availablePayoutBalance: Money
|
5809
6042
|
|
5810
|
-
"""
|
5811
|
-
|
6043
|
+
"""Seller commission for the order"""
|
6044
|
+
sellerCommission: Money
|
5812
6045
|
|
5813
|
-
"""
|
5814
|
-
|
6046
|
+
"""Validation status for the order"""
|
6047
|
+
validationStatus: [ValidationStatus!]
|
6048
|
+
|
6049
|
+
"""
|
6050
|
+
Determines if seller is the only seller on the related nautical order. Note: if nautical order doesn't exist - will return None.
|
6051
|
+
"""
|
6052
|
+
isOnlySellerOnNauticalOrder: Boolean
|
6053
|
+
|
6054
|
+
"""Marketplace order that this seller order belongs to."""
|
6055
|
+
marketplaceOrder: NauticalOrder
|
6056
|
+
|
6057
|
+
"""All vendor payouts that contain this order"""
|
6058
|
+
vendorPayouts: [VendorPayout!]
|
6059
|
+
|
6060
|
+
"""Voucher discount for the order"""
|
6061
|
+
voucherDiscount: Money
|
5815
6062
|
}
|
5816
6063
|
|
5817
6064
|
"""An enumeration."""
|
5818
|
-
enum
|
6065
|
+
enum OrderOrderSource {
|
5819
6066
|
"""checkout"""
|
5820
6067
|
CHECKOUT
|
5821
6068
|
|
@@ -5830,7 +6077,7 @@ enum NauticalOrderOrderSource {
|
|
5830
6077
|
}
|
5831
6078
|
|
5832
6079
|
"""An enumeration."""
|
5833
|
-
enum
|
6080
|
+
enum OrderStatus {
|
5834
6081
|
DRAFT
|
5835
6082
|
UNFULFILLED
|
5836
6083
|
PARTIALLY_FULFILLED
|
@@ -5845,7 +6092,7 @@ enum NauticalOrderStatus {
|
|
5845
6092
|
}
|
5846
6093
|
|
5847
6094
|
"""An enumeration."""
|
5848
|
-
enum
|
6095
|
+
enum OrderSubStatus {
|
5849
6096
|
"""Awaiting Payment"""
|
5850
6097
|
AWAITING_PAYMENT
|
5851
6098
|
|
@@ -5853,12 +6100,40 @@ enum NauticalOrderSubStatus {
|
|
5853
6100
|
COMPLETE
|
5854
6101
|
}
|
5855
6102
|
|
5856
|
-
|
5857
|
-
|
5858
|
-
|
6103
|
+
"""Extra fee associated with an order"""
|
6104
|
+
type OrderFee implements Node {
|
6105
|
+
"""The ID of the object"""
|
6106
|
+
id: ID!
|
6107
|
+
tenant: Tenant!
|
6108
|
+
order: Order
|
5859
6109
|
|
5860
|
-
"""
|
5861
|
-
|
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
|
6134
|
+
|
6135
|
+
"""Manual Order Fee"""
|
6136
|
+
MANUAL_ORDER_FEE
|
5862
6137
|
}
|
5863
6138
|
|
5864
6139
|
"""Represents order line of particular order."""
|
@@ -6146,18 +6421,12 @@ type ShippingZoneCountryArea implements Node {
|
|
6146
6421
|
countryArea: CountryArea!
|
6147
6422
|
}
|
6148
6423
|
|
6149
|
-
enum
|
6150
|
-
"""
|
6151
|
-
|
6152
|
-
|
6153
|
-
"""Represents a mark-as-paid action."""
|
6154
|
-
MARK_AS_PAID
|
6155
|
-
|
6156
|
-
"""Represents a refund action."""
|
6157
|
-
REFUND
|
6424
|
+
enum OrderSubStatusEnum {
|
6425
|
+
"""Awaiting Payment"""
|
6426
|
+
AWAITING_PAYMENT
|
6158
6427
|
|
6159
|
-
"""
|
6160
|
-
|
6428
|
+
"""Complete"""
|
6429
|
+
COMPLETE
|
6161
6430
|
}
|
6162
6431
|
|
6163
6432
|
"""Represents an Invoice."""
|
@@ -6186,189 +6455,59 @@ type Invoice implements ObjectWithMetadata & Job & Node {
|
|
6186
6455
|
"""Date time of job last update in ISO 8601 format."""
|
6187
6456
|
updatedAt: DateTime!
|
6188
6457
|
|
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
|
6458
|
+
"""Job message."""
|
6459
|
+
message: String
|
6330
6460
|
|
6331
|
-
"""
|
6332
|
-
|
6461
|
+
"""URL to download an invoice."""
|
6462
|
+
url: String
|
6463
|
+
}
|
6333
6464
|
|
6334
|
-
|
6335
|
-
|
6465
|
+
interface Job {
|
6466
|
+
"""Job status."""
|
6467
|
+
status: JobStatusEnum!
|
6336
6468
|
|
6337
|
-
"""
|
6338
|
-
|
6469
|
+
"""Created date time of job in ISO 8601 format."""
|
6470
|
+
createdAt: DateTime!
|
6339
6471
|
|
6340
|
-
"""
|
6341
|
-
|
6472
|
+
"""Date time of job last update in ISO 8601 format."""
|
6473
|
+
updatedAt: DateTime!
|
6342
6474
|
|
6343
|
-
"""
|
6344
|
-
|
6475
|
+
"""Job message."""
|
6476
|
+
message: String
|
6345
6477
|
}
|
6346
6478
|
|
6347
|
-
|
6348
|
-
"""
|
6349
|
-
|
6479
|
+
enum JobStatusEnum {
|
6480
|
+
"""Pending"""
|
6481
|
+
PENDING
|
6350
6482
|
|
6351
|
-
"""
|
6352
|
-
|
6483
|
+
"""Processing"""
|
6484
|
+
PROCESSING
|
6353
6485
|
|
6354
|
-
"""
|
6355
|
-
|
6486
|
+
"""Success"""
|
6487
|
+
SUCCESS
|
6356
6488
|
|
6357
|
-
"""
|
6358
|
-
|
6489
|
+
"""Failed"""
|
6490
|
+
FAILED
|
6359
6491
|
|
6360
|
-
"""
|
6361
|
-
|
6492
|
+
"""Deleted"""
|
6493
|
+
DELETED
|
6362
6494
|
}
|
6363
6495
|
|
6364
|
-
|
6365
|
-
|
6366
|
-
|
6367
|
-
|
6496
|
+
"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 "
|
6497
|
+
enum PaymentChargeStatusEnum {
|
6498
|
+
NOT_CHARGED
|
6499
|
+
PENDING
|
6500
|
+
PARTIALLY_CHARGED
|
6501
|
+
FULLY_CHARGED
|
6502
|
+
PARTIALLY_REFUNDED
|
6503
|
+
FULLY_REFUNDED
|
6504
|
+
REFUSED
|
6505
|
+
CANCELLED
|
6506
|
+
VOIDED
|
6368
6507
|
}
|
6369
6508
|
|
6370
6509
|
"""History log of the order."""
|
6371
|
-
type
|
6510
|
+
type OrderEvent implements Node {
|
6372
6511
|
"""The ID of the object"""
|
6373
6512
|
id: ID!
|
6374
6513
|
|
@@ -6376,7 +6515,7 @@ type NauticalOrderEvent implements Node {
|
|
6376
6515
|
date: DateTime!
|
6377
6516
|
|
6378
6517
|
"""Order event type."""
|
6379
|
-
type: OrderEventsEnum
|
6518
|
+
type: OrderEventsEnum
|
6380
6519
|
|
6381
6520
|
"""User who performed the action."""
|
6382
6521
|
user: User
|
@@ -6415,7 +6554,10 @@ type NauticalOrderEvent implements Node {
|
|
6415
6554
|
oversoldItems: [String!]
|
6416
6555
|
|
6417
6556
|
"""The concerned lines."""
|
6418
|
-
lines: [
|
6557
|
+
lines: [OrderEventOrderLineObject!]
|
6558
|
+
|
6559
|
+
"""The lines fulfilled."""
|
6560
|
+
fulfilledItems: [FulfillmentLine!]
|
6419
6561
|
|
6420
6562
|
"""The warehouse were items were restocked."""
|
6421
6563
|
warehouse: Warehouse
|
@@ -6611,239 +6753,81 @@ enum OrderEventsEmailsEnum {
|
|
6611
6753
|
PAYMENT_LINK_SENT
|
6612
6754
|
}
|
6613
6755
|
|
6614
|
-
type
|
6756
|
+
type OrderEventOrderLineObject {
|
6615
6757
|
"""The variant quantity."""
|
6616
6758
|
quantity: Int
|
6617
6759
|
|
6618
6760
|
"""The order line."""
|
6619
|
-
orderLine:
|
6761
|
+
orderLine: OrderLine
|
6620
6762
|
|
6621
6763
|
"""The variant name."""
|
6622
6764
|
itemName: String
|
6623
6765
|
}
|
6624
6766
|
|
6625
|
-
"""
|
6626
|
-
|
6627
|
-
"""
|
6628
|
-
type Refund implements Node & ObjectWithMetadata {
|
6629
|
-
createdAt: DateTime!
|
6630
|
-
updatedAt: DateTime!
|
6631
|
-
description: String!
|
6632
|
-
descriptionHtml: String!
|
6633
|
-
|
6634
|
-
"""The ID of the object"""
|
6635
|
-
id: ID!
|
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!
|
6638
|
-
|
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!
|
6673
|
-
}
|
6674
|
-
|
6675
|
-
type RefundLineCountableConnection {
|
6676
|
-
"""Pagination data for this connection."""
|
6677
|
-
pageInfo: PageInfo!
|
6678
|
-
edges: [RefundLineCountableEdge!]!
|
6679
|
-
|
6680
|
-
"""A total count of items in the collection."""
|
6681
|
-
totalCount: Int
|
6682
|
-
}
|
6683
|
-
|
6684
|
-
type RefundLineCountableEdge {
|
6685
|
-
"""The item at the end of the edge."""
|
6686
|
-
node: RefundLine!
|
6687
|
-
|
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
|
-
|
6767
|
+
"""Represents line of the fulfillment."""
|
6768
|
+
type FulfillmentLine implements Node {
|
6697
6769
|
"""The ID of the object"""
|
6698
6770
|
id: ID!
|
6771
|
+
quantity: Int!
|
6772
|
+
orderLine: OrderLine
|
6699
6773
|
|
6700
|
-
"""
|
6701
|
-
|
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!
|
6774
|
+
"""Reason customer requested item return."""
|
6775
|
+
returnReason: String
|
6782
6776
|
}
|
6783
6777
|
|
6784
|
-
|
6785
|
-
|
6786
|
-
|
6787
|
-
updatedAt: DateTime!
|
6788
|
-
|
6789
|
-
"""The ID of the object"""
|
6790
|
-
id: ID!
|
6791
|
-
|
6792
|
-
"""How this payment is made"""
|
6793
|
-
paymentType: RefundPaymentTypeEnum!
|
6778
|
+
enum OrderPayoutStatusEnum {
|
6779
|
+
"""Not ready"""
|
6780
|
+
NOT_READY
|
6794
6781
|
|
6795
|
-
"""
|
6796
|
-
|
6782
|
+
"""Not paid"""
|
6783
|
+
NOT_PAID
|
6797
6784
|
|
6798
|
-
"""
|
6799
|
-
|
6800
|
-
}
|
6785
|
+
"""Ready for payout"""
|
6786
|
+
READY_FOR_PAYOUT
|
6801
6787
|
|
6802
|
-
|
6803
|
-
|
6804
|
-
TRANSACTION
|
6788
|
+
"""Paid out"""
|
6789
|
+
PAID_OUT
|
6805
6790
|
|
6806
|
-
"""
|
6807
|
-
|
6808
|
-
}
|
6791
|
+
"""Partially paid out"""
|
6792
|
+
PARTIALLY_PAID_OUT
|
6809
6793
|
|
6810
|
-
|
6794
|
+
"""Error"""
|
6795
|
+
ERROR
|
6796
|
+
}
|
6811
6797
|
|
6812
|
-
|
6813
|
-
"""
|
6814
|
-
|
6798
|
+
type OrderPayoutSummary {
|
6799
|
+
"""Commissions that affected the payout"""
|
6800
|
+
commissions: Money!
|
6815
6801
|
|
6816
|
-
"""
|
6817
|
-
|
6802
|
+
"""Discounts that affected payouts"""
|
6803
|
+
discounts: Money!
|
6818
6804
|
|
6819
|
-
"""
|
6820
|
-
|
6805
|
+
"""Fees that affect the payout"""
|
6806
|
+
fees: Money!
|
6821
6807
|
|
6822
|
-
"""
|
6823
|
-
|
6808
|
+
"""Refunds that affected the payout"""
|
6809
|
+
refunds: Money!
|
6824
6810
|
|
6825
|
-
"""
|
6826
|
-
|
6811
|
+
"""Commissions that were reduced as a result of refunds"""
|
6812
|
+
refundsCommission: Money!
|
6827
6813
|
|
6828
|
-
"""
|
6829
|
-
|
6814
|
+
"""Sales in the payout"""
|
6815
|
+
sales: Money!
|
6830
6816
|
|
6831
|
-
"""
|
6832
|
-
|
6817
|
+
"""Shipping in the payout"""
|
6818
|
+
shipping: Money!
|
6833
6819
|
|
6834
|
-
"""
|
6835
|
-
|
6820
|
+
"""Total for this payout"""
|
6821
|
+
total: Money!
|
6836
6822
|
|
6837
|
-
"""
|
6838
|
-
|
6823
|
+
"""Vendor Payout associated with this data"""
|
6824
|
+
vendorPayout: VendorPayout!
|
6839
6825
|
}
|
6840
6826
|
|
6841
|
-
|
6842
|
-
|
6843
|
-
|
6844
|
-
|
6845
|
-
"""Order Line Refund"""
|
6846
|
-
ORDERLINEREFUND
|
6827
|
+
type ValidationStatus {
|
6828
|
+
message: String
|
6829
|
+
code: String
|
6830
|
+
variant: ID
|
6847
6831
|
}
|
6848
6832
|
|
6849
6833
|
"""An enumeration."""
|
@@ -6879,55 +6863,22 @@ enum FulfillmentStatus {
|
|
6879
6863
|
RETURN_CANCELLED
|
6880
6864
|
}
|
6881
6865
|
|
6882
|
-
|
6883
|
-
|
6884
|
-
|
6885
|
-
id: ID!
|
6886
|
-
quantity: Int!
|
6887
|
-
orderLine: OrderLine
|
6888
|
-
|
6889
|
-
"""Reason customer requested item return."""
|
6890
|
-
returnReason: String
|
6891
|
-
}
|
6892
|
-
|
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
|
6899
|
-
|
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
|
-
}
|
6866
|
+
enum OrderAction {
|
6867
|
+
"""Represents the capture action."""
|
6868
|
+
CAPTURE
|
6916
6869
|
|
6917
|
-
|
6918
|
-
|
6919
|
-
}
|
6870
|
+
"""Represents a mark-as-paid action."""
|
6871
|
+
MARK_AS_PAID
|
6920
6872
|
|
6921
|
-
|
6922
|
-
|
6923
|
-
AGREEMENT_FEES
|
6873
|
+
"""Represents a refund action."""
|
6874
|
+
REFUND
|
6924
6875
|
|
6925
|
-
"""
|
6926
|
-
|
6876
|
+
"""Represents a void action."""
|
6877
|
+
VOID
|
6927
6878
|
}
|
6928
6879
|
|
6929
6880
|
"""History log of the order."""
|
6930
|
-
type
|
6881
|
+
type NauticalOrderEvent implements Node {
|
6931
6882
|
"""The ID of the object"""
|
6932
6883
|
id: ID!
|
6933
6884
|
|
@@ -6935,7 +6886,7 @@ type OrderEvent implements Node {
|
|
6935
6886
|
date: DateTime!
|
6936
6887
|
|
6937
6888
|
"""Order event type."""
|
6938
|
-
type: OrderEventsEnum
|
6889
|
+
type: OrderEventsEnum!
|
6939
6890
|
|
6940
6891
|
"""User who performed the action."""
|
6941
6892
|
user: User
|
@@ -6974,75 +6925,121 @@ type OrderEvent implements Node {
|
|
6974
6925
|
oversoldItems: [String!]
|
6975
6926
|
|
6976
6927
|
"""The concerned lines."""
|
6977
|
-
lines: [
|
6978
|
-
|
6979
|
-
"""The lines fulfilled."""
|
6980
|
-
fulfilledItems: [FulfillmentLine!]
|
6928
|
+
lines: [NauticalOrderEventOrderLineObject!]
|
6981
6929
|
|
6982
6930
|
"""The warehouse were items were restocked."""
|
6983
6931
|
warehouse: Warehouse
|
6984
6932
|
}
|
6985
6933
|
|
6986
|
-
type
|
6934
|
+
type NauticalOrderEventOrderLineObject {
|
6987
6935
|
"""The variant quantity."""
|
6988
6936
|
quantity: Int
|
6989
6937
|
|
6990
6938
|
"""The order line."""
|
6991
|
-
orderLine:
|
6939
|
+
orderLine: NauticalOrderLine
|
6992
6940
|
|
6993
6941
|
"""The variant name."""
|
6994
6942
|
itemName: String
|
6995
6943
|
}
|
6996
6944
|
|
6997
|
-
|
6998
|
-
"""
|
6999
|
-
|
6945
|
+
type CreditCard {
|
6946
|
+
"""Card brand."""
|
6947
|
+
brand: String!
|
7000
6948
|
|
7001
|
-
"""
|
7002
|
-
|
6949
|
+
"""First 4 digits of the card number."""
|
6950
|
+
firstDigits: String
|
7003
6951
|
|
7004
|
-
"""
|
7005
|
-
|
6952
|
+
"""Last 4 digits of the card number."""
|
6953
|
+
lastDigits: String!
|
7006
6954
|
|
7007
|
-
"""
|
7008
|
-
|
6955
|
+
"""Two-digit number representing the card’s expiration month."""
|
6956
|
+
expMonth: Int
|
7009
6957
|
|
7010
|
-
"""
|
7011
|
-
|
6958
|
+
"""Four-digit number representing the card’s expiration year."""
|
6959
|
+
expYear: Int
|
6960
|
+
}
|
7012
6961
|
|
7013
|
-
|
7014
|
-
|
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
|
6987
|
+
|
6988
|
+
"""Refund failed"""
|
6989
|
+
REFUND_FAILED
|
6990
|
+
|
6991
|
+
"""Refund reversed"""
|
6992
|
+
REFUND_REVERSED
|
6993
|
+
|
6994
|
+
"""Confirm"""
|
6995
|
+
CONFIRM
|
6996
|
+
|
6997
|
+
"""Cancel"""
|
6998
|
+
CANCEL
|
6999
|
+
|
7000
|
+
"""Created"""
|
7001
|
+
CREATED
|
7015
7002
|
}
|
7016
7003
|
|
7017
|
-
|
7018
|
-
"""
|
7019
|
-
|
7004
|
+
enum RefundStatusEnum {
|
7005
|
+
"""Requested"""
|
7006
|
+
REQUESTED
|
7020
7007
|
|
7021
|
-
"""
|
7022
|
-
|
7008
|
+
"""Canceled"""
|
7009
|
+
CANCELED
|
7023
7010
|
|
7024
|
-
"""
|
7025
|
-
|
7011
|
+
"""Declined"""
|
7012
|
+
DECLINED
|
7026
7013
|
|
7027
|
-
"""
|
7028
|
-
|
7014
|
+
"""Approved"""
|
7015
|
+
APPROVED
|
7029
7016
|
|
7030
|
-
"""
|
7031
|
-
|
7017
|
+
"""Processing"""
|
7018
|
+
PROCESSING
|
7032
7019
|
|
7033
|
-
"""
|
7034
|
-
|
7020
|
+
"""Failed"""
|
7021
|
+
FAILED
|
7035
7022
|
|
7036
|
-
"""
|
7037
|
-
|
7023
|
+
"""Paid"""
|
7024
|
+
PAID
|
7038
7025
|
|
7039
|
-
"""
|
7040
|
-
|
7026
|
+
"""Locked"""
|
7027
|
+
LOCKED
|
7041
7028
|
|
7042
|
-
"""
|
7043
|
-
|
7029
|
+
"""Settled"""
|
7030
|
+
SETTLED
|
7031
|
+
}
|
7032
|
+
|
7033
|
+
enum RefundTypeEnum {
|
7034
|
+
"""Manual Refund"""
|
7035
|
+
MANUALREFUND
|
7036
|
+
|
7037
|
+
"""Order Line Refund"""
|
7038
|
+
ORDERLINEREFUND
|
7044
7039
|
}
|
7045
7040
|
|
7041
|
+
union RefundScope = NauticalOrder | Order | OrderLine
|
7042
|
+
|
7046
7043
|
"""History log of the vendor payout."""
|
7047
7044
|
type VendorPayoutEvent implements Node {
|
7048
7045
|
"""The ID of the object"""
|
@@ -7087,6 +7084,23 @@ enum VendorPayoutEventsEnum {
|
|
7087
7084
|
VENDOR_PAYOUT_EMAIL_SENT
|
7088
7085
|
}
|
7089
7086
|
|
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
|
+
|
7090
7104
|
type AgreementSellersCountableConnection {
|
7091
7105
|
"""Pagination data for this connection."""
|
7092
7106
|
pageInfo: PageInfo!
|
@@ -11341,7 +11355,7 @@ type Mutation {
|
|
11341
11355
|
description: String
|
11342
11356
|
|
11343
11357
|
"""
|
11344
|
-
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types:
|
11358
|
+
Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/x-tif, application/gzip-compressed, application/dxf, application/x-rtf, application/vnd.pdf, image/vnd.dwg, application/gzipped, text/plain, application/csv, application/x-autocad, image/heic, application/zip, image/x-tiff, image/tiff, application/tiff, application/x-dxf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-tif, application/vnd.oasis.opendocument.text, image/x-dxf, image/png, application/x-eps, image/jpeg, image/svg+xml, application/rtf, image/heif, pplication/vnd.rar, application/x-tar, application/x-rar-compressed, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/comma-separated-values, image/x-eps, application/msword, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/eps, image/x-dwg, application/gzip, application/x-jpg, text/x-pdf, text/svg-xml, image/tif, application/x-tiff, application/x-zip-compressed, text/pdf, image/x-ms-bmp, image/gif, application/pdf, application/svg+xml, application/vnd.oasis.opendocument.spreadsheet, drawing/dwg, application/vnd.ms-excel, image/bmp, application/vnd.ms-word, application/vnd.oasis.opendocument.presentation, application/x-dwg, application/x-gzip, application/tif, application/x-acad, text/rtf, application/acrobat, application/acad, application/vnd.ms-powerpoint, application/x-pdf, drawing/x-dwf, text/csv, image/x-bmp, image/heic-sequence, application/jpg, image/dxf, application/x-csv, image/heif-sequence, application/x-rar, image/jpg, application/postscript, application/dwg, image/eps, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/webp, text/x-comma-separated-values, text/svg, image/svg, text/x-csv, drawing/x-dwg, application/excel.
|
11345
11359
|
"""
|
11346
11360
|
file: Upload!
|
11347
11361
|
|