Skip to main content
PATCH
/
bins
/
{id}
Update a bin
curl --request PATCH \
  --url https://api.arcuserp.com/v1/bins/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bin_code": "<string>",
  "zone": "<string>",
  "aisle": "<string>",
  "shelf": "<string>",
  "rack": "<string>",
  "position": "<string>",
  "bin_type": "<string>",
  "is_default": true,
  "sort_order": 123,
  "max_weight": 123,
  "max_volume": 123
}
'
import requests

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

payload = {
    "bin_code": "<string>",
    "zone": "<string>",
    "aisle": "<string>",
    "shelf": "<string>",
    "rack": "<string>",
    "position": "<string>",
    "bin_type": "<string>",
    "is_default": True,
    "sort_order": 123,
    "max_weight": 123,
    "max_volume": 123
}
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({
    bin_code: '<string>',
    zone: '<string>',
    aisle: '<string>',
    shelf: '<string>',
    rack: '<string>',
    position: '<string>',
    bin_type: '<string>',
    is_default: true,
    sort_order: 123,
    max_weight: 123,
    max_volume: 123
  })
};

fetch('https://api.arcuserp.com/v1/bins/{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/bins/{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([
    'bin_code' => '<string>',
    'zone' => '<string>',
    'aisle' => '<string>',
    'shelf' => '<string>',
    'rack' => '<string>',
    'position' => '<string>',
    'bin_type' => '<string>',
    'is_default' => true,
    'sort_order' => 123,
    'max_weight' => 123,
    'max_volume' => 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}"

	payload := strings.NewReader("{\n  \"bin_code\": \"<string>\",\n  \"zone\": \"<string>\",\n  \"aisle\": \"<string>\",\n  \"shelf\": \"<string>\",\n  \"rack\": \"<string>\",\n  \"position\": \"<string>\",\n  \"bin_type\": \"<string>\",\n  \"is_default\": true,\n  \"sort_order\": 123,\n  \"max_weight\": 123,\n  \"max_volume\": 123\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/bins/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bin_code\": \"<string>\",\n  \"zone\": \"<string>\",\n  \"aisle\": \"<string>\",\n  \"shelf\": \"<string>\",\n  \"rack\": \"<string>\",\n  \"position\": \"<string>\",\n  \"bin_type\": \"<string>\",\n  \"is_default\": true,\n  \"sort_order\": 123,\n  \"max_weight\": 123,\n  \"max_volume\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/bins/{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  \"bin_code\": \"<string>\",\n  \"zone\": \"<string>\",\n  \"aisle\": \"<string>\",\n  \"shelf\": \"<string>\",\n  \"rack\": \"<string>\",\n  \"position\": \"<string>\",\n  \"bin_type\": \"<string>\",\n  \"is_default\": true,\n  \"sort_order\": 123,\n  \"max_weight\": 123,\n  \"max_volume\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "bin",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bin_code": "<string>",
  "zone": "<string>",
  "aisle": "<string>",
  "shelf": "<string>",
  "rack": "<string>",
  "position": "<string>",
  "bin_type": "storage",
  "is_active": true,
  "is_default": false,
  "sort_order": 0,
  "max_weight": 123,
  "max_volume": 123,
  "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"
}

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
bin_code
string
zone
string | null
aisle
string | null
shelf
string | null
rack
string | null
position
string | null
bin_type
string | null
is_default
boolean
sort_order
integer
max_weight
number<float> | null
max_volume
number<float> | null

Response

Updated bin

A warehouse bin location (zone/aisle/shelf/rack/position addressable). Bins belong to a location_id (Layer 4 scope). Deactivate is the soft-delete path; restore is the reverse. The sub-resource /bins/{id}/products tracks product-bin assignments (binned_products), where each row carries quantity and an is_default_bin flag. Scope: bins:read / bins:write / bins:delete.

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

"bin"

entity_id
string<uuid>
read-only
location_id
string<uuid>

Layer 4 warehouse scope. Required.

bin_code
string

Operator-defined code unique per location. 1..50 chars.

zone
string | null
aisle
string | null
shelf
string | null
rack
string | null
position
string | null
bin_type
string | null

Bin role hint (storage, pick, receiving, staging, etc.). Default storage.

Example:

"storage"

is_active
boolean
default:true

False = deactivated. Restore flips back to true.

is_default
boolean
default:false

Marks the default bin for the location. At most one per location.

sort_order
integer
default:0
max_weight
number<float> | null

Optional capacity hint (lb).

max_volume
number<float> | null

Optional capacity hint (cubic in).

created_at
string<date-time>
read-only