List serials

Returns a page of serial-tracked units for the calling entity. Honors Layer 4 location scoping via the X-Location-Id header (takes precedence over location_id query). The canonical handler filters inventory.serial_numbers.location_id directly. Page-based pagination (page + per_page); response includes stats + tab_counts aggregates for the UI rail. Requires the serials:read scope.

GET /serials

List serials

cURL

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

import requests

url = "https://api.arcuserp.com/v1/serials"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.arcuserp.com/v1/serials', 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/serials",
  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/serials"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/serials")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/serials")

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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "serial",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "serial_number": "<string>",
      "status": "available",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "package_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lot_number": "<string>",
      "expiry_date": "2023-12-25",
      "warranty_start_date": "2023-11-07T05:31:56Z",
      "warranty_end_date": "2023-11-07T05:31:56Z",
      "extended_warranty_end_date": "2023-11-07T05:31:56Z",
      "warranty_status": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "sold_at": "2023-11-07T05:31:56Z",
      "returned_at": "2023-11-07T05:31:56Z",
      "last_scanned_at": "2023-11-07T05:31:56Z",
      "last_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_package_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_package_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123,
  "stats": {
    "total": 123,
    "available": 123,
    "sold": 123,
    "returned": 123,
    "voided": 123,
    "warranty_expiring": 123,
    "entity_wide_total": 123
  },
  "tab_counts": {}
}

{
  "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

product_id · string<uuid>

status · enum<string>

Available options: available, allocated, sold, returned, dispositioned

location_id · string<uuid>

Layer 4 scope. X-Location-Id header takes precedence.

search · string

Partial serial_number match.

page · integer · default: 1

Required range: x >= 1

per_page · integer · default: 25

Required range: 1 <= x <= 250

Response

200

application/json

Serial list (page envelope)

data · object[]

Show child attributes

total · integer

page · integer

per_page · integer

total_pages · integer

stats · object

Entity-wide aggregates over the filtered set.

Show child attributes

tab_counts · object

Counts for UI tab badges.