Bin faces

A bin face is one of four optional attributes (zone, aisle, row, and bin face) you can assign to a bin to make it easier to find within the warehouse.

List bin faces

get/objects/inventory-control/bin-face

Returns up to 100 object references from the collection with a key, ID, and link for each bin face. 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": "BF11",
      • "href": "/objects/inventory-control/bin-face/12"
      },
    • {
      • "key": "14",
      • "id": "BF22",
      • "href": "/objects/inventory-control/bin-face/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a bin face
post/objects/inventory-control/bin-face
Creates a new bin face.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique identifier or name for the bin face. The bin face ID cannot be modified.


 
 Example:  "BF232"
description
string
Description for the bin face.


 
 Example:  "Bin Face 232"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "BF2",
  • "description": "Bin Face 2"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "22",
    • "id": "BF2",
    • "href": "/objects/inventory-control/bin-face/22"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a bin face
get/objects/inventory-control/bin-face/{key}
Returns detailed information for a specified bin face.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1232",
    • "id": "BF123",
    • "description": "Bin Face 123",
    • "audit": {
      • "createdDateTime": "2021-05-07T01:15:23Z",
      • "modifiedDateTime": "2021-05-07T01:15:23Z",
      • "createdBy": "13",
      • "modifiedBy": "13"
      },
    • "href": "/objects/inventory-control/bin-face/1232"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a bin face
patch/objects/inventory-control/bin-face/{key}
Updates an existing bin face by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  99
Request Body schema: application/json
description
string
Description for the bin face.


 
 Example:  "Bin Face 232"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "W1 G1 Bestsellers"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1232",
    • "id": "BF123",
    • "href": "/objects/inventory-control/bin-face/1232"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a bin face
delete/objects/inventory-control/bin-face/{key}
Deletes a bin face.


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


 
 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
    }
}