Skip to content
Last updated

INSPIRE Public Rest API

Fulfillment WMS provides this API as an optional service available for subscription.

Follow @FulfillmentWMS on LinkedIn for notifications regarding API changes.

This API provides real-time access to the following capabilities-

Read/Query

  • Orders (Shipping)
  • Receipts (Receiving)
  • Projects (Work Orders)
  • Inventory
  • Items
  • Item Templates
  • Facilities (Warehouses)
  • Facility Locations
  • Facility Location Templates
  • Users
  • Transit Lanes
  • Carriers
  • Customers
  • Accounts
  • Invoices
  • Hazmat Details
  • Scheduled Tasks
  • Sequences (Counters)
  • Mobile Tasks
  • Dock Schedules
  • Yard Equipment and Inventory

Import/Update

Data can also be inserted or updated by using the Import API. It is important to mention that existing imports can be customized and that new imports can be created from the browser application.

Data cannot be deleted using the public Rest API

Insights (Metrics)

The Insights family of API end points are designed for metrics and reporting and focus on data that changing frequently. For example, Units Picked Per Hour or Dock to Stock time compared to defined KPIs.

Permissions

The API enforces full user permissions. Even though an API may be documented and available, the user must have sufficient permissions for each API end point.

openapi.json

The INSPIRE Public Rest API is documented using the OpenAPI specification and can be found in openapi.json.

Getting Started with the API

A session is required to call an API end point, with a few exceptions.

  1. Call https://auth.fulfillmentwms.com/rest/api/v1/auth/pub/user/licenses (POST) with the following-

    • user's email
    • user's password.
    • See API documentation for details.

    This will return a list of licenses available to the user based on the company the user is associated with. Typically, a user will have both a production and test license.

  2. Call https://auth.fulfillmentwms.com/rest/api/v1/auth/pub/user/session (POST) with the following-

    • user's email

    • user's password

    • license Id requested

    • session type requested ('INTEGRATION', 'USER', 'EXTERNALUSER')

    • See API documentation for details

    • locale may be optionally provided as a query parameter in the URI. For example, "?locale=de_DE"

If the API call is successful, the response will contain-

  • redirectURL - this URL will contain the following as a URL encoded string-

    • license Id
    • encrypted license details
    • host (the current API host that should be used for future API calls. Do not save this value becuase the API host will change dynamically)
    • email of the user for this session
    • locale (language selected for the user)
    • jwt (JSON web token required for Authentication: bearer API calls)

  • refreshToken - this token can be used to refresh the redirectURL

  • expiresAt - a timestamp when the JWT will expire

After successfully creating a session, all subsequent API end point calls must use Authentication: bearer JWT with the API server associated with the host in the redirectURL

 
Next page