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.

​
Overview

The Arcus ERP API reference is auto-generated from arcus-api-v1.yaml. Every endpoint documented here matches the live API exactly — there is no drift between the spec and the documentation.

​
Try it now

Each endpoint page includes a Try it now panel. Enter your API key in the auth panel, fill in the parameters, and click Send to fire a real request against your chosen environment.
The try-it-now console fires requests directly from your browser to the Arcus API. Your API key is stored in browser localStorage scoped to arcuserp.mintlify.app only and is never sent to Mintlify’s servers.

​
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.

​
Authentication

All endpoints require the Authorization header. The entity ID is part of the URL path: 
Authorization: Bearer <api_key>
URL: /v1/entities/{entity_id}/{resource}
See Authentication for key types, scopes, and security guidance.

​
Available resources

ResourceBase pathScopes
Accounts/v1/entities/{entity_id}/accountsaccounts:read, accounts:write
Orders/v1/entities/{entity_id}/ordersorders:read, orders:write
Products/v1/entities/{entity_id}/productsproducts:read, products:write
Inventory/v1/entities/{entity_id}/inventoryinventory:read, inventory:write
Fulfillment/v1/entities/{entity_id}/fulfillmentfulfillment:read, fulfillment:write
Returns/v1/entities/{entity_id}/returnsreturns:read, returns:write
Purchasing/v1/entities/{entity_id}/purchase-orderspurchasing:read, purchasing:write
Payments/v1/entities/{entity_id}/paymentspayments:read, payments:write
Accounting/v1/entities/{entity_id}/accountingaccounting:read, accounting:write
Locations/v1/entities/{entity_id}/locationslocations:read, locations:write
Payment Terms/v1/entities/{entity_id}/payment-termspayment_terms:read, payment_terms:write
Units of Measure/v1/entities/{entity_id}/units-of-measureunits_of_measure:read, units_of_measure:write
Sales Channels/v1/entities/{entity_id}/sales-channelssales_channels:read, sales_channels:write
Pricing Levels/v1/entities/{entity_id}/pricing-levelspricing_levels:read, pricing_levels:write
Product Categories/v1/entities/{entity_id}/product-categoriesproduct_categories:read, product_categories:write
Tags/v1/entities/{entity_id}/tagstags:read, tags:write
Integrations/v1/entities/{entity_id}/integrationsintegrations:read, integrations:write
Webhooks/v1/entities/{entity_id}/webhookswebhooks:read, webhooks:write
Activity/v1/entities/{entity_id}/activityactivity:read
Migration/v1/entities/{entity_id}/migrationsmigrations:read, migrations:write

​
Common patterns

Every endpoint follows the same conventions:
  • List endpoints: GET /v1/entities/{entity_id}/<resource> with cursor pagination (?starting_after=<id>)
  • Retrieve endpoints: GET /v1/entities/{entity_id}/<resource>/:id
  • Create endpoints: POST /v1/entities/{entity_id}/<resource> with Idempotency-Key header
  • Update endpoints: PATCH /v1/entities/{entity_id}/<resource>/:id
  • Delete endpoints: DELETE /v1/entities/{entity_id}/<resource>/:id
See Pagination, Idempotency, and Errors for the full contract.