Transition serial number status
curl --request PATCH \
--url https://api.arcuserp.com/v1/inventory/serials/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"warranty_status": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/inventory/serials/{id}"
payload = {
"reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"warranty_status": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reason: '<string>',
location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lot_number: '<string>',
warranty_start_date: '2023-12-25',
warranty_end_date: '2023-12-25',
extended_warranty_end_date: '2023-12-25',
warranty_status: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/inventory/serials/{id}', 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/inventory/serials/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>',
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lot_number' => '<string>',
'warranty_start_date' => '2023-12-25',
'warranty_end_date' => '2023-12-25',
'extended_warranty_end_date' => '2023-12-25',
'warranty_status' => '<string>'
]),
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/inventory/serials/{id}"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/inventory/serials/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/inventory/serials/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"serial_number": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"expiry_date": "2023-12-25",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"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",
"created_at": "2023-11-07T05:31:56Z",
"updated_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"
}{
"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"
}Inventory
Transition serial number status
Status transition matrix: available -> quarantined, damaged, end_of_life, disassembled, allocated allocated -> available (release), sold sold -> returned returned -> available, damaged, quarantined, end_of_life damaged -> quarantined, end_of_life quarantined -> available, damaged, end_of_life end_of_life -> (terminal) consumed_in_manufacturing -> (terminal) disassembled -> available (re-receive) Invalid transition: 422 invalid_serial_transition. Immutable fields (id, product_id, serial_number, etc.) return 400 field_not_writable. GL: none.
PATCH
/
inventory
/
serials
/
{id}
Transition serial number status
curl --request PATCH \
--url https://api.arcuserp.com/v1/inventory/serials/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"warranty_status": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/inventory/serials/{id}"
payload = {
"reason": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"warranty_status": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reason: '<string>',
location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lot_number: '<string>',
warranty_start_date: '2023-12-25',
warranty_end_date: '2023-12-25',
extended_warranty_end_date: '2023-12-25',
warranty_status: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/inventory/serials/{id}', 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/inventory/serials/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>',
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lot_number' => '<string>',
'warranty_start_date' => '2023-12-25',
'warranty_end_date' => '2023-12-25',
'extended_warranty_end_date' => '2023-12-25',
'warranty_status' => '<string>'
]),
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/inventory/serials/{id}"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/inventory/serials/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/inventory/serials/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot_number\": \"<string>\",\n \"warranty_start_date\": \"2023-12-25\",\n \"warranty_end_date\": \"2023-12-25\",\n \"extended_warranty_end_date\": \"2023-12-25\",\n \"warranty_status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"serial_number": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot_number": "<string>",
"expiry_date": "2023-12-25",
"warranty_start_date": "2023-12-25",
"warranty_end_date": "2023-12-25",
"extended_warranty_end_date": "2023-12-25",
"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",
"created_at": "2023-11-07T05:31:56Z",
"updated_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"
}{
"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
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
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:
255Path Parameters
Body
application/json
Available options:
available, allocated, sold, returned, damaged, quarantined, end_of_life, consumed_in_manufacturing, disassembled Response
Updated serial number
Serial number with lifecycle status. Immutable: id, entity_id, product_id, serial_number.
Show child attributes
Show child attributes
Was this page helpful?
⌘I