Bins

A bin identifies a specific location within a warehouse where items are or can be stored. Bins make it easier to find items during transaction processing.

List bins

get/objects/inventory-control/bin

Returns up to 100 objects from the collection with a key, ID, and link for each bin. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "12",
      • "id": "Z4-A2-R3a-BF2-B10",
      • "href": "/objects/inventory-control/bin/122"
      },
    • {
      • "key": "32",
      • "id": "Z4-A2-R3a-BF2-B11",
      • "href": "/objects/inventory-control/bin/132"
      },
    • {
      • "key": "44",
      • "id": "Z4-A2-R3a-BF2-B12",
      • "href": "/objects/inventory-control/bin/44"
      },
    • {
      • "key": "13",
      • "id": "Z4-A2-R3a-BF2-B13",
      • "href": "/objects/inventory-control/bin/13"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": 2,
    • "previous": 0
    }
}
Create a bin
post/objects/inventory-control/bin
Creates a new bin.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string  <= 30 characters 
Name or other unique identifier for the bin. The identifier should make it easy to find the bin. For example, if bin 10 is in zone 4, aisle 2, row 3a, and bin face 2, Z4-A2-R3a-BF2-B10 would be a good ID.


 
 Example:  "Z4-A2-R3a-BF2-B10"
description
string  <= 100 characters 
Description of the bin.


 
 Example:  "Bin of wrenches 02"
object
 
key
string
System-assigned key for the warehouse.


 
 Example:  "2"
id
string
Name or other unique identifier for the warehouse.


 
 Example:  "WA2"
object
 
key
string
System-assigned key for the aisle.


 
 Example:  "13"
id
string
Name or other unique identifier for the aisle.


 
 Example:  "A2"
object
 
key
string
System-assigned key for the row.


 
 Example:  "23"
id
string
Name or other unique identifier for the row.


 
 Example:  "R3a"
object
 
key
string
System-assigned key for the zone.


 
 Example:  "12"
id
string
Name or other unique identifier for the zone.


 
 Example:  "Z4"
object
 
key
string
System-assigned key for the bin face.


 
 Example:  "3"
id
string
Name or other unique identifier for the bin face.


 
 Example:  "BF2"
object
 
key
string
System-assigned key for the Bin Size


 
 Example:  "5"
id
string
Name or other unique identifier for the bin size.


 
 Example:  "B10"
sequenceNumber
string  <= 10 characters ^-{0,1}[0-9]*\.{0,1}[0-9]*$
Sequence number for the bin. Sequence numbering supports more efficient picking, packing, and cycle counts.


 
 Example:  "1233"
isPortable
boolean
 Default:  false
Set to true if the bin can be moved to another location, otherwise set to false.


 
 Example:  true
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Z4-A2-R3a-BF2-B10",
  • "description": "Bin Adapters 2",
  • "sequenceNumber": "4432",
  • "isPortable": true,
  • "warehouse": {
    • "id": "WA2"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "id": "Z4-A2-R3a-BF2-B10",
    • "href": "/objects/inventory-control/bin/111"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bin
get/objects/inventory-control/bin/{key}
Returns detailed information for a specified bin.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bin.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "id": "Z4-A2-R3a-BF2-B10",
    • "description": "Bin of adapters 2",
    • "warehouse": {
      • "key": "2",
      • "id": "WA2",
      • "href": "/objects/inventory-control/warehouse/2"
      },
    • "aisle": {
      • "key": "13",
      • "id": "A2",
      • "href": "/objects/inventory-control/aisle/13"
      },
    • "row": {
      • "key": "23",
      • "id": "R3a",
      • "href": "/objects/inventory-control/row/23"
      },
    • "zone": {
      • "key": "12",
      • "id": "Z4",
      • "href": "/objects/inventory-control/zone/12"
      },
    • "binFace": {
      • "key": "3",
      • "id": "BF2",
      • "href": "/objects/inventory-control/bin-face/3"
      },
    • "binSize": {
      • "key": "5",
      • "id": "B10",
      • "href": "/objects/inventory-control/bin-size/5"
      },
    • "href": "/objects/inventory-control/bin/111",
    • "sequenceNumber": "1221",
    • "status": "active",
    • "isPortable": false,
    • "audit": {
      • "createdDateTime": "2021-05-07T21:30:03Z",
      • "modifiedDateTime": "2021-05-07T21:30:03Z",
      • "createdBy": "13",
      • "modifiedBy": "13"
      }
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a bin
patch/objects/inventory-control/bin/{key}
Updates an existing bin by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bin.


 
 Example:  99
Request Body schema: application/json
id
string  <= 30 characters 
Name or other unique identifier for the bin. The identifier should make it easy to find the bin. For example, if bin 10 is in zone 4, aisle 2, row 3a, and bin face 2, Z4-A2-R3a-BF2-B10 would be a good ID.


 
 Example:  "Z4-A2-R3a-BF2-B10"
description
string  <= 100 characters 
Description of the bin.


 
 Example:  "Bin of wrenches 02"
object
 
key
string
System-assigned key for the warehouse.


 
 Example:  "2"
id
string
Name or other unique identifier for the warehouse.


 
 Example:  "WA2"
object
 
key
string
System-assigned key for the aisle.


 
 Example:  "13"
id
string
Name or other unique identifier for the aisle.


 
 Example:  "A2"
object
 
key
string
System-assigned key for the row.


 
 Example:  "23"
id
string
Name or other unique identifier for the row.


 
 Example:  "R3a"
object
 
key
string
System-assigned key for the zone.


 
 Example:  "12"
id
string
Name or other unique identifier for the zone.


 
 Example:  "Z4"
object
 
key
string
System-assigned key for the bin face.


 
 Example:  "3"
id
string
Name or other unique identifier for the bin face.


 
 Example:  "BF2"
object
 
key
string
System-assigned key for the Bin Size


 
 Example:  "5"
id
string
Name or other unique identifier for the bin size.


 
 Example:  "B10"
sequenceNumber
string  <= 10 characters ^-{0,1}[0-9]*\.{0,1}[0-9]*$
Sequence number for the bin. Sequence numbering supports more efficient picking, packing, and cycle counts.


 
 Example:  "1233"
isPortable
boolean
 Default:  false
Set to true if the bin can be moved to another location, otherwise set to false.


 
 Example:  true
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Bin of adapters 3"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "Z4-A2-R3a-BF2-B10",
    • "href": "/objects/inventory-control/bin/2"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bin
delete/objects/inventory-control/bin/{key}
Deletes a bin. You can delete a bin if it is not being used and you no longer need it.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the bin.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}