Skip to content
/
Get a list of Mobile Work...

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 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": [ … ]
  }
]

Get a list of Schedules

Request

Get a list of Schedules

Security
Authorization
Query
namestring

Search by schedule name

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

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
enabledboolean
namestring
descriptionstring
notesstring
typestring
Enum"RECURRING""DAILY""WEEKLY""MONTHLY""ANNUALLY""SPECIFIC_DAY_OF_MONTH"
recurring_minutesinteger(int32)
day_weekstring
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
day_monthstring
Enum"1""2""3""4""5""6""7""8""9""10"
month_yearstring
Enum"JANUARY""FEBRUARY""MARCH""APRIL""MAY""JUNE""JULY""AUGUST""SEPTEMBER""OCTOBER"
day_yearstring
Enum"1""2""3""4""5""6""7""8""9""10"
time_sendstring(date-time)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "enabled": true,
    "name": "string",
    "description": "string",
    "notes": "string",
    "type": "RECURRING",
    "recurring_minutes": 0,
    "day_week": "MONDAY",
    "day_month": "1",
    "month_year": "JANUARY",
    "day_year": "1",
    "time_send": "2019-08-24T14:15:22Z"
  }
]

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