Queries all items.

Queries all items.

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

import requests

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

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/items', 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/items",
  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/items"

	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/items")

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": [
    {
      "sKU": "<string>",
      "isDeliveryTimeAutomatic": true,
      "salesPriceNet": 123,
      "suggestedRetailPrice": 123,
      "amazonPrice": 123,
      "ebayPrice": 123,
      "buffer": 123,
      "allowNegativeStock": true,
      "isInventoryManagementActive": true,
      "isDivisible": true,
      "hasBatch": true,
      "hasBestBeforeDate": true,
      "isSerialNumberManaged": true,
      "isActive": true,
      "isOnPriceList": true,
      "isTopItem": true,
      "isNew": true,
      "isBillOfMaterials": true,
      "isBillOfMaterialsComponent": true,
      "isVariationParent": true,
      "isVariationChild": true,
      "hasMinimumStock": true,
      "isBlockedForOrderSuggestions": true,
      "isShopActive": true,
      "isOrderProcessProhibited": true,
      "isFulfillmentActive": true,
      "isFulfillmentOwn": true,
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "billOfMaterialsId": 123,
      "parentItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemIdForCategoryItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sortNumber": 123,
      "name": "<string>",
      "unit": "<string>",
      "description": "<string>",
      "shortDescription": "<string>",
      "notes": "<string>",
      "labels": "<string>",
      "series": "<string>",
      "gTIN": "<string>",
      "manufacturerNumber": "<string>",
      "iSBN": "<string>",
      "defaultAsin": "<string>",
      "taricCode": "<string>",
      "uPC": "<string>",
      "uNNumber": "<string>",
      "hazardNumber": "<string>",
      "amazonFnsku": "<string>",
      "jfsku": "<string>",
      "countryOfOrigin": "<string>",
      "manufacturerName": "<string>",
      "deliveryStatus": "<string>",
      "manualDeliveryTimeDays": 123,
      "width": 123,
      "height": 123,
      "length": 123,
      "shippingWeight": 123,
      "weight": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "modifiedTimestamp": "2023-11-07T05:31:56Z",
      "releaseDate": "2023-11-07T05:31:56Z",
      "lastPurchaseDate": "2023-11-07T05:31:56Z",
      "lastEditor": "<string>",
      "salesPriceGross": 123,
      "averagePurchasePriceNet": 123,
      "lastPurchasePrice": 123,
      "profit": 123,
      "profitPercent": 123,
      "specialPriceStatus": 123,
      "basePriceValue": 123,
      "basePriceUnit": "<string>",
      "measurementUnit": "<string>",
      "stockTotal": 123,
      "stockOwn": 123,
      "stockIncoming": 123,
      "stockOnPurchaseList": 123,
      "stockInOrders": 123,
      "stockAvailable": 123,
      "stockReservedTotal": 123,
      "stockInAmazonOffers": 123,
      "ebayStock": 123,
      "minimumOrderQuantity": 123,
      "purchaseInterval": 123,
      "minimumStock": 123,
      "serialNumberTrackingMode": 0,
      "salesPackagingUnit": 123,
      "conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "conditionName": "<string>",
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxClassName": "<string>",
      "manufacturerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "productGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "productGroupName": "<string>",
      "defaultSupplierId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "defaultSupplier": "<string>",
      "shippingClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shippingClassName": "<string>",
      "defaultImageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "additionalProcessingTime": 123,
      "metaDescription": "<string>",
      "titleTag": "<string>",
      "metaKeywords": "<string>",
      "languageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

GET

items

Queries all items.

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

import requests

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

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/items', 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/items",
  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/items"

	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/items")

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": [
    {
      "sKU": "<string>",
      "isDeliveryTimeAutomatic": true,
      "salesPriceNet": 123,
      "suggestedRetailPrice": 123,
      "amazonPrice": 123,
      "ebayPrice": 123,
      "buffer": 123,
      "allowNegativeStock": true,
      "isInventoryManagementActive": true,
      "isDivisible": true,
      "hasBatch": true,
      "hasBestBeforeDate": true,
      "isSerialNumberManaged": true,
      "isActive": true,
      "isOnPriceList": true,
      "isTopItem": true,
      "isNew": true,
      "isBillOfMaterials": true,
      "isBillOfMaterialsComponent": true,
      "isVariationParent": true,
      "isVariationChild": true,
      "hasMinimumStock": true,
      "isBlockedForOrderSuggestions": true,
      "isShopActive": true,
      "isOrderProcessProhibited": true,
      "isFulfillmentActive": true,
      "isFulfillmentOwn": true,
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "billOfMaterialsId": 123,
      "parentItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemIdForCategoryItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sortNumber": 123,
      "name": "<string>",
      "unit": "<string>",
      "description": "<string>",
      "shortDescription": "<string>",
      "notes": "<string>",
      "labels": "<string>",
      "series": "<string>",
      "gTIN": "<string>",
      "manufacturerNumber": "<string>",
      "iSBN": "<string>",
      "defaultAsin": "<string>",
      "taricCode": "<string>",
      "uPC": "<string>",
      "uNNumber": "<string>",
      "hazardNumber": "<string>",
      "amazonFnsku": "<string>",
      "jfsku": "<string>",
      "countryOfOrigin": "<string>",
      "manufacturerName": "<string>",
      "deliveryStatus": "<string>",
      "manualDeliveryTimeDays": 123,
      "width": 123,
      "height": 123,
      "length": 123,
      "shippingWeight": 123,
      "weight": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z",
      "modifiedTimestamp": "2023-11-07T05:31:56Z",
      "releaseDate": "2023-11-07T05:31:56Z",
      "lastPurchaseDate": "2023-11-07T05:31:56Z",
      "lastEditor": "<string>",
      "salesPriceGross": 123,
      "averagePurchasePriceNet": 123,
      "lastPurchasePrice": 123,
      "profit": 123,
      "profitPercent": 123,
      "specialPriceStatus": 123,
      "basePriceValue": 123,
      "basePriceUnit": "<string>",
      "measurementUnit": "<string>",
      "stockTotal": 123,
      "stockOwn": 123,
      "stockIncoming": 123,
      "stockOnPurchaseList": 123,
      "stockInOrders": 123,
      "stockAvailable": 123,
      "stockReservedTotal": 123,
      "stockInAmazonOffers": 123,
      "ebayStock": 123,
      "minimumOrderQuantity": 123,
      "purchaseInterval": 123,
      "minimumStock": 123,
      "serialNumberTrackingMode": 0,
      "salesPackagingUnit": 123,
      "conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "conditionName": "<string>",
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxClassName": "<string>",
      "manufacturerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "productGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "productGroupName": "<string>",
      "defaultSupplierId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "defaultSupplier": "<string>",
      "shippingClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shippingClassName": "<string>",
      "defaultImageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "additionalProcessingTime": 123,
      "metaDescription": "<string>",
      "titleTag": "<string>",
      "metaKeywords": "<string>",
      "languageId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

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

Headers

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Query Parameters

searchTerm

string

The search term.

searchOperator

enum<integer>

The type of search used. 46 = Begins with, 48 = Contains, 50 = Wildcard

Available options:

46,

48,

50

searchField

enum<integer>[]

The fields that will be searched.

0 = SKU, 1 = GTIN, 2 = MPN, 3 = UPC, 4 = ISBN, 5 = Item name, 6 = Container unit GTIN, 7 = ASIN, 8 = SKU (supplier), 9 = Container unit UPC, 10 = FNSKU, 11 = JTL-Fulfillment ID, 12 = Subset ID, 13 = Shop Suchbegriffe

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13

extendedFilter

string

The serialized XML from the extended filter.

pageNumber

integer<int32>

Number of the page of items to fetch. Defaults to 1 when omitted.

pageSize

integer<int32>

Size of the page specified by PageNumber. Defaults to 100 when omitted.

sortBy

string

Property to sort by. Multiple comma-separated fields are applied in order (OrderBy, then ThenBy).

sortDescending

boolean

Sort in descending order. Defaults to ascending when omitted.

createdDateAfter

string<date-time>

Only include items whose CreatedDate is after (greater than) this value.

createdDateBefore

string<date-time>

Only include items whose CreatedDate is before (less than) this value.

modifiedDateAfter

string<date-time>

Only include items whose ModifiedDate is after (greater than) this value.

modifiedDateBefore

string<date-time>

Only include items whose ModifiedDate is before (less than) this value.

modifiedTimestampAfter

string<date-time>

Only include items whose ModifiedTimestamp is after (greater than) this value.

modifiedTimestampBefore

string<date-time>

Only include items whose ModifiedTimestamp is before (less than) this value.

releaseDateAfter

string<date-time>

Only include items whose ReleaseDate is after (greater than) this value.

releaseDateBefore

string<date-time>

Only include items whose ReleaseDate is before (less than) this value.

lastPurchaseDateAfter

string<date-time>

Only include items whose LastPurchaseDate is after (greater than) this value.

lastPurchaseDateBefore

string<date-time>

Only include items whose LastPurchaseDate is before (less than) this value.

Response

Paged result.

totalItems

integer<int32>

required

pageNumber

integer<int32>

required

pageSize

integer<int32>

required

items

object[]

required

Show child attributes

totalPages

integer<int32>

hasPreviousPage

boolean

hasNextPage

boolean

nextPageNumber

integer<int32>

previousPageNumber

integer<int32>

Overview

GraphQL

REST API

Authorizations

Headers

Query Parameters

Response