Bin Faces
- Get Bin Face Object Definition
- List Bin Faces
- List Bin Faces (Legacy)
- Get Bin Face
- Get Bin Face by Name
- Create Bin Face
- Update Bin Face
- Delete Bin Face
A bin face is one of the four optional attributes (zone, aisle, row, and bin face) that you can assign to a bin to make it easier to find the location of the bin within the warehouse.
Typically, each section between pillars in an aisle is considered a bin face.
Get Bin Face Object Definition
lookup
List all the fields and relationships for the bin face object:
<lookup>
<object>BINFACE</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List Bin Faces
query
List the ID and description for each bin face:
<query>
<object>BINFACE</object>
<select>
<field>FACEID</field>
<field>FACEDESC</field>
</select>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List Bin Faces (Legacy)
readByQuery
<readByQuery>
<object>BINFACE</object>
<fields>*</fields>
<query/>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get Bin Face
read
<read>
<object>BINFACE</object>
<keys>4</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
keys | Required | string | Object RECORDNO to get |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Get Bin Face by Name
readByName
<readByName>
<object>BINFACE</object>
<keys>F2</keys>
<fields>*</fields>
</readByName>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
keys | Required | string | Object FACEID to get |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Create Bin Face
create
<create>
<BINFACE>
<FACEID>F2</FACEID>
<FACEDESC>Bin Face 02</FACEDESC>
</BINFACE>
</create>
Parameters
Name | Required | Type | Description |
---|---|---|---|
BINFACE | Required | object | Object to create |
BINFACE
Name | Required | Type | Description |
---|---|---|---|
FACEID | Required | string | Unique identifier for the bin face. The face ID cannot be modified. |
FACEDESC | Optional | string | Description for the bin face |
Update Bin Face
update
<update>
<BINFACE>
<FACEID>F2</FACEID>
<FACEDESC>Bin Face 02-1</FACEDESC>
</BINFACE>
</update>
Parameters
Name | Required | Type | Description |
---|---|---|---|
BINFACE | Required | object | Object to create |
BINFACE
Name | Required | Type | Description |
---|---|---|---|
RECORDNO | Optional | integer | Bin face RECORDNO to update. Required if not supplying the face ID. |
FACEID | Optional | string | Unique identifier for the bin face. Required if not supplying the bin face record number. The face ID cannot be modified. |
FACEDESC | Optional | string | Description for the bin face |
Delete Bin Face
delete
<delete>
<object>BINFACE</object>
<keys>4</keys>
</delete>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BINFACE |
keys | Required | string | Bin face RECORDNO to delete |