Zones

A zone 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 zones

get/objects/inventory-control/zone

Returns up to 100 object references from the collection with a key, ID, and link for each zone. 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": "546",
      • "id": "RZ1A",
      • "href": "/objects/inventory-control/zone/546"
      },
    • {
      • "key": "547",
      • "id": "RZ2A",
      • "href": "/objects/inventory-control/zone/547"
      },
    • {
      • "key": "548",
      • "id": "RZ3A",
      • "href": "/objects/inventory-control/zone/548"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 2,
    • "previous": 1
    }
}
Create a zone
post/objects/inventory-control/zone
Creates a new zone.


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


 
 Example:  "Z4REF"
description
string
Description for the zone.


 
 Example:  "Refrigeration Zone Four"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Z2",
  • "description": "Refrigeration zone 2"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "546",
    • "id": "RZ2",
    • "href": "/objects/inventory-control/zone/546"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a zone
get/objects/inventory-control/zone/{key}
Returns detailed information for a specified zone.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


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


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


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


 
 Example:  "Refrigeration Zone Four"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Refrigeration zone 2A"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "564",
    • "id": "RZ2",
    • "href": "/objects/inventory-control/zone/564"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a zone
delete/objects/inventory-control/zone/{key}
Deletes a zone. You can delete a zone if it is not being used and you no longer need it. Deleted zones cannot be recovered.


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


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