AlphaAlpha Docs
API ReferenceStock inventory

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

Searches stock inventory items with pagination

GET
/inventory/search
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

application/json

curl -X GET "http://localhost:18080/api/v1/inventory/search?pageNumber=0"
{
  "content": [
    {
      "assetValue": 0.1,
      "availableQuantity": 0.1,
      "avgDailyConsumption": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "id": "string",
      "isUp": true,
      "locations": [
        {
          "batches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "lastExpiryAlertAt": "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",
      "suggestedReorderDate": "2019-08-24T14:15:22Z",
      "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"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}