Developer Guide

Getting started

Architecture Overview Learn about the front-end and back-end components that make a Nautical marketplace.

Get Started with the GraphQL API Learn the basics about Nautical's API.

Authentication and Authorization Learn how to authenticate users or apps to grant access to API operations.

Pagination Learn how to traverse large datasets.

Error Handling Handle error conditions.

Metadata Store additional information about items.

Reference docs

API Reference Use the API reference to see detailed information about the operations and types in the Nautical GraphQL API.

Schema Explorer Explore Nautical's GraphQL API in an interactive schema map.

Seller management

Onboard sellers How to set up seller accounts in your marketplace.

Payouts How to conduct seller payouts using Stripe.

Product catalog management

Products Access the products catalog.

Categories Access product categories.

Product Templates Access product templates.

Variants Access product variants or listings.

Inventory management

Warehouses, Stock, and Shipping How to set up warehouses, shipping zones, shipping rates and assign stock to variants.

Backorders Allow products to be sold after they are out of stock.

Order management

Checkout Managing the checkout flow.

Orders How to add and manage order notes.

Order notes Marketplace and seller orders.

Quotes Marketplace and seller quotes (request for quote).

Refunds Managing refunds.

Customers Creating and managing customer accounts.

Address Validation Learn about the address validation framework.

Integrations

Webhooks Learn about webhook events.

Apps Connect apps to Nautical.

Exporting data

Exporting products Export product data to file.

Exporting reporting data Export reporting data.