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

Get a list of all of the Import Templates available

Request

Get a list of all of the Import Templates available

Security
Authorization
curl -i -X GET \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/import \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
import_typestring
Enum"FACILITY_LOCATIONS""FACILITY_LOCATION_TMPLTS""FACILITY_EQUIPMENT""CARTON_STOCK""CARRIERS""CUSTOMERS""ITEMS""ITEM_TMPLTS""KITS""BILLING_RULES"
import_format_summarystring
enabledboolean
nodeleteboolean
namestring
descriptionstring
notesstring
rulesArray of objects(ImportRulesSecureType)
dataElementsArray of objects(ImportDeSecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "import_type": "FACILITY_LOCATIONS",
    "import_format_summary": "string",
    "enabled": true,
    "nodelete": true,
    "name": "string",
    "description": "string",
    "notes": "string",
    "rules": [ … ],
    "dataElements": [ … ]
  }
]

uploadFile

Request

Security
Authorization
Path
templateNamestringrequired

Name of the import template

Query
updateDataboolean

Update data if it exists. By default, update is false

Default false
Bodymultipart/form-data
formDataMapobject
preamblestring
partsArray of objects(InputPart)
curl -i -X POST \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/import/upload/{templateName}?updateData=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'formDataMap[property1][0][contentTypeFromMessage]=true' \
  -F 'formDataMap[property1][0][mediaType][type]=string' \
  -F 'formDataMap[property1][0][mediaType][subtype]=string' \
  -F 'formDataMap[property1][0][mediaType][parameters][property1]=string' \
  -F 'formDataMap[property1][0][mediaType][parameters][property2]=string' \
  -F 'formDataMap[property1][0][mediaType][wildcardType]=true' \
  -F 'formDataMap[property1][0][mediaType][wildcardSubtype]=true' \
  -F 'formDataMap[property1][0][bodyAsString]=string' \
  -F 'formDataMap[property1][0][headers][empty]=true' \
  -F 'formDataMap[property1][0][headers][property1]=string' \
  -F 'formDataMap[property1][0][headers][property2]=string' \
  -F 'formDataMap[property1][0][fileName]=string' \
  -F 'formDataMap[property2][0][contentTypeFromMessage]=true' \
  -F 'formDataMap[property2][0][mediaType][type]=string' \
  -F 'formDataMap[property2][0][mediaType][subtype]=string' \
  -F 'formDataMap[property2][0][mediaType][parameters][property1]=string' \
  -F 'formDataMap[property2][0][mediaType][parameters][property2]=string' \
  -F 'formDataMap[property2][0][mediaType][wildcardType]=true' \
  -F 'formDataMap[property2][0][mediaType][wildcardSubtype]=true' \
  -F 'formDataMap[property2][0][bodyAsString]=string' \
  -F 'formDataMap[property2][0][headers][empty]=true' \
  -F 'formDataMap[property2][0][headers][property1]=string' \
  -F 'formDataMap[property2][0][headers][property2]=string' \
  -F 'formDataMap[property2][0][fileName]=string' \
  -F preamble=string \
  -F 'parts[0][contentTypeFromMessage]=true' \
  -F 'parts[0][mediaType][type]=string' \
  -F 'parts[0][mediaType][subtype]=string' \
  -F 'parts[0][mediaType][parameters][property1]=string' \
  -F 'parts[0][mediaType][parameters][property2]=string' \
  -F 'parts[0][mediaType][wildcardType]=true' \
  -F 'parts[0][mediaType][wildcardSubtype]=true' \
  -F 'parts[0][bodyAsString]=string' \
  -F 'parts[0][headers][empty]=true' \
  -F 'parts[0][headers][property1]=string' \
  -F 'parts[0][headers][property2]=string' \
  -F 'parts[0][fileName]=string'

Responses

default response

Bodyapplication/json
Response
application/json
null

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