Aisles

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

List aisles

get/objects/inventory-control/aisle

Returns up to 100 object references from the collection with a key, ID, and link for each aisle. 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": "145",
      • "id": "A12",
      • "href": "/objects/inventory-control/aisle/145"
      },
    • {
      • "key": "146",
      • "id": "A14",
      • "href": "/objects/inventory-control/aisle/146"
      },
    • {
      • "key": "147",
      • "id": "A16",
      • "href": "/objects/inventory-control/aisle/147"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create an aisle
post/objects/inventory-control/aisle
Creates a new aisle.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the aisle. The aisle ID cannot be modified.


 
 Example:  "A2"
description
string
Description for the aisle.


 
 Example:  "Aisle 2 Dishwashers"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "A12",
  • "description": "Aisle 12 Dishwashers"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "145",
    • "id": "AD12",
    • "href": "/objects/inventory-control/aisle/145"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an aisle
get/objects/inventory-control/aisle/{key}
Returns detailed information for a specified aisle.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "145",
    • "id": "A12",
    • "description": "Aisle 12 of dishwashers",
    • "audit": {
      • "createdDateTime": "2021-05-07T01:15:23Z",
      • "modifiedDateTime": "2021-05-07T01:15:23Z",
      • "createdBy": "13",
      • "modifiedBy": "13"
      },
    • "href": "/objects/inventory-control/aisle/145"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update an aisle
patch/objects/inventory-control/aisle/{key}
Updates an existing aisle by setting field values. Any fields not provided remain unchanged.


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


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


 
 Example:  "Aisle 2 Dishwashers"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Aisle 1 dishwashers"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "145",
    • "id": "A12",
    • "href": "/objects/inventory-control/aisle/145"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an aisle
delete/objects/inventory-control/aisle/{key}
Deletes an aisle. You can delete an aisle if it is not being used and you no longer need it. Deleted aisles cannot be recovered.


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


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