Link a serial to a lot for traceability

Attaches the serial to a lot (same entity, same product). Used for compliance and recall traceability. Requires the serials:write scope.

POST /serials/{id}/link-lot

Link a serial to a lot for traceability

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/serials/{id}/link-lot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.arcuserp.com/v1/serials/{id}/link-lot"

payload = { "lot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
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({lot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.arcuserp.com/v1/serials/{id}/link-lot', 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/{id}/link-lot",
  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([
    'lot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/{id}/link-lot"

	payload := strings.NewReader("{\n  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/{id}/link-lot")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/serials/{id}/link-lot")

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  \"lot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

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

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.

Path Parameters

id · string<uuid> · required

Body

application/json

lot_id · string<uuid> · required

Response

200

application/json

Linked serial

A serial-tracked unit of a product. Created in bulk by generateSerials at purchase-order receipt (status available) and walks the lifecycle available -> allocated -> sold -> returned -> dispositioned. The disposition action records a terminal outcome (restock, write_off, return_to_vendor) and the link-lot action attaches the serial to a lot for traceability. Scope: serials:read / serials:write / serials:delete. Rule 23 SSOT: status is written only by canonical generateSerials / allocateSerial / consumeSerial / receiveSerialReturn / dispositionSerial.

id · string<uuid> · read-only

object · string

Example:

"serial"

entity_id · string<uuid> · read-only

product_id · string<uuid>

serial_number · string

Unique-per-product serial value. 1..255 chars.

status · enum<string>

Lifecycle state. See enum serial_status.

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

Example:

"available"

location_id · string<uuid> | null

Layer 4 location scope; serials are warehouse-bound.

order_id · string<uuid> | null

Current allocation/sale order, if any.

order_item_id · string<uuid> | null

package_id · string<uuid> | null

Current outbound package, if any.

package_item_id · string<uuid> | null

lot_id · string<uuid> | null

Linked lot for traceability; null if not lot-tracked.

lot_number · string | null

Convenience copy of lots.lot_code at link time; lot_id is the FK.

expiry_date · string<date> | null

warranty_start_date · string<date-time> | null

warranty_end_date · string<date-time> | null

extended_warranty_end_date · string<date-time> | null

warranty_status · string | null

active, expired, voided.

received_at · string<date-time> | null · read-only

sold_at · string<date-time> | null · read-only

returned_at · string<date-time> | null · read-only

last_scanned_at · string<date-time> | null · read-only

last_order_id · string<uuid> | null · read-only

Previous allocation; preserved through return cycles.

last_order_item_id · string<uuid> | null · read-only

last_package_id · string<uuid> | null · read-only

last_package_item_id · string<uuid> | null · read-only

notes · string | null

created_at · string<date-time> · read-only