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.
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 query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Inventory Control |
---|---|
Configuration | Advanced workflows is enabled. |
User ype | Business, CRM, Employee, Warehouse |
Permissions | List, View Zones |
OK
Bad Request
{- "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
}
}
Creates a new zone.
Subscription | Inventory Control |
---|---|
Configuration | Advanced workflows is enabled. |
User ype | Business |
Permissions | List, View, Add Zones |
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" |
Created
Bad Request
{- "id": "Z2",
- "description": "Refrigeration zone 2"
}
{- "ia::result": {
- "key": "546",
- "id": "RZ2",
- "href": "/objects/inventory-control/zone/546"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified zone.
Subscription | Inventory Control |
---|---|
Configuration | Advanced workflows is enabled. |
User ype | Business, CRM, Employee, Warehouse |
Permissions | List, View Zones |
key required | string System-assigned unique key for the zone. Example: 564 |
OK
Bad Request
{- "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
}
}
Updates an existing zone by setting field values. Any fields not provided remain unchanged.
Subscription | Inventory Control |
---|---|
Configuration | Advanced workflows is enabled. |
User ype | Business |
Permissions | List, View, Edit Zones |
key required | string System-assigned unique key for the zone. Example: 564 |
description | string Description for the zone. Example: "Refrigeration Zone Four" |
OK
Bad Request
{- "description": "Refrigeration zone 2A"
}
{- "ia::result": {
- "key": "564",
- "id": "RZ2",
- "href": "/objects/inventory-control/zone/564"
}, - "ia::meta": {
- "totalCount": 1
}
}
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.
Subscription | Inventory Control |
---|---|
Configuration | Advanced workflows is enabled. |
User ype | Business |
Permissions | List, View, Delete Zones |
key required | string System-assigned unique key for the zone. Example: 564 |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "inventory-control/zone" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "inventory-control/aisle",
- "filters": [
- {
- "$contains": {
- "description": "storage"
}
}
], - "fields": [
- "key",
- "id",
- "description",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "3",
- "id": "Z003",
- "description": "Dry storage",
- "href": "/objects/inventory-control/zone/3"
}, - {
- "key": "4",
- "id": "Z004",
- "description": "Security storage",
- "href": "/objects/inventory-control/zone/4"
}, - {
- "key": "5",
- "id": "Z005",
- "description": "Oversize storage",
- "href": "/objects/inventory-control/zone/5"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}