address
Look up an address by ID
agreementEvents
List of change events for an agreement. Requires MANAGE_AGREEMENTS permission.
agreementTimeline
Unified timeline of ALL change events for an agreement and its related models (commissions, fees, seller assignments). Requires MANAGE_AGREEMENTS permission.
agreement
Look up a marketplace agreement by ID or slug.
agreements
List of the marketplace agreements. Requires MANAGE_AGREEMENTS permission.
allCategories
Get all categories in a flat list.
analyticsId
Returns analytics ID (e.g. Google Tag ID).
app
Look up an app by ID
apps
List all apps
attributeValue
Look up an attribute value by ID (requires MANAGE_PRODUCTS permission)
attributeValues
List attribute values with filtering (requires MANAGE_PRODUCTS permission)
attribute
Look up an attribute by ID
attributes
List all attributes with optional filtering and sorting
avalaraRequestLogs
List Avalara request logs.
bigqueryCustomers
BigQuery customers report.
bigqueryNetSalesByCategory
BigQuery net sales by category report.
bigqueryNetSalesBySeller
BigQuery net sales by seller report.
bigqueryOrderLineItems
BigQuery order line items report.
bigqueryOrdersByStatus
BigQuery orders by status report.
bigqueryPayouts
BigQuery payouts report.
bigquerySalesPerDay
BigQuery sales per day report.
bigquerySellerOrders
BigQuery seller orders report.
bigquerySellerPayouts
BigQuery seller payouts report.
bigqueryTenantOrders
BigQuery daily order counts report.
bigqueryThirtySixtyNinety
BigQuery 30/60/90 day sales report.
bigqueryVariantList
BigQuery variant list report.
categories
List all categories with optional filtering and sorting
category
Look up a category by ID or slug
checkoutEvents
List checkout events.
checkoutLines
List all checkout lines. Requires MANAGE_CHECKOUTS permission.
checkout
Look up a checkout by token.
checkouts
List all checkouts. Requires MANAGE_CHECKOUTS permission.
collection
Look up a collection by ID or slug
collections
List all collections with optional filtering and sorting
contentDraft
Look up content draft by ID or slug.
contentList
List all content.
content
Look up content by ID or slug.
countries
List of countries available in the shop.
currencies
List of supported currencies.
currentTenant
Return the current tenant.
customFieldTemplate
Look up a custom field template by ID or content type
customFieldTemplates
List all available custom field templates
customStorefrontDomain
If set, the custom storefront domain.
customerTaxCertificates
Get customer tax certificates.
customers
List of the shop's customers
dashboardGraph
Get dashboard graph data.
dashboardOrdersSummary
Get dashboard orders summary.
dashboardTopSellerPerformance
Get top seller performance.
dashboardUiIntegrations
List dashboard UI integrations for given contexts
_debug
Debug information (SQL queries, exceptions).
designerdata
Get designer data by name.
designerdatalist
List all designer data.
digitalContent
Look up digital content by ID
digitalContents
List all digital content (requires MANAGE_PRODUCTS permission)
draftOrders
No description
emailLogs
List of email logs with filtering and sorting
emailTemplatePreview
Preview email template.
emailTemplate
Get email template by ID.
emailTemplates
List all email templates.
events
List of all events for the given object.
exportFile
Get export file by ID.
exportFiles
List all export files.
fontList
List available fonts.
getClientSecret
Get client secret for payment gateway.
getPayoutGateways
List of active payment gateways that have payouts enabled.
importFile
Get import file by ID.
importFiles
List all import files.
insightsTopPerformingCategories
Get top/worst performing categories. Requires MANAGE_PRODUCTS permission.
insightsTopPerformingProducts
Get top/worst performing products. Requires MANAGE_ORDERS permission.
integrationEmbeddingToken
Token necessary for connecting to the embedded integration platform
isEmailTokenValid
Determine if the email token provided is still valid or not.
journalEntries
List journal entries. Requires MANAGE_PAYOUTS permission.
ledgers
List ledgers. Requires MANAGE_PAYOUTS permission.
marketplaceConfiguration
Return the marketplace configuration.
marketplaceSubscription
Look up a marketplace subscription by ID. Requires MANAGE_MARKETPLACE permission.
marketplaceSubscriptions
List marketplace subscriptions. Requires MANAGE_MARKETPLACE permission.
mcpConfiguration
Return the hosted MCP configuration for the current tenant, or null if the tenant has not been configured. A null result means everything is off (fail-closed defaults).
me
Return the currently authenticated user
mediaList
List all media.
media
Get media by ID.
menuItem
Look up a menu item by ID
menuItems
List all menu items with optional filtering and sorting
menu
Look up a menu by ID, name, or slug
menus
List all menus with optional filtering and sorting
nauticalConfigurationList
Return all nautical configuration items.
nauticalConfiguration
Get a nautical configuration by name.
nauticalDraftOrders
No description
nauticalOrderByToken
Look up a nautical order by token.
nauticalOrder
Look up a nautical order by ID. Requires MANAGE_MARKETPLACE permission.
nauticalOrdersTotal
Return the total sales amount from a specific period. Requires MANAGE_MARKETPLACE permission.
nauticalOrders
No description
orderByToken
Look up an order by token. Public access for storefront.
orderMetrics
Get order metrics including time series data for bar charts and status breakdown for pie charts. Automatically filtered by seller for seller staff users.
order
Look up an order by ID. Requires MANAGE_ORDERS permission.
ordersTotal
Return the total sales amount from a specific period. Requires MANAGE_ORDERS permission.
orders
No description
page
Look up a page by ID or slug
pages
List all pages with optional filtering and sorting
payment
Look up a payment by ID. Requires MANAGE_ORDERS permission.
payments
List all payments. Requires MANAGE_ORDERS permission.
payout
Look up a payout by ID. Requires MANAGE_PAYOUTS permission.
payouts
List all payouts. Requires MANAGE_PAYOUTS permission.
permissionGroup
Get permission group by ID.
permissionGroups
List permission groups.
plugin
Look up a plugin by ID. Requires MANAGE_PLUGINS permission.
plugins
List all plugins. Requires MANAGE_PLUGINS permission.
policies
List all policies with optional filtering and sorting
policy
Look up a policy by ID or slug
productType
Look up a product type by ID
productTypes
List all product types with optional filtering and sorting
productVariant
Look up a product variant by ID or NSN (Nautical Stock Number)
productVariants
List all product variants with optional filtering and sorting
product
Look up a product by ID or slug
products
List all products with optional filtering and sorting
refund
Look up a refund by ID. Requires MANAGE_ORDERS permission.
refunds
List all refunds. Requires MANAGE_ORDERS permission.
returns
No description
sale
Look up a sale by ID. Requires MANAGE_DISCOUNTS permission.
salesMetrics
Get sales metrics including time series data for bar charts and breakdown by seller (MPO only) and category. Automatically filtered by seller for seller staff users.
salesVelocity
Get sales velocity metrics (30/60/90 day windows) for product variants. Shows units sold and sales amount for each time window, plus current inventory. Useful for inventory planning and identifying fast/slow-moving products. Automatically filtered by seller for seller staff users.
sales
List all sales. Requires MANAGE_DISCOUNTS permission.
sellerAgreement
Look up what agreement a seller is attached to for the current date.
sellerAgreements
Look up agreement history for a seller.
sellerBySlug
Get public seller info by slug.
sellerEvents
List seller events.
sellerUser
Look up a seller-user mapping by ID or email
sellerUsers
List seller-user mappings, optionally filtered by email
seller
Look up a seller by ID, number (PK), or slug
sellers
List sellers. Requires MANAGE_MARKETPLACE, except for the cross-sell discovery use case (filter.hasCrossSellProducts=true), which is open to any authenticated user so sellers can browse other sellers' cross-sell-enabled catalogs.
shippingZone
Look up a shipping zone by ID. Requires MANAGE_SHIPPING permission.
shippingZones
List all shipping zones. Requires MANAGE_SHIPPING permission.
shop
Return the shop resource.
shopifyWebhookTransactions
List Shopify webhook transactions.
ssoIntegrations
List of SSO integrations that are active and can be used to authenticate users.
staffUsers
List of staff users
stock
Look up a stock record by ID
stocks
List stock records with optional filtering
taxExemptCodes
List tax exempt codes.
taxTypes
List of available tax types.
tenant
Look up a tenant by ID. Requires Nautical employee access.
tenants
List all tenants. Requires Nautical employee access.
userByEmail
Look up a user by email address
userSellers
List all seller mappings for a user by email
user
Look up a user by ID
vendorPayoutList
List vendor payouts for a specific vendor. Requires permissions or seller ownership.
vendorPayout
Look up a vendor payout by ID. Requires MANAGE_PAYOUTS permission or seller ownership.
vendorPayouts
Vendor payout report with included/excluded subsets. Requires MANAGEMARKETPLACE + MANAGEPAYOUTS.
voucher
Look up a voucher by ID. Requires MANAGE_DISCOUNTS permission.
vouchers
List all vouchers. Requires MANAGE_DISCOUNTS permission.
warehouse
Look up a warehouse by ID
warehouses
List warehouses with optional filtering and sorting
webhookEventLogs
List of webhook event logs
webhookEvents
List of all available webhook events. Requires MANAGE_APPS permission.
webhookJobs
List webhook jobs.
webhook
Look up a webhook by ID.
wishlistItemsByName
Get wishlist items by name.