Skip to main content
POST
/
bins
/
{id}
/
products
Assign a product to a bin
curl --request POST \
  --url https://api.arcuserp.com/v1/bins/{id}/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 0,
  "is_default_bin": false,
  "min_quantity": 123,
  "max_quantity": 123
}
'
import requests

url = "https://api.arcuserp.com/v1/bins/{id}/products"

payload = {
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 0,
"is_default_bin": False,
"min_quantity": 123,
"max_quantity": 123
}
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',
quantity: 0,
is_default_bin: false,
min_quantity: 123,
max_quantity: 123
})
};

fetch('https://api.arcuserp.com/v1/bins/{id}/products', 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/bins/{id}/products",
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',
'quantity' => 0,
'is_default_bin' => false,
'min_quantity' => 123,
'max_quantity' => 123
]),
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/bins/{id}/products"

payload := strings.NewReader("{\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 0,\n \"is_default_bin\": false,\n \"min_quantity\": 123,\n \"max_quantity\": 123\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/bins/{id}/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 0,\n \"is_default_bin\": false,\n \"min_quantity\": 123,\n \"max_quantity\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/bins/{id}/products")

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 \"quantity\": 0,\n \"is_default_bin\": false,\n \"min_quantity\": 123,\n \"max_quantity\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "binned_product",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bin_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "is_default_bin": false,
  "min_quantity": 123,
  "max_quantity": 123,
  "last_counted_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"
}

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

Path Parameters

id
string<uuid>
required

Body

application/json
product_id
string<uuid>
required
quantity
number<float>
default:0
is_default_bin
boolean
default:false
min_quantity
number<float> | null
max_quantity
number<float> | null

Response

Created binned-product assignment

A product-bin assignment row, returned by GET /bins/{id}/products and written by POST /bins/{id}/products. Quantity is informational (not the SSOT for inventory_balances). is_default_bin marks the preferred bin for the product within its location. Scope: bins:read / bins:write.

id
string<uuid>
read-only
object
string
Example:

"binned_product"

entity_id
string<uuid>
read-only
bin_id
string<uuid>
product_id
string<uuid>
quantity
number<float>

Optional reported quantity. SSOT for true on-hand is inventory.inventory_balances.

is_default_bin
boolean
default:false
min_quantity
number<float> | null
max_quantity
number<float> | null
last_counted_at
string<date-time> | null
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only