Rows

A row 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 rows

get/objects/inventory-control/row

Returns up to 100 object references from the collection with a key, ID, and link for each row. 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": "354",
      • "id": "R1ADW",
      • "href": "/objects/inventory-control/row/354"
      },
    • {
      • "key": "355",
      • "id": "R1BDW",
      • "href": "/objects/inventory-control/row/355"
      },
    • {
      • "key": "356",
      • "id": "R2ADW",
      • "href": "/objects/inventory-control/row/356"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageRow": 100
    }
}
Create a row
post/objects/inventory-control/row
Creates a new row.


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


 
 Example:  "R3ADW"
description
string
Description for the row.


 
 Example:  "Row 3A Dishwashers"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "R3ADW",
  • "description": "Row 3A Dishwashers"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "543",
    • "id": "R3ADW",
    • "href": "/objects/inventory-control/row/543"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a row
get/objects/inventory-control/row/{key}
Returns detailed information for a specified row.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "354",
    • "id": "R3ADW",
    • "description": "Row 3 A Dishwashers",
    • "audit": {
      • "createdDateTime": "2021-05-07T01:15:23Z",
      • "modifiedDateTime": "2021-05-07T01:15:23Z",
      • "createdBy": "13",
      • "modifiedBy": "13"
      },
    • "href": "/objects/inventory-control/row/354"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a row
patch/objects/inventory-control/row/{key}
Updates an existing row by setting field values. Any fields not provided remain unchanged.


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


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


 
 Example:  "Row 3A Dishwashers"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Row 3A1 Dishwashers"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "R3ADW",
    • "href": "/objects/inventory-control/row/2"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a row
delete/objects/inventory-control/row/{key}
Deletes a row. You can delete a row if it is not being used and you no longer need it. Deleted rows cannot be recovered.


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


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