Create a lot

curl --request POST \
  --url https://api.arcuserp.com/v1/lots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lot_code": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manufacture_date": "2023-12-25",
  "expiration_date": "2023-12-25",
  "received_at": "2023-11-07T05:31:56Z",
  "cost": 123,
  "quantity_received": 0,
  "notes": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lot_code": "<string>",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manufacture_date": "2023-12-25",
    "expiration_date": "2023-12-25",
    "received_at": "2023-11-07T05:31:56Z",
    "cost": 123,
    "quantity_received": 0,
    "notes": "<string>",
    "metadata": {}
}
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',
    lot_code: '<string>',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manufacture_date: '2023-12-25',
    expiration_date: '2023-12-25',
    received_at: '2023-11-07T05:31:56Z',
    cost: 123,
    quantity_received: 0,
    notes: '<string>',
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/lots', 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/lots",
  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',
    'lot_code' => '<string>',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manufacture_date' => '2023-12-25',
    'expiration_date' => '2023-12-25',
    'received_at' => '2023-11-07T05:31:56Z',
    'cost' => 123,
    'quantity_received' => 0,
    'notes' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/lots"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\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/lots")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "lot",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lot_code": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manufacture_date": "2023-12-25",
  "expiration_date": "2023-12-25",
  "received_at": "2023-11-07T05:31:56Z",
  "cost": 123,
  "quantity_received": 123,
  "quantity_on_hand": 123,
  "quantity_consumed": 123,
  "quantity_written_off": 123,
  "status": "active",
  "notes": "<string>",
  "external_source": "<string>",
  "external_id": "<string>",
  "metadata": {},
  "inventory_summary": {
    "on_hand": 123
  },
  "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"
}

POST

lots

Create a lot

curl --request POST \
  --url https://api.arcuserp.com/v1/lots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lot_code": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manufacture_date": "2023-12-25",
  "expiration_date": "2023-12-25",
  "received_at": "2023-11-07T05:31:56Z",
  "cost": 123,
  "quantity_received": 0,
  "notes": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lot_code": "<string>",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manufacture_date": "2023-12-25",
    "expiration_date": "2023-12-25",
    "received_at": "2023-11-07T05:31:56Z",
    "cost": 123,
    "quantity_received": 0,
    "notes": "<string>",
    "metadata": {}
}
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',
    lot_code: '<string>',
    vendor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manufacture_date: '2023-12-25',
    expiration_date: '2023-12-25',
    received_at: '2023-11-07T05:31:56Z',
    cost: 123,
    quantity_received: 0,
    notes: '<string>',
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/lots', 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/lots",
  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',
    'lot_code' => '<string>',
    'vendor_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manufacture_date' => '2023-12-25',
    'expiration_date' => '2023-12-25',
    'received_at' => '2023-11-07T05:31:56Z',
    'cost' => 123,
    'quantity_received' => 0,
    'notes' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/lots"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\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/lots")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"lot_code\": \"<string>\",\n  \"vendor_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manufacture_date\": \"2023-12-25\",\n  \"expiration_date\": \"2023-12-25\",\n  \"received_at\": \"2023-11-07T05:31:56Z\",\n  \"cost\": 123,\n  \"quantity_received\": 0,\n  \"notes\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "lot",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lot_code": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manufacture_date": "2023-12-25",
  "expiration_date": "2023-12-25",
  "received_at": "2023-11-07T05:31:56Z",
  "cost": 123,
  "quantity_received": 123,
  "quantity_on_hand": 123,
  "quantity_consumed": 123,
  "quantity_written_off": 123,
  "status": "active",
  "notes": "<string>",
  "external_source": "<string>",
  "external_id": "<string>",
  "metadata": {},
  "inventory_summary": {
    "on_hand": 123
  },
  "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"
}

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

lot_code

string

required

1..100 chars.

vendor_id

string<uuid> | null

manufacture_date

string<date> | null

expiration_date

string<date> | null

received_at

string<date-time> | null

cost

number<float> | null

quantity_received

number<float>

default:0

notes

string | null

metadata

object | null

Response

Created lot

A lot-tracked production batch of a product. Created when receiving lot- tracked inventory and consumed via FEFO (first-expiry-first-out) at allocation time. Status walks active -> on_hold -> expired -> recalled via the change-status endpoint. Soft-delete refuses when quantity_on_hand > 0 (HTTP 409). Scope: lots:read / lots:write / lots:delete. Rule 23 SSOT: quantity_on_hand is written only by canonical inventory_transactions postings; the API never writes it directly.

string<uuid>

read-only

object

string

Example:

"lot"

entity_id

string<uuid>

read-only

product_id

string<uuid>

lot_code

string

Operator-supplied or vendor-supplied lot identifier. 1..100 chars.

vendor_id

string<uuid> | null

manufacture_date

string<date> | null

expiration_date

string<date> | null

received_at

string<date-time> | null

cost

number<float> | null

Per-unit landed cost at receipt (USD).

quantity_received

number<float>

Original receive quantity. Immutable after creation.

quantity_on_hand

number<float>

read-only

Current on-hand. SSOT: derived via inventory_transactions.

quantity_consumed

number<float>

read-only

quantity_written_off

number<float>

read-only

status

enum<string>

Lifecycle state. Changed via POST /lots/{id}/change-status with mandatory reason.

Available options:

active,

on_hold,

expired,

recalled

Example:

"active"

notes

string | null

external_source

string | null

Migration provenance (e.g. versa, bubble).

external_id

string | null

metadata

object

Free-form caller metadata. Default {}.

inventory_summary

object

read-only

Computed aggregate joined on lot_id from inventory.inventory_transactions. Only on GET /lots/{id}, not on list.

Show child attributes

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

List lots Retrieve a lot (with inventory summary)

Overview

All Endpoints

Create a lot

Authorizations

Headers

Body

Response