API Docs
API Reference
Inventory Balance Report Query

Inventory Balance Report Query API

Inventory Balance Report Query API allows users to search and retrieve Return the Items Movement Summary using a date range. This article introduces the general Inventory Balance Report Query API for easily understanding and applying this API.

Introduction

Inventory Balance Report Query API helps users track inventory changes, ensuring better stock management and supporting decisions related to purchasing, replenishment and warehouse operations.

API Request

API: POST /edi/inventory/balance-report/search-by-paging
Body Request:

Body ParameterRequiredDescriptionNote
FacilityIDYFacility ID"889"
CustomerIDYCustomer ID"AUKINT0001"
CompanyIDYCompany ID"LT"
ItemSpecNameNItem Id"KNT-TT-BK"
DescriptionNItem Description"Travel Tumbler / Black"
TitleIDNTitle Id"AIRHOUSE, INC."
PagingNPage Object"PageNo": 2

API Return

It returns the query inventory activity balance report, for more detail, please refer to the following example.

Example

Request

  {
      "FacilityID":"889",
      "CustomerID":"AUKINT0001",
      "CompanyID":"LT",
      "ItemSpecName": "KNT-TT-BK",
      "Description": "Travel Tumbler / Black",
      "TitleID": "AIRHOUSE, INC.",
      "Paging": {
          "PageNo": 1
      }
  }

Response

// Success return
{
    "results": {
        "head": [
            "Item ID",
            "Description",
            "Short Description",
            "Title",
            "Supplier",
            "UOM",
            "Current Balance",
            "Beginning Balance",
            "Received",
            "Shipped",
            "Adjust In",
            "Adjust Out",
            "Transfer In",
            "Transfer Out"
        ],
        "data": []
    },
    "paging": {
        "totalCount": 1,
        "pageNo": 2,
        "totalPage": 1,
        "startIndex": 101,
        "endIndex": 101,
        "limit": 100
    }
}