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

# Postman Collection

> Download the official Arcus ERP Postman collection for every API endpoint.

## Download

The Arcus ERP Postman collection is auto-generated from `arcus-api-v1.yaml` and updated on every spec change. It includes every endpoint pre-configured with environment variables, example request bodies, and test scripts.

<Card title="Download Postman Collection" icon="download" href="/postman-collection.json">
  Click to download `arcus-erp-v1.postman_collection.json`
</Card>

Alternatively, download from **Settings > Developers > Collections** in the Arcus app.

## Import into Postman

1. Open Postman and click **Import**
2. Select the downloaded JSON file
3. Postman imports the collection with all endpoints organized by resource

## Set up your environment

Create a Postman environment with these variables:

| Variable          | Value                                     |
| ----------------- | ----------------------------------------- |
| `ARCUS_API_KEY`   | Your API key (from Settings > Developers) |
| `ARCUS_ENTITY_ID` | Your entity UUID                          |
| `ARCUS_BASE_URL`  | `https://api.arcuserp.com/v1`             |

The collection uses `{{ARCUS_BASE_URL}}`, `{{ARCUS_API_KEY}}`, and `{{ARCUS_ENTITY_ID}}` placeholders throughout. Use `ark_test_*` keys for sandbox data and `ark_live_*` keys for production data.

## What is included

* Every endpoint (accounts, orders, products, inventory, fulfillment, returns, purchasing, payments, accounting, master data, integrations, webhooks)
* Pre-filled example request bodies with realistic data
* Collection-level pre-request scripts that auto-set `Idempotency-Key` on mutating requests
* Test scripts that assert `2xx` status and validate response shapes
* Pre-configured environment template pointing to `https://api.arcuserp.com/v1`

## Keeping it current

The collection is regenerated on every merge to `main` that touches the OpenAPI spec. Download a fresh copy from the Arcus app when you need the latest endpoints.