Table of Contents

Bin Content API

Overview

The WMS Bin Content API provides access to bin content information in the warehouse management system. This API allows users to retrieve details about bin locations, items, quantities, and lot numbers.

API Details

  • Publisher: smart
  • API Group: wms
  • API Version: v2.0
  • Entity Name: binContent
  • Entity Set Name: binContents
  • Source Table: Bin Content

Key Features

  • Retrieve bin content details such as location, bin code, item number, and quantities.
  • Access available quantities to take and lot-specific information.
  • Read-only API with no editing capabilities.

OData Key Fields

The following fields are used as OData key fields for identifying records:

  • Location Code
  • Bin Code
  • Item No.

Fields

The API exposes the following fields:

Field Name Description
locationCode The location code of the bin.
binCode The bin code.
itemNo The item number.
quantityBase The base quantity in the bin.
PickQuantityBase The pick quantity in the base unit.
availableQtyToTake The available quantity to take.
lotNo The lot number.
availableQtyByLot The available quantity by lot.

Procedures

GetLotNo()

Retrieves the lot number for the current bin content record.

  • Returns: Code[50] - The lot number.
  • Logic:
    • Filters and aggregates lot numbers by bin code.
    • Returns the first available lot number with a positive quantity.

Example Usage

Request

GET host/instance/api/smart/wms/v2.0/companies(companyId)/binContents?$filter=locationCode eq 'MAIN' and binCode eq 'A01'

Response

[
        {
                "locationCode": "MAIN",
                "binCode": "A01",
                "itemNo": "ITEM001",
                "quantityBase": 100,
                "PickQuantityBase": 20,
                "availableQtyToTake": 80,
                "lotNo": "LOT123",
                "availableQtyByLot": 50
        }
]

Notes

  • The API is read-only and does not allow modifications to the data.
  • Ensure proper filtering to retrieve relevant bin content information.

For further details, refer to the source code or contact the API publisher.

Edit this page