curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/allocate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 2,
"reservation_mode": "firm"
}
]
}
]
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/allocate"
payload = { "lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 2,
"reservation_mode": "firm"
}
]
}
] }
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({
lines: [
{
order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
legs: [
{
location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
qty: 2,
reservation_mode: 'firm'
}
]
}
]
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/allocate', 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/orders/{id}/allocate",
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([
'lines' => [
[
'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'legs' => [
[
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'qty' => 2,
'reservation_mode' => 'firm'
]
]
]
]
]),
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/orders/{id}/allocate"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\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/orders/{id}/allocate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/allocate")
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 \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 123,
"reservation_mode": "firm"
}
]
}
]
}
}Commit a multi-warehouse allocation plan (per-location reservations)
Applies a sourcing plan by creating per-location reservations through the canonical
reservation doorway (each warehouse leg reserves independently; the over-allocation
gate fires per leg). Idempotent: re-running releases any existing reservations for the
order, then re-reserves per the plan. The body may carry an operator-edited plan; if
omitted, the system auto-plan (preferred location first, then most-available) is used
for every physical line. Posts NO journal entry (reservation is not a GL event,
AICPA ASC 606). Requires orders:write scope. Idempotent via the Idempotency-Key
header.
curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/allocate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 2,
"reservation_mode": "firm"
}
]
}
]
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/allocate"
payload = { "lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 2,
"reservation_mode": "firm"
}
]
}
] }
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({
lines: [
{
order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
legs: [
{
location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
qty: 2,
reservation_mode: 'firm'
}
]
}
]
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/allocate', 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/orders/{id}/allocate",
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([
'lines' => [
[
'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'legs' => [
[
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'qty' => 2,
'reservation_mode' => 'firm'
]
]
]
]
]),
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/orders/{id}/allocate"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\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/orders/{id}/allocate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/allocate")
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 \"lines\": [\n {\n \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"legs\": [\n {\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"qty\": 2,\n \"reservation_mode\": \"firm\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qty": 123,
"reservation_mode": "firm"
}
]
}
]
}
}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.
255Path Parameters
Body
Optional operator-edited plan. When omitted, the system auto-plan is used.
Show child attributes
Show child attributes
Response
The committed allocation plan.
Show child attributes
Show child attributes
Was this page helpful?

