Skip to content

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

Query Inventory

Request

Query Inventory

Security
Authorization
Body*/*

Query filter

facilitiesArray of strings(uuid)
accountsArray of strings(uuid)
itemsArray of strings(uuid)
lotsArray of strings
sublotsArray of strings
containersArray of strings
channelsArray of strings(uuid)
orderNumberstring
poNumberstring
transNumberstring
carriersArray of strings(uuid)
statusesArray of strings
Items Enum"PENDING""INTRANSIT""OPEN""HOLD""WAITING_PUTAWAY""PUTTINGAWAY""PUTAWAY""WAITING_RESERVE""RESERVED""WAITING_PICK"
createdonstring(date-time)
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/inv/query \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Ok

Bodyapplication/jsonArray [
idinteger(int64)
inv_key_idstring(uuid)
facility_idstring(uuid)
account_idstring(uuid)
item_idstring(uuid)
internalstatusstring
Enum"FOREIGNENTITY""PICKEDUP""INTRANSITRECEIVE""INGATE""UNLOADED""QC""ONHAND""SAFETY""ONHANDBYPASSPUTAWAY""RESERVEDWITHORDER"
reservedfor_idstring(uuid)
account_namestring
account_descriptionstring
reservedfor_channel_idstring(uuid)
channel_namestring
channel_descriptionstring
ssccstring
lotcodestring
sublotcodestring
wtnumber
wt_modestring
Enum"LBS""KGS"
expirydatestring(date-time)
tempnumber
temp_modestring
Enum"F""C"
case_packnumber
ip_packnumber
udef0string
udef1string
udef2string
udef3string
udef4string
udef5string
udef6string
udef7string
udef8string
udef9string
udef10string
udef11string
udef12string
udef13string
udef14string
asn0string
asn1string
asn2string
asn3string
asn4string
asn5string
asn6string
asn7string
asn8string
asn9string
asn10string
asn11string
asn12string
asn13string
asn14string
qty_pcs_totalnumber
qty_pcsnumber
qty_casesnumber
qty_ipnumber
invKeyobject(InvKeySecureType)
]
Response
application/json
[
  {
    "id": 0,
    "inv_key_id": "0ef18765-1c41-4af5-8e29-8f01e6eae6c1",
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
    "internalstatus": "FOREIGNENTITY",
    "reservedfor_id": "8fb6b986-2719-4b3d-8f97-ded4b6816475",
    "account_name": "string",
    "account_description": "string",
    "reservedfor_channel_id": "ced14407-e8c1-4ca6-a0a7-3c1c84c9698b",
    "channel_name": "string",
    "channel_description": "string",
    "sscc": "string",
    "lotcode": "string",
    "sublotcode": "string",
    "wt": 0,
    "wt_mode": "LBS",
    "expirydate": "2019-08-24T14:15:22Z",
    "temp": 0,
    "temp_mode": "F",
    "case_pack": 0,
    "ip_pack": 0,
    "udef0": "string",
    "udef1": "string",
    "udef2": "string",
    "udef3": "string",
    "udef4": "string",
    "udef5": "string",
    "udef6": "string",
    "udef7": "string",
    "udef8": "string",
    "udef9": "string",
    "udef10": "string",
    "udef11": "string",
    "udef12": "string",
    "udef13": "string",
    "udef14": "string",
    "asn0": "string",
    "asn1": "string",
    "asn2": "string",
    "asn3": "string",
    "asn4": "string",
    "asn5": "string",
    "asn6": "string",
    "asn7": "string",
    "asn8": "string",
    "asn9": "string",
    "asn10": "string",
    "asn11": "string",
    "asn12": "string",
    "asn13": "string",
    "asn14": "string",
    "qty_pcs_total": 0,
    "qty_pcs": 0,
    "qty_cases": 0,
    "qty_ip": 0,
    "invKey": { … }
  }
]

Query Inventory with Location Filters

Request

Query Inventory with Location Filters

Security
Authorization
Body*/*

