v1
latestOpenAPI 3.0.02026-07-2455104.8 MBProduct
View product V2
Returns details of a single product
get/api/v2/products/{id}
Path parameters
idstring required
Resource identifier.
Example:17
The resource's identifier.
Response
Operation completed successfully.
Example response
{
"data": {
"id": "1",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"project": {
"id": "1",
"name": "Project1"
},
"merchandiseGroup": null,
"name": "Sample Product",
"standardSupplier": null,
"description": "This is a high-quality product designed for everyday use.",
"ean": "1234567890123",
"stockCount": 150,
"number": "SKU123456",
"thumbnailUrl": "https://www.example.com/images/thumbnail.jpg",
"thumbnailId": "thumb-001",
"customsTariffNumber": "1234.56.78",
"countryOfOrigin": "DE",
"tags": [],
"shortDescription": "A compact and efficient product for everyday use.",
"internalComment": "Handle with care.",
"minimumStorageQuantity": 50,
"minimumOrderQuantity": 10,
"isMatrixProduct": true,
"hasBatches": false,
"serialNumbersMode": "mandatory",
"hasBestBeforeDate": true,
"allowPurchaseFromAllSuppliers": false,
"isStockTakingDisabled": false,
"ageRating": "12+",
"hasBillOfMaterials": true,
"isProductionProduct": true,
"isExternallyProduced": false,
"isCustomProduct": true,
"isAssembledJustInTime": false,
"hideJustInTimeItemsOnDocuments": true,
"isDisabled": false,
"disabledReason": "Product is under review.",
"isDeleted": false,
"regionOfOrigin": "London, UK",
"unit": {
"name": "Kilogram"
},
"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"
}
},
"manufacturer": {
"name": "Test Corp",
"number": "AC12345",
"link": "https://www.testcorp.com"
},
"isStockItem": true,
"salesTax": "reduced",
"isShippingCostsProduct": false,
"discount": {
"isDiscountProduct": true,
"discountPercentage": 15.15
},
"stockTaking": {
"hasStockTakingValue": true,
"stockTakingValue": 100.75
},
"calculatedPurchasePrice": {
"hasCalculatedPurchasePrice": false,
"price": {
"amount": "13.37",
"currency": "EUR"
}
},
"calculatoryPurchasePriceSettings": {
"addPurchasePriceToCalculationTriggers": [
"onPurchaseOrderCompletion"
],
"calculatoryPurchasePriceRecalculationTriggers": [
"onPurchaseOrderCompletion"
],
"calculatoryPurchasePriceRecalculationMethod": "latestPurchaseOrdersWeightedAverage"
},
"salesChannel": {
"description": "A high-quality product.",
"meta": {
"title": "Sample Product Title",
"description": "This product is designed for everyday use.",
"keywords": "product, products"
},
"isStockNumberSyncActive": true,
"isSoldOut": false,
"isRemainingQuantity": true,
"suggestedRetailPrice": "19.99",
"isVisible": true
},
"options": [],
"selectedOptions": [],
"variants": [],
"mainVariant": null,
"freeFields": [
{
"id": "2",
"name": "ff_2",
"value": "ff2",
"translations": []
},
{
"id": "29",
"name": "ff_29",
"value": "ff29",
"translations": []
},
{
"id": "35",
"name": null,
"value": "ff35",
"translations": []
}
],
"updatedAt": "2024-09-19T12:34:56Z",
"isVariant": true,
"variantOf": null,
"categories": [
{
"id": "1"
}
]
}
}