List purchase orders

curl --request GET \
  --url https://api.arcuserp.com/v1/purchase-orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/purchase-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/purchase-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/purchase-orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/purchase-orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "purchase_order",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "po_number": "<string>",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "draft",
      "po_date": "2023-11-07T05:31:56Z",
      "expected_date": "2023-11-07T05:31:56Z",
      "subtotal": 123,
      "tax_total": 123,
      "shipping_total": 123,
      "po_total": 123,
      "currency": "USD",
      "notes": "<string>",
      "internal_notes": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "approved_total": 123,
      "approval_stale": true,
      "header_editability": {},
      "billed_total": 123,
      "unbilled_balance": 123
    }
  ],
  "has_more": true
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Purchasing

List purchase orders

Returns a paginated list of purchase orders for the entity. Supports filtering by vendor_id, status (canonical order_status values OR comma-separated multi-value), location_id, created_after, and created_before. Results are cursor-paginated using starting_after. This is the dedicated PO resource; prefer this over the orders-family GET /orders/purchase-orders. Requires purchasing:read scope.

status filter — accepted values (canonical): draft, open, processing, fulfilled, cancelled, archived, expired, awaiting_ach_clearance. Pass a single value (status=open) or comma-separated for multi (status=open,processing). The sentinel all returns every row (no status filter).

status filter — legacy aliases (translated server-side, accepted for backward compatibility): sent -> open, partially_received -> processing, received -> fulfilled, closed -> archived, on_hold -> awaiting_ach_clearance. New integrations SHOULD use canonical values.

Unknown status tokens return HTTP 400 invalid_status with the list of accepted canonical + alias values in the hint field.

GET

purchase-orders

List purchase orders

curl --request GET \
  --url https://api.arcuserp.com/v1/purchase-orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/purchase-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/purchase-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/purchase-orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/purchase-orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "purchase_order",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "po_number": "<string>",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "draft",
      "po_date": "2023-11-07T05:31:56Z",
      "expected_date": "2023-11-07T05:31:56Z",
      "subtotal": 123,
      "tax_total": 123,
      "shipping_total": 123,
      "po_total": 123,
      "currency": "USD",
      "notes": "<string>",
      "internal_notes": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "approved_total": 123,
      "approval_stale": true,
      "header_editability": {},
      "billed_total": 123,
      "unbilled_balance": 123
    }
  ],
  "has_more": true
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Query Parameters

status

string

Single canonical status, comma-separated multi-value, or all. Accepts canonical order_status ENUM values and 5 legacy aliases (translated server-side).

Example:

"open,processing"

vendor_id

string<uuid>

UUID of the vendor account. Canonical filter name.

account_id

string<uuid>

Legacy alias for vendor_id. Vendor records are account rows so both keys refer to the same vendor account UUID. If both are provided with different values, vendor_id wins and a server-side warning is logged. New integrations SHOULD use vendor_id.

limit

integer

default:25

Required range: x <= 100

starting_after

string

expand[]

enum<string>[]

Available options:

data.line_items,

data.line_items.product,

data.vendor,

data.receipts,

data.bills

Response

Paginated list of purchase orders

object

enum<string>

Available options:

list

data

object[]

Show child attributes

has_more

boolean

Overview

All Endpoints

List purchase orders

Authorizations

Query Parameters

Response