Frequently asked questions
Common Enterprise API questions.
What is the FreeIGM Enterprise API?
The FreeIGM Enterprise API is a REST API that allows cargo management systems, freight ERP platforms, TMS software, and airline ground handling systems to submit CGM/Air Consol filings directly to ICEGATE — without any human intervention. Your system sends the manifest data, the API files it on ICEGATE, and returns the acknowledgement and live status back to your system automatically.
What systems can integrate with the FreeIGM API?
Any cargo management system, freight ERP, TMS, WMS, airline ground handling system, or custom-built logistics platform can integrate with the FreeIGM Enterprise API. The API is REST-based with JSON payloads and standard HTTP authentication, making it compatible with virtually any modern software stack.
What ICEGATE filing operations does the API support?
The FreeIGM Enterprise API supports fresh CGM filing, part filing, and amendment filing for Air Consol/CGM on ICEGATE. It also provides real-time status polling endpoints for Air Consol status, Air IGM status, and Bill of Entry readiness — all without any manual ICEGATE login or portal interaction.
How does the API handle ICEGATE acknowledgement?
After your system submits a filing through the API, FreeIGM handles the full ICEGATE submission cycle — digital signing, transmission, and acknowledgement capture — and returns the ICEGATE filing reference number and acceptance status to your system in the API response. Your cargo management system can store and display this directly without any manual lookups.
Is the API available 24/7?
Yes. The FreeIGM API is available around the clock, ensuring your cargo management system can file CGM and retrieve status at any time — including overnight, during weekend arrivals, and for time-critical pre-arrival filings. ICEGATE availability windows and maintenance periods are handled transparently with appropriate error codes.
What authentication method does the FreeIGM API use?
The FreeIGM Enterprise API uses token-based authentication with API keys scoped to your enterprise account. API keys can be rotated, scoped to specific operations (file-only, status-only, or full access), and monitored via the enterprise dashboard. Contact the team at support@freeigm.com for sandbox access and onboarding.
Does the API support webhook notifications for filing status?
Yes. The FreeIGM Enterprise API supports webhook callbacks so your cargo management system receives real-time push notifications when filing status changes — including ICEGATE acceptance, rejection, amendment requests, and Bill of Entry readiness — without needing to poll the status endpoint.
What is the SLA for the enterprise API?
Enterprise API integrations include an SLA covering uptime, response time, and support response. Contact the FreeIGM team at support@freeigm.com to discuss SLA terms, dedicated onboarding, and integration support for your cargo management platform.
Can we test the API in a sandbox before going live?
Yes. FreeIGM provides a sandbox environment for enterprise API integrations. The sandbox accepts the same request formats as production and returns simulated ICEGATE responses, so your development team can build, test, and validate the full integration before connecting to the live ICEGATE filing pipeline.
How long does enterprise API integration typically take?
Most cargo management system integrations complete in 1–5 days depending on the complexity of the existing system and the number of filing workflows. The FreeIGM team provides API documentation, a sandbox environment, a sample Postman collection, and direct technical support throughout the integration.
Is this a real REST API or file-based integration?
The FreeIGM Enterprise API is a standard REST API — not file upload, not CSV/Excel ingestion, not SFTP-based transfer. Your system sends a structured JSON POST request over HTTPS to a versioned endpoint (e.g. POST /api/v1/cgm/file), receives a JSON response with the ICEGATE filing reference and status, and can register a webhook URL to receive push notifications when filing status changes. This is the same API architecture used by logistics and customs platforms globally — HTTP verbs, JSON payloads, Bearer token authentication, and versioned endpoints.
Why is the API documentation not publicly listed on the website?
The FreeIGM Enterprise API is a controlled-access integration — not a self-serve developer sandbox open to anonymous sign-ups. API access is granted after enterprise onboarding to protect the ICEGATE filing pipeline from abuse and to ensure each integration is correctly configured for production filing. On onboarding, enterprises receive complete API documentation covering all endpoints, request/response schemas, error codes, and authentication setup, plus a Postman collection for immediate testing. This is the standard model for customs filing APIs globally — controlled access does not mean undocumented or immature; it means the integration is production-grade from day one.
Does FreeIGM provide Swagger or OpenAPI specification files?
Yes. Enterprise integrations receive full API documentation including an OpenAPI-compatible specification covering all endpoints, request body schemas, response formats, and error code definitions, along with a ready-to-use Postman collection. The sandbox environment allows your development team to test every filing and status flow against real API behavior before connecting to the live ICEGATE pipeline.
What does the API request and response look like?
A CGM filing request is a JSON POST to /api/v1/cgm/file with your MAWB number, flight details, total pieces and weight, and an array of house bill objects (each with HAWB number, consignee, shipper, pieces, weight, commodity). The API response returns the ICEGATE filing reference number, the acceptance status code, and a timestamp — structured JSON your system can parse and store directly. Status polling via GET /api/v1/cgm/{id}/status returns Air Consol status, Air IGM status, and BOE readiness in a single response. Full schema documentation with field definitions, data types, and example values is provided on enterprise onboarding.