SmartWay API

● Live

SmartWay API Platform

Secure integration services for SmartWay Applications, including Atlas, Compass, and future platform products.

v1 Current version 10 Import services API Key Authentication Required

API Status

Operational

Services available

Authentication

Enabled

x-smartway-api-key required

API Version

Production release

API Explorer

Protected

Authorized users only

Authentication

All external API requests require a SmartWay-issued API key. API keys are generated and managed by Customer Administrators through SmartWay Atlas under Administration → Integrations → API Management. Only one active API key may exist per customer at any time.

Required

                    Base URL
                    https://api.smartwayapplications.com
                

                    Header
                    x-smartway-api-key: YOUR_API_KEY
                

                    Content Type
                    application/json
                

Important: API keys are displayed only once when generated. Store the key securely. If a key is lost, a Customer Administrator must regenerate the key from SmartWay Atlas, which automatically disables the previous key.

Available API Services

Current SmartWay API v1 endpoints.

10 Services

Staged

Business Partners

POST /api/external/v1/import/business-partners

Stages business partners, partner roles, and relationship data for SmartWay validation, partner resolution, and automated relationship creation.

Staged

Business Partner Contacts

POST /api/external/v1/import/business-partner-contacts

Stages business partner contacts and role assignments for automated contact resolution and relationship association.

Direct

Locations

POST /api/external/v1/import/locations

Imports customer-owned partner location records.

Direct

Team Members

POST /api/external/v1/import/team-members

Imports internal team member records from HR or payroll systems.

Direct

Jobs

POST /api/external/v1/import/jobs

Imports job codes, job titles, job requirements, and role risk indicators.

Direct

Departments

POST /api/external/v1/import/departments

Imports departments, department codes, ownership indicators, and organizational expectations.

Direct

Equipment

POST /api/external/v1/import/equipment

Imports equipment, assets, trailers, containers, and related data.

Direct

Catalog

POST /api/external/v1/import/catalog

Imports catalog items, HTS data, duty flags, and product risk attributes.

Direct

Seals

POST /api/external/v1/import/seals

Imports seal specifications, ranges, box numbers, and ISO 17712 details.

Direct

Packaging

POST /api/external/v1/import/packaging

Imports packaging specs, material, labeling, pallet patterns, and weights.