FacilityGroups

Deprecated (since maarg 4.4.0): Use admin/facilityGroups

list FacilityGroup

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/facilityGroups

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z"
  }
]

create FacilityGroup

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: org.apache.ofbiz.product.facility.FacilityGroup

facilityGroupIdstringOptional

facilityGroupTypeIdstringOptional

primaryParentGroupIdstringOptional

facilityGroupNamestringOptional

descriptionstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/facilityGroups

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
  "facilityGroupId": "text"
}

one FacilityGroup

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

facilityGroupIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/facilityGroups/{facilityGroupId}

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z"
}

update FacilityGroup

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

facilityGroupIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: org.apache.ofbiz.product.facility.FacilityGroup

facilityGroupIdstringOptional

facilityGroupTypeIdstringOptional

primaryParentGroupIdstringOptional

facilityGroupNamestringOptional

descriptionstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

put

/facilityGroups/{facilityGroupId}

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
  "facilityGroupId": "text"
}

list FacilityGroupAndMember

get

View entity for Facility and Facility Group Member details.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/facilityGroups/{facilityGroupId}/facilities

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z",
    "thruDate": "2025-12-16T23:57:50.400Z",
    "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-12-16T23:57:50.400Z",
    "closedDate": "2025-12-16T23:57:50.400Z",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text"
  }
]

store FacilityGroupMember

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

facilityGroupIdstringRequired

facilityIdstringRequired

Body

application/jsonmultipart/form-data

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

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

HTTPcURLJavaScriptPython

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-12-16T23:57:50.400Z",
  "thruDate": "2025-12-16T23:57:50.400Z",
  "sequenceNum": 1,
  "lastUpdatedStamp": "2025-12-16T23:57:50.400Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.product.facility.FacilityGroupMember.PK",
  "facilityId": "text",
  "facilityGroupId": "text",
  "fromDate": "2025-12-16T23:57:50.400Z"
}