Generate serials (bulk receive)

Bulk-creates serial rows for a product at receive time. Accepts either an explicit list of serials or a count with optional prefix for auto generation. Idempotent on Idempotency-Key. Requires the serials:write scope.

POST /serials

Generate serials (bulk receive)

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/serials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count": 2,
  "prefix": "<string>",
  "serials": [
    "<string>"
  ],
  "lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "received_at": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count": 2,
    "prefix": "<string>",
    "serials": ["<string>"],
    "lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "received_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    count: 2,
    prefix: '<string>',
    serials: ['<string>'],
    lot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    received_at: '2023-11-07T05:31:56Z'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'count' => 2,
    'prefix' => '<string>',
    'serials' => [
        '<string>'
    ],
    'lot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'received_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"count\": 2,\n  \"prefix\": \"<string>\",\n  \"serials\": [\n    \"<string>\"\n  ],\n  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"received_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/serials")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"count\": 2,\n  \"prefix\": \"<string>\",\n  \"serials\": [\n    \"<string>\"\n  ],\n  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"received_at\": \"2023-11-07T05:31:56Z\"\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"count\": 2,\n  \"prefix\": \"<string>\",\n  \"serials\": [\n    \"<string>\"\n  ],\n  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"received_at\": \"2023-11-07T05:31:56Z\"\n}"

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

201

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

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

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

Headers

Idempotency-Key · string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json

product_id · string<uuid> · required

location_id · string<uuid> | null

count · integer

Auto-generate this many serials with optional prefix.

Required range: x >= 1

prefix · string | null

serials · string[]

Explicit list. Mutually exclusive with count + prefix.

lot_id · string<uuid> | null

received_at · string<date-time> | null

Response

201

application/json

Generated serials

data · object[]

Show child attributes