POST api/v1/WH_Bin

Retrieve details of bins map for a given warehouse

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WarehouseID		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2
}

application/xml, text/xml

Sample:

<WH_Bin_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WarehouseID>2</WarehouseID>
</WH_Bin_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of bins
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content
503 Service Unavailable

WH_Bins

Name	Description	Type	Additional information
WH_BinList		Collection of WH_Bin	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_BinList": [
    {
      "BinID": 1,
      "ComputedBin": "sample string 2",
      "Zone": "sample string 3",
      "Area": "sample string 4",
      "Aisle": "sample string 5",
      "BinNo": "sample string 6",
      "Profile": "sample string 7",
      "ProfileDescription": "sample string 8",
      "UsageClassDescription": "sample string 9",
      "Handling": "sample string 10",
      "HandlingDescription": "sample string 11",
      "LastStockCheck": "sample string 12",
      "WalkSequence": 13,
      "isBulkBin": true,
      "isPickable": true,
      "isAlloc": true,
      "isAutoRes": true,
      "isHandlingLicenceReqd": true,
      "isMixedItems": true,
      "isFrozen": true,
      "isQuarantine": true
    },
    {
      "BinID": 1,
      "ComputedBin": "sample string 2",
      "Zone": "sample string 3",
      "Area": "sample string 4",
      "Aisle": "sample string 5",
      "BinNo": "sample string 6",
      "Profile": "sample string 7",
      "ProfileDescription": "sample string 8",
      "UsageClassDescription": "sample string 9",
      "Handling": "sample string 10",
      "HandlingDescription": "sample string 11",
      "LastStockCheck": "sample string 12",
      "WalkSequence": 13,
      "isBulkBin": true,
      "isPickable": true,
      "isAlloc": true,
      "isAutoRes": true,
      "isHandlingLicenceReqd": true,
      "isMixedItems": true,
      "isFrozen": true,
      "isQuarantine": true
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Bins xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_Bin>
    <BinID>1</BinID>
    <ComputedBin>sample string 2</ComputedBin>
    <Zone>sample string 3</Zone>
    <Area>sample string 4</Area>
    <Aisle>sample string 5</Aisle>
    <BinNo>sample string 6</BinNo>
    <Profile>sample string 7</Profile>
    <ProfileDescription>sample string 8</ProfileDescription>
    <UsageClassDescription>sample string 9</UsageClassDescription>
    <Handling>sample string 10</Handling>
    <HandlingDescription>sample string 11</HandlingDescription>
    <LastStockCheck>sample string 12</LastStockCheck>
    <WalkSequence>13</WalkSequence>
    <isBulkBin>true</isBulkBin>
    <isPickable>true</isPickable>
    <isAlloc>true</isAlloc>
    <isAutoRes>true</isAutoRes>
    <isHandlingLicenceReqd>true</isHandlingLicenceReqd>
    <isMixedItems>true</isMixedItems>
    <isFrozen>true</isFrozen>
    <isQuarantine>true</isQuarantine>
  </WH_Bin>
  <WH_Bin>
    <BinID>1</BinID>
    <ComputedBin>sample string 2</ComputedBin>
    <Zone>sample string 3</Zone>
    <Area>sample string 4</Area>
    <Aisle>sample string 5</Aisle>
    <BinNo>sample string 6</BinNo>
    <Profile>sample string 7</Profile>
    <ProfileDescription>sample string 8</ProfileDescription>
    <UsageClassDescription>sample string 9</UsageClassDescription>
    <Handling>sample string 10</Handling>
    <HandlingDescription>sample string 11</HandlingDescription>
    <LastStockCheck>sample string 12</LastStockCheck>
    <WalkSequence>13</WalkSequence>
    <isBulkBin>true</isBulkBin>
    <isPickable>true</isPickable>
    <isAlloc>true</isAlloc>
    <isAutoRes>true</isAutoRes>
    <isHandlingLicenceReqd>true</isHandlingLicenceReqd>
    <isMixedItems>true</isMixedItems>
    <isFrozen>true</isFrozen>
    <isQuarantine>true</isQuarantine>
  </WH_Bin>
</WH_Bins>