Get stock overview

GET

stocks

overview

Get stock overview

curl --request GET \
  --url https://dev.flextell.ai/api/v1/stocks/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'

import requests

url = "https://dev.flextell.ai/api/v1/stocks/overview"

headers = {
    "X-Tenant": "<x-tenant>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Tenant': '<x-tenant>', Authorization: 'Bearer <token>'}
};

fetch('https://dev.flextell.ai/api/v1/stocks/overview', 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://dev.flextell.ai/api/v1/stocks/overview",
  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>",
    "X-Tenant: <x-tenant>"
  ],
]);

$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://dev.flextell.ai/api/v1/stocks/overview"

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

	req.Header.Add("X-Tenant", "<x-tenant>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dev.flextell.ai/api/v1/stocks/overview")

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

request = Net::HTTP::Get.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "product": {
        "id": 123,
        "name": "<string>"
      },
      "warehouse": {
        "id": 123,
        "name": "<string>"
      },
      "balance": 123,
      "unit_label": "<string>",
      "critical_stock_level": 123
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant

number

required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

warehouse_id

integer | null

Filter by warehouse ID.

Required range: x >= 1

brand_id

integer | null

Filter by product brand ID.

Required range: x >= 1

base_unit_code_id

integer | null

Filter by base unit code ID.

Required range: x >= 1

base_unit

integer | null

Alias of base_unit_code_id (filter by base unit code ID).

Required range: x >= 1

stock_status

enum<string> | null

Filter by stock status (normal, low, critical).

Available options:

normal,

low,

critical

per_page

integer | null

The number of items per page.

Required range: 1 <= x <= 100

page

integer | null

The page number.

Required range: x >= 1

sort_by

enum<string> | null

The field to sort by.

Available options:

product_name,

warehouse_name,

balance,

stock_status,

critical_stock_level

sort_order

enum<string> | null

The sort direction (asc or desc).

Available options:

asc,

desc

Response

Paginated set of StockOverviewResource

data

StockOverviewResource · object[]

required

Show child attributes

links

object

required

Show child attributes

meta

object

required

Show child attributes

Get stock overview

curl --request GET \
  --url https://dev.flextell.ai/api/v1/stocks/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'

import requests

url = "https://dev.flextell.ai/api/v1/stocks/overview"

headers = {
    "X-Tenant": "<x-tenant>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Tenant': '<x-tenant>', Authorization: 'Bearer <token>'}
};

fetch('https://dev.flextell.ai/api/v1/stocks/overview', 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://dev.flextell.ai/api/v1/stocks/overview",
  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>",
    "X-Tenant: <x-tenant>"
  ],
]);

$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://dev.flextell.ai/api/v1/stocks/overview"

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

	req.Header.Add("X-Tenant", "<x-tenant>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dev.flextell.ai/api/v1/stocks/overview")

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

request = Net::HTTP::Get.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "product": {
        "id": 123,
        "name": "<string>"
      },
      "warehouse": {
        "id": 123,
        "name": "<string>"
      },
      "balance": 123,
      "unit_label": "<string>",
      "critical_stock_level": 123
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}