Skip to content
/
Get a list of Items for a...

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 Item Templates

Request

Get a list of Item Templates

Security
Authorization
Query
namestring

Search by name

Default ""
curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/items/tmplts/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"
enabledboolean
namestring
descriptionstring
notesstring
typestring
Enum"ITEM_INVENTORIED""KIT_INVENTORIED""CONSUMABLE_INVENTORIED""ITEM_NONINVENTORIED""KIT_NONINVENTORIED""CONSUMABLE_NONINVENTORIED"
invputaway_flow_lpnstring
Enum"LPNMANUALSELECT""LPNAUTOSELECT""CLUSTERMANUALSELECT""CLUSTERAUTOSELECT"
invputaway_flow_clusterstring
Enum"LPNMANUALSELECT""LPNAUTOSELECT""CLUSTERMANUALSELECT""CLUSTERAUTOSELECT"
invresv_mode_lpnstring
Enum"HOLDMANUAL""HOLDHOLD""RESVORDERAUTO""RESVWAVEAUTO""RESVCLUSTERAUTO""RESVZONEAUTO"
invresv_mode_clusterstring
Enum"HOLDMANUAL""HOLDHOLD""RESVORDERAUTO""RESVWAVEAUTO""RESVCLUSTERAUTO""RESVZONEAUTO"
cc_strategystring
Enum"ON_PUTAWAY""COUNT_ON_PICK_ZERO_QTY""LOCATIONS_TOUCHED_YESTERDAY""ADHOCK""SCHEDULED"
nodeleteboolean
sistring
pickistring
packistring
securitylevelinteger(int32)
tracklotcodeboolean
tracksublotcodeboolean
trackweightinboolean
trackweightoutboolean
trackexpirydateboolean
tracksninboolean
validatesninboolean
tracksnoutboolean
validatesnoutboolean
tracktempinboolean
tracktempoutboolean
trackssccboolean
requirespackingboolean
htariffstring
coostring
hazmat_idstring(uuid)
tempminnumber
tempmaxnumber
allowfractionsboolean
requires_recv_lpnboolean
requires_recv_qcboolean
safety_inv_qtynumber
udef0_titlestring
udef0_trackboolean
udef1_titlestring
udef1_trackboolean
udef2_titlestring
udef2_trackboolean
udef3_titlestring
udef3_trackboolean
udef4_titlestring
udef4_trackboolean
udef5_titlestring
udef5_trackboolean
udef6_titlestring
udef6_trackboolean
udef7_titlestring
udef7_trackboolean
udef8_titlestring
udef8_trackboolean
udef9_titlestring
udef9_trackboolean
udef10_titlestring
udef10_trackboolean
udef11_titlestring
udef11_trackboolean
udef12_titlestring
udef12_trackboolean
udef13_titlestring
udef13_trackboolean
udef14_titlestring
udef14_trackboolean
]
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",
    "enabled": true,
    "name": "string",
    "description": "string",
    "notes": "string",
    "type": "ITEM_INVENTORIED",
    "invputaway_flow_lpn": "LPNMANUALSELECT",
    "invputaway_flow_cluster": "LPNMANUALSELECT",
    "invresv_mode_lpn": "HOLDMANUAL",
    "invresv_mode_cluster": "HOLDMANUAL",
    "cc_strategy": "ON_PUTAWAY",
    "nodelete": true,
    "si": "string",
    "picki": "string",
    "packi": "string",
    "securitylevel": 0,
    "tracklotcode": true,
    "tracksublotcode": true,
    "trackweightin": true,
    "trackweightout": true,
    "trackexpirydate": true,
    "tracksnin": true,
    "validatesnin": true,
    "tracksnout": true,
    "validatesnout": true,
    "tracktempin": true,
    "tracktempout": true,
    "tracksscc": true,
    "requirespacking": true,
    "htariff": "string",
    "coo": "string",
    "hazmat_id": "761c687e-29b3-47a6-85d1-4e5984950e72",
    "tempmin": 0,
    "tempmax": 0,
    "allowfractions": true,
    "requires_recv_lpn": true,
    "requires_recv_qc": true,
    "safety_inv_qty": 0,
    "udef0_title": "string",
    "udef0_track": true,
    "udef1_title": "string",
    "udef1_track": true,
    "udef2_title": "string",
    "udef2_track": true,
    "udef3_title": "string",
    "udef3_track": true,
    "udef4_title": "string",
    "udef4_track": true,
    "udef5_title": "string",
    "udef5_track": true,
    "udef6_title": "string",
    "udef6_track": true,
    "udef7_title": "string",
    "udef7_track": true,
    "udef8_title": "string",
    "udef8_track": true,
    "udef9_title": "string",
    "udef9_track": true,
    "udef10_title": "string",
    "udef10_track": true,
    "udef11_title": "string",
    "udef11_track": true,
    "udef12_title": "string",
    "udef12_track": true,
    "udef13_title": "string",
    "udef13_track": true,
    "udef14_title": "string",
    "udef14_track": true
  }
]

Get a list of Items for an Account

Request

Get a list of Items for an Account

Security
Authorization
Path
accountIdstring(uuid)required
Query
itemcodestring

Search by item code

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

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
account_idstring(uuid)
tmplt_idstring(uuid)
enabledboolean
typestring
Enum"ITEM_INVENTORIED""KIT_INVENTORIED""CONSUMABLE_INVENTORIED""ITEM_NONINVENTORIED""KIT_NONINVENTORIED""CONSUMABLE_NONINVENTORIED"
itemcodestring
descriptionstring
notesstring
wtnumber
wt_modestring
Enum"LBS""KGS"
lnumber
wnumber
hnumber
dim_modestring
Enum"INCHES""FEET""CM""METER"
image_file_uristring
safety_inv_qtynumber
tmpltobject(ItemTmpltSecureType)
componentsArray of objects(ItemComponentsSecureType)
]
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",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "tmplt_id": "0cf10b77-feef-4821-ab9d-66698af376f5",
    "enabled": true,
    "type": "ITEM_INVENTORIED",
    "itemcode": "string",
    "description": "string",
    "notes": "string",
    "wt": 0,
    "wt_mode": "LBS",
    "l": 0,
    "w": 0,
    "h": 0,
    "dim_mode": "INCHES",
    "image_file_uri": "string",
    "safety_inv_qty": 0,
    "tmplt": { … },
    "components": [ … ]
  }
]

Get a list of Mobile Workflows

Request

Get a list of Mobile Workflows

Security
Authorization
Query
namestring

Search by name

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

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
enabledboolean
nodeleteboolean
namestring
descriptionstring
order_typestring
Enum"PO""RECEIPT""RETURN""TRANSFER""PROJECT""ORDER""SHIPMENT"
typestring
Enum"PICKING""RECEIVING""RETURN""PUTAWAY""REPLEN""RELOCATE""PACK""UNPACK""QCRECV""QCPICK"
versionstring
stepsArray of objects(MWorkflowStepsSecureType)
]
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,
    "nodelete": true,
    "name": "string",
    "description": "string",
    "order_type": "PO",
    "type": "PICKING",
    "version": "string",
    "steps": [ … ]
  }
]

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