# INSPIRE Public Rest API Documentation. Copyright 2025 Fulfillment WMS. All rights reserved. OpenAPI documentation for API and Auth Rest Services Version: 1.0 License: Proprietary ## Security ### Authorization Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [INSPIRE Public Rest API Documentation. Copyright 2025 Fulfillment WMS. All rights reserved.](https://apidocs.fulfillmentwms.com/_bundle/openapi.yaml) ## Dock Appointment Scheduling Service Dock Appointment Scheduling Services ### Get Dock Appointment By Id - [GET /v1/api/pub/dock/appt/{apptId}](https://apidocs.fulfillmentwms.com/openapi/dock-appointment-scheduling-service/getappointmentbyid.md): Get Dock Appointment By Id ### Get All Dock Appointments - [POST /v1/api/pub/dock/appt/query](https://apidocs.fulfillmentwms.com/openapi/dock-appointment-scheduling-service/getdockappointments.md): Get All Dock Appointments ## Import Service Services related to importing data ### Get a list of all of the Import Templates available - [GET /v1/api/pub/import](https://apidocs.fulfillmentwms.com/openapi/import-service/getimportlist.md): Get a list of all of the Import Templates available ### uploadFile - [POST /v1/api/pub/import/upload/{templateName}](https://apidocs.fulfillmentwms.com/openapi/import-service/uploadfile.md) ## Reporting, Insights and Metrics Service Services related to Reporting, Insights and Metrics ### Get a list of Service end points - [GET /v1/api/pub/insights](https://apidocs.fulfillmentwms.com/openapi/reporting-insights-and-metrics-service/getendpointslist.md): Get a list of service end points ### Get Mobile Task metrics for users - [GET /v1/api/pub/insights/users/metrics](https://apidocs.fulfillmentwms.com/openapi/reporting-insights-and-metrics-service/getusersmetrics.md): Get Mobile Task metrics for users ## Inventory Service Services related to Inventory ### Query Inventory - [POST /v1/api/pub/inv/query](https://apidocs.fulfillmentwms.com/openapi/inventory-service/getinventorydetails.md): Query Inventory ### Query Inventory with Location Filters - [POST /v1/api/pub/inv/query/locations](https://apidocs.fulfillmentwms.com/openapi/inventory-service/getinventorydetailswithlocations.md): Query Inventory with Location Filters ### Query Inventory History - [POST /v1/api/pub/inv/history](https://apidocs.fulfillmentwms.com/openapi/inventory-service/getinventoryhistory.md): Query Inventory History ## Invoice for 3PL Billing Service Services related to viewing Invoices for 3PL Billing ### Query Invoices - [POST /v1/api/pub/invoices/query](https://apidocs.fulfillmentwms.com/openapi/invoice-for-3pl-billing-service/getinventorydetails_1.md): Query Invoices ## Lists Service Services related to Querying Lists of Objects ### Display All of the Objects that can be displayed - [GET /v1/api/pub/lists](https://apidocs.fulfillmentwms.com/openapi/lists-service/displaylists.md): Display All of the Objects that can be displayed ### Get a list of Accounts - [GET /v1/api/pub/lists/accounts/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getaccounts.md): Get a list of Accounts ### Get a list of Carriers for an Account - [GET /v1/api/pub/lists/accounts/{accountId}/carriers/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getcarriersforaccount.md): Get a list of Carriers for an Account ### Get a list of Channels for an Account - [GET /v1/api/pub/lists/accounts/{accountId}/channels/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getchannelsforaccount.md): Get a list of Channels for an Account ### Get a list of Customers for an Account - [GET /v1/api/pub/lists/accounts/{accountId}/customers/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getcustomersforaccount.md): Get a list of Customers for an Account ### Get a list of Facilities - [GET /v1/api/pub/lists/facilities/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getfacilities.md): Get a list of Facilities ### Get a list of Location Templates - [GET /v1/api/pub/lists/facilities/locations/tmplts/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getfacilitylocationtmplts.md): Get a list of Location Templates ### Get a list of Locations for a Facility - [GET /v1/api/pub/lists/facilities/{facilityId}/locations/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getfacilitylocations.md): Get a list of Locations for a Facility ### Get a list of Hazmat - [GET /v1/api/pub/lists/hazmat/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/gethazmatlist.md): Get a list of Hazmat ### Get a list of Item Templates - [GET /v1/api/pub/lists/items/tmplts/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getitemtmplts.md): Get a list of Item Templates ### Get a list of Items for an Account - [GET /v1/api/pub/lists/accounts/{accountId}/items/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getitemsforaccount.md): Get a list of Items for an Account ### Get a list of Mobile Workflows - [GET /v1/api/pub/lists/mworkflows/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getmworkflows.md): Get a list of Mobile Workflows ### Get a list of Schedules - [GET /v1/api/pub/lists/scheduler/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getschedules.md): Get a list of Schedules ### Get a list of Sequences - [GET /v1/api/pub/lists/sequences/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getsequences.md): Get a list of Sequences ### Get a list of Transit Lanes - [GET /v1/api/pub/lists/transitlanes/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/gettransitlanes.md): Get a list of Transit Lanes ### Get a list of Schedules - [GET /v1/api/pub/lists/users/query](https://apidocs.fulfillmentwms.com/openapi/lists-service/getusers.md): Get a list of Schedules ## Mobile Tasks Service Services related to Mobile Tasks ### Get All Mobile Tasks - [POST /v1/api/pub/mtask/query](https://apidocs.fulfillmentwms.com/openapi/mobile-tasks-service/getmtasks.md): Get All Mobile Tasks ## Receiving Order Service Services related to Receiving Orders ### Get Receiving Order By Id - [GET /v1/api/pub/order/receipts/{receiptId}](https://apidocs.fulfillmentwms.com/openapi/receiving-order-service/getreceivingorderbyid.md): Get Receiving Order By Id ### Get All Receiving Orders - [POST /v1/api/pub/order/receipts/query](https://apidocs.fulfillmentwms.com/openapi/receiving-order-service/getreceivingorders.md): Get All Receiving Orders ## Shipping Order Service Services related to Shipping Orders ### Get Shipping Order By Id - [GET /v1/api/pub/order/orders/{orderId}](https://apidocs.fulfillmentwms.com/openapi/shipping-order-service/getshippingorderbyid.md): Get Shipping Order By Id ### Get All Shipping Orders - [POST /v1/api/pub/order/orders/query](https://apidocs.fulfillmentwms.com/openapi/shipping-order-service/getshippingorders.md): Get All Shipping Orders ## Work/Project Order Service Services related to Work/Project Orders ### Get Work Order By Id - [GET /v1/api/pub/order/projects/{projectId}](https://apidocs.fulfillmentwms.com/openapi/workproject-order-service/getworkorderbyid.md): Get Work Order By Id ### Get All Work Orders - [POST /v1/api/pub/order/projects/query](https://apidocs.fulfillmentwms.com/openapi/workproject-order-service/getworkorders.md): Get All Work Orders ## Authentication Service Services related to authentication ### Deletes the current session for the user and creates a new one - [POST /v1/auth/pub/user/session](https://apidocs.fulfillmentwms.com/openapi/authentication-service/createsessionbylicense.md): Deletes the current session for the user and creates a new one. Also redirects to the current configured Servers. ### Validate JWT Token - [GET /v1/auth/pub/jwt](https://apidocs.fulfillmentwms.com/openapi/authentication-service/validatejwt.md): Validate JWT Token ### Delete session by JWT Token - [DELETE /v1/auth/pub/jwt](https://apidocs.fulfillmentwms.com/openapi/authentication-service/deletesessionbyjwt.md): Delete session by JWT Token ### Delete session by Session - [DELETE /v1/auth/pub/jwt/{userSession}](https://apidocs.fulfillmentwms.com/openapi/authentication-service/deletesessionbysession.md): This is used by an Admin to delete another user's session ### Returns a list of licenses associated with this user - [POST /v1/auth/pub/user/licenses](https://apidocs.fulfillmentwms.com/openapi/authentication-service/getlicenselist.md): Returns a list of licenses associated with this user ### Simple Communication Test - [GET /v1/auth/pub/ping](https://apidocs.fulfillmentwms.com/openapi/authentication-service/getping.md): Simple Communication Test ### Get Minimal User Details by Email - [GET /v1/auth/pub/jwt/list](https://apidocs.fulfillmentwms.com/openapi/authentication-service/getsessionlist.md): Get Minimal User Details by Email for Authentication ### Uses Refresh token and deletes the current session for the user and creates a new one - [POST /v1/auth/pub/user/session/refresh](https://apidocs.fulfillmentwms.com/openapi/authentication-service/refreshsessionbylicense.md): Uses Refresh token and deletes the current session for the user and creates a new one. Also redirects to the current configured Servers. ### From Email and Password Combination, determine if this is a valid Enabled User - [POST /v1/auth/pub/user/validate](https://apidocs.fulfillmentwms.com/openapi/authentication-service/uservalidate.md): From Email and Password Combination, determine if this is a valid Enabled User, returns the User's email as a confirmation ### Get Minimal User Details by Email - [GET /v1/auth/pub/users/email/{email}](https://apidocs.fulfillmentwms.com/openapi/authentication-service/validateuserbyemail.md): Get Minimal User Details by Email for Authentication