v1
latestOpenAPI 3.0.02026-07-2455104.8 MBProduct
List products V1
Returns a collection with all products.
get/api/v1/products
Query parameters
Response
Operation completed successfully.
Example response
{
"data": [
{
"id": "17",
"uuid": "a00fd11e-3a67-433b-83c0-4e815fd4a0e1",
"project": {
"id": "1337",
"name": "Diamond"
},
"category": {
"id": "1337",
"name": "Diamond"
},
"standardSupplier": {
"id": "12345"
},
"name": "Product one",
"stockCount": 150,
"number": "SKU-0099",
"description": "This is a high-quality product designed for everyday use.",
"internalComment": "This product is seasonal and only available during the summer.",
"shortDescription": "This is a high-quality product designed for everyday use.",
"thumbnailUrl": "https://example.com/images/product-thumbnail.jpg",
"thumbnailId": "thumb-12345",
"minimumOrderQuantity": 10,
"minimumStorageQuantity": 5,
"allowPurchaseFromAllSuppliers": true,
"serialNumbersMode": "mandatory",
"hasBestBeforeDate": true,
"isAssembledJustInTime": true,
"isProductionProduct": true,
"isExternallyProduced": true,
"ageRating": "12+",
"countryOfOrigin": "DE",
"unit": {
"name": "kilogram"
},
"textsAndDescriptions": {
"inCatalog": true,
"primaryLanguage": {
"name": "Produkt eins",
"shortDescription": "Kurze Beschreibung des Produkts.",
"description": "Dies ist eine detaillierte Produktbeschreibung.",
"shopDescription": "Verkaufsbeschreibung für den Shop.",
"metaTitle": "Produkt SEO-Titel",
"metaDescription": "Meta-Beschreibung für das Produkt.",
"metaKeywords": "Produkt, SEO, Keywords",
"catalogName": "Produktkatalogname",
"catalogText": "Detaillierter Katalogtext für das Produkt."
},
"english": {
"name": "Product One",
"shortDescription": "Short description of the product.",
"description": "This is a detailed product description.",
"shopDescription": "Shop description for the product.",
"metaTitle": "Product SEO Title",
"metaDescription": "Meta description for the product.",
"metaKeywords": "product, SEO, keywords",
"catalogName": "Product Catalog Name",
"catalogText": "Detailed catalog text for the product."
}
},
"measurements": {
"width": {
"value": 20,
"unit": "cm"
},
"height": {
"value": 10,
"unit": "cm"
},
"length": {
"value": 30,
"unit": "cm"
},
"weight": {
"value": 2,
"unit": "kg"
},
"netWeight": {
"value": 1.5,
"unit": "kg"
}
},
"isStockItem": true,
"hideJustInTimeItemsOnDocuments": true,
"disabledReason": "Out of stock",
"salesTax": "standard",
"shopPriceDisplay": "19.99",
"ean": "1234567890123",
"manufacturerName": "Test Corp",
"manufacturerNumber": "MN-98765",
"customsTariffNumber": "1234.56.78",
"regionOfOrigin": "04",
"isShippingCostsProduct": true,
"discount": {
"isDiscountProduct": false,
"discountPercentage": 15.5
},
"stockTaking": {
"hasStockTakingValue": true,
"stockTakingValue": 100.75
},
"calculatedPurchasePrice": {
"hasCalculatedPurchasePrice": false,
"price": {
"amount": "13.37",
"currency": "EUR"
}
},
"purchasePriceNet": {
"amount": "13.37",
"currency": "EUR"
},
"purchasePriceGross": {
"amount": "13.37",
"currency": "EUR"
},
"salesPriceNet": {
"amount": "13.37",
"currency": "EUR"
},
"salesPriceGross": {
"amount": "13.37",
"currency": "EUR"
},
"stockStats": {
"purchasedCount": "100.5",
"totalCount": "500.75",
"availableCount": "300.25",
"inProductionCount": "50.0"
},
"freeFields": [
{
"id": "17"
}
],
"tags": [
{
"color": "ff0000"
}
],
"options": [
{
"id": "17",
"values": [
{
"id": "17"
}
]
}
],
"selectedOptions": [
{
"id": "17",
"values": [
{
"id": "17"
}
]
}
],
"variants": [
{
"id": "17",
"options": [
{
"id": "17"
}
]
}
],
"isVariant": true,
"variantOf": {
"id": "parent-product-98765"
},
"updatedAt": "2023-09-23T14:30:00Z"
}
],
"extra": {
"totalCount": 1,
"page": {
"number": 1,
"size": 10
}
}
}