Query filter

facilitiesArray of strings(uuid)
accountsArray of strings(uuid)
itemsArray of strings(uuid)
lotsArray of strings
sublotsArray of strings
lpnsArray of strings
containersArray of strings
channelsArray of strings(uuid)
orderNumberstring
poNumberstring
transNumberstring
carriersArray of strings(uuid)
locationsArray of strings
statusesArray of strings
Items Enum"PENDING""INTRANSIT""OPEN""HOLD""WAITING_PUTAWAY""PUTTINGAWAY""PUTAWAY""WAITING_RESERVE""RESERVED""WAITING_PICK"
createdonstring(date-time)
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/inv/query/locations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Ok

Bodyapplication/jsonArray [
idinteger(int64)
inv_key_idstring(uuid)
facility_idstring(uuid)
account_idstring(uuid)
item_idstring(uuid)
lpn_idstring(uuid)
lpnstring
lpn_location_stridstring
facilitylocation_idstring(uuid)
location_stridstring
internalstatusstring
Enum"FOREIGNENTITY""PICKEDUP""INTRANSITRECEIVE""INGATE""UNLOADED""QC""ONHAND""SAFETY""ONHANDBYPASSPUTAWAY""RESERVEDWITHORDER"
reservedfor_idstring(uuid)
account_namestring
account_descriptionstring
reservedfor_channel_idstring(uuid)
channel_namestring
channel_descriptionstring
ssccstring
lotcodestring
sublotcodestring
wtnumber
wt_modestring
Enum"LBS""KGS"
expirydatestring(date-time)
tempnumber
temp_modestring
Enum"F""C"
case_packnumber
ip_packnumber
udef0string
udef1string
udef2string
udef3string
udef4string
udef5string
udef6string
udef7string
udef8string
udef9string
udef10string
udef11string
udef12string
udef13string
udef14string
asn0string
asn1string
asn2string
asn3string
asn4string
asn5string
asn6string
asn7string
asn8string
asn9string
asn10string
asn11string
asn12string
asn13string
asn14string
qty_pcs_totalnumber
qty_pcsnumber
qty_casesnumber
qty_ipnumber
invKeyobject(InvKeySecureType)
]
Response
application/json
[
  {
    "id": 0,
    "inv_key_id": "0ef18765-1c41-4af5-8e29-8f01e6eae6c1",
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",
    "lpn_id": "b1acb478-72a3-40e7-b5a2-ecc166beef1b",
    "lpn": "string",
    "lpn_location_strid": "string",
    "facilitylocation_id": "9eb517dc-162f-4f83-a7d2-d40867c1a2c6",
    "location_strid": "string",
    "internalstatus": "FOREIGNENTITY",
    "reservedfor_id": "8fb6b986-2719-4b3d-8f97-ded4b6816475",
    "account_name": "string",
    "account_description": "string",
    "reservedfor_channel_id": "ced14407-e8c1-4ca6-a0a7-3c1c84c9698b",
    "channel_name": "string",
    "channel_description": "string",
    "sscc": "string",
    "lotcode": "string",
    "sublotcode": "string",
    "wt": 0,
    "wt_mode": "LBS",
    "expirydate": "2019-08-24T14:15:22Z",
    "temp": 0,
    "temp_mode": "F",
    "case_pack": 0,
    "ip_pack": 0,
    "udef0": "string",
    "udef1": "string",
    "udef2": "string",
    "udef3": "string",
    "udef4": "string",
    "udef5": "string",
    "udef6": "string",
    "udef7": "string",
    "udef8": "string",
    "udef9": "string",
    "udef10": "string",
    "udef11": "string",
    "udef12": "string",
    "udef13": "string",
    "udef14": "string",
    "asn0": "string",
    "asn1": "string",
    "asn2": "string",
    "asn3": "string",
    "asn4": "string",
    "asn5": "string",
    "asn6": "string",
    "asn7": "string",
    "asn8": "string",
    "asn9": "string",
    "asn10": "string",
    "asn11": "string",
    "asn12": "string",
    "asn13": "string",
    "asn14": "string",
    "qty_pcs_total": 0,
    "qty_pcs": 0,
    "qty_cases": 0,
    "qty_ip": 0,
    "invKey": { … }
  }
]

