List locations

GET

admin

api

inventories

locations

List locations

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/inventories/locations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/inventories/locations', 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://erp.arukz.com/admin/api/v1/inventories/locations",
  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;
}

{
  "data": [
    {
      "id": 1,
      "name": "Physical Locations",
      "full_name": "Physical Locations",
      "description": null,
      "parent_path": "1/",
      "barcode": null,
      "type": "view",
      "position_x": 0,
      "position_y": 0,
      "position_z": 0,
      "removal_strategy": null,
      "cyclic_inventory_frequency": 0,
      "last_inventory_date": null,
      "next_inventory_date": null,
      "is_scrap": false,
      "is_replenish": false,
      "is_dock": false,
      "created_at": "2025-04-07T13:12:33.000000Z",
      "updated_at": "2025-04-07T13:12:33.000000Z",
      "deleted_at": null
    },
    {
      "id": 1,
      "name": "Physical Locations",
      "full_name": "Physical Locations",
      "description": null,
      "parent_path": "1/",
      "barcode": null,
      "type": "view",
      "position_x": 0,
      "position_y": 0,
      "position_z": 0,
      "removal_strategy": null,
      "cyclic_inventory_frequency": 0,
      "last_inventory_date": null,
      "next_inventory_date": null,
      "is_scrap": false,
      "is_replenish": false,
      "is_dock": false,
      "created_at": "2025-04-07T13:12:33.000000Z",
      "updated_at": "2025-04-07T13:12:33.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Query Parameters

include

string

Comma-separated list of relationships to include.

Available options: parent, children, storageCategory, warehouse, company, creator

Example:

"parent,storageCategory"

filter[id]

string

Comma-separated list of IDs to filter by

Example:

"architecto"

filter[name]

string

Filter by location name

Example:

"Stock"

filter[full_name]

string

Filter by full location name

Example:

"WH/Stock"

filter[type]

string

Filter by location types

Example:

"internal"

filter[barcode]

string

Filter by barcode

Example:

"LOC-01"

filter[parent_id]

string

Filter by parent location IDs

Example:

"architecto"

filter[storage_category_id]

string

Filter by storage category IDs

Example:

"architecto"

filter[warehouse_id]

string

Filter by warehouse IDs

Example:

"architecto"

filter[company_id]

string

Filter by company IDs

Example:

"architecto"

sort

string

Sort field

Example:

"-created_at"

Response

Success

⌘I

List locations

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/inventories/locations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/inventories/locations', 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://erp.arukz.com/admin/api/v1/inventories/locations",
  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;
}

{
  "data": [
    {
      "id": 1,
      "name": "Physical Locations",
      "full_name": "Physical Locations",
      "description": null,
      "parent_path": "1/",
      "barcode": null,
      "type": "view",
      "position_x": 0,
      "position_y": 0,
      "position_z": 0,
      "removal_strategy": null,
      "cyclic_inventory_frequency": 0,
      "last_inventory_date": null,
      "next_inventory_date": null,
      "is_scrap": false,
      "is_replenish": false,
      "is_dock": false,
      "created_at": "2025-04-07T13:12:33.000000Z",
      "updated_at": "2025-04-07T13:12:33.000000Z",
      "deleted_at": null
    },
    {
      "id": 1,
      "name": "Physical Locations",
      "full_name": "Physical Locations",
      "description": null,
      "parent_path": "1/",
      "barcode": null,
      "type": "view",
      "position_x": 0,
      "position_y": 0,
      "position_z": 0,
      "removal_strategy": null,
      "cyclic_inventory_frequency": 0,
      "last_inventory_date": null,
      "next_inventory_date": null,
      "is_scrap": false,
      "is_replenish": false,
      "is_dock": false,
      "created_at": "2025-04-07T13:12:33.000000Z",
      "updated_at": "2025-04-07T13:12:33.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Get started

Endpoints

Authorizations

Query Parameters

Response