Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Arcus ERP

​
Welcome

The Arcus ERP Public API is a RESTful HTTP API for reading and writing data across every module of the Arcus platform: accounts, orders, products, inventory, fulfillment, purchasing, payments, returns, accounting, and more. The API is the canonical integration layer for:
  • Data migration — import your existing records from a legacy ERP, QuickBooks, or a spreadsheet
  • External integrations — connect your warehouse management system, 3PL, or BI tool
  • Automation — trigger workflows from external events (Zapier, Make, or bespoke scripts)
  • Custom portals — build customer-facing experiences on top of your Arcus data

Quickstart

Send your first request in under 5 minutes.

Authentication

Create an API key and understand scopes.

API Reference

Every endpoint, every parameter, try-it-now.

SDKs

TypeScript, Python, and Go client libraries.

​
Design principles

The Arcus API follows the same conventions as Stripe, Plaid, and Shopify. If you have used any of those APIs, you will feel at home immediately.
ConventionDescription
RESTStandard HTTP verbs (GET, POST, PATCH, DELETE) on resource paths
JSONEvery request and response body is application/json
Bearer authAuthorization: Bearer <api_key> on every request
Entity scopingEntity ID is part of the URL path: /v1/entities/{entity_id}/{resource}
Cursor pagination?starting_after=<id> for all list endpoints (see Pagination)
Expand?expand[]=customer to hydrate related resources inline (see Expand)
IdempotencyIdempotency-Key: <uuid> for safe retries on POST/PATCH/DELETE (see Idempotency)
VersioningDate-based Arcus-Version: YYYY-MM-DD header (see Versioning)

​
Base URL

All requests go to https://api.arcuserp.com/v1. Test mode vs live mode is determined by your API key prefix (ark_test_* for sandbox data, ark_live_* for production data) — no separate URL required.

​
Need help?

  • Browse the API Reference for endpoint-level details
  • Read Concepts for deep-dives on pagination, errors, webhooks, and more
  • Contact support via the in-app Help button or the Support page