Overview
This API Usage Policy governs access to and use of InterFulfillment’s Warehouse Management System (“WMS”) API services, powered by Extensiv. The API supports authorized integrations for order management, inventory synchronization, shipment visibility, reporting, and related operational workflows. By accessing or using the API, clients agree to comply with this policy and any related service agreements.
API Access
API access is available to authorized InterFulfillment clients with an active account. InterFulfillment reserves the right to approve, deny, suspend, or revoke API access at its discretion. Certain integrations may operate as pre-wired integrations as defined in this policy.
Pre-Wired Integrations
Pre-wired integrations are system-configured connections that operate using predefined logic for stability and consistency. API behaviour in these integrations is primarily system-controlled and generally not customizable. Clients may adjust synchronization frequency settings, which can increase API usage and result in additional bandwidth charges under this policy. Pre-wired integrations operate in alignment with this policy, though certain customer-level controls referenced may not apply.
API Billing & Usage
API access is billed per active connection. Each connection includes a weekly API connection fee which provides up to 1GB of monthly API bandwidth usage. API bandwidth usage includes API requests, responses, authentication activity, and all related data transfer generated by integrations, including configuration-driven activity such as polling frequency and synchronization behavior. Additional usage is billed at $225 CAD per additional GB.
InterFulfillment reserves the right to adjust API pricing, usage thresholds, or billing methodology with notice.
Client Responsibilities
Clients are responsible for:
- Securing API credentials
- Monitoring and managing API consumption
- Maintaining efficient integration design and polling behavior where applicable
- Preventing unauthorized or abusive API activity
- Understanding the usage impact of integration configuration settings, including synchronization frequency in pre-wired integrations
Clients are also responsible for the activity of any third-party developers, middleware providers, ERP systems, or applications using their credentials.
Acceptable Use
Clients must use the API in a manner that:
- Maintains platform stability and performance
- Avoids excessive or unnecessary polling
- Uses reasonable synchronization intervals
- Follows Extensiv API standards and authentication requirements
- Complies with applicable laws and regulations
- Recognizes that some integrations may operate as pre-wired integrations with system-defined API behavior and limited customer-configurable settings, as outlined in this policy
InterFulfillment may provide integration best-practice recommendations to support efficient API utilization.
API Best Practices
Bearer Auth Token Generation
Integrations should generate a new Bearer Auth Token approximately every 50–55 minutes, as tokens expire every 60 minutes. Generating new tokens more frequently than every 30 minutes is considered excessive and may be treated as abusive API behaviour.
Inventory Endpoints
Inventory polling should generally occur nightly or every 8 hours. Polling more frequently than every 2 hours requires prior approval from InterFulfillment, as inventory endpoint activity is a significant driver of API bandwidth usage. Where pre-wired integrations require higher-frequency synchronization settings, this will result in greater API usage and may result in overages.
Orders & Shipment Polling
For recommendations related to outbound order and shipment polling, please refer to: API Tips: Polling for Orders
Receivers & Inbound Polling
For recommendations related to inbound inventory, receivers, customer returns, and RTS workflows, please refer to: API Tips: Polling for Receivers
Prohibited Activities
The following activities are prohibited:
- Unauthorized access attempts
- Sharing API credentials with unauthorized parties
- Reverse engineering or compromising platform security
- Excessive or abusive API activity impacting system performance
- Unlawful, fraudulent, or malicious use of the API
- Canceling or Editing orders using the InterFulfillment API
InterFulfillment reserves the right to suspend integrations that create operational, security, or performance risks.
Monitoring & Reporting
InterFulfillment monitors API utilization through reporting provided by Extensiv. Clients remain responsible for monitoring and managing their own API usage and integration behaviour. API consumption is influenced by integration design and configuration, including synchronization frequency, polling intervals, and pre-wired integration behavior. Clients are responsible for understanding how these factors impact usage and billing. Clients anticipating temporary elevated API usage related to migrations, historical data exports, ERP transitions, or similar activities should notify InterFulfillment in advance for review.
Suspension & Policy Updates
InterFulfillment may suspend or terminate API access where:
- usage violates this policy
- invoices remain unpaid
- required agreements are not executed
- integrations create operational or security concerns
InterFulfillment may update this policy periodically. Continued API usage constitutes acceptance of the current policy.
Contact
For API support or integration inquiries, please contact support@interfulfillment.com and include ‘Integration’ or ‘API’ in the subject line to help ensure faster ticket routing and response times.