Public OpenAPI Rest Specification

We are excited to publish our Public OpenAPI specification.

Follow this link to view the technical documentation - OpenAPI Swagger documentation.

This is an optional subscription item that can be included with INSPIRE. This API provides the following-

Query/Read

• Orders (Shipping)

• Receipts (Receiving)

• Projects (Work Orders)

• Inventory

• Items

• Item Templates

• Facilities

• Facility Locations

• Facility Location Templates

• Users

• Transit Lanes

• Carriers

• Accounts

• Customers

• Invoices

• Hazmat Details

• Scheduled Tasks

• Sequences (Counters)

• Mobile Tasks (Warehouse Operations)

Import/Update

• Orders (Shipping)

• Receipts (Receiving)

• Projects (Work Orders)

• Inventory

• Items

• Item Templates

• Facilities

• Facility Locations

• Facility Location Templates

• Users

• Transit Lanes

• Carriers

• Accounts

• Customers

• Invoices

• Hazmat Details

• Scheduled Tasks

Insights (Metrics)

• Real-time metrics and reporting for operations.

Authentication

• Login and create a new session

All API end points enforce full user permissions.

Why are public APIs helpful and how do they benefit your company?

An API allows another application (Dashboard tools, Integration tools, Reporting tools) to access both the data and the central "nervous system" of an application like INSPIRE. Typically technology partners or fulfillment/distribution companies with technical resources or Fulfillment WMS will use these APIs to-

• Create integrations to shopping carts, marketplaces, ERP systems and more

• Provide customized reporting and dashboards

• Integrate with internal tools and corporate systems

The end result is that a well designed API removes barriers and assists with your company's success.