API documentation
Full reference of the main Base.com API methods.
Shops API
Documentation for connecting your own e-commerce platform as a partner.
Two API surfaces
Base exposes two distinct integration surfaces. Understanding which one you need is the first step before writing any code. Main Base.com API (api.baselinker.com) This is the primary API used by the vast majority of integrations. You authenticate with a token and call it from your own system to:
- Download orders from online stores, marketplaces, and manual entries in the Base panel
- Sync product inventory, prices, and catalog data
- Generate shipping labels and retrieve tracking numbers
- Issue or attach invoices
- Read and write order statuses and custom fields
order_source field identifying where it originated: a connected online store, a marketplace such as Amazon or Walmart, or a manual entry. The full list of sources and their IDs is returned by getOrderSources.
Shops API (Partner integration) If you operate an e-commerce platform and want to offer your customers a native Base.com integration, so their Base account can pull orders and sync stock directly from your platform, you connect via the Shops API. In this model, Base calls your server: you implement a defined set of endpoints that Base queries whenever it needs to fetch orders, update stock, or push status changes. This is a partner-level integration and requires activation through Base.
Before you begin
Whichever section you go to next, every call to the main Base.com API shares the same shape. It’s worth having these four things straight before you write your first request.The API enforces a limit of 100 requests per minute per token. Build your sync loops (see Downloading Orders) with this in mind: batch generously, and back off if you receive a rate-limit error rather than retrying immediately.
What’s covered
Orders
Download orders, manage statuses, generate shipping labels, handle invoices, and catch real-time events with webhooks.
Products
Upload product data, sync prices and stock, and manage categories, manufacturers, and multi-warehouse setups.
Returns
Retrieve return records created in Base so your ERP or warehouse system can process refunds and restocking.
Shops API (Partner)
Implement the server-side endpoints that let Base pull orders and sync inventory directly from your e-commerce platform.
Base Analytics
Access sales and operational data from Base to power dashboards, reports, and business intelligence workflows.
Getting help
If you run into a scenario that doesn’t fit neatly into the standard API endpoints, or you’re unsure which integration approach is the right fit for your architecture, contact Base support. They can help you design and validate the integration before you commit to a particular approach, saving significant rework later.