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

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

Deletes the current session for the user and creates a new one

Request

Deletes the current session for the user and creates a new one. Also redirects to the current configured Servers.

Query
localestring
Bodyapplication/json
emailstring
passwordstring
licenseIdstring(uuid)

Create the new session for the License ID provided.

snTypestring

Session Type

Enum"SYSTEM""SUPPORT""INTEGRATION""ADMIN""USER""EXTERNALUSER"
curl -i -X POST \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/user/session?locale=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string",
    "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
    "snType": "SYSTEM"
  }'

Responses

Ok, URI for redirection

Bodyapplication/json
redirectURLstring
refreshTokenstring
expiresAtstring(date-time)
Response
application/json
{
  "redirectURL": "string",
  "refreshToken": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}

Validate JWT Token

Request

Validate JWT Token

curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/jwt

Responses

Ok, responds with claim details of JWTr

Bodyapplication/json
userEmailstring
licenseIdstring(uuid)
snstring
expiresAtstring(date-time)
zoneIdStrstring
Response
application/json
{
  "userEmail": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "sn": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "zoneIdStr": "string"
}

Delete session by JWT Token

Request

Delete session by JWT Token

curl -i -X DELETE \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/jwt

Responses

Ok, responds with claim details of JWTr

Bodyapplication/json
userEmailstring
licenseIdstring(uuid)
snstring
expiresAtstring(date-time)
zoneIdStrstring
Response
application/json
{
  "userEmail": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "sn": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "zoneIdStr": "string"
}

Delete session by Session

Request

This is used by an Admin to delete another user's session

Path
userSessionstringrequired
curl -i -X DELETE \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/jwt/{userSession}'

Responses

Ok, responds with claim details of JWTr

Bodyapplication/json
userEmailstring
licenseIdstring(uuid)
snstring
expiresAtstring(date-time)
zoneIdStrstring
Response
application/json
{
  "userEmail": "string",
  "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  "sn": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "zoneIdStr": "string"
}

Returns a list of licenses associated with this user

Request

Returns a list of licenses associated with this user

Bodyapplication/json
emailstring
passwordstring
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/user/licenses \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string"
  }'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
customer_idstring(uuid)
customer_namestring
license_typestring
Enum"COMMUNITY""FREEMIUM""LITE""PRO""ENTERPRISE"
enabledboolean
productionboolean
descriptionstring
number_full_usersinteger(int32)
number_rf_usersinteger(int32)
number_ro_usersinteger(int32)

Number of Read Only Users

number_facilitiesinteger(int32)
number_transactionsinteger(int32)
number_integrationsinteger(int32)
msgstring
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "customer_name": "string",
    "license_type": "COMMUNITY",
    "enabled": true,
    "production": true,
    "description": "string",
    "number_full_users": 0,
    "number_rf_users": 0,
    "number_ro_users": 0,
    "number_facilities": 0,
    "number_transactions": 0,
    "number_integrations": 0,
    "msg": "string"
  }
]

Simple Communication Test

Request

Simple Communication Test

curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/ping

Responses

default response

Bodytext/plain
string

Get Minimal User Details by Email

Request

Get Minimal User Details by Email for Authentication

curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/jwt/list

Responses

Ok

Bodyapplication/json
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": [
    { … }
  ]
}

Uses Refresh token and deletes the current session for the user and creates a new one

Request

Uses Refresh token and deletes the current session for the user and creates a new one. Also redirects to the current configured Servers.

Query
sn_typestring
Default "USER"
Enum"SYSTEM""SUPPORT""INTEGRATION""ADMIN""USER""EXTERNALUSER"
localestring
Bodyapplication/json
emailstring
passwordstring
refreshTokenstring
curl -i -X POST \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/user/session/refresh?sn_type=SYSTEM&locale=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string",
    "refreshToken": "string"
  }'

Responses

Ok, URI for redirection

Bodyapplication/json
redirectURLstring
refreshTokenstring
expiresAtstring(date-time)
Response
application/json
{
  "redirectURL": "string",
  "refreshToken": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}

Determine of Email and Password Combination is a valid Enabled User

Request

Determine of Email and Password Combination is a valid Enabled User, returns the User's email as a confirmation

Bodyapplication/json
emailstring
passwordstring
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/user/validate \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string"
  }'

Responses

Ok, responds with email of the user

Bodyapplication/json
string
Response
application/json
"string"

Get Minimal User Details by Email

Request

Get Minimal User Details by Email for Authentication

Path
emailstringrequired
Query
includeDisabledboolean

By default, includeDisabled is false

Default false
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/auth/pub/users/email/{email}?includeDisabled=false'

Responses

Ok

Bodyapplication/json
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": [
    { … }
  ]
}