Skip to main content
GET
/
v1
/
inventory
/
groups
List inventory groups
curl --request GET \
  --url http://localhost:3000/v1/inventory/groups
import requests

url = "http://localhost:3000/v1/inventory/groups"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/inventory/groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/inventory/groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "http://localhost:3000/v1/inventory/groups"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/inventory/groups")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/inventory/groups")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "location_code": "<string>",
      "zone_code": "<string>",
      "aisle_number": 123,
      "bay_number": 123,
      "shelf_number": 123,
      "slot_number": 123,
      "parent_group_id": "<string>",
      "is_active": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>"
    }
  ]
}

Query Parameters

type
enum<string>
default:all

Filter by group type

Available options:
aisle,
bay,
shelf,
slot,
all
Example:

"slot"

zone
string

Filter by zone code

Example:

"A"

aisle
integer | null

Filter by aisle number

Example:

1

parent_id
string<uuid>

Filter by parent group ID

Response

200 - application/json

List of inventory groups

groups
object[]
required