HomeGlossary

FacilityGroups

Get the facility groups

list FacilityGroup

get
Authorizations
Query parameters
pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

facilityGroupIdstringOptional
facilityGroupTypeIdstringOptional
primaryParentGroupIdstringOptional
facilityGroupNamestringOptional
descriptionstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
get
GET /rest/s1/available-to-promise/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
    "facilityGroupId": "text",
    "facilityGroupTypeId": "text",
    "primaryParentGroupId": "text",
    "facilityGroupName": "text",
    "description": "text",
    "lastUpdatedStamp": "2025-07-11T17:39:59.287Z"
  }
]

create FacilityGroup

post
Authorizations
Body
_entitystringOptionalDefault: org.apache.ofbiz.product.facility.FacilityGroup
facilityGroupIdstringOptional
facilityGroupTypeIdstringOptional
primaryParentGroupIdstringOptional
facilityGroupNamestringOptional
descriptionstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
POST /rest/s1/available-to-promise/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
  "facilityGroupId": "text",
  "facilityGroupTypeId": "text",
  "primaryParentGroupId": "text",
  "facilityGroupName": "text",
  "description": "text",
  "lastUpdatedStamp": "2025-07-11T17:39:59.287Z"
}
{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
  "facilityGroupId": "text"
}

one FacilityGroup

get
Authorizations
Path parameters
facilityGroupIdstringRequired
Responses
200
Success
application/json
get
GET /rest/s1/available-to-promise/facilityGroups/{facilityGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
  "facilityGroupId": "text",
  "facilityGroupTypeId": "text",
  "primaryParentGroupId": "text",
  "facilityGroupName": "text",
  "description": "text",
  "lastUpdatedStamp": "2025-07-11T17:39:59.287Z"
}

update FacilityGroup

put
Authorizations
Path parameters
facilityGroupIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.product.facility.FacilityGroup
facilityGroupIdstringOptional
facilityGroupTypeIdstringOptional
primaryParentGroupIdstringOptional
facilityGroupNamestringOptional
descriptionstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
put
PUT /rest/s1/available-to-promise/facilityGroups/{facilityGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
  "facilityGroupId": "text",
  "facilityGroupTypeId": "text",
  "primaryParentGroupId": "text",
  "facilityGroupName": "text",
  "description": "text",
  "lastUpdatedStamp": "2025-07-11T17:39:59.287Z"
}
{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
  "facilityGroupId": "text"
}

list FacilityGroupAndMember

get

View entity for Facility and Facility Group Member details.

Authorizations
Path parameters
facilityGroupIdstringRequired
Query parameters
pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

parentFacilityTypeIdstringOptional
facilityGroupTypeIdstringOptional
primaryParentGroupIdstringOptional
facilityGroupNamestringOptional
descriptionstringOptional
facilityIdstringOptional
fromDatestring · date-timeOptional
thruDatestring · date-timeOptional
sequenceNumnumber · int64Optional
facilityTypeIdstringOptional
parentFacilityIdstringOptional
ownerPartyIdstringOptional
defaultInventoryItemTypeIdstringOptional
facilityNamestringOptional
primaryFacilityGroupIdstringOptional
oldSquareFootagenumber · int64Optional
facilitySizenumberOptional
facilitySizeUomIdstringOptional
productStoreIdstringOptional
defaultDaysToShipnumber · int64Optional

In the absence of a product specific days to ship in ProductFacility, this will be used

openedDatestring · date-timeOptional
closedDatestring · date-timeOptional
defaultDimensionUomIdstringOptional

This field store the unit of measurement of dimension (length, width and height)

defaultWeightUomIdstringOptional
geoPointIdstringOptional
externalIdstringOptional

This field stores facility ID of the external system

openTimestringOptional
closeTimestringOptional
facilityTimeZonestringOptional
maximumOrderLimitnumber · int64Optional
postalCodestringOptional
Responses
200
Success
application/json
get
GET /rest/s1/available-to-promise/facilityGroups/{facilityGroupId}/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.facility.FacilityGroupAndMember",
    "parentFacilityTypeId": "text",
    "facilityGroupId": "text",
    "facilityGroupTypeId": "text",
    "primaryParentGroupId": "text",
    "facilityGroupName": "text",
    "description": "text",
    "facilityId": "text",
    "fromDate": "2025-07-11T17:39:59.287Z",
    "thruDate": "2025-07-11T17:39:59.287Z",
    "sequenceNum": 1,
    "facilityTypeId": "text",
    "parentFacilityId": "text",
    "ownerPartyId": "text",
    "defaultInventoryItemTypeId": "text",
    "facilityName": "text",
    "primaryFacilityGroupId": "text",
    "oldSquareFootage": 1,
    "facilitySize": 1,
    "facilitySizeUomId": "text",
    "productStoreId": "text",
    "defaultDaysToShip": 1,
    "openedDate": "2025-07-11T17:39:59.287Z",
    "closedDate": "2025-07-11T17:39:59.287Z",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text"
  }
]

store FacilityGroupMember

post
Authorizations
Path parameters
facilityGroupIdstringRequired
facilityIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.product.facility.FacilityGroupMember
facilityIdstringOptional
facilityGroupIdstringOptional
fromDatestring · date-timeOptional
thruDatestring · date-timeOptional
sequenceNumnumber · int64Optional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
POST /rest/s1/available-to-promise/facilityGroups/{facilityGroupId}/facilities/{facilityId}/association HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroupMember",
  "facilityId": "text",
  "facilityGroupId": "text",
  "fromDate": "2025-07-11T17:39:59.287Z",
  "thruDate": "2025-07-11T17:39:59.287Z",
  "sequenceNum": 1,
  "lastUpdatedStamp": "2025-07-11T17:39:59.287Z"
}
{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroupMember.PK",
  "facilityId": "text",
  "facilityGroupId": "text",
  "fromDate": "2025-07-11T17:39:59.287Z"
}
PreviousFacilitiesNextCheckOmsConnection

Was this helpful?