Skip to content
/
Get a list of Location Te...

INSPIRE Public Rest API Documentation. Copyright 2025 Fulfillment WMS. All rights reserved. (1.0)

OpenAPI documentation for API and Auth Rest Services

Detailed API Documentation
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://apidocs.fulfillmentwms.com/_mock/openapi

Dock Appointment Scheduling Service

Dock Appointment Scheduling Services

Operations

Import Service

Services related to importing data

Operations

Reporting, Insights and Metrics Service

Services related to Reporting, Insights and Metrics

Operations

Inventory Service

Services related to Inventory

Operations

Invoice for 3PL Billing Service

Services related to viewing Invoices for 3PL Billing

Operations

Lists Service

Services related to Querying Lists of Objects

Operations

Get a list of Facilities

Request

Get a list of Facilities

Security
Authorization
Query
namestring

Search by name

Default ""
curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/facilities/query \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
enabledboolean
typestring
Enum"WAREHOUSE""TERMINAL""DEPOT""VIRTUAL"
codestring
accounting_refstring
namestring
descriptionstring
notesstring
address1string
address2string
address3string
address4string
citystring
state_provincestring
postal_codestring
countrystring
contact_namestring
contact_phonestring
contact_emailstring
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "enabled": true,
    "type": "WAREHOUSE",
    "code": "string",
    "accounting_ref": "string",
    "name": "string",
    "description": "string",
    "notes": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "string",
    "state_province": "string",
    "postal_code": "string",
    "country": "string",
    "contact_name": "string",
    "contact_phone": "string",
    "contact_email": "string"
  }
]

Get a list of Location Templates

Request

Get a list of Location Templates

Security
Authorization
Query
namestring

Search by name

Default ""
curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/facilities/locations/tmplts/query \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
enabledboolean
namestring
descriptionstring
notesstring
nodeleteboolean
sistring
typestring
Enum"GENERALPURPOSE""DOCKDOOR""STAGING""LABELING""QC""PICKAUDIT""PACK""HOLD""DAMAGED""QUARANTINE"
securitylevelinteger(int32)
zonestring
pickableboolean
resvseqinteger(int32)
pickseqinteger(int32)
putawayseqinteger(int32)
pickfaceboolean
reserveboolean
sdockboolean
sstageboolean
rdockboolean
rstageboolean
projectboolean
wtnumber
wt_modestring
Enum"LBS""KGS"
cubenumber
cube_modestring
Enum"CF""CM"
temp_minnumber
temp_maxnumber
temp_modestring
Enum"F""C"
max_number_lpninteger(int32)
onhand_enableboolean
damaged_enableboolean
hold_enableboolean
quarantine_enableboolean
qa_enableboolean
each_enabledboolean
ip_enabledboolean
case_enabledboolean
pallet_enabledboolean
auto_break_lpnboolean
auto_convert_statusstring
Enum"FOREIGNENTITY""PICKEDUP""INTRANSITRECEIVE""INGATE""UNLOADED""QC""ONHAND""SAFETY""ONHANDBYPASSPUTAWAY""RESERVEDWITHORDER"
auto_convert_uomstring
Enum"EACH""IP""CASE"
velocity_unknownboolean
velocity_aboolean
velocity_bboolean
velocity_cboolean
velocity_dboolean
requires_equipboolean
equip_typestring
Enum"VERT_HEAVY_WIREGUIDED""VERT_HEAVY""NONVERT_CART""NONVERT_PALLET_JACK""NONVERT_HUMAN""MATERIAL_HANDLING"
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "enabled": true,
    "name": "string",
    "description": "string",
    "notes": "string",
    "nodelete": true,
    "si": "string",
    "type": "GENERALPURPOSE",
    "securitylevel": 0,
    "zone": "string",
    "pickable": true,
    "resvseq": 0,
    "pickseq": 0,
    "putawayseq": 0,
    "pickface": true,
    "reserve": true,
    "sdock": true,
    "sstage": true,
    "rdock": true,
    "rstage": true,
    "project": true,
    "wt": 0,
    "wt_mode": "LBS",
    "cube": 0,
    "cube_mode": "CF",
    "temp_min": 0,
    "temp_max": 0,
    "temp_mode": "F",
    "max_number_lpn": 0,
    "onhand_enable": true,
    "damaged_enable": true,
    "hold_enable": true,
    "quarantine_enable": true,
    "qa_enable": true,
    "each_enabled": true,
    "ip_enabled": true,
    "case_enabled": true,
    "pallet_enabled": true,
    "auto_break_lpn": true,
    "auto_convert_status": "FOREIGNENTITY",
    "auto_convert_uom": "EACH",
    "velocity_unknown": true,
    "velocity_a": true,
    "velocity_b": true,
    "velocity_c": true,
    "velocity_d": true,
    "requires_equip": true,
    "equip_type": "VERT_HEAVY_WIREGUIDED"
  }
]

Get a list of Locations for a Facility

Request

Get a list of Locations for a Facility

Security
Authorization
Path
facilityIdstring(uuid)required
Query
stridstring

Search by location Id

Default ""
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/facilities/{facilityId}/locations/query' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
localestring
Enum"pt_BR""es_MX""fr_FR""en_US""de_DE""zh_CN"
nodeleteboolean
facility_idstring(uuid)
tmplt_idstring(uuid)
aisle_details_idstring(uuid)
enabledboolean
notesstring
stridstring
strcdstring
aisleszstring
levelszstring
slotszstring
descriptionstring
aisleintinteger(int32)
levelintinteger(int32)
slotintinteger(int32)
belowlocstring
abovelocstring
leftlocstring
rightlocstring
frontlocstring
backlocstring
coord_xnumber
coord_ynumber
coord_znumber
tmpltobject(FacilityLocationTmpltSecureType)
subLocationsArray of objects(FacilityLocationSecureType)
aisleDetailsobject(FacilityAisleDetailsSecureType)
facilityobject(FacilityMinSecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "locale": "pt_BR",
    "nodelete": true,
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "tmplt_id": "0cf10b77-feef-4821-ab9d-66698af376f5",
    "aisle_details_id": "b297023c-5230-4ab1-9b5b-5662e5b8d2b5",
    "enabled": true,
    "notes": "string",
    "strid": "string",
    "strcd": "string",
    "aislesz": "string",
    "levelsz": "string",
    "slotsz": "string",
    "description": "string",
    "aisleint": 0,
    "levelint": 0,
    "slotint": 0,
    "belowloc": "string",
    "aboveloc": "string",
    "leftloc": "string",
    "rightloc": "string",
    "frontloc": "string",
    "backloc": "string",
    "coord_x": 0,
    "coord_y": 0,
    "coord_z": 0,
    "tmplt": { … },
    "subLocations": [ … ],
    "aisleDetails": { … },
    "facility": { … }
  }
]

Mobile Tasks Service

Services related to Mobile Tasks

Operations

Receiving Order Service

Services related to Receiving Orders

Operations

Shipping Order Service

Services related to Shipping Orders

Operations

Work/Project Order Service

Services related to Work/Project Orders

Operations

Authentication Service

Services related to authentication

Operations