# FacilityGroups

Deprecated (since maarg 4.4.0): Use admin/facilityGroups

## GET /facilityGroups

> list FacilityGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/facilityGroups":{"get":{"tags":["facilityGroups"],"summary":"list FacilityGroup","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"facilityGroupId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityGroupTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryParentGroupId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityGroupName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /facilityGroups

> create FacilityGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup.PK":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup.PK"},"facilityGroupId":{"type":"string"}}},"org.apache.ofbiz.product.facility.FacilityGroup":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/facilityGroups":{"post":{"tags":["facilityGroups"],"summary":"create FacilityGroup","description":null,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}}},"required":false}}}}}
```

## GET /facilityGroups/{facilityGroupId}

> one FacilityGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/facilityGroups/{facilityGroupId}":{"get":{"tags":["facilityGroups"],"summary":"one FacilityGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"facilityGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## PUT /facilityGroups/{facilityGroupId}

> update FacilityGroup

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup.PK":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup.PK"},"facilityGroupId":{"type":"string"}}},"org.apache.ofbiz.product.facility.FacilityGroup":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/facilityGroups/{facilityGroupId}":{"put":{"tags":["facilityGroups"],"summary":"update FacilityGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"facilityGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroup"}}},"required":false}}}}}
```

## list FacilityGroupAndMember

> View entity for Facility and Facility Group Member details.

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.facility.FacilityGroupAndMember":{"title":"Facility Group And Member","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.FacilityGroupAndMember"},"parentFacilityTypeId":{"type":"string"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"facilityId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"facilityTypeId":{"type":"string"},"parentFacilityId":{"type":"string"},"ownerPartyId":{"type":"string"},"defaultInventoryItemTypeId":{"type":"string"},"facilityName":{"type":"string"},"primaryFacilityGroupId":{"type":"string"},"oldSquareFootage":{"type":"number","format":"int64"},"facilitySize":{"type":"number"},"facilitySizeUomId":{"type":"string"},"productStoreId":{"type":"string"},"defaultDaysToShip":{"type":"number","format":"int64"},"openedDate":{"type":"string","format":"date-time"},"closedDate":{"type":"string","format":"date-time"},"defaultDimensionUomId":{"type":"string"},"defaultWeightUomId":{"type":"string"},"geoPointId":{"type":"string"},"externalId":{"type":"string"},"openTime":{"type":"string"},"closeTime":{"type":"string"},"facilityTimeZone":{"type":"string"},"maximumOrderLimit":{"type":"number","format":"int64"},"postalCode":{"type":"string"}}}}},"paths":{"/facilityGroups/{facilityGroupId}/facilities":{"get":{"tags":["facilityGroups"],"summary":"list FacilityGroupAndMember","description":"View entity for Facility and Facility Group Member details.","parameters":[{"schema":{"type":"string"},"name":"facilityGroupId","in":"path","required":true,"description":null},{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"parentFacilityTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityGroupTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryParentGroupId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityGroupName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"fromDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"thruDate","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"parentFacilityId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"ownerPartyId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"defaultInventoryItemTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryFacilityGroupId","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"oldSquareFootage","in":"query","required":false,"description":null},{"schema":{"type":"number","format":""},"name":"facilitySize","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilitySizeUomId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"productStoreId","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"defaultDaysToShip","in":"query","required":false,"description":"In the absence of a product specific days to ship in ProductFacility, this will be used"},{"schema":{"type":"string","format":"date-time"},"name":"openedDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"closedDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"defaultDimensionUomId","in":"query","required":false,"description":"This field store the unit of measurement of dimension (length, width and height)"},{"schema":{"type":"string","format":""},"name":"defaultWeightUomId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"geoPointId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"externalId","in":"query","required":false,"description":"This field stores facility ID of the external system"},{"schema":{"type":"string","format":""},"name":"openTime","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"closeTime","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"facilityTimeZone","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"maximumOrderLimit","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"postalCode","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/co.hotwax.facility.FacilityGroupAndMember"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /facilityGroups/{facilityGroupId}/facilities/{facilityId}/association

> store FacilityGroupMember

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"facilityGroups","description":"Deprecated (since maarg 4.4.0): Use admin/facilityGroups"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.product.facility.FacilityGroupMember.PK":{"title":"Facility Group Member","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroupMember.PK"},"facilityId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}},"org.apache.ofbiz.product.facility.FacilityGroupMember":{"title":"Facility Group Member","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroupMember"},"facilityId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/facilityGroups/{facilityGroupId}/facilities/{facilityId}/association":{"post":{"tags":["facilityGroups"],"summary":"store FacilityGroupMember","description":null,"parameters":[{"schema":{"type":"string"},"name":"facilityGroupId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"facilityId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroupMember.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroupMember"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/org.apache.ofbiz.product.facility.FacilityGroupMember"}}},"required":false}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/facilitygroups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.