List quantities

GET

admin

api

inventories

quantities

List quantities

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

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

fetch('https://erp.arukz.com/admin/api/v1/inventories/quantities', 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/quantities",
  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,
      "quantity": -100,
      "reserved_quantity": 0,
      "counted_quantity": 0,
      "difference_quantity": 0,
      "inventory_diff_quantity": 100,
      "available_quantity": -100,
      "inventory_quantity_set": false,
      "scheduled_at": "2025-12-31T00:00:00.000000Z",
      "incoming_at": "2025-04-10T12:36:39.000000Z",
      "created_at": "2025-04-10T12:36:39.000000Z",
      "updated_at": "2025-04-10T12:36:39.000000Z"
    },
    {
      "id": 1,
      "quantity": -100,
      "reserved_quantity": 0,
      "counted_quantity": 0,
      "difference_quantity": 0,
      "inventory_diff_quantity": 100,
      "available_quantity": -100,
      "inventory_quantity_set": false,
      "scheduled_at": "2025-12-31T00:00:00.000000Z",
      "incoming_at": "2025-04-10T12:36:39.000000Z",
      "created_at": "2025-04-10T12:36:39.000000Z",
      "updated_at": "2025-04-10T12:36:39.000000Z"
    }
  ],
  "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: product, location, storageCategory, lot, package, partner, user, company, creator

Example:

"product,location"

filter[id]

string

Comma-separated list of IDs to filter by

Example:

"architecto"

filter[product_id]

string

Filter by product IDs

Example:

"architecto"

filter[location_id]

string

Filter by location IDs

Example:

"architecto"

filter[lot_id]

string

Filter by lot IDs

Example:

"architecto"

filter[package_id]

string

Filter by package IDs

Example:

"architecto"

filter[inventory_quantity_set]

string

Filter by inventory quantity set (0 or 1)

Example:

"1"

sort

string

Sort field

Example:

"-updated_at"

Response

Success

⌘I

List quantities

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

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

fetch('https://erp.arukz.com/admin/api/v1/inventories/quantities', 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/quantities",
  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,
      "quantity": -100,
      "reserved_quantity": 0,
      "counted_quantity": 0,
      "difference_quantity": 0,
      "inventory_diff_quantity": 100,
      "available_quantity": -100,
      "inventory_quantity_set": false,
      "scheduled_at": "2025-12-31T00:00:00.000000Z",
      "incoming_at": "2025-04-10T12:36:39.000000Z",
      "created_at": "2025-04-10T12:36:39.000000Z",
      "updated_at": "2025-04-10T12:36:39.000000Z"
    },
    {
      "id": 1,
      "quantity": -100,
      "reserved_quantity": 0,
      "counted_quantity": 0,
      "difference_quantity": 0,
      "inventory_diff_quantity": 100,
      "available_quantity": -100,
      "inventory_quantity_set": false,
      "scheduled_at": "2025-12-31T00:00:00.000000Z",
      "incoming_at": "2025-04-10T12:36:39.000000Z",
      "created_at": "2025-04-10T12:36:39.000000Z",
      "updated_at": "2025-04-10T12:36:39.000000Z"
    }
  ],
  "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