Introduction
Welcome
Access
App access
Mutations
appTokenCreate
appTokenDelete
appTokenVerify
Types
AppToken
AppTokenCreate
AppTokenDelete
AppTokenInput
AppTokenVerify
User access
Mutations
tokenCreate
tokenRefresh
tokenVerify
tokensDeactivateAll
Types
CreateToken
DeactivateAllUserTokens
RefreshToken
VerifyToken
OAuth
Mutations
authUrlGenerate
createCustomerToken
tokenCreateSso
Types
AuthError
AuthURLGenerate
CreateCustomerToken
OauthProviderSourceEnum
SsoProviderType
TokenCreateSSO
Catalog Management
Attributes
Queries
attribute
attributes
Mutations
attributeAssign
attributeBulkDelete
attributeCreate
attributeDelete
attributeUnassign
attributeUpdate
attributeValueBulkCreate
attributeValueBulkDelete
attributeValueCreate
attributeValueDelete
attributeValueUpdate
attributeValuesReorder
Types
Attribute
AttributeAssign
AttributeAssignInput
AttributeBulkDelete
AttributeCountableConnection
AttributeCountableEdge
AttributeCreate
AttributeCreateInput
AttributeDelete
AttributeError
AttributeFilterConnector
AttributeFilterInput
AttributeInput
AttributeInputTypeEnum
AttributeSortField
AttributeSortingInput
AttributeTypeEnum
AttributeUnassign
AttributeUpdate
AttributeUpdateInput
AttributeValue
AttributeValueBulkCreate
AttributeValueBulkDelete
AttributeValueCreate
AttributeValueCreateInput
AttributeValueDelete
AttributeValueInput
AttributeValuesReorder
AttributeValueType
AttributeValueUpdate
SelectedAttribute
Categories
Queries
allCategories
categories
category
Mutations
categoryBulkDelete
categoryCreate
categoryDelete
categoryUpdate
Types
Category
CategoryBulkDelete
CategoryCountableConnection
CategoryCountableEdge
CategoryCreate
CategoryDelete
CategoryFilterInput
CategoryInput
CategorySortField
CategorySortingInput
CategoryUpdate
Collections
Queries
collection
collections
Mutations
collectionAddProducts
collectionAddVariants
collectionBulkDelete
collectionBulkPublish
collectionCreate
collectionDelete
collectionRemoveProducts
collectionRemoveVariants
collectionReorderProducts
collectionUpdate
Types
Collection
CollectionAddProducts
CollectionAddVariants
CollectionBulkDelete
CollectionBulkPublish
CollectionCountableConnection
CollectionCountableEdge
CollectionCreate
CollectionCreateInput
CollectionDelete
CollectionFilterInput
CollectionInput
CollectionPublished
CollectionRemoveProducts
CollectionRemoveVariants
CollectionReorderProducts
CollectionSortField
CollectionSortingInput
CollectionTypeEnum
CollectionUpdate
CollectionVisible
MoveProductInput
Digital content
Queries
digitalContent
digitalContents
Mutations
digitalContentCreate
digitalContentDelete
digitalContentUpdate
digitalContentUrlCreate
Types
DigitalContent
DigitalContentCountableConnection
DigitalContentCountableEdge
DigitalContentCreate
DigitalContentDelete
DigitalContentInput
DigitalContentUpdate
DigitalContentUploadInput
DigitalContentUrl
DigitalContentUrlCreate
DigitalContentUrlCreateInput
Export
Queries
exportFile
exportFiles
Mutations
catalogExport
productsExport
Types
CatalogExport
ExportError
ExportErrorCode
ExportEvent
ExportEventsEnum
ExportFile
ExportFileCountableConnection
ExportFileCountableEdge
ExportFileFilterInput
ExportFileSortField
ExportFileSortingInput
ExportInfoInput
ExportProductsInput
ExportScope
ProductsExport
Features
Mutations
featureCreate
featureDelete
featureUpdate
productTypeFeatureCreate
productTypeFeatureDelete
productTypeFeatureUpdate
Types
Feature
FeatureCreate
FeatureCreateInput
FeatureDelete
FeatureFilterConnector
FeatureFilterInput
FeatureFilterOperation
FeatureFilterOperationCondition
FeatureInput
FeatureTypeEnum
FeatureUpdate
ProductFeature
ProductFeatureCountableConnection
ProductFeatureCountableEdge
ProductTypeFeatureCreate
ProductTypeFeatureCreateInput
ProductTypeFeatureDelete
ProductTypeFeatureInput
ProductTypeFeatureUpdate
ProductTypeProductFeature
ProductTypeVariantFeature
VariantFeature
VariantFeatureCountableConnection
VariantFeatureCountableEdge
Import
Queries
availableImportSources
catalogImportProcess
catalogImportProcesses
importThirdPartyProduct
thirdPartyProducts
Mutations
catalogImport
productsImport
Types
CatalogImport
CatalogImportOperation
CatalogImportProcess
CatalogImportProcessCountableConnection
CatalogImportProcessCountableEdge
CatalogImportProcessFilterInput
CatalogImportProcessLogRecord
CatalogImportProcessLogRecordCountableConnection
CatalogImportProcessLogRecordCountableEdge
CatalogImportProcessLogRecordFilterInput
CatalogImportProcessLogRecordOperation
CatalogImportProcessLogRecordSortField
CatalogImportProcessLogRecordSortInput
CatalogImportProcessSortField
CatalogImportProcessSortInput
CatalogImportProcessStatus
ImportError
ImportEvent
ImportEventsEnum
ImportFile
ProductsImport
Locations
Queries
locationGeocode
locationSearch
Mutations
productLocationCreate
productLocationDelete
productLocationUpdate
productSetLocationType
Types
Coordinates
Location
LocationInput
LocationKindEnum
LocationSuggestion
LocationTypeEnum
ProductLocationCreate
ProductLocationDelete
ProductLocationUpdate
ProductSetLocationType
Products
Queries
product
products
Mutations
productBulkCategoryUpdate
productBulkDelete
productBulkPublish
productCreate
productDelete
productImageBulkDelete
productImageCreate
productImageDelete
productImageReorder
productImageUpdate
productReorderVariants
productSetAvailabilityForPurchase
productUpdate
Types
BulkProductError
Product
ProductAction
ProductBulkCategoryUpdate
ProductBulkDelete
ProductBulkPublish
ProductCountableConnection
ProductCountableEdge
ProductCreate
ProductCreateInput
ProductDelete
ProductError
ProductErrorCode
ProductFieldEnum
ProductFilterInput
ProductImage
ProductImageBulkDelete
ProductImageCountableConnection
ProductImageCountableEdge
ProductImageCreate
ProductImageCreateInput
ProductImageDelete
ProductImageReorder
ProductImageUpdate
ProductImageUpdateInput
ProductInput
ProductOrder
ProductOrderField
ProductPricingInfo
ProductReorderVariants
ProductSearchFieldEnum
ProductSearchInput
ProductSetAvailabilityForPurchase
ProductStatus
ProductStockFilterInput
ProductSubStatus
ProductSubStatusEnum
ProductUpdate
Product types
Queries
productType
productTypes
Mutations
productTypeBulkDelete
productTypeCreate
productTypeDelete
productTypeReorderAttributes
productTypeUpdate
Types
ProductType
ProductTypeBulkDelete
ProductTypeBulkDelete
ProductTypeConfigurable
ProductTypeCountableConnection
ProductTypeCountableEdge
ProductTypeCreate
ProductTypeDelete
ProductTypeEnum
ProductTypeFilterInput
ProductTypeInput
ProductTypeReorderAttributes
ProductTypeSortField
ProductTypeSortingInput
ProductTypeUpdate
Product variants
Queries
productVariant
productVariants
Mutations
productVariantBulkCreate
productVariantBulkDelete
productVariantCreate
productVariantDelete
productVariantImageAssign
productVariantImageUnassign
productVariantSetDefault
productVariantUpdate
Types
ProductVariant
ProductVariantBulkCreate
ProductVariantBulkCreateInput
ProductVariantBulkDelete
ProductVariantCountableConnection
ProductVariantCountableEdge
ProductVariantCreate
ProductVariantCreateInput
ProductVariantDelete
ProductVariantFilterInput
ProductVariantImageAssign
ProductVariantImageUnassign
ProductVariantInput
ProductVariantReportType
ProductVariantSearchFieldEnum
ProductVariantSearchInput
ProductVariantSetDefault
ProductVariantStatus
ProductVariantSubStatus
ProductVariantSubStatusEnum
ProductVariantUpdate
VariantPricingInfo
VariantSize
VariantSizeInput
VariantSortField
VariantSortingInput
VariantUniquenessEnum
Vendor Management
Sellers
Queries
newSellers
seller
sellerAgreement
sellerAgreements
sellerBySlug
sellerCommissions
sellerDetailCards
sellerEvents
sellerListCards
sellerOrders
sellerUser
sellerUsers
sellers
Mutations
sellerAddressCreate
sellerAddressDelete
sellerAddressSetDefault
sellerAddressUpdate
sellerAgreementAssign
sellerAgreementAcknowledge
sellerAgreementDelete
sellerAgreementDelete
sellerApplicationUpdate
sellerDataCreate
sellerDataUpdate
sellerLogoUpdate
sellerNoteCreate
sellerOnboardingChecklistComplete
sellerOnboardingSettingsCreate
sellerOnboardingSettingsUpdate
sellerOwnerDelete
sellerSettingsUpdate
sellerShellCreate
sellerUserMappingCreate
sellerWithOwnerCreate
Types
DefaultSellerChecklist
DefaultSellerChecklistInput
DetailedSellerInput
PublicSeller
Seller
SellerAddressCreate
SellerAddressDelete
SellerAddressSetDefault
SellerAddressUpdate
SellerAgreementAssign
SellerAgreementAcknowledge
SellerAgreementDelete
SellerAgreementInput
SellerApplication
SellerApplicationCheckpoint
SellerApplicationUpdate
SellerApplicationUpdateInput
SellerCards
SellerChecklistInput
SellerCountableConnection
SellerCountableEdge
SellerDataCreate
SellerDataUpdate
SellerDetailCards
SellerError
SellerErrorCode
SellerEventsEnum
SellerEventType
SellerEventTypeCountableConnection
SellerEventTypeCountableEdge
SellerExternalPayoutSource
SellerFilterInput
SellerInput
SellerLogoUpdate
SellerNoteCreate
SellerNoteInput
SellerOnboardingChecklist
SellerOnboardingChecklistComplete
SellerOnboardingChecklistError
SellerOnboardingChecklistErrorCode
SellerOnboardingSettings
SellerOnboardingSettingsCreate
SellerOnboardingSettingsCreateInput
SellerOnboardingSettingsUpdate
SellerOnboardingSettingsUpdateInput
SellerOwnerCreateInput
SellerOwnerDelete
SellerSettingsUpdate
SellerSettingsUpdateInput
SellerShellCreate
SellerShippingMethodInput
SellerSortField
SellerSortingInput
SellerStatus
SellerStatusEnum
SellerStatusFilter
SellerType
SellerUpdateInput
SellerUserInput
SellerUserMappingCreate
SellerUserType
SellerUserTypeCountableConnection
SellerUserTypeCountableEdge
SellerWithOwnerCreate
Financials
Agreements
Queries
agreement
agreements
availablePlans
Mutations
agreementBulkDelete
agreementBulkPublish
agreementCommissionCreate
agreementCommissionDelete
agreementCreate
agreementDelete
agreementFeeCreate
agreementFeeDelete
agreementUpdate
Types
Agreement
AgreementBulkDelete
AgreementBulkPublish
AgreementCommission
AgreementCommissionCreate
AgreementCommissionCreateInput
AgreementCommissionDelete
AgreementCountableConnection
AgreementCountableEdge
AgreementCreate
AgreementDelete
AgreementError
AgreementErrorCode
AgreementFeeCreate
AgreementFeeDelete
AgreementFeeInput
AgreementFees
AgreementFilterInput
AgreementGranularCommissionType
AgreementInput
AgreementOrder
AgreementSellers
AgreementSellersCountableConnection
AgreementSellersCountableEdge
AgreementSortField
AgreementUpdate
CommissionTypeEnum
FeeType
MarkupCommissionTypeEnum
Ledgers
Queries
journalEntries
ledgers
Mutations
journalEntryCorrect
Types
FinancialError
FinancialErrorCode
JournalEntry
JournalEntryCountableConnection
JournalEntryCountableEdge
JournalEntryCorrect
JournalEntryCorrectInput
JournalEntryFilterInput
JournalEntrySortField
JournalEntrySortingInput
JournalEntryTypeEnum
Ledger
LedgerAccountTypeEnum
LedgerCountableConnection
LedgerCountableEdge
LedgerEntry
LedgerEntryFilterInput
LedgerEntryInput
LedgerSortField
LedgerSortingInput
LedgerTypeEnum
Payouts
Queries
getPayoutGateways
payout
payouts
vendorPayout
vendorPayoutList
vendorPayouts
Mutations
payoutBulkArchive
payoutCreate
payoutDatesUpdate
payoutDelete
payoutStatusUpdate
payoutUpdate
vendorPayoutCreate
vendorPayoutNoteAdd
vendorPayoutNoteUpdate
vendorPayoutOnboardingLinkRequest
vendorPayoutStatusUpdate
vendorPayoutsBulkExclude
vendorPayoutsBulkInclude
vendorPayoutsBulkProcess
Types
Payout
PayoutBulkArchive
PayoutCountableConnection
PayoutCountableEdge
PayoutCreate
PayoutCreateInput
PayoutDatesInput
PayoutDatesUpdate
PayoutDelete
PayoutError
PayoutErrorCode
PayoutFilterInput
PayoutSortField
PayoutSortingInput
PayoutStatus
PayoutStatusFilter
PayoutStatusInput
PayoutStatusUpdate
PayoutUpdate
PayoutUpdateInput
UserExternalPayoutSource
VendorPayout
VendorPayoutCreate
VendorPayoutAddNoteInput
VendorPayoutCountableConnection
VendorPayoutCountableEdge
VendorPayoutDetails
VendorPayoutEvent
VendorPayoutEventsEnum
VendorPayoutNoteAdd
VendorPayoutNoteUpdate
VendorPayoutOnboardingLinkRequest
VendorPayoutReport
VendorPayoutReportSubset
VendorPayoutsBulkExclude
VendorPayoutsBulkInclude
VendorPayoutsBulkProcess
VendorPayoutStatus
VendorPayoutStatusInput
VendorPayoutStatusUpdate
VendorPayoutUpdateInput
VendorPayoutUpdateNoteInput
Order Management
Checkout
Queries
checkout
checkoutEvents
checkoutLine
checkoutLines
checkouts
Mutations
checkoutAddPoNumbers
checkoutAddPromoCode
checkoutBillingAddressUpdate
checkoutComplete
checkoutConvertToNauticalQuoteOrder
checkoutCreate
checkoutCustomerAttach
checkoutCustomerDetach
checkoutDelete
checkoutEmailUpdate
checkoutEventTriggered
checkoutMarketplaceShippingMethodUpdate
checkoutLineAddNote
checkoutLineDelete
checkoutLinesAdd
checkoutLinesUpdate
checkoutNoteUpdate
checkoutPaymentCreate
checkoutRemovePoNumbers
checkoutRemovePromoCode
checkoutSellerShippingMethodsBulkUpdate
checkoutSellerShippingMethodsClear
checkoutSellerShippingMethodsUpdate
checkoutSetTransactionCurrency
checkoutShippingAddressUpdate
checkoutThemeCreate
checkoutThemeUpdate
Types
Checkout
CheckoutAddPONumbers
CheckoutAddPromoCode
CheckoutBillingAddressUpdate
CheckoutComplete
CheckoutConvertToNauticalQuoteOrder
CheckoutCountableConnection
CheckoutCountableEdge
CheckoutCreate
CheckoutCreateInput
CheckoutCustomerAttach
CheckoutCustomerDetach
CheckoutDelete
CheckoutEmailUpdate
CheckoutError
CheckoutErrorCode
CheckoutLine
CheckoutEvent
CheckoutEventCountableConnection
CheckoutEventCountableEdge
CheckoutEventFilterInput
CheckoutEventSortInput
CheckoutEventSortField
CheckoutEventTriggered
CheckoutEventType
CheckoutLineAddNote
CheckoutLineCountableConnection
CheckoutLineCountableEdge
CheckoutLineDelete
CheckoutLineInput
CheckoutLinesAdd
CheckoutLinesUpdate
CheckoutNoteUpdate
CheckoutMarketplaceShippingMethodUpdate
CheckoutPaymentCreate
CheckoutRemovePONumbers
CheckoutRemovePromoCode
CheckoutSellerShipping
CheckoutSellerShippingMethodsBulkUpdate
CheckoutSellerShippingMethodsClear
CheckoutSellerShippingMethodsUpdate
CheckoutSetTransactionCurrency
CheckoutShippingAddressUpdate
MultiSellerShippingMethod
CheckoutTheme
CheckoutThemeCreate
CheckoutThemeCreateInput
CheckoutThemeInput
CheckoutThemeUpdate
SellerVolumeDiscount
Customers
Queries
customers
Mutations
customerBulkDelete
customerCreate
customerDelete
customerUpdate
customersExport
Types
CustomerBulkDelete
CustomerCreate
CustomerDelete
CustomerEvent
CustomerEventsEnum
CustomerFilterInput
CustomerInput
CustomerNauticalOrderFilterInput
CustomerOrderFilterInput
CustomersExport
CustomerUpdate
Currency
Queries
currencies
Mutations
exchangeRatesRefresh
Types
ExchangeRatesRefresh
NauticalCurrency
Draft orders
Queries
draftOrders
nauticalDraftOrders
Mutations
draftOrderBulkDelete
draftOrderComplete
draftOrderCreate
draftOrderDelete
draftOrderLineDelete
draftOrderLinePriceOverride
draftOrderLineUpdate
draftOrderLinesBulkDelete
draftOrderLinesCreate
draftOrderSetTransactionCurrency
draftOrderUpdate
nauticalDraftOrderBulkDelete
nauticalDraftOrderComplete
nauticalDraftOrderCreate
nauticalDraftOrderDelete
nauticalDraftOrderLineDelete
nauticalDraftOrderLinePriceOverride
nauticalDraftOrderLineUpdate
nauticalDraftOrderLinesBulkDelete
nauticalDraftOrderLinesCreate
nauticalDraftOrderSetTransactionCurrency
nauticalDraftOrderUpdate
nauticalOrderLinesCsvUpload
orderLinesCsvUpload
Types
DraftOrderBulkDelete
DraftOrderComplete
DraftOrderCreate
DraftOrderCreateInput
DraftOrderDelete
DraftOrderInitialStatus
DraftOrderInput
DraftOrderLineDelete
DraftOrderLinePriceOverride
DraftOrderLinesBulkDelete
DraftOrderLinesCreate
DraftOrderLineUpdate
DraftOrderSetTransactionCurrency
DraftOrderUpdate
NauticalDraftOrderBulkDelete
NauticalDraftOrderComplete
NauticalDraftOrderCreate
NauticalDraftOrderCreateInput
NauticalOrderLinesCsvUpload
NauticalDraftOrderDelete
NauticalDraftOrderInput
NauticalDraftOrderLineDelete
NauticalDraftOrderLinePriceOverride
NauticalDraftOrderLinesBulkDelete
NauticalDraftOrderLinesCreate
NauticalDraftOrderLineUpdate
NauticalDraftOrderSetTransactionCurrency
NauticalDraftOrderUpdate
NauticalOrderDraftFilterInput
OrderDraftFilterInput
OrderLinesCsvUpload
Fulfillment
Mutations
orderDeclineFulfillment
orderFulfill
orderFulfillmentCancel
orderFulfillmentUpdateTracking
orderMarkAsDelivered
Types
DeclineFulfillInput
DeclineFulfillLineInput
DeclineFulfillStockInput
Fulfillment
FulfillmentCancel
FulfillmentCancelInput
FulfillmentCountableConnection
FulfillmentCountableEdge
FulfillmentLine
FulfillmentStatus
FulfillmentStatusFilter
FulfillmentUpdateTracking
FulfillmentUpdateTrackingInput
OrderDeclineFulfillment
OrderFulfill
OrderFulfillInput
OrderMarkAsDelivered
Invoices
Mutations
invoiceCancel
invoiceCreate
invoiceDelete
invoiceFinalize
invoiceRefresh
invoiceRequest
invoiceRequestDelete
invoiceSendNotification
invoiceUpdate
Types
Invoice
InvoiceCancel
InvoiceCreate
InvoiceCreateInput
InvoiceDelete
InvoiceError
InvoiceErrorCode
InvoiceFinalize
InvoiceRefresh
InvoiceRequest
InvoiceRequestDelete
InvoiceSendNotification
InvoiceUpdate
UpdateInvoiceInput
Marketplace orders
Queries
nauticalOrder
nauticalOrderByToken
nauticalOrders
nauticalOrdersTotal
Mutations
nauticalHistoricalOrderCreate
nauticalOrderAddNote
nauticalOrderCancel
nauticalOrderCapture
nauticalOrderLineAddNote
nauticalOrderLineBulkCancel
nauticalOrderMarkAsPaid
nauticalOrderPaymentCreate
nauticalOrderUpdate
nauticalOrderUpdateApplyVoucherCode
nauticalOrderUpdateDeleteDiscount
nauticalOrderUpdateMarketplaceShipping
nauticalOrderUpdateShipping
nauticalOrderVoid
Types
HistoricalOrderLineInput
NauticalHistoricalOrderCreate
NauticalHistoricalOrderInput
NauticalOrder
NauticalOrderAddNote
NauticalOrderCancel
NauticalOrderCapture
NauticalOrderCountableConnection
NauticalOrderCountableEdge
NauticalOrderEvent
NauticalOrderEventCountableConnection
NauticalOrderEventCountableEdge
NauticalOrderEventOrderLineObject
NauticalOrderFilterInput
NauticalOrderLine
NauticalOrderLineAddNote
NauticalOrderLineBulkCancel
NauticalOrderMarkAsPaid
NauticalOrderOrderSource
NauticalOrderPaymentCreate
NauticalOrderStatus
NauticalOrderSubStatus
NauticalOrderUpdate
NauticalOrderUpdateInput
NauticalOrderUpdateApplyVoucherCode
NauticalOrderUpdateDeleteDiscount
nauticalOrderUpdateInput
NauticalOrderUpdateMarketplaceShipping
NauticalOrderUpdateMarketplaceShippingInput
NauticalOrderUpdateShipping
NauticalOrderUpdateShippingInput
NauticalOrderVoid
Offer orders
Mutations
bidAccept
bidCreate
bidReject
orderOfferConvertToNauticalQuoteOrder
Types
Bid
BidAccept
BidCreate
BidError
BidErrorCode
BidInput
BidReject
BidRole
BidRoleEnum
BidStatus
OfferOrderSubStatusFilter
OrderOfferConvertToNauticalQuoteOrder
Payments
Queries
getClientSecret
payment
payments
Mutations
paymentCapture
paymentVoid
Types
CreditCard
GatewayConfigLine
Payment
PaymentCapture
PaymentChargeStatusEnum
PaymentCountableConnection
PaymentCountableEdge
PaymentError
PaymentErrorCode
PaymentGateway
PaymentInput
PaymentSource
PaymentVoid
StripeClientPaymentData
Transaction
TransactionKind
Quote orders
Queries
nauticalQuoteOrderByToken
nauticalQuoteOrders
quoteOrders
Mutations
nauticalQuoteOrderCancel
nauticalQuoteOrderSendToCustomer
Types
NauticalOrderQuoteFilterInput
NauticalQuoteOrderCancel
NauticalQuoteOrderSendToCustomer
OrderQuoteFilterInput
QuoteOrderSubStatusFilter
Refunds
Queries
refund
refunds
Mutations
refundCreate
refundLinesAdd
refundLinesDelete
refundLinesUpdate
refundPaymentsAdd
refundPaymentsDelete
refundPaymentsUpdate
refundUpdate
refundsChangeStatus
refundsDelete
Types
Refund
RefundBulkDelete
RefundChargeToEnum
RefundCountableConnection
RefundCountableEdge
RefundCreate
RefundCreateInput
RefundError
RefundErrorCode
RefundFilterInput
RefundLine
RefundLineBulkDelete
RefundLineCountableConnection
RefundLineCountableEdge
RefundLineInput
RefundLinesAdd
RefundLineScopeEnum
RefundLinesUpdate
RefundLineTypeEnum
RefundLineUpdateInput
RefundMethod
RefundPayment
RefundPaymentCountableConnection
RefundPaymentCountableEdge
RefundPaymentInput
RefundPaymentsAdd
RefundPaymentsDelete
RefundPaymentsUpdate
RefundPaymentTypeEnum
RefundPaymentUpdateInput
RefundsChangeStatus
RefundScope
RefundSortField
RefundSortingInput
RefundStatusEnum
RefundTypeEnum
RefundUpdate
RefundUpdateInput
Returns
Queries
returns
Mutations
fulfillmentBulkReturn
nauticalOrderReturnFromStorefrontNotification
nauticalOrderReturnNotification
orderFulfillmentReturn
orderFulfillmentUpdateReturnStatus
orderReturnNotification
vendorOrderReturnFromStorefrontNotification
Types
BulkFulfillmentReturnInput
FulfillmentBulkReturn
FulfillmentReturn
FulfillmentReturnInput
FulfillmentReturnStatusBulkUpdate
FulfillmentUpdateReturnStatusInput
NauticalOrderReturnFromStorefrontNotification
NauticalOrderReturnNotification
OrderReturnNotification
OrderReturnNotificationInput
ReturnFulfillmentFilterInput
ReturnFulfillmentSortField
ReturnFulfillmentSortingInput
VendorOrderReturnFromStorefrontNotification
Seller orders
Queries
order
orderByToken
orders
ordersTotal
Mutations
orderAddNote
orderBulkCancel
orderCancel
orderFeeCreate
orderFeeDelete
orderLineAddNote
orderPayoutStatusUpdate
orderUpdate
orderUpdateShipping
Types
FeeScope
Order
OrderAction
OrderAddNote
OrderAddNoteInput
OrderBulkCancel
OrderCancel
OrderCountableConnection
OrderCountableEdge
OrderDirection
OrderError
OrderErrorCode
OrderEvent
OrderEventCountableConnection
OrderEventCountableEdge
OrderEventOrderLineObject
OrderEventsEmailsEnum
OrderEventsEnum
OrderFee
OrderFeeCreate
OrderFeeDelete
OrderFeeInput
OrderFilterInput
OrderFulfillLineInput
OrderFulfillStockInput
OrderLine
OrderLineAddNote
OrderLineCreateInput
OrderLineInput
OrderLinePriceOverrideInput
OrderOrderSource
OrderPayoutSummary
OrderPayoutStatusEnum
OrderPayoutStatusUpdate
OrderPayoutStatusUpdateInput
OrderSellerSummaryType
OrderSortField
OrderSortingInput
OrderSourceFilter
OrderStatus
OrderStatusFilter
OrderSubStatus
OrderSubStatusEnum
OrderSummaryDeltaDataType
OrderUpdate
OrderUpdateInput
OrderUpdateShipping
OrderUpdateShippingInput
OrderVendorSummaryType
SourceFeeEnum
Taxes
Queries
avalaraRequestLogs
customerTaxCertificates
taxExemptCodes
taxTypes
Mutations
nauticalOrderRefreshTaxes
shopFetchTaxRates
Types
AvalaraRequestLog
AvalaraRequestLogCountableConnection
AvalaraRequestLogCountableEdge
NauticalOrderRefreshTaxes
ShopFetchTaxRates
TaxCertificate
TaxedMoney
TaxedMoneyRange
TaxExemptCode
TaxType
Wishlist
Queries
wishlistItemsByName
Mutations
wishlistAddProduct
wishlistAddVariant
wishlistCreate
wishlistCreateForBuyer
wishlistDelete
wishlistItemUpdate
wishlistRemoveProduct
wishlistRemoveVariant
wishlistSetDefault
wishlistUpdate
Types
Wishlist
WishlistAddProduct
WishlistAddProductVariant
WishlistBuyerInput
WishlistCountableConnection
WishlistCountableEdge
WishlistCreate
WishlistCreateForBuyer
WishlistDelete
WishlistError
WishlistErrorCode
WishlistInput
WishlistItem
WishlistItemCountableConnection
WishlistItemCountableEdge
WishlistItemInputFilter
WishlistItemSortField
WishlistItemSortingInput
WishlistItemUpdate
WishlistItemUpdateInput
WishlistRemoveProduct
WishlistRemoveProductVariant
WishlistSetDefault
WishlistUpdate
Inventory Management
Shipping zones
Queries
shippingZone
shippingZones
Mutations
shippingPriceBulkDelete
shippingPriceCreate
shippingPriceDelete
shippingPriceUpdate
shippingZoneBulkDelete
shippingZoneCreate
shippingZoneDelete
shippingZoneUpdate
Types
ShippingError
ShippingErrorCode
ShippingMethod
ShippingMethodTypeEnum
ShippingPriceBulkDelete
ShippingPriceCreate
ShippingPriceDelete
ShippingPriceInput
ShippingPriceUpdate
ShippingZone
ShippingZoneBulkDelete
ShippingZoneCountryArea
ShippingZoneCountryAreaInput
ShippingZoneCountableConnection
ShippingZoneCountableEdge
ShippingZoneCreate
ShippingZoneCreateInput
ShippingZoneDelete
ShippingZoneFilterInput
ShippingZoneUpdate
ShippingZoneUpdateInput
Stock
Queries
stock
stocks
Mutations
productVariantStocksCreate
productVariantStocksDelete
productVariantStocksUpdate
Types
Allocation
BulkStockError
ProductVariantStocksCreate
ProductVariantStocksDelete
ProductVariantStocksUpdate
Stock
StockAvailability
StockCountableConnection
StockCountableEdge
StockError
StockErrorCode
StockEvent
StockEventType
StockFilterInput
StockInput
Warehouses
Queries
warehouse
warehouses
Mutations
warehouseCreate
warehouseDelete
warehouseUpdate
Types
Warehouse
WarehouseAddressInput
WarehouseCountableConnection
WarehouseCountableEdge
WarehouseCreate
WarehouseCreateInput
WarehouseDelete
WarehouseError
WarehouseErrorCode
WarehouseFilterInput
WarehouseSortField
WarehouseSortingInput
WarehouseStats
WarehouseUpdate
WarehouseUpdateInput
Discounts
Price books
Queries
priceBook
priceBookProductTypes
priceBookProductTypesHistory
priceBookProducts
priceBookProductsHistory
priceBookUsers
priceBookVariants
priceBookVariantsHistory
priceBooks
Mutations
priceBookBulkDelete
priceBookCreate
priceBookDelete
priceBookProductBulkDelete
priceBookProductCreate
priceBookProductDelete
priceBookProductTypeBulkDelete
priceBookProductTypeCreate
priceBookProductTypeDelete
priceBookProductTypeUpdate
priceBookProductUpdate
priceBookUpdate
priceBookVariantBulkDelete
priceBookVariantCreate
priceBookVariantDelete
priceBookVariantUpdate
userAddToPriceBook
userRemoveFromPriceBook
Types
PriceBook
PriceBookBulkDelete
PriceBookCountableConnection
PriceBookCountableEdge
PriceBookCreate
PriceBookCreateInput
PriceBookDelete
PriceBookError
PriceBookErrorCode
PriceBookFilterInput
PriceBookProduct
PriceBookProductBulkDelete
PriceBookProductCountableConnection
PriceBookProductCountableEdge
PriceBookProductCreate
PriceBookProductCreateInput
PriceBookProductDelete
PriceBookProductFilterInput
PriceBookProductHistory
PriceBookProductHistoryCountableConnection
PriceBookProductHistoryCountableEdge
PriceBookProductHistoryFilterInput
PriceBookProductHistorySortField
PriceBookProductHistorySortingInput
PriceBookProductHistoryValueType
PriceBookProductSortField
PriceBookProductSortingInput
PriceBookProductType
PriceBookProductTypeBulkDelete
PriceBookProductTypeCountableConnection
PriceBookProductTypeCountableEdge
PriceBookProductTypeCreate
PriceBookProductTypeCreateInput
PriceBookProductTypeDelete
PriceBookProductTypeFilterInput
PriceBookProductTypeHistory
PriceBookProductTypeHistoryCountableConnection
PriceBookProductTypeHistoryCountableEdge
PriceBookProductTypeHistoryFilterInput
PriceBookProductTypeHistorySortField
PriceBookProductTypeHistorySortingInput
PriceBookProductTypeHistoryValueType
PriceBookProductTypeSortField
PriceBookProductTypeSortingInput
PriceBookProductTypeUpdate
PriceBookProductTypeUpdateInput
PriceBookProductTypeValueType
PriceBookProductUpdate
PriceBookProductUpdateInput
PriceBookProductValueType
PriceBookSortField
PriceBookSortingInput
PriceBookUpdate
PriceBookUpdateInput
PriceBookValueTypeEnum
PriceBookVariant
PriceBookVariantBulkDelete
PriceBookVariantCountableConnection
PriceBookVariantCountableEdge
PriceBookVariantCreate
PriceBookVariantCreateInput
PriceBookVariantDelete
PriceBookVariantFilterInput
PriceBookVariantHistory
PriceBookVariantHistoryCountableConnection
PriceBookVariantHistoryCountableEdge
PriceBookVariantHistoryFilterInput
PriceBookVariantHistorySortField
PriceBookVariantHistorySortingInput
PriceBookVariantHistoryValueType
PriceBookVariantSortField
PriceBookVariantSortingInput
PriceBookVariantUpdate
PriceBookVariantUpdateInput
PriceBookVariantValueType
UserAddToPriceBook
UserAddToPriceBookInput
UserRemoveFromPriceBook
Sales
Queries
sale
sales
Mutations
saleBulkDelete
saleCataloguesAdd
saleCataloguesRemove
saleCreate
saleDelete
saleUpdate
Types
Sale
SaleAddCatalogues
SaleBulkDelete
SaleCountableConnection
SaleCountableEdge
SaleCreate
SaleDelete
SaleFilterInput
SaleInput
SaleRemoveCatalogues
SaleSortField
SaleSortingInput
SaleUpdate
SaleTypeEnum
Vouchers
Queries
voucher
vouchers
Mutations
voucherBulkDelete
voucherCataloguesAdd
voucherCataloguesRemove
voucherCreate
voucherDelete
voucherUpdate
Types
DiscountError
DiscountErrorCode
DiscountStatusEnum
DiscountValueTypeEnum
Voucher
VoucherAddCatalogues
VoucherBulkDelete
VoucherCountableConnection
VoucherCountableEdge
VoucherCreate
VoucherDelete
VoucherDiscountType
VoucherFilterInput
VoucherInput
VoucherRemoveCatalogues
VoucherSortField
VoucherSortingInput
VoucherTypeEnum
VoucherUpdate
User management
Address
Queries
address
addressValidationRules
Mutations
accountAddressCreate
accountAddressDelete
accountAddressSetDefault
accountAddressUpdate
addressCreate
addressDelete
addressSetDefault
addressUpdate
Types
AccountAddressCreate
AccountAddressDelete
AccountAddressSetDefault
AccountAddressUpdate
Address
AddressCreate
AddressDelete
AddressInput
AddressSetDefault
AddressType
AddressTypeEnum
AddressUpdate
AddressValidationData
Email
Mutations
emailChangeConfirm
emailChangeRequest
Types
EmailChangeConfirm
EmailChangeRequest
Password
Mutations
passwordChange
passwordRequestReset
passwordSet
Types
PasswordChange
PasswordRequestReset
PasswordSet
Permission groups
Queries
permissionGroup
permissionGroups
Mutations
permissionGroupCreate
permissionGroupDelete
permissionGroupUpdate
Types
Permission
PermissionEnum
PermissionGroupCreate
PermissionGroupCreateInput
PermissionGroupDelete
PermissionGroupError
PermissionGroupErrorCode
PermissionGroupFilterInput
PermissionGroupSortField
PermissionGroupSortingInput
PermissionGroupUpdate
PermissionGroupUpdateInput
Staff members
Queries
staffUsers
Mutations
staffBulkDelete
staffCreate
staffDelete
staffUpdate
Types
StaffBulkDelete
StaffCreate
StaffCreateInput
StaffDelete
StaffError
StaffMemberStatus
StaffUpdate
StaffUpdateInput
StaffUserInput
Users
Queries
allowedOwners
me
user
userByEmail
userSellers
Mutations
accountConfirm
accountDelete
accountRegister
accountRequestDeletion
accountUpdate
userAvatarDelete
userAvatarUpdate
userBulkSetActive
Types
AccountConfirm
AccountDelete
AccountError
AccountErrorCode
AccountInput
AccountRegister
AccountRegisterInput
AccountRequestDeletion
AccountUpdate
User
UserAvatarDelete
UserAvatarUpdate
UserBulkSetActive
UserCountableConnection
UserCountableEdge
UserCreateInput
UserPermission
UserSortField
UserSortingInput
UserType
Extensibility
Apps
Queries
app
apps
appsInstallations
Mutations
appActivate
appCreate
appDeactivate
appDelete
appDeleteFailedInstallation
appFetchManifest
appInstall
appRetryInstall
appUpdate
Types
App
AppActivate
AppCountableConnection
AppCountableEdge
AppCreate
AppDeactivate
AppDelete
AppDeleteFailedInstallation
AppError
AppErrorCode
AppFetchManifest
AppFilterInput
AppInput
AppInstall
AppInstallation
AppInstallInput
AppRetryInstall
AppSortField
AppSortingInput
AppTypeEnum
AppUpdate
Manifest
Metadata
Mutations
metadataDelete
metadataUpdate
privateMetadataDelete
privateMetadataUpdate
Types
MetadataDelete
MetadataError
MetadataErrorCode
MetadataFilterInput
MetadataInput
MetadataItem
MetadataUpdate
ObjectWithMetadata
PrivateMetadataDelete
PrivateMetadataUpdate
Plugins
Queries
plugin
pluginFlows
plugins
typeformForm
typeformForms
Mutations
pluginFlowDelete
pluginFlowUpdate
pluginUpdate
Types
Flow
FlowProcess
Plugin
PluginConfigurationCategory
PluginCountableConnection
PluginCountableEdge
PluginError
PluginErrorCode
PluginFilterInput
PluginFlowDelete
PluginFlowInput
PluginFlowUpdate
PluginSortField
PluginSortingInput
PluginUpdate
PluginUpdateInput
TypeformForm
TypeformFormAttachment
TypeformFormFields
TypeformFormLayout
TypeformFormOption
TypeformFormProperties
TypeformForms
TypeformFormsItem
TypeformFormsItemLink
TypeformFormsItemSelf
TypeformGroupProperties
Webhooks
Queries
webhook
webhookEventLogs
webhookEvents
webhookJobs
webhookSamplePayload
Mutations
webhookCreate
webhookDelete
webhookUpdate
Types
GenericWebhookTransactionType
Webhook
WebhookCreate
WebhookCreateInput
WebhookDelete
WebhookDirectionEnum
WebhookError
WebhookErrorCode
WebhookEvent
WebhookEventLog
WebhookEventLogCountableConnection
WebhookEventLogCountableEdge
WebhookEventTypeEnum
WebhookJob
WebhookJobCountableConnection
WebhookJobCountableEdge
WebhookJobFilterInput
WebhookJobSortField
WebhookJobSortingInput
WebhookJobSource
WebhookJobStatus
WebhookJobType
WebhookSampleEventTypeEnum
WebhookUpdate
WebhookUpdateInput
General
Analytics
Queries
insightsMarketplacePaymentsSummary
insightsMarketplacePayoutsSummary
insightsMarketplaceTaxSummary
insightsMarketplaceTaxesByCountry
insightsMarketplaceTaxesByCountryArea
insightsOrdersCustomerSummary
insightsOrdersMarketplaceSummary
insightsOrdersSellerSummary
insightsTopPerformingCategories
insightsTopPerformingProducts
reportProductSales
Types
AbstractOrderSellerReportType
AbstractPaymentsType
AbstractPercentReportType
AbstractProductVariantType
InReportMarketplacePaymentsSummaryType
InReportMarketplacePayoutsSummaryType
InReportMarketplaceTaxesByCountryType
InReportMarketplaceTaxSummaryType
InReportOrderCustomerSummaryType
InReportOrderMarketplaceSummaryType
InReportOrderSellerSummaryType
InReportTopPerformingCategoriesType
InReportTopPerformingProductsType
InsightDimensionEnum
MarketplaceTaxReportByLocaleType
MarketplaceTaxReportType
OrderCustomerReportType
OrderMarketplaceReportType
OrderSellerReportType
OrderVendorReportType
PaymentsDayReportType
PerformancePerspective
ProductCategoryReportType
ReportingPeriod
SingleVendorPayoutReport
SingleVendorReportType
SingleVendorSummaryType
Custom fields
Queries
customFieldTemplate
customFieldTemplates
Mutations
customAttributeAssign
customAttributeUnassign
instanceAttributeUnassign
Types
CustomAttributeAssign
CustomAttributeUnassign
CustomFieldInstance
CustomFieldTemplate
CustomFieldTemplateEnum
InstanceAttributeUnassign
Dashboard
Queries
dashboardGraph
dashboardOrdersSummary
dashboardTopSellerPerformance
No-Code Storefront
Queries
content
contentDraft
contentList
media
mediaList
Mutations
contentCreate
contentDelete
contentDiscard
contentDuplicate
contentPublish
contentSave
mediaBulkDelete
mediaCreate
mediaUpdate
storefrontThemeCreate
storefrontThemeUpdate
Types
Content
ContentCountableConnection
ContentCountableEdge
ContentCreate
ContentCreateInput
ContentDelete
ContentDiscard
ContentDuplicate
ContentDuplicateInput
ContentFilterInput
ContentPublish
ContentPublishInput
ContentSave
ContentSaveInput
ContentSortField
ContentSortingInput
Media
MediaBulkDelete
MediaCountableConnection
MediaCountableEdge
MediaCreate
MediaCreateInput
MediaFilterInput
MediaSortField
MediaSortingInput
MediaUpdate
MediaUpdateInput
StorefrontTheme
StorefrontThemeCreate
StorefrontThemeInput
StorefrontThemeUpdate
Documents
Mutations
documentAdd
documentAttach
documentRemove
documentUpdate
Types
Document
DocumentAdd
DocumentAttach
DocumentError
DocumentErrorCode
DocumentRemove
DocumentTargetInstance
DocumentUpdate
DocumentUpdateInput
Storefront
Queries
media
mediaList
Mutations
designerDataCreate
designerDataUpdate
Types
DesignerDataCreate
DesignerDataInput
DesignerDataType
DesignerDataUpdate
Email notifications
Queries
emailLogs
Types
EmailEvent
EmailEventCountableConnection
EmailEventCountableEdge
EmailEventFilterInput
EmailEventMessageType
EmailEventSortField
EmailEventSortingInput
EmailEventSortingInput
NotifyEventTypeEnum
Marketplace configuration
Queries
marketplaceConfiguration
Mutations
marketplaceConfigurationUpdate
Types
AttributeTemplateStrategyEnum
AvailableShippingStrategyEnum
FulfillmentModelEnum
MarketplaceConfiguration
MarketplaceConfigurationAttributeTemplateStrategy
MarketplaceConfigurationCurrencyEnum
MarketplaceConfigurationError
MarketplaceConfigurationErrorCode
MarketplaceConfigurationInput
MarketplaceConfigurationPayoutAutomationStrategyEnum
MarketplaceConfigurationUpdate
RevenueAccrualStrategyEnum
Menus
Queries
menu
menuItem
menuItems
menus
Mutations
menuBulkDelete
menuCreate
menuDelete
menuItemBulkDelete
menuItemCreate
menuItemDelete
menuItemMove
menuItemUpdate
menuUpdate
Types
Menu
MenuBulkDelete
MenuCountableConnection
MenuCountableEdge
MenuCreate
MenuCreateInput
MenuDelete
MenuError
MenuErrorCode
MenuFilterInput
MenuInput
MenuItem
MenuItemBulkDelete
MenuItemCountableConnection
MenuItemCountableEdge
MenuItemCreate
MenuItemCreateInput
MenuItemDelete
MenuItemFilterInput
MenuItemInput
MenuItemMove
MenuItemMoveInput
MenuItemSortingInput
MenuItemsSortField
MenuItemUpdate
MenuSortField
MenuSortingInput
MenuUpdate
Microsites
Queries
microsite
microsites
vendorMicrosite
Mutations
micrositeAddProducts
micrositeBulkDelete
micrositeBulkPublish
micrositeCreate
micrositeDelete
micrositeRemoveProducts
micrositeReorderProducts
micrositeUpdate
Types
Microsite
MicrositeAddProducts
MicrositeBulkDelete
MicrositeBulkPublish
MicrositeCountableConnection
MicrositeCountableEdge
MicrositeCreate
MicrositeCreateInput
MicrositeDelete
MicrositeFilterInput
MicrositeInput
MicrositePublished
MicrositeRemoveProducts
MicrositeReorderProducts
MicrositeSortField
MicrositeSortingInput
MicrositeUpdate
Nautical configuration
Queries
nauticalConfiguration
nauticalConfigurationList
Mutations
nauticalConfigurationUpdate
Types
NauticalConfiguration
NauticalConfigurationError
NauticalConfigurationErrorCode
NauticalConfigurationInputItem
NauticalConfigurationUpdate
Pages
Queries
page
pages
Mutations
pageBulkDelete
pageBulkPublish
pageCreate
pageDelete
pageUpdate
Types
Page
PageBulkDelete
PageBulkPublish
PageCountableConnection
PageCountableEdge
PageCreate
PageDelete
PageError
PageErrorCode
PageFilterInput
PageInput
PageSortField
PageSortingInput
PageUpdate
Shop settings
Queries
shop
Mutations
shopAddressUpdate
shopDomainUpdate
shopSettingsUpdate
Types
Shop
ShopAddressUpdate
ShopDomainUpdate
ShopError
ShopErrorCode
ShopSettingsUpdate
ShopSettingsInput
Common types
BigInt
Boolean
CatalogueInput
ChoiceValue
ColumnObjectType
ConfigurationItem
ConfigurationItemInput
ConfigurationTypeFieldEnum
ContentPageData
ContentPageDataCreate
ContentPageDataCreateInput
ContentPageDataUpdate
ContentPageDataUpdateInput
CountryArea
CountryCode
CountryDisplay
CountryState
CustomDateRangeInput
CustomDomain
CustomDomainCreate
CustomDomainCreateInput
CustomDomainDelete
DashboardGraphType
DashboardOrdersSummaryType
DashboardSellerOrderPerformanceType
DashboardTopSellerPerformanceType
Date
DateRangeInput
DateTime
DateTimeRangeInput
Decimal
DistanceUnit
DistanceUnitsEnum
Domain
DomainStatusEnum
EmailTemplate
EmailTemplateCountableConnection
EmailTemplateCountableEdge
EmailTemplateFilterInput
EmailTemplatePreview
EmailTemplateSortField
EmailTemplateSortingInput
EmailTemplateUpdate
EmailTemplateUpdateInput
EventTypeEnum
FieldSet
File
FileSize
FileTypesEnum
FilterObjectType
Float
Font
FontCountableConnection
FontCountableEdge
GenericScalar
Geolocalization
GraphDataType
Group
GroupCountableConnection
GroupCountableEdge
ID
Image
ImportErrorCode
Int
IntRangeInput
JSONString
Job
JobStatusEnum
LanguageCodeEnum
Margin
Money
MoneyRange
Mutation
NauticalUUID
Node
NoteInput
NotificationError
NotificationErrorCode
OptimizedHome
PageInfo
PositiveDecimal
PriceRangeInput
ProductStatusLog
Query
RadiusSearchInput
RecipientTypeEnum
ReorderInput
SellerAgreementAcknowledgeInput
SellerAgreementDecline
SellerAgreementDeclineInput
SellerBannerDelete
SellerBannerUpdate
SellerChecklistCompletionTriggersEnum
SellerLogoDelete
SeoInput
SiteDomainInput
String
TenantErrorCode
TenantUpdateInput
UUID
Upload
ValidationStatus
Vendor
Weight
WeightScalar
WeightUnitsEnum
_Any
_Entity
_Service
federation__Policy
federation__Scope
AbstractPercentReportType
Object
Fields
#
average
Float
discounts
Float
gross
Float
net
Float
orders
Float
revenue
Float
shipping
Float
taxes
Float
totals
Float
volumeDiscounts
Float
Deprecated
This will be removed on February 1, 2025.
Usages
#
References
#
Field
percent
from
OrderSummaryDeltaDataType
