Facilities

Get the facilities

list FacilityAndType

get

Authorizations

basicAuthapi_key

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

typeDescriptionstringOptional

facilityIdstringOptional

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

descriptionstringOptional

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

parentTypeIdstringOptional

hasTablestringOptional

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

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.facility.FacilityAndType",
    "typeDescription": "text",
    "facilityId": "text",
    "facilityTypeId": "text",
    "parentFacilityId": "text",
    "ownerPartyId": "text",
    "defaultInventoryItemTypeId": "text",
    "facilityName": "text",
    "primaryFacilityGroupId": "text",
    "oldSquareFootage": 1,
    "facilitySize": 1,
    "facilitySizeUomId": "text",
    "productStoreId": "text",
    "defaultDaysToShip": 1,
    "openedDate": "2025-08-10T19:10:08.996Z",
    "closedDate": "2025-08-10T19:10:08.996Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "parentTypeId": "text",
    "hasTable": "text"
  }
]

create Facility

post

Authorizations

basicAuthapi_key

Body

application/jsonmultipart/form-data

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

facilityIdstringOptional

facilityTypeIdstringOptional

parentFacilityIdstringOptional

ownerPartyIdstringOptional

defaultInventoryItemTypeIdstringOptional

facilityNamestringOptional

primaryFacilityGroupIdstringOptional

oldSquareFootagenumber · int64Optional

facilitySizenumberOptional

facilitySizeUomIdstringOptional

productStoreIdstringOptional

defaultDaysToShipnumber · int64Optional

openedDatestring · date-timeOptional

closedDatestring · date-timeOptional

descriptionstringOptional

defaultDimensionUomIdstringOptional

defaultWeightUomIdstringOptional

geoPointIdstringOptional

externalIdstringOptional

openTimestringOptional

closeTimestringOptional

facilityTimeZonestringOptional

maximumOrderLimitnumber · int64Optional

postalCodestringOptional

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

HTTPcURLJavaScriptPython

POST /rest/s1/available-to-promise/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 700

{
  "_entity": "org.apache.ofbiz.product.facility.Facility",
  "facilityId": "text",
  "facilityTypeId": "text",
  "parentFacilityId": "text",
  "ownerPartyId": "text",
  "defaultInventoryItemTypeId": "text",
  "facilityName": "text",
  "primaryFacilityGroupId": "text",
  "oldSquareFootage": 1,
  "facilitySize": 1,
  "facilitySizeUomId": "text",
  "productStoreId": "text",
  "defaultDaysToShip": 1,
  "openedDate": "2025-08-10T19:10:08.996Z",
  "closedDate": "2025-08-10T19:10:08.996Z",
  "description": "text",
  "defaultDimensionUomId": "text",
  "defaultWeightUomId": "text",
  "geoPointId": "text",
  "externalId": "text",
  "openTime": "text",
  "closeTime": "text",
  "facilityTimeZone": "text",
  "maximumOrderLimit": 1,
  "postalCode": "text",
  "lastUpdatedStamp": "2025-08-10T19:10:08.996Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.product.facility.Facility.PK",
  "facilityId": "text"
}

one FacilityAndType

get

Authorizations

basicAuthapi_key

Path parameters

facilityIdstringRequired

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

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/facilities/{facilityId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "co.hotwax.facility.FacilityAndType",
  "typeDescription": "text",
  "facilityId": "text",
  "facilityTypeId": "text",
  "parentFacilityId": "text",
  "ownerPartyId": "text",
  "defaultInventoryItemTypeId": "text",
  "facilityName": "text",
  "primaryFacilityGroupId": "text",
  "oldSquareFootage": 1,
  "facilitySize": 1,
  "facilitySizeUomId": "text",
  "productStoreId": "text",
  "defaultDaysToShip": 1,
  "openedDate": "2025-08-10T19:10:08.996Z",
  "closedDate": "2025-08-10T19:10:08.996Z",
  "description": "text",
  "defaultDimensionUomId": "text",
  "defaultWeightUomId": "text",
  "geoPointId": "text",
  "externalId": "text",
  "openTime": "text",
  "closeTime": "text",
  "facilityTimeZone": "text",
  "maximumOrderLimit": 1,
  "postalCode": "text",
  "parentTypeId": "text",
  "hasTable": "text"
}

update Facility

put

Authorizations

basicAuthapi_key

Path parameters

facilityIdstringRequired

Body

application/jsonmultipart/form-data

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

facilityIdstringOptional

facilityTypeIdstringOptional

parentFacilityIdstringOptional

ownerPartyIdstringOptional

defaultInventoryItemTypeIdstringOptional

facilityNamestringOptional

primaryFacilityGroupIdstringOptional

oldSquareFootagenumber · int64Optional

facilitySizenumberOptional

facilitySizeUomIdstringOptional

productStoreIdstringOptional

defaultDaysToShipnumber · int64Optional

openedDatestring · date-timeOptional

closedDatestring · date-timeOptional

descriptionstringOptional

defaultDimensionUomIdstringOptional

defaultWeightUomIdstringOptional

geoPointIdstringOptional

externalIdstringOptional

openTimestringOptional

closeTimestringOptional

facilityTimeZonestringOptional

maximumOrderLimitnumber · int64Optional

postalCodestringOptional

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

HTTPcURLJavaScriptPython

PUT /rest/s1/available-to-promise/facilities/{facilityId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 700

{
  "_entity": "org.apache.ofbiz.product.facility.Facility",
  "facilityId": "text",
  "facilityTypeId": "text",
  "parentFacilityId": "text",
  "ownerPartyId": "text",
  "defaultInventoryItemTypeId": "text",
  "facilityName": "text",
  "primaryFacilityGroupId": "text",
  "oldSquareFootage": 1,
  "facilitySize": 1,
  "facilitySizeUomId": "text",
  "productStoreId": "text",
  "defaultDaysToShip": 1,
  "openedDate": "2025-08-10T19:10:08.996Z",
  "closedDate": "2025-08-10T19:10:08.996Z",
  "description": "text",
  "defaultDimensionUomId": "text",
  "defaultWeightUomId": "text",
  "geoPointId": "text",
  "externalId": "text",
  "openTime": "text",
  "closeTime": "text",
  "facilityTimeZone": "text",
  "maximumOrderLimit": 1,
  "postalCode": "text",
  "lastUpdatedStamp": "2025-08-10T19:10:08.996Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.product.facility.Facility.PK",
  "facilityId": "text"
}

list FacilityOrderCount

get

Authorizations

basicAuthapi_key

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

facilityIdstringOptional

lastOrderCountnumber · int64Optional

entryDatestring · dateOptional

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

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/facilities/orderCount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.facility.FacilityOrderCount",
    "facilityId": "text",
    "lastOrderCount": 1,
    "entryDate": "2025-08-10",
    "lastUpdatedStamp": "2025-08-10T19:10:08.996Z"
  }
]