Developer documentation

Everything you need to build on Foundry IMS — back-office integrations through the Partner API, custom storefronts through the Storefront API, and event-driven sync with signed webhooks.

Getting started

Core concepts

Organizations, channels, products, variants, and how data flows through Foundry.

Authentication & API keys

Key types, roles, per-key permission scopes, and key management.

Roles & permissions

What each user role can see and do, and which role to give warehouse, purchasing, sales and finance staff.

Data & imports

Importing data

Bring supplier and catalog data in via CSV, FTP/FTPS, Google Sheets, or SFTP — with column mapping.

Vendor SFTP feeds

Let suppliers push files to a Foundry-hosted SFTP account, with per-feed logins and filename routing.

Catalog modeling

Categories & brands

Hierarchical categories, brands, slugs, rich descriptions, and manual sort order.

Bundles

Sell a set of SKUs as one — buildable quantity, component reservations at sale, nested kits, costs, and CSV.

Storefront menus & categories

How categories reach each storefront, per-storefront header menus with links and groups, product counts, and auto-hiding.

Custom fields

Your own typed attributes on products, variants, categories, brands, and channel SKUs.

PIM classes & templates

Define what "complete" means per product kind — required fields and channel mappings.

SEO metadata

Meta titles and descriptions with resolved fallbacks and per-channel overrides.

Administration

Activity history & stock timeline

The per-product timeline of stock movements and record changes, the running balance, and who did what.

Trash & recovery

Restore deleted records from the trash, or roll catalog, channel, and settings data back to an hourly snapshot.

API reference

Partner API

The back-office REST API: catalog, orders, purchase orders, stock.

Storefront API

Channel-scoped catalog, inventory checks, and order intake for headless storefronts.

Webhook events

Every subscribable event with example payloads, signatures, and retry behavior.

Accounting

QuickBooks Online

Supplier bills, sales, and inventory value in QuickBooks — every piece optional, configured per channel and per workflow.

Extending Foundry

Connect Claude

Administer your catalog from Claude through the Foundry MCP connector.

Building a partner app

How back-office integrations install into an org with scoped keys and webhook endpoints.

Publishing an app

Sandbox, submission, the automated checks, and what sends a review to a human.

Connecting an app with OAuth

The authorization-code flow that hands your app a scoped token without the merchant touching a credential.

OAuth worked example

A complete TypeScript implementation of the flow, contributed by the first team to build on the marketplace.

Interactive API explorers

Live OpenAPI references with every endpoint, schema, and a “try it” console. The raw OpenAPI 3 documents are at /api/docs/partner-json and /api/docs/public-json — import them into Postman or a client generator.

Partner API explorer →

Admin fims_* keys — catalog, orders, purchase orders, stock, webhooks.

Storefront API explorer →

Storefront fims_sf_* keys — channel-scoped catalog, inventory, orders.

Looking for product how-tos instead?

Day-to-day usage of the Foundry admin — imports, catalog management, fulfillment — lives in the Guides. Platform connectors (BigCommerce, Shopify, Medusa, Throttle) live under Integrations.