FieldEx Logo Black
FieldEx Developer
developer notes

Get All Bins by Location

Retrieve bins using the API endpoint. Employ pagination, sorting, and filtering options, including warehouse location, zone, type, and search criteria, for a tailored result set.

Method Endpoint
GET {{endpoint}}/api/ext/bins/combination/pick-list/paged

‍

Headers

‍

Key Value
Content-Type application/json
Authorization Bearer{{token}}

‍

Filter Fields

‍

Parameter Type Example Length Required Description
page Number 0 Yes Page number for pagination
perPage Number 25 Yes Items per page
startForm Number 0 Yes Starting point of results
search String JOH-ARFT! Yes Search Item
columnName String binDisplayName Yes Column to sort by
sortOrder String desc Yes Sort order (asc or desc)
wareHouseLocation Number 1 Yes Warehouse location ID
zoneId Number 1 Yes Zone ID
type String location Yes Type of bin
binName String a Yes Bin name
name String a Yes Name
binDisplayName String a Yes Display name of bin
productId Number 1 Yes Product ID
assetsId Number 1 Yes Asset ID
selectedFromBinId Number 1 Yes Selected from bin ID

‍

API Query Example

‍

Method API Call
GET api/ext/bins/combination/pick-list/paged?page=0&perPage=25&startFrom=0&search=JOH-ARFT!&columnName=binDisplayName&sortOrder=desc&wareHouseLocationId=1&zoneId=1&type=location&binName=a&name=a&binDisplayName=a&productId=1&assetsId=1&selectedFromBinId=1

‍

Example Response

‍

// 200 Response Code
{
    "total": 1,
    "count": 25,
    "data": [
        {
            "id": 1,
            "zoneId": 1,
            "wareHouseLocationId": 1,
            "userId": null,
            "name": Bin A,
            "shortCode": Bin A,
            "binNumber": BI-000001,
            "binDisplayName": Bin A,
            "zoneNumber": ZO-000001,
            "zoneShortCode": Zone A,
            "zoneName": Zone A,
            "wareHouseLocationNumber": LOC-000001,
            "wareHouseLocationShortCode": Loc A,
            "wareHouseLocationName": Loc A,
            "combinationName": LOC-000001-ZO-000001-BI-000001,
            "userFullName": null
        }
    ],
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "status": HAS_DATA
}