Query Stocks Per Item

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/stocks \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/stocks"

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

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

print(response.text)

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

fetch('https://api.jtl-cloud.com/erp/v2/stocks', 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.jtl-cloud.com/erp/v2/stocks",
  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-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v2/stocks"

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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://api.jtl-cloud.com/erp/v2/stocks")

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

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

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

{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "storageLocationName": "<string>",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shelfLifeExpirationDate": "2023-11-07T05:31:56Z",
      "batchNumber": "<string>",
      "quantityTotal": 123,
      "quantityLockedForShipment": 123,
      "quantityLockedForAvailability": 123,
      "quantityInPickingLists": 123
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

{
  "errorCode": "<string>",
  "validationErrors": {},
  "errors": {},
  "errorMessage": "<string>",
  "stacktrace": "<string>"
}

GET

stocks

Query Stocks Per Item

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/stocks \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/stocks"

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

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

print(response.text)

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

fetch('https://api.jtl-cloud.com/erp/v2/stocks', 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.jtl-cloud.com/erp/v2/stocks",
  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-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v2/stocks"

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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://api.jtl-cloud.com/erp/v2/stocks")

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

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

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

{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "warehouseId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "storageLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "storageLocationName": "<string>",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shelfLifeExpirationDate": "2023-11-07T05:31:56Z",
      "batchNumber": "<string>",
      "quantityTotal": 123,
      "quantityLockedForShipment": 123,
      "quantityLockedForAvailability": 123,
      "quantityInPickingLists": 123
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

{
  "errorCode": "<string>",
  "validationErrors": {},
  "errors": {},
  "errorMessage": "<string>",
  "stacktrace": "<string>"
}

Authorizations

Authorization

string

header

required

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

FlowAuthorization Code

Authorization URL: https://auth.jtl-cloud.com/oauth2/auth
Token URL: https://auth.jtl-cloud.com/oauth2/token

Scopes1

inventories.read

Grants permission to read stock levels.

Headers

x-companyid

string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Query Parameters

itemId

string<uuid>

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

warehouseId

string<uuid>

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

storageLocationId

string<uuid>

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

pageNumber

integer<int32>

Number of the page of items to fetch.

pageSize

integer<int32>

Size of the page that is specified by pageNumber.

Response

The requested stock information.

Represents a paginated list of items

totalItems

integer<int32>

required

Gets or sets the total number of items available in the data source.

pageNumber

integer<int32>

required

Gets or sets the current page number in the paginated list.

pageSize

integer<int32>

required

Gets or sets the number of items per page in the paginated list.

items

object[]

required

Gets or sets the collection of items contained in the paged list.

Show child attributes

totalPages

integer<int32>

Gets the total number of pages based on the total number of items and the page size.

hasPreviousPage

boolean

Gets a value indicating whether there is a previous page available in the paginated list.

hasNextPage

boolean

Gets a value indicating whether there is a next page available.

nextPageNumber

integer<int32>

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

previousPageNumber

integer<int32>

Gets the number of the previous page. If there is no previous page, it returns 1.

Overview

GraphQL

REST API

Query Stocks Per Item

Authorizations

Headers

Query Parameters

Response