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

Download OpenAPI description
Overview
License
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

Request

Get a list of Transit Lanes

Security
Authorization
Query
namestring

Search by name

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

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
typestring
Enum"state_state""city_city""POSTAL_POSTAL"
enabledboolean
nodeleteboolean
namestring
descriptionstring
notesstring
entriesArray of objects(TransitLaneEntriesSecureType)
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "createdby": "string", "createdon": "2019-08-24T14:15:22Z", "modifiedon": "2019-08-24T14:15:22Z", "type": "state_state", "enabled": true, "nodelete": true, "name": "string", "description": "string", "notes": "string", "entries": [ … ] } ]

Request

Get a list of Schedules

Security
Authorization
Query
emailstring

Search by email

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

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
modifiedonstring(date-time)
securityLevelinteger(int32)
emailstring
localestring
Enum"pt_BR""es_MX""fr_FR""en_US""de_DE""zh_CN"
descriptionstring
namestring
enabledboolean
typestring
Enum"SYSTEM""SUPPORT""INTEGRATION""ADMIN""USER""USER_MOBILEONLY""EXTERNALUSER""CUSTOMER"
internaluseboolean
email_aliasstring
fav1linkstring
fav1namestring
fav1iconstring
fav2linkstring
fav2namestring
fav2iconstring
fav3linkstring
fav3namestring
fav3iconstring
facilitiesArray of objects(FacilityMinSecureType)
rolesArray of objects(UserRoleSecureType)
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ncode": 0, "modifiedon": "2019-08-24T14:15:22Z", "securityLevel": 0, "email": "string", "locale": "pt_BR", "description": "string", "name": "string", "enabled": true, "type": "SYSTEM", "internaluse": true, "email_alias": "string", "fav1link": "string", "fav1name": "string", "fav1icon": "string", "fav2link": "string", "fav2name": "string", "fav2icon": "string", "fav3link": "string", "fav3name": "string", "fav3icon": "string", "facilities": [ … ], "roles": [ … ] } ]

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