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.

Vendor management

Onboard sellers how to conduct vendor payouts using Stripe

Payouts how to conduct vendor payouts using Stripe

Catalog management

Products access the products catalog

Categories access product categories

Product Types access product types

Variants access product variants or listings

Inventory management

Warehouses, Stock, and Shipping how to set up warehouses, shipping sones, 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.