Warehouse is a dimension that can be defined by the company and set on transactions to expand report functionality and insight.


List Warehouses

readByQuery

<readByQuery>
    <object>WAREHOUSE</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use WAREHOUSE
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. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
STATUS Optional string Status. Use T for Active and F for Inactive.

Get Warehouse

read

<read>
    <object>WAREHOUSE</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use WAREHOUSE
keys Required string Warehouse 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 Warehouse by Name

readByName

<readByName>
    <object>WAREHOUSE</object>
    <keys>9ADMIN</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use WAREHOUSE
keys Required string Warehouse WAREHOUSEID 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 Warehouse

create

<create>
    <WAREHOUSE>
        <WAREHOUSEID>W1234</WAREHOUSEID>
        <NAME>hello world</NAME>
        <LOC>
            <LOCATIONID>L1234</LOCATIONID>
        </LOC>
    </WAREHOUSE>
</create>

Parameters

Name Required Type Description
WAREHOUSE Optional object Object to create

WAREHOUSE

Name Required Type Description
WAREHOUSEID Required string Warehouse ID to create
NAME Required string Warehouse name
LOC Required object Location
MANAGERID Optional string Manager employee ID
PARENTID Optional string Parent warehouse ID
CONTACTINFO Optional object Primary contact
SHIPTO Optional object Ship to contact
USEDINGL Optional boolean Used in GL. Use false for No, true for Yes. (Default: true)
STATUS Optional string Warehouse status. Use active for Active otherwise use inactive for Inactive (Default: active)
Custom fields Optional varies Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

LOC

Name Required Type Description
LOCATIONID Required string Location ID of warehouse

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

Update Warehouse

update

<update>
    <WAREHOUSE>
        <RECORDNO>212</RECORDNO>
        <STATUS>active</STATUS>
    </WAREHOUSE>
</update>

Parameters

Name Required Type Description
WAREHOUSE Optional object Object to update

WAREHOUSE

Name Required Type Description
RECORDNO Optional integer Record number of warehouse to update. Required if not using WAREHOUSEID.
WAREHOUSEID Optional string Warehouse ID. Required if not using RECORDNO.
NAME Optional string Warehouse name
LOC Optional object Location
MANAGERID Optional string Manager employee ID
PARENTID Optional string Parent warehouse ID
CONTACTINFO Optional object Primary contact
SHIPTO Optional object Ship to contact
USEDINGL Optional boolean Used in GL. Use false for No, true for Yes. (Default: true)
STATUS Optional string Warehouse status. Use active for Active otherwise use inactive for Inactive (Default: active)
Custom fields Optional varies Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

LOC

Name Required Type Description
LOCATIONID Required string Location ID of warehouse

CONTACTINFO

Name Required Type Description
CONTACTNAME Required string Primary contact name

SHIPTO

Name Required Type Description
CONTACTNAME Required string Ship to contact name

Delete Warehouse

delete

<delete>
    <object>WAREHOUSE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use WAREHOUSE
keys Required string Warehouse RECORDNO to delete

Provide feedback