API Docs
Use Case
Inventory
Search Inventory Item Level

Inventory Item Level Query Use Case

This article introduces the general Inventory Item Level Query API use case for easily understanding and applying this API.

Introduction

The Inventory Item Level API is designed for querying inventory summary. It allows users to access detailed information about specific inventory summary. By utilizing this API, businesses can manage their inventory more accurately, ensuring a smooth supply chain operation. The API also supports paginated search for handling large datasets, making it ideal for large-scale inventory management.

This API enhances inventory management by providing real-time item-level visibility, enabling businesses to make informed decisions and optimize stock control.

API Request

API: POST /edi/inventory/item-level/search-by-paging
Body Request:

Body ParameterRequiredDescriptionNote
FacilityIDYFacility ID"889"
CustomerIDYCustomer ID"AUKINT0001"
CompanyIDYCompany ID"LT"
ItemSpecNameNItem ID"ATVP-MP-001"
IncludeZeroNIf IncludeZero is true, API will return 0 when there is no inventory
Default: false
Options: true/false
PagingNPage Object"PageNo": 2

Example

Request

{
    "FacilityID":"889",
    "CustomerID":"AUKINT0001",
    "CompanyID":"LT",
    "ItemSpecName": "",
    "Paging":  {
         "PageNo": 1
    }
}

Response

// Success return
{
  "results": {
      "head": [
          "Item ID",
          "Short Description",
          "Description",
          "Units/pkg",
          "Customer",
          "Title",
          "Available",
          "Allocated",
          "Damaged",
          "Hold",
          "Incomming",
          "Open Order",
          "On Hand",
          "UOM"
      ],
      "data": []
  },
  "paging": {
      "totalCount": 0,
      "pageNo": 1,
      "totalPage": 0,
      "startIndex": 1,
      "endIndex": 0,
      "limit": 100
  }
}