Query Items By Category Id
curl --request GET \
--url https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/items \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <x-tenant-id>'import requests
url = "https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/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/categories/{categoryId}/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/categories/{categoryId}/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/categories/{categoryId}/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))
}HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/items")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/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",
"defaultImageUrl": "<string>",
"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
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}Item
Query Items By Category Id
Queries the items of a category. By default only items that are directly assigned to the category are returned; with “includeSubcategories”, items assigned to any of its subcategories, including nested ones, are returned as well. Each item is returned once, even if it is assigned to several of these categories. Inactive categories are included. A category without items returns an empty list; an unknown category returns 404 Not Found. The items are ordered by their ID.
Paged query. Query parameters: pageNumber (default 1), pageSize (default 100). Date filtering per date field via After (greater than) and Before (less than).
GET
/
v2
/
categories
/
{categoryId}
/
items
Query Items By Category Id
curl --request GET \
--url https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/items \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <x-tenant-id>'import requests
url = "https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/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/categories/{categoryId}/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/categories/{categoryId}/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/categories/{categoryId}/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))
}HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/items")
.header("x-tenant-id", "<x-tenant-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jtl-cloud.com/erp/v2/categories/{categoryId}/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",
"defaultImageUrl": "<string>",
"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
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}{
"type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"instance": "/api/route",
"traceId": "0HMPNHL0JHL76:00000001",
"detail": "<string>",
"errors": [
{
"name": "Error or field name",
"reason": "Error reason",
"code": "<string>",
"severity": "<string>"
}
]
}Authorizations
oauth2-authorization-codeoauth2-client-credentials
Scopes
Path Parameters
Query Parameters
Was this page helpful?