For each bin in the given warehouse, list the bin ID and description:
Parameters
Name
Required
Type
Description
object
Required
string
Use BIN
filter
Optional
object
Filter expression to limit the response to only objects that match the 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).
select
Required
sequence
The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
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>
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>
Specify the returnformat for the response: xml (default), json, or csv <returnformat>json</returnformat>
pagesize
Optional
integer
Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset
Optional
integer
Point at which to start indexing into records (Default: 0)
Query and List Bins (Legacy)
readByQuery
Parameters
Name
Required
Type
Description
object
Required
string
Use BIN
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
read
Parameters
Name
Required
Type
Description
object
Required
string
Use BIN
keys
Required
string
Comma-separated list of object RECORDNO to get
fields
Optional
string
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields.
returnFormat
Optional
string
Data format for the response body:
xml (default)
json
csv
Get Bin by ID
readByName
Parameters
Name
Required
Type
Description
object
Required
string
Use BIN
keys
Required
string
Comma-separated list of object BINID to get
fields
Optional
string
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields.
returnFormat
Optional
string
Data format for the response body:
xml (default)
json
csv
Create Bin
create
Parameters
Name
Required
Type
Description
BIN
Required
object
Object to create
BIN
Name
Required
Type
Description
BINID
Required
string
Unique identifier for the bin. Consider using an identifier that makes it easier to find the bin. For example, if bin 10 is in zone 4, aisle 2, row 3a, and bin face 2, you might use Z4-A2-R3a-BF2-B10 for the ID.
BINDESC
Optional
string
Description for the bin
BINSIZEID
Optional
string
ID for the bin size
SEQUENCENO
Optional
numeric
Sequence number for the bin. Sequence numbering supports more efficient picking and packing, and cycle counts.
STATUS
Optional
string
Status of the bin. Use active or inactive (Default: active)
PORTABLE
Optional
boolean
Use true if the bin can be moved to another location, false otherwise (Default: false).
WAREHOUSEID
Optional
string
ID of the warehouse
ZONEID
Optional
string
ID of the zone
AISLEID
Optional
string
ID of the aisle
ROWID
Optional
string
ID of the row
FACEID
Optional
string
ID of the bin face
Update Bin
update
Update the status of the bin with the given ID:
Update the ID of the bin with the given record number:
Parameters
Name
Required
Type
Description
BIN
Required
object
Object to update
BIN
Name
Required
Type
Description
BINID
Optional
string
ID of the bin. Required if not providing a record number.
RECORDNO
Optional
string
Record number of the bin. Required if not providing a bin ID.
BINDESC
Optional
string
Description for the bin
BINSIZEID
Optional
string
ID of the bin size
SEQUENCENO
Optional
numeric
Sequence number for the bin. Sequence numbering supports more efficient picking and packing, and cycle counts.
STATUS
Optional
string
Status of the bin. Use active or inactive. Bins should only be set to to inactive when empty.
PORTABLE
Optional
boolean
Use true if the bin can be moved to another location, false otherwise. Bins should only be set as portable when empty.