Alpha Product
API calls concerning products
Create product
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products" \ -H "Content-Type: application/json" \ -d '{ "metaData": [ { "key": "string", "value": "string" } ], "name": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Import image from URL
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
url*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/assets/string/import-from-url" \ -H "Content-Type: application/json" \ -d '{ "url": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Upload file to an element
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
assetType*string
Value in
"IMAGE" | "VIDEO" | "AUDIO" | "DOCUMENT" | "THREE_D" | "UNKNOWN"Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/assets/string/IMAGE" \ -F file="string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Download file
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/assets/string/string""string"{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete file
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/products/assets/string/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create products
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/batch" \ -H "Content-Type: application/json" \ -d '[ { "metaData": [ { "key": "string", "value": "string" } ], "name": "string" } ]'[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get all product brands within tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/brands"[
"string"
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create product with single file
AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/create-with-file" \ -F product="{\n \"metaData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"name\": \"string\"\n}"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Download Csv_ Product
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/csv-export""string"{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete a list of entities by their IDs
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/products/delete-list?ids=string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add discount
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/discounts/string" \ -H "Content-Type: application/json" \ -d '{ "active": true, "clientTypes": [ "PERSON" ], "name": "string", "regions": [ "string" ], "volumeThresholds": [ { "discountPercentage": 1, "minAmount": 1 } ] }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update discount
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
discountName*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/products/discounts/string/string" \ -H "Content-Type: application/json" \ -d '{ "active": true, "clientTypes": [ "PERSON" ], "name": "string", "regions": [ "string" ], "volumeThresholds": [ { "discountPercentage": 1, "minAmount": 1 } ] }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove discount
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
discountName*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/products/discounts/string/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Dynamic Search_ Product
AuthorizationBearer <token>
In: header
Query Parameters
search?array<>
filters?array<>
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sort?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/dynamic-search"{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Dynamic Search Post_ Product
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/dynamic-search" \ -H "Content-Type: application/json" \ -d '{ "filters": { "property1": null, "property2": null }, "page": 0, "search": [ "string" ], "size": 0, "sort": [ { "ascending": true, "field": "string" } ] }'{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Check if product exists
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/exists/string"true{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by list of ids in current tenant
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/find?ids=string"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find all for current tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/find-all"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find a list of entities by their IDs
AuthorizationBearer <token>
In: header
Query Parameters
ids?array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/find-list"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Generate product ID
AuthorizationBearer <token>
In: header
Query Parameters
persist?boolean
Default
falseResponse Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/generate-id"{
"value": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Search images
AuthorizationBearer <token>
In: header
Query Parameters
query*string
count?integer
Default
20Format
int32Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/image-search?query=string"[
{
"height": 0,
"thumbnailUrl": "string",
"url": "string",
"width": 0
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Import products from Excel
AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/import" \ -F file="string"{
"created": 0,
"errors": [
{
"message": "string",
"productId": "string",
"row": 0
}
],
"skipped": 0,
"updated": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get page by page number and size with optional sorting based on field to sortBy and direction
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/page"{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Search products
AuthorizationBearer <token>
In: header
Query Parameters
search?string
pageNumber*integer
Format
int32pageSize*integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"myOrg?boolean
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/search?pageNumber=0&pageSize=0"{
"content": [
{
"owner": {
"id": "string",
"logoUrl": "string",
"name": "string"
},
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Search products for employees
AuthorizationBearer <token>
In: header
Query Parameters
search?string
pageNumber*integer
Format
int32pageSize*integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/search-storefront?pageNumber=0&pageSize=0"{
"content": [
{
"category": "string",
"currency": "string",
"description": "string",
"id": "string",
"name": "string",
"price": 0.1,
"supplier": "string",
"thumbnail": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get Stats_ Product
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/stats"{
"productsByCategory": {
"property1": 0,
"property2": 0
},
"totalCategories": 0,
"totalProducts": 0,
"totalSuppliers": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add unit of measurement
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/units/string" \ -H "Content-Type: application/json" \ -d '{ "cost": 0.1, "isDecimal": true, "name": "string", "quantity": 0.1, "salesPrice": 0.1 }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add base unit of measurement
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/units/string/base-unit" \ -H "Content-Type: application/json" \ -d '{ "cost": 0.1, "isDecimal": true, "name": "string", "quantity": 0.1, "salesPrice": 0.1, "unit": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update base unit of measurement
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/products/units/string/base-unit" \ -H "Content-Type: application/json" \ -d '{ "cost": 0.1, "isDecimal": true, "name": "string", "quantity": 0.1, "salesPrice": 0.1, "unit": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update unit of measurement
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
unitName*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/products/units/string/string" \ -H "Content-Type: application/json" \ -d '{ "cost": 0.1, "isDecimal": true, "name": "string", "quantity": 0.1, "salesPrice": 0.1 }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove unit of measurement
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
unitName*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/products/units/string/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/products/string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add a comment to an entity
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
body*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/products/string/comment" \ -H "Content-Type: application/json" \ -d 'string'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update product
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/products/string" \ -H "Content-Type: application/json" \ -d '{ "metaData": [ { "key": "string", "value": "string" } ], "name": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get product batches
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Query Parameters
pageNumber*integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/string/batches?pageNumber=0"{
"content": [
{
"actualDeliveryDate": "2019-08-24T14:15:22Z",
"actualExpiryDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"amountReserved": 0.1,
"batchId": "string",
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"expectedExpiryDate": "2019-08-24T14:15:22Z",
"history": [
{
"action": "string",
"amount": 0.1,
"date": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"lastMoveDate": "2019-08-24T14:15:22Z",
"price": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"productionDate": "2019-08-24T14:15:22Z",
"purchaseOrderId": "string",
"status": "EXPECTED"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update product parts
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/products/string/parts" \ -H "Content-Type: application/json" \ -d '[ { "amount": 0.1, "productId": "string", "unit": "string" } ]'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get purchase orders for product
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Query Parameters
pageNumber*integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/string/purchase-orders?pageNumber=0"{
"content": [
{
"acceptedProducts": [
{
"productId": "string",
"quantity": 0.1
}
],
"accessTokenHash": "string",
"actualDeliveryDate": "2019-08-24T14:15:22Z",
"allowOverdraft": true,
"amountAccepted": 0.1,
"amountOfProducts": 0.1,
"amountRejected": 0.1,
"approvalRuleSnapshot": {
"amountThreshold": 0.1,
"approvalMode": "ANY",
"approverUserIds": [
"string"
],
"globalApproverUserIds": [
"string"
],
"ruleId": "string"
},
"attachments": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"baseConversionRate": 0.1,
"cancellationReason": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"currentLocation": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalApprovals": [
{
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
}
],
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"isLocked": true,
"localizedTotal": 0.1,
"mailBody": "string",
"note": "string",
"pdf": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"percentageAccepted": 0.1,
"percentageRejected": 0.1,
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"rejectedProducts": [
{
"batches": [
{
"quantity": 0.1,
"reason": "string"
}
],
"productId": "string",
"quantity": 0.1
}
],
"rejectionReason": "string",
"sentMails": [
"string"
],
"shortageProducts": [
{
"batches": [
{
"quantity": 0.1,
"reason": "string",
"resolutions": [
{
"glAccountId": "string",
"id": "string",
"quantity": 0.1,
"referenceId": "string",
"resolvedAt": "2019-08-24T14:15:22Z",
"resolvedBy": "string",
"type": "DEBIT_NOTE"
}
],
"resolvedQuantity": 0.1,
"unresolvedQuantity": 0.1
}
],
"productId": "string",
"quantity": 0.1,
"resolvedQuantity": 0.1,
"unresolvedQuantity": 0.1
}
],
"signature": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"signedAt": "2019-08-24T14:15:22Z",
"signedBy": "string",
"status": "DRAFT",
"stockSiteId": "string",
"subsidiaryId": "string",
"supplierEmail": "string",
"supplierId": "string",
"supplierReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"tenantId": "string",
"total": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get sales orders for product
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Query Parameters
pageNumber*integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/string/sales-orders?pageNumber=0"{
"content": [
{
"amountOfProducts": 0.1,
"cachedInvoicePaidAmount": 0.1,
"cachedInvoicedAmount": 0.1,
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"directPaymentAmount": 0.1,
"directPayments": [
{
"amount": 0.1,
"createdBy": "string",
"currency": "string",
"id": "string",
"note": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"receiptAsset": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"receiptGenerated": true,
"reference": "string"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"internalCancellationReason": "string",
"internalReview": {
"approved": true,
"by": "string",
"on": "2019-08-24T14:15:22Z",
"reason": "string"
},
"invoiceIds": [
"string"
],
"invoicedProducts": [
{
"invoiceId": "string",
"productId": "string",
"quantityInvoiced": 0.1,
"unit": "string"
}
],
"isFullyCancelled": true,
"isOverdue": true,
"orderDate": "2019-08-24T14:15:22Z",
"packages": [
{
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"location": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"coordinate": {
"latitude": -90,
"longitude": -180
},
"name": "string"
},
"picklistId": "string",
"weight": 0.1
}
],
"paymentAmount": 0.1,
"paymentMethod": "CREDIT_CARD",
"paymentPercentage": 0.1,
"paymentStatus": "UNPAID",
"paymentTerm": 0,
"picklistIds": [
"string"
],
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reference": "string",
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"salesValue": 0.1,
"status": "DRAFT",
"subsidiaryId": "string",
"tenantId": "string",
"totalAmount": 0.1,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get stock transfers for product
AuthorizationBearer <token>
In: header
Path Parameters
productId*string
Query Parameters
pageNumber*integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/products/string/transfers?pageNumber=0"{
"content": [
{
"batchAllocations": [
{
"batchNumber": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"locationId": "string",
"productId": "string",
"quantity": 0.1
}
],
"cancelledProducts": {
"isNotEmpty": true,
"products": [
{
"productId": "string",
"quantity": 0.1,
"unit": "string"
}
]
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryMethod": "REGULAR",
"destinationStockSiteId": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"incomingStockTransferId": "string",
"isFullyCancelled": true,
"note": "string",
"picklistIds": [
"string"
],
"priority": "LOW",
"products": [
{
"baseUnitConversion": 0.1,
"baseUnitQuantity": 0.1,
"pricePerBaseUnit": 0.1,
"pricePerUnit": 0.1,
"productId": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string"
}
],
"reservedProducts": [
{
"productId": "string",
"quantity": 0.1,
"siteId": "string"
}
],
"status": "DRAFT",
"stockSiteId": "string",
"subsidiaryId": "string",
"tenantId": "string",
"transferNumber": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}