AlphaAlpha Docs
API Reference

Stock Inventory

Stock Inventory API

Add inventory to a stock location

POST
/inventory

Authorization

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/inventory" \  -H "Content-Type: application/json" \  -d '{    "products": [      {        "batchNumber": "string",        "locationId": "string",        "originalPurchaseOrderId": "string",        "price": 0.1,        "productId": "string",        "quantity": 0.1,        "stockSource": "PURCHASE_ORDER"      }    ],    "stockSiteId": "string",    "subsidiaryId": "string"  }'
[
  {
    "availableQuantity": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "inTransitQuantity": 0.1,
    "inTransitStock": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "transferId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "locations": [
      {
        "batches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "lastStockDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1,
            "stockSource": "PURCHASE_ORDER",
            "uomSplit": [
              {
                "productId": "string",
                "quantity": 0.1,
                "unit": "string"
              }
            ]
          }
        ],
        "earliestExpirationDate": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastStockDate": "2019-08-24T14:15:22Z",
        "totalQuantity": 0.1
      }
    ],
    "maximum": 0.1,
    "minimum": 0.1,
    "productId": "string",
    "reservations": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "reservationSourceId": "string",
        "reservationType": "ORDER",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "reservedQuantity": 0.1,
    "siteId": "string",
    "status": "IN_STOCK",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalQuantity": 0.1,
    "unitPrice": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Adjust inventory stock level manually

POST
/inventory/adjust

Authorization

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/inventory/adjust" \  -H "Content-Type: application/json" \  -d '{    "newQuantity": 0.1,    "newUnitPrice": 0.1,    "productId": "string",    "stockSiteId": "string"  }'
{
  "availableQuantity": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "inTransitQuantity": 0.1,
  "inTransitStock": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "transferId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "locations": [
    {
      "batches": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "originalPurchaseOrderId": "string",
          "productionDate": "2019-08-24T14:15:22Z",
          "quantity": 0.1,
          "stockSource": "PURCHASE_ORDER",
          "uomSplit": [
            {
              "productId": "string",
              "quantity": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "earliestExpirationDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastStockDate": "2019-08-24T14:15:22Z",
      "totalQuantity": 0.1
    }
  ],
  "maximum": 0.1,
  "minimum": 0.1,
  "productId": "string",
  "reservations": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "reservationSourceId": "string",
      "reservationType": "ORDER",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "reservedQuantity": 0.1,
  "siteId": "string",
  "status": "IN_STOCK",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalQuantity": 0.1,
  "unitPrice": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 inventory batches at a site

GET
/inventory/batch-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

stockSiteId*string
search?string
category?string
brand?string
batchNumber?string
locationId?string
expiryFrom?string
Formatdate-time
expiryTo?string
Formatdate-time
stockDateFrom?string
Formatdate-time
stockDateTo?string
Formatdate-time
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sortBy?string
Default"productName"
direction?string
Value in"ASC" | "DESC"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/batch-search?stockSiteId=string"
{
  "content": [
    {
      "batchNumber": "string",
      "brand": "string",
      "category": "string",
      "expirationDate": "2019-08-24T14:15:22Z",
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "lastStockDate": "2019-08-24T14:15:22Z",
      "locationId": "string",
      "productId": "string",
      "productName": "string",
      "productionDate": "2019-08-24T14:15:22Z",
      "quantity": 0.1,
      "unitPrice": 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"
}

Update batch (quantity and expirationDate) of stock inventory

PUT
/inventory/batches

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

dto*

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/inventory/batches?batchNumber=string&expirationDate=2019-08-24T14%3A15%3A22Z&locationId=string&productId=string&productionDate=2019-08-24T14%3A15%3A22Z&quantity=0.1&stockSiteId=string"
{
  "availableQuantity": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "inTransitQuantity": 0.1,
  "inTransitStock": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "transferId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "locations": [
    {
      "batches": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "originalPurchaseOrderId": "string",
          "productionDate": "2019-08-24T14:15:22Z",
          "quantity": 0.1,
          "stockSource": "PURCHASE_ORDER",
          "uomSplit": [
            {
              "productId": "string",
              "quantity": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "earliestExpirationDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastStockDate": "2019-08-24T14:15:22Z",
      "totalQuantity": 0.1
    }
  ],
  "maximum": 0.1,
  "minimum": 0.1,
  "productId": "string",
  "reservations": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "reservationSourceId": "string",
      "reservationType": "ORDER",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "reservedQuantity": 0.1,
  "siteId": "string",
  "status": "IN_STOCK",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalQuantity": 0.1,
  "unitPrice": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Download Csv_ Stock Inventory

GET
/inventory/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/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

DELETE
/inventory/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/inventory/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"
}

Dynamic search for product stock

GET
/inventory/dynamic-product-stock-inventory-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string
stockSiteId?string
destinationStockSiteId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/dynamic-product-stock-inventory-search"
{
  "content": [
    {
      "amountAvailable": 0.1,
      "amountReserved": 0.1,
      "baseUnit": {
        "baseUnit": true,
        "cost": 0.1,
        "decimal": true,
        "isBaseUnit": true,
        "isDecimal": true,
        "name": "string",
        "quantity": 0.1,
        "salesPrice": 0.1,
        "unit": "string"
      },
      "currency": "string",
      "destinationProductInfo": {
        "amountAvailable": 0.1,
        "amountReserved": 0.1,
        "maximum": 0.1,
        "minimum": 0.1,
        "stockSiteId": "string",
        "stockSiteName": "string",
        "totalAmount": 0.1
      },
      "imageBlobId": "string",
      "maximum": 0.1,
      "minimum": 0.1,
      "productId": "string",
      "productName": "string",
      "productType": "RAW_MATERIAL",
      "salesPrice": 0.1,
      "stockSiteId": "string",
      "stockSiteName": "string",
      "subsidiaryId": "string",
      "totalAmount": 0.1,
      "unitPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "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"
}

Dynamic Search_ Stock Inventory

GET
/inventory/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/dynamic-search"
{
  "content": [
    {
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "inTransitQuantity": 0.1,
      "inTransitStock": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "transferId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "productId": "string",
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "status": "IN_STOCK",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 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"
}

Dynamic Search Post_ Stock Inventory

POST
/inventory/dynamic-search

Authorization

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/inventory/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": [
    {
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "inTransitQuantity": 0.1,
      "inTransitStock": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "transferId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "productId": "string",
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "status": "IN_STOCK",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 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"
}

Dynamic search for enriched inventory

GET
/inventory/enriched-dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/enriched-dynamic-search"
{
  "content": [
    {
      "assetValue": 0.1,
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "isUp": true,
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "product": {
        "brand": "string",
        "category": "string",
        "description": "string",
        "imageBlobId": "string",
        "name": "string",
        "productId": "string",
        "salesPrice": 0.1,
        "stockInfo": {
          "amountAvailable": 0.1,
          "amountReserved": 0.1,
          "baseUnit": {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          },
          "currency": "string",
          "destinationProductInfo": {
            "amountAvailable": 0.1,
            "amountReserved": 0.1,
            "maximum": 0.1,
            "minimum": 0.1,
            "stockSiteId": "string",
            "stockSiteName": "string",
            "totalAmount": 0.1
          },
          "imageBlobId": "string",
          "maximum": 0.1,
          "minimum": 0.1,
          "productId": "string",
          "productName": "string",
          "productType": "RAW_MATERIAL",
          "salesPrice": 0.1,
          "stockSiteId": "string",
          "stockSiteName": "string",
          "subsidiaryId": "string",
          "totalAmount": 0.1,
          "unitPrice": 0.1,
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        },
        "unitPrice": 0.1,
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ]
      },
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "siteName": "string",
      "stockStatus": "IN_STOCK",
      "subsidiaryId": "string",
      "supplierId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 0.1,
      "untilStockOutDays": 0,
      "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"
}

Find by list of ids in current tenant

GET
/inventory/find

Authorization

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/inventory/find?ids=string"
[
  {
    "availableQuantity": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "inTransitQuantity": 0.1,
    "inTransitStock": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "transferId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "locations": [
      {
        "batches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "lastStockDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1,
            "stockSource": "PURCHASE_ORDER",
            "uomSplit": [
              {
                "productId": "string",
                "quantity": 0.1,
                "unit": "string"
              }
            ]
          }
        ],
        "earliestExpirationDate": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastStockDate": "2019-08-24T14:15:22Z",
        "totalQuantity": 0.1
      }
    ],
    "maximum": 0.1,
    "minimum": 0.1,
    "productId": "string",
    "reservations": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "reservationSourceId": "string",
        "reservationType": "ORDER",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "reservedQuantity": 0.1,
    "siteId": "string",
    "status": "IN_STOCK",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalQuantity": 0.1,
    "unitPrice": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find all for current tenant

GET
/inventory/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/find-all"
[
  {
    "availableQuantity": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "inTransitQuantity": 0.1,
    "inTransitStock": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "transferId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "locations": [
      {
        "batches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "lastStockDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1,
            "stockSource": "PURCHASE_ORDER",
            "uomSplit": [
              {
                "productId": "string",
                "quantity": 0.1,
                "unit": "string"
              }
            ]
          }
        ],
        "earliestExpirationDate": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastStockDate": "2019-08-24T14:15:22Z",
        "totalQuantity": 0.1
      }
    ],
    "maximum": 0.1,
    "minimum": 0.1,
    "productId": "string",
    "reservations": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "reservationSourceId": "string",
        "reservationType": "ORDER",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "reservedQuantity": 0.1,
    "siteId": "string",
    "status": "IN_STOCK",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalQuantity": 0.1,
    "unitPrice": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find a list of entities by their IDs

GET
/inventory/find-list

Authorization

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/inventory/find-list"
[
  {
    "availableQuantity": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "inTransitQuantity": 0.1,
    "inTransitStock": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "transferId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "locations": [
      {
        "batches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "lastStockDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1,
            "stockSource": "PURCHASE_ORDER",
            "uomSplit": [
              {
                "productId": "string",
                "quantity": 0.1,
                "unit": "string"
              }
            ]
          }
        ],
        "earliestExpirationDate": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastStockDate": "2019-08-24T14:15:22Z",
        "totalQuantity": 0.1
      }
    ],
    "maximum": 0.1,
    "minimum": 0.1,
    "productId": "string",
    "reservations": [
      {
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "quantity": 0.1,
        "reservationSourceId": "string",
        "reservationType": "ORDER",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "reservedQuantity": 0.1,
    "siteId": "string",
    "status": "IN_STOCK",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalQuantity": 0.1,
    "unitPrice": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find by id in current tenant

GET
/inventory/find/{id}

Authorization

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/inventory/find/string"
{
  "availableQuantity": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "inTransitQuantity": 0.1,
  "inTransitStock": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "transferId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "locations": [
    {
      "batches": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "originalPurchaseOrderId": "string",
          "productionDate": "2019-08-24T14:15:22Z",
          "quantity": 0.1,
          "stockSource": "PURCHASE_ORDER",
          "uomSplit": [
            {
              "productId": "string",
              "quantity": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "earliestExpirationDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastStockDate": "2019-08-24T14:15:22Z",
      "totalQuantity": 0.1
    }
  ],
  "maximum": 0.1,
  "minimum": 0.1,
  "productId": "string",
  "reservations": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "reservationSourceId": "string",
      "reservationType": "ORDER",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "reservedQuantity": 0.1,
  "siteId": "string",
  "status": "IN_STOCK",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalQuantity": 0.1,
  "unitPrice": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Get all locations for stock site

GET
/inventory/locations/{stockSiteId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

stockSiteId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/locations/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"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/inventory/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?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/inventory/page"
{
  "content": [
    {
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "inTransitQuantity": 0.1,
      "inTransitStock": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "transferId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "productId": "string",
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "status": "IN_STOCK",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 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"
}

Count available stock inventory by product id

GET
/inventory/product/{productId}/stock

Authorization

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/inventory/product/string/stock"
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 page by page number and size with optional sorting based on field to sortBy and direction

GET
/inventory/search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber*integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string
stockSiteId?string
subsidiaryId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/search?pageNumber=0"
{
  "content": [
    {
      "assetValue": 0.1,
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "isUp": true,
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "product": {
        "brand": "string",
        "category": "string",
        "description": "string",
        "imageBlobId": "string",
        "name": "string",
        "productId": "string",
        "salesPrice": 0.1,
        "stockInfo": {
          "amountAvailable": 0.1,
          "amountReserved": 0.1,
          "baseUnit": {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          },
          "currency": "string",
          "destinationProductInfo": {
            "amountAvailable": 0.1,
            "amountReserved": 0.1,
            "maximum": 0.1,
            "minimum": 0.1,
            "stockSiteId": "string",
            "stockSiteName": "string",
            "totalAmount": 0.1
          },
          "imageBlobId": "string",
          "maximum": 0.1,
          "minimum": 0.1,
          "productId": "string",
          "productName": "string",
          "productType": "RAW_MATERIAL",
          "salesPrice": 0.1,
          "stockSiteId": "string",
          "stockSiteName": "string",
          "subsidiaryId": "string",
          "totalAmount": 0.1,
          "unitPrice": 0.1,
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        },
        "unitPrice": 0.1,
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ]
      },
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "siteName": "string",
      "stockStatus": "IN_STOCK",
      "subsidiaryId": "string",
      "supplierId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 0.1,
      "untilStockOutDays": 0,
      "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"
}

Search products for stock info

GET
/inventory/search/products

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?string
pageNumber*integer
Formatint32
pageSize*integer
Formatint32
sortBy?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/inventory/search/products?pageNumber=0&pageSize=0"
{
  "content": [
    {
      "amountAvailable": 0.1,
      "amountReserved": 0.1,
      "baseUnit": {
        "baseUnit": true,
        "cost": 0.1,
        "decimal": true,
        "isBaseUnit": true,
        "isDecimal": true,
        "name": "string",
        "quantity": 0.1,
        "salesPrice": 0.1,
        "unit": "string"
      },
      "currency": "string",
      "destinationProductInfo": {
        "amountAvailable": 0.1,
        "amountReserved": 0.1,
        "maximum": 0.1,
        "minimum": 0.1,
        "stockSiteId": "string",
        "stockSiteName": "string",
        "totalAmount": 0.1
      },
      "imageBlobId": "string",
      "maximum": 0.1,
      "minimum": 0.1,
      "productId": "string",
      "productName": "string",
      "productType": "RAW_MATERIAL",
      "salesPrice": 0.1,
      "stockSiteId": "string",
      "stockSiteName": "string",
      "subsidiaryId": "string",
      "totalAmount": 0.1,
      "unitPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "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 available batches for a product at a site

GET
/inventory/sites/{siteId}/products/{productId}/batches

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

siteId*string
productId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/sites/string/products/string/batches"
[
  {
    "batchNumber": "string",
    "expirationDate": "2019-08-24T14:15:22Z",
    "locationId": "string",
    "originalPurchaseOrderId": "string",
    "productionDate": "2019-08-24T14:15:22Z",
    "quantity": 0.1,
    "stockSource": "PURCHASE_ORDER"
  }
]
{
  "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 stats

GET
/inventory/stats

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

stockSiteId?string
subsidiaryId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/stats"
{
  "productsInStock": 0,
  "productsLowStock": 0,
  "productsOutOfStock": 0,
  "totalProducts": 0,
  "totalStockValue": 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

DELETE
/inventory/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/inventory/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

POST
/inventory/{id}/comment

Authorization

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/inventory/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "availableQuantity": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "inTransitQuantity": 0.1,
  "inTransitStock": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "transferId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "locations": [
    {
      "batches": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "originalPurchaseOrderId": "string",
          "productionDate": "2019-08-24T14:15:22Z",
          "quantity": 0.1,
          "stockSource": "PURCHASE_ORDER",
          "uomSplit": [
            {
              "productId": "string",
              "quantity": 0.1,
              "unit": "string"
            }
          ]
        }
      ],
      "earliestExpirationDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastStockDate": "2019-08-24T14:15:22Z",
      "totalQuantity": 0.1
    }
  ],
  "maximum": 0.1,
  "minimum": 0.1,
  "productId": "string",
  "reservations": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "quantity": 0.1,
      "reservationSourceId": "string",
      "reservationType": "ORDER",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "reservedQuantity": 0.1,
  "siteId": "string",
  "status": "IN_STOCK",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalQuantity": 0.1,
  "unitPrice": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Get stock inventory by product id

GET
/inventory/{productId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

productId*string

Query Parameters

pageNumber*integer
Formatint32
pageSize?integer
Formatint32
sortBy?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/inventory/string?pageNumber=0"
{
  "content": [
    {
      "assetValue": 0.1,
      "availableQuantity": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "isUp": true,
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastStockDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1,
              "stockSource": "PURCHASE_ORDER",
              "uomSplit": [
                {
                  "productId": "string",
                  "quantity": 0.1,
                  "unit": "string"
                }
              ]
            }
          ],
          "earliestExpirationDate": "2019-08-24T14:15:22Z",
          "id": "string",
          "lastStockDate": "2019-08-24T14:15:22Z",
          "totalQuantity": 0.1
        }
      ],
      "maximum": 0.1,
      "minimum": 0.1,
      "product": {
        "brand": "string",
        "category": "string",
        "description": "string",
        "imageBlobId": "string",
        "name": "string",
        "productId": "string",
        "salesPrice": 0.1,
        "stockInfo": {
          "amountAvailable": 0.1,
          "amountReserved": 0.1,
          "baseUnit": {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          },
          "currency": "string",
          "destinationProductInfo": {
            "amountAvailable": 0.1,
            "amountReserved": 0.1,
            "maximum": 0.1,
            "minimum": 0.1,
            "stockSiteId": "string",
            "stockSiteName": "string",
            "totalAmount": 0.1
          },
          "imageBlobId": "string",
          "maximum": 0.1,
          "minimum": 0.1,
          "productId": "string",
          "productName": "string",
          "productType": "RAW_MATERIAL",
          "salesPrice": 0.1,
          "stockSiteId": "string",
          "stockSiteName": "string",
          "subsidiaryId": "string",
          "totalAmount": 0.1,
          "unitPrice": 0.1,
          "unitsOfMeasurement": [
            {
              "baseUnit": true,
              "cost": 0.1,
              "decimal": true,
              "isBaseUnit": true,
              "isDecimal": true,
              "name": "string",
              "quantity": 0.1,
              "salesPrice": 0.1,
              "unit": "string"
            }
          ]
        },
        "unitPrice": 0.1,
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ]
      },
      "reservations": [
        {
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "quantity": 0.1,
          "reservationSourceId": "string",
          "reservationType": "ORDER",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "reservedQuantity": 0.1,
      "siteId": "string",
      "siteName": "string",
      "stockStatus": "IN_STOCK",
      "subsidiaryId": "string",
      "supplierId": "string",
      "tenantId": "string",
      "totalQuantity": 0.1,
      "unitPrice": 0.1,
      "untilStockOutDays": 0,
      "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"
}

Stock Count

Previous Page

Stock Site

Next Page