Query Inventory History

Request

Query Inventory History

Security
Authorization
Body*/*

Query filter

facilitiesArray of strings(uuid)
accountsArray of strings(uuid)
itemsArray of strings(uuid)
lotsArray of strings
sublotsArray of strings
lpnsArray of strings
containersArray of strings
channelsArray of strings(uuid)
orderNumberstring
poNumberstring
transNumberstring
carriersArray of strings(uuid)
locationsArray of strings
statusesArray of strings
Items Enum"PENDING""INTRANSIT""OPEN""HOLD""WAITING_PUTAWAY""PUTTINGAWAY""PUTAWAY""WAITING_RESERVE""RESERVED""WAITING_PICK"
createdonstring(date-time)
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/inv/history \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
inv_trxns_idstring(uuid)
inv_key_idstring(uuid)
inv_idstring(uuid)
cntrlstring
typestring
Enum"INV""JRNL"
createdbystring
tsstring(date-time)
qty_pcs_totalnumber
qty_pcsnumber
qty_casesnumber
qty_ipnumber
supplier_idstring(uuid)
ohdrrecv_idstring(uuid)
olinerecv_idstring(uuid)
ohdralloc_idstring(uuid)
olinealloc_idstring(uuid)
ohdrwork_idstring(uuid)
olinework_idstring(uuid)
trxnsobject(InvTrxnsSecureType)
invobject(InvSecureType)
supplierobject(AccountSecureType)
getoRecvHdrobject(OrderRecvHdrSecureType)
getoRecvLineobject(OrderLineSecureType)
getoShipHdrobject(OrderShipHdrSecureType)
getoShipLineobject(OrderLineSecureType)
getoWorkHdrobject(OrderWorkHdrSecureType)
getoWorkLineobject(OrderLineSecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "inv_trxns_id": "164651fb-2b3f-458a-a0c5-30b1b6ce6aa5",
    "inv_key_id": "0ef18765-1c41-4af5-8e29-8f01e6eae6c1",
    "inv_id": "18ed08e4-4e0a-4d9f-9772-0b68d880e0bd",
    "cntrl": "string",
    "type": "INV",
    "createdby": "string",
    "ts": "2019-08-24T14:15:22Z",
    "qty_pcs_total": 0,
    "qty_pcs": 0,
    "qty_cases": 0,
    "qty_ip": 0,
    "supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
    "ohdrrecv_id": "692c4050-3acb-42de-ac0f-4944bb456615",
    "olinerecv_id": "5373ea6f-1b2b-42c5-9a7d-8850928b84c9",
    "ohdralloc_id": "a77fd68f-1400-4c73-bfc2-9f702d2cff9a",
    "olinealloc_id": "88b6d57a-ee38-45ae-9af7-dfb52d2ca05b",
    "ohdrwork_id": "3ee1bf61-2ef8-4816-a17f-f1d90e9a93b9",
    "olinework_id": "e4f1384d-73c0-4671-be99-fa7227ec5370",
    "trxns": { … },
    "inv": { … },
    "supplier": { … },
    "getoRecvHdr": { … },
    "getoRecvLine": { … },
    "getoShipHdr": { … },
    "getoShipLine": { … },
    "getoWorkHdr": { … },
    "getoWorkLine": { … }
  }
]

Invoice for 3PL Billing Service

Services related to viewing Invoices for 3PL Billing

Operations

Lists Service

Services related to Querying Lists of Objects

Operations

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