Skip to main content
GET
/
bins
/
{id}
Retrieve a bin
curl --request GET \
  --url https://api.arcuserp.com/v1/bins/{id} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/bins/{id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.

Path Parameters

id
string<uuid>
required

Response

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