Warehouse groups

A warehouse group categorizes warehouse dimension records, mainly for the purpose of structuring financial reporting.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List warehouse groups

get/objects/inventory-control/warehouse-group

Returns up to 100 object references from the collection with a key, ID, and link for each warehouse group. This operation is mostly for use in testing; use query 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": "1",
      • "id": "Top Level warehouses",
      • "href": "/objects/inventory-control/warehouse-group/1"
      },
    • {
      • "key": "5",
      • "id": "warehouses without Activity",
      • "href": "/objects/inventory-control/warehouse-group/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a warehouse group
post/objects/inventory-control/warehouse-group
Creates a new warehouse group.


SecurityOAuth2 
Request 
Request Body schema: application/json
Create a new warehouse group


id
required
string
Unique identifier for the warehouse group.


 
 Example:  "EastCoastWarehouses"
name
required
string
Name of the warehouse group.


 
 Example:  "EastCoast Warehouses"
groupType
required
string
Group membership type. The group type and related fields that you set determine which warehouses are added to the group. * all - All items that match the memberFilter criteria. If ‘all’ is selected, 'memberFilter' is required. * specific - Specify the items to include and their order in the groupMembers array. If ‘specific’ is selected, 'groupMembers' is required.


 Enum: "all" "specific"  
 Example:  "all"
description
string
Description of the warehouse group.


 
 Example:  "Warehouses on the east coast"
sortField
string
 Default:  "warehouseId"
Warehouse field to sort on. Only applicable when groupType = all.


 Enum: "createdAtEntityId" "location" "managerId" "parentWarehouse" "status" "warehouseId"  
 Example:  "warehouseId"
sortOrder
string
 Default:  "ascending"
Sort order for warehouse that match the memberFilter. Only applicable when groupType = all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
The maximum number of warehouses that match the memberFilter to include in the warehouse group. Only applicable when groupType = all.


 
 Example:  100
createDimensionComponents
boolean
 Default:  false
Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering.


 
 Example:  true
object
General ledger (GL) account group associated with the warehouse group.


 
Array of objects or null
One or more filters to select the warehouses to include in the warehouse group.


 
 Array 
field
string
Warehouse field to filter on.


 Enum: "createdAtEntityId" "location" "managerId" "parentWarehouse" "status" "warehouseId"  
 Example:  "status"
operator
string
Operator to filter the group.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "equals"
value
string
Value to use to filter the group.


 
 Example:  "active"
conditionType
string
 Default:  "and"
Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string
Expression for combining multiple filters. Only applicable if the 'conditionType' is 'expression'.


 
 Example:  "(1 AND 2) OR 3"
Array of objects
The members of the warehouse group.


 
 Array 
object
Warehouse group that this warehouse is a member of.


 
object
Member warehouse of the warehousegroup.


 
sortOrder
integer
Sort Order of the warehouse within the warehouse group startting from 0.


 
 Example:  1
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "EastCoastWarehouses",
  • "name": "EastCoast Warehouses",
  • "description": "Warehouses on eastcoast",
  • "groupType": "specific",
  • "createDimensionComponents": true,
  • "memberFilter": [ ],
  • "maxMatches": 0,
  • "sortField": "warehouseId",
  • "conditionType": "and",
  • "expression": "",
  • "sortOrder": "ascending",
  • "groupMembers": [
    • {
      • "warehouse": {
        },
      • "sortOrder": 0
      },
    • {
      • "warehouse": {
        },
      • "sortOrder": 1
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "EastCoastWarehouses",
    • "href": "/objects/inventory-control/warehouse-group/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a warehouse group
get/objects/inventory-control/warehouse-group/{key}
Returns detailed information for a specified warehouse group.


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


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "BooksWarehouses",
    • "name": "Books Warehouses",
    • "description": "Warehouses store Books",
    • "groupType": "all",
    • "memberFilter": [
      • {
        }
      ],
    • "audit": {
      • "createdDateTime": "2023-12-12T23:33:05Z",
      • "modifiedDateTime": "2023-12-12T23:33:05Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "glAccountGroup": {
      • "id": "BooksWarehouses"
      },
    • "groupMembers": [ ],
    • "maxMatches": 10,
    • "sortField": "warehouseId",
    • "conditionType": "and",
    • "expression": "",
    • "sortOrder": "ascending",
    • "href": "/objects/inventory-control/warehouse-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a warehouse group
patch/objects/inventory-control/warehouse-group/{key}
Updates an existing warehouse group by setting field values. Any fields not provided remain unchanged.


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


 
Request Body schema: application/json
name
string
Name of the warehouse group.


 
 Example:  "EastCoast Warehouses"
description
string
Description of the warehouse group.


 
 Example:  "Warehouses on the east coast"
groupType
string
Group membership type. The group type and related fields that you set determine which warehouses are added to the group. * all - All items that match the memberFilter criteria. If ‘all’ is selected, 'memberFilter' is required. * specific - Specify the items to include and their order in the groupMembers array. If ‘specific’ is selected, 'groupMembers' is required.


 Enum: "all" "specific"  
 Example:  "all"
sortField
string
 Default:  "warehouseId"
Warehouse field to sort on. Only applicable when groupType = all.


 Enum: "createdAtEntityId" "location" "managerId" "parentWarehouse" "status" "warehouseId"  
 Example:  "warehouseId"
sortOrder
string
 Default:  "ascending"
Sort order for warehouse that match the memberFilter. Only applicable when groupType = all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
The maximum number of warehouses that match the memberFilter to include in the warehouse group. Only applicable when groupType = all.


 
 Example:  100
createDimensionComponents
boolean
 Default:  false
Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering.


 
 Example:  true
object
General ledger (GL) account group associated with the warehouse group.


 
Array of objects or null
One or more filters to select the warehouses to include in the warehouse group.


 
 Array 
field
string
Warehouse field to filter on.


 Enum: "createdAtEntityId" "location" "managerId" "parentWarehouse" "status" "warehouseId"  
 Example:  "status"
operator
string
Operator to filter the group.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "equals"
value
string
Value to use to filter the group.


 
 Example:  "active"
conditionType
string
 Default:  "and"
Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string
Expression for combining multiple filters. Only applicable if the 'conditionType' is 'expression'.


 
 Example:  "(1 AND 2) OR 3"
Array of objects
The members of the warehouse group.


 
 Array 
object
Warehouse group that this warehouse is a member of.


 
object
Member warehouse of the warehousegroup.


 
sortOrder
integer
Sort Order of the warehouse within the warehouse group startting from 0.


 
 Example:  1
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Warehouses store Books and notebooks"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "BooksWarehouses",
    • "href": "/objects/inventory-control/warehouse-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a warehouse group
delete/objects/inventory-control/warehouse-group/{key}
Deletes a warehouse group. A warehouse group can be deleted if it is not being used for reporting.


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


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query warehouse groups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "inventory-control/warehouse-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
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
